neowofetch/uwufetch_man.md

120 lines
3 KiB
Markdown
Raw Normal View History

2021-04-12 13:16:45 +02:00
% UWUFETCH(1) uwufetch 1.2
% TheDarkBug
% April 2021
2021-04-12 13:16:45 +02:00
<!---
I am using markdown instead of troff because i don't know how to use it, and the same could be for some people.
I also don't know if this is a good practice, but it works, so I am keeping it.
To "compile" this file you need pandoc (https://pandoc.org).
--->
2021-04-12 13:16:45 +02:00
# NAME
2021-04-12 13:16:45 +02:00
uwufetch - A meme system info tool for Linux, based on nyan/uwu trend on r/linuxmasterrace.
# SYNOPSIS
2021-04-12 13:16:45 +02:00
**uwufetch** [*OPTIONS*] [*ARGUMENTS*]\
## OPTIONS
-a --ascii\
2021-04-12 13:16:45 +02:00
prints the logo as ascii text (default)
2021-04-14 23:49:02 +02:00
-c --config\
you can change config path
-d --distro\
2021-04-12 13:16:45 +02:00
you can choose the logo to print by the distro name
-h --help\
2021-04-12 13:16:45 +02:00
prints a help page
-i --image\
2021-04-14 23:49:02 +02:00
prints image instead of ascii logo\
uses a custom image if one is provided
2021-04-12 13:16:45 +02:00
-l --list\
2021-04-12 13:16:45 +02:00
prints a list of all supported distributions
# CONFIG FILE
2021-04-19 00:15:38 +02:00
The config file is located in $HOME/.config/uwufetch/config.json (you need to create it), but you can change the path by using the `--config` option.
## EXAMPLE
```json
{
"distribution": "debian",
"image": "/home/user/Pictures/debian.png",
"ascii": false,
"user": true,
"os": true,
"kernel": true,
"cpu": true,
"gpu": true,
"ram": true,
"resolution": true,
"shell": true,
"pkgs": true,
"uptime": true,
"colors": true
}
```
2021-04-12 13:16:45 +02:00
# SUPPORTED DISTRIBUTIONS
Distribution name\ \ \ \ \ -d option
Nyalpine\ \ \ \ \ \ \ \ \ alpine\
Nyarch Linuwu\ \ \ \ \ \ \ arch\
Nyartix Linuwu\ \ \ \ \ \ \ artix\
Debinyan\ \ \ \ \ \ \ \ \ debian\
Fedowa\ \ \ \ \ \ \ \ \ \ \ fedora\
GentOwO\ \ \ \ \ \ \ \ \ \ gentoo\
GnUwU gUwUix\ \ \ \ \ \ \ guix\
Miwint\ \ \ \ \ \ \ \ \ \ \ linuxmint\
Myanjawo\ \ \ \ \ \ \ \ \ manjaro\
Myanjawo AWM\ \ \ \ \ \ \ \\"manjaro-arm\\"\
OwOpenSUSE\ \ \ \ \ \ \ \ \ \\"opensuse-leap\\"\
Pop OwOs\ \ \ \ \ \ \ \ \ pop\
RaspNyan\ \ \ \ \ \ \ \ \ raspbian\
UwUntu\ \ \ \ \ \ \ \ \ \ \ ubuntu\
OwOid\ \ \ \ \ \ \ \ \ \ \ \\"void\\"\
Nyandroid\ \ \ \ \ \ \ \ \ android\
Unknown (tux logo)\ \ \ \ \ unknown
2021-04-12 13:16:45 +02:00
--image/ascii only distributions--\
endeavOwO\ \ \ \ \ \ \ \ \ endeavour\
KDE NeOwOn\ \ \ \ \ \ \ \ \ neon\
nixOwOs\ \ \ \ \ \ \ \ \ \ nixos\
Swackwawe\ \ \ \ \ \ \ \ \ slackware\
sOwOlus\ \ \ \ \ \ \ \ \ \ solus\
FweeBSD\ \ \ \ \ \ \ \ \ \ freebsd\
OwOpenBSD\ \ \ \ \ \ \ \ \ openbsd
2021-04-12 13:16:45 +02:00
# DESCRIPTION
2021-04-12 13:16:45 +02:00
Uwufetch is a program inspired by neofetch and ufetch, that takes system informations\
and prints them in the terminal in an UwU way, with and UwU ascii logo or image.
# EXAMPLES
uwufetch -d arch\ \ \ \ \ \ \ \ \ \ # prints arch logo\
uwufetch -\-custom some_image.png\ \ # prints custom image (does not need full path)\
ueufetch -i -d artix\ \ \ \ \ \ \ \ # prints artix image
2021-04-12 13:16:45 +02:00
# DEPENDANCES
json-c\ \ \ to parse the config file\
lshw\ \ \ better gpu info\
viu\ \ \ \ print images instead of ascii logo\
kitty\ \ \ better image viewing
2021-04-12 13:16:45 +02:00
All of this are optional, there is no necessary dependancy.
# LICENSE AND COPYRIGTH
uwufetch is provided under the GPL3 license, for copyright info read\
https://github.com/TheDarkBug/uwufetch/tree/main/res/COPYRIGHT.md.