neowofetch/uwufetch.1

123 lines
3.5 KiB
Groff
Raw Normal View History

2021-08-27 20:32:02 +02:00
.\" A little documentation for future use
.\" This a comment
.\" TH request sets the title of the man page and the section (between 1 and 8)
.\" SH is a primary section heading
.\" TP sets up an indented paragraph with label
.\" B makes text appear in bold face
.\" I makes text appear in italic face
.\" inline versions would look like \fBthis\fR and \fIthis\fR
.\" EX and EE surrounds example section with text as is, with no empty lines in between the actual lines
.TH UWUFETCH 1 "27 August 2021" "1.4" "A meme system info tool for Linux"
2021-08-27 20:32:02 +02:00
.SH DESCRIPTION
UwUfetch is a program inspired by neofetch and ufetch, that takes system information and prints it in terminal in an UwU way, with either UwU ascii or image logo.
.SH SYNOPSYS
\fBuwufetch\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
.SH OPTIONS
.TP
.B -a --ascii
prints the logo as ascii text (default)
.TP
.B -c --config
you can change config path
.TP
.B -d --distro
2022-04-17 18:56:10 +02:00
lets you choose the logo to print based on the distribution name
2021-08-27 20:32:02 +02:00
.TP
.B -h --help
2022-04-17 18:56:10 +02:00
prints the help page
2021-08-27 20:32:02 +02:00
.TP
.B -i --image
2021-11-06 00:34:53 +01:00
prints image instead of ascii logo uses a custom image if one is provided (disabled on iOS)
2022-04-17 18:56:10 +02:00
works in most terminals, read README.md for more info
2021-08-27 20:32:02 +02:00
.TP
.B -l --list
prints a list of all supported distributions
2022-04-17 18:56:10 +02:00
.TP
.B -v --version
prints the current uwufetch version
.TP
.B -w --write-cache writes to the cache file (~/.cache/uwufetch.cache)
prints the current uwufetch version
2021-08-27 20:32:02 +02:00
.SH CONFIGURATION
2022-03-08 21:24:52 +01:00
The system-wide config file is /etc/uwufetch/config, and you can use it to configure uwufetch globally or as a template for your own config.
The user config file is located in $HOME/.config/uwufetch/config (you need to create it), but you can change the path by using the \fB--config\fR option.
2021-08-27 20:32:02 +02:00
.TP
.SH EXAMPLE
.EX
distro=arch
2022-04-17 18:56:10 +02:00
image=~/Pictures/picture.png
ascii=true
2021-08-27 20:32:02 +02:00
user=true
os=true
host=true
kernel=true
cpu=true
2022-04-17 18:56:10 +02:00
gpu=0
2021-08-27 20:32:02 +02:00
ram=true
resolution=true
shell=true
pkgs=true
uptime=true
colors=true
.EE
.SH SUPPORTED DISTRIBUTIONS
Distribution name -d \fBoption\fR
.TP
.SH FULLY SUPPORTED
.EX
Nyalpine \fBalpine\fR
Nyarch Linuwu \fBarch\fR
2021-08-29 13:22:21 +02:00
ArcOwO Linuwu \fBarcolinux\fR
2021-08-27 20:32:02 +02:00
Nyartix Linuwu \fBartix\fR
Debinyan \fBdebian\fR
endeavOwO \fBendeavour\fR
2021-08-27 20:32:02 +02:00
Fedowa \fBfedora\fR
GentOwO \fBgentoo\fR
GnUwU gUwUix \fBguix\fR
Miwint \fBlinuxmint\fR
Myanjawo \fBmanjaro\fR
Myanjawo AWM \fBmanjaro-arm\fR
OwOpenSUSE \fBopensuse-leap\fR
Pop OwOs \fBpop\fR
RaspNyan \fBraspbian\fR
Swackwawe \fBslackware\fR
sOwOlus \fBsolus\fR
2021-08-27 20:32:02 +02:00
UwUntu \fBubuntu\fR
OwOid \fBvoid\fR
Nyandroid \fBandroid\fR
Unknown (tux logo) \fBunknown\fR
.EE
.TP
.SH IMAGE OR ASCII ONLY
.EX
2021-09-10 00:51:37 +02:00
AmogOwOs \fBamogos\fR
2021-08-27 20:32:02 +02:00
KDE NeOwOn \fBneon\fR
nixOwOs \fBnixos\fR
2021-09-29 21:47:47 +02:00
xuwulinux \fBxerolinux\fR
2021-08-27 20:32:02 +02:00
FweeBSD \fBfreebsd\fR
OwOpenBSD \fBopenbsd\fR
macOwOS \fBmacos\fR
2021-11-06 00:34:53 +01:00
iOwOS \fBios\fR
2021-08-27 20:32:02 +02:00
WinyandOwOws \fBwindows\fR
.EE
.SH EXAMPLES
.EX
uwufetch -d arch # uses ascii Arch logo
2022-04-17 18:56:10 +02:00
uwufetch -i some_image.png # prints custom image (no full path is needed)
uwufetch -id artix # uses Artix image logo (which is also uwu)
2021-08-27 20:32:02 +02:00
.EE
.SH DEPENDENCIES
.TP 8
.B lshw
better gpu info
.TP
.B viu
print images instead of ascii logo
.TP
.B kitty
better image viewing
.P
All of these dependencies are optional. There are no required dependencies.
.SH LICENSE AND COPYRIGHT
uwufetch is provided under the GPL3 license, for copyright info read https://github.com/TheDarkBug/uwufetch/tree/main/res/COPYRIGHT.md.