Added man pages, close #68
This commit is contained in:
parent
873c3f7246
commit
eb2471b86f
6 changed files with 98 additions and 1 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,3 +1,4 @@
|
|||
uwufetch
|
||||
*.zip
|
||||
*.vscode
|
||||
*.1
|
9
Makefile
9
Makefile
|
@ -4,9 +4,12 @@ CFLAGS = -O3
|
|||
CFLAGS_DEBUG = -Wall -Wextra
|
||||
PREFIX = /usr/bin
|
||||
CC = cc
|
||||
MAN_COMPILER = pandoc
|
||||
|
||||
build: $(FILES)
|
||||
$(CC) $(CFLAGS) -o $(NAME) $(FILES)
|
||||
$(MAN_COMPILER) $(NAME)_man.md -st man -o $(NAME).1
|
||||
@gzip $(NAME).1
|
||||
|
||||
debug:
|
||||
@clear
|
||||
|
@ -17,10 +20,12 @@ install:
|
|||
cp $(NAME) $(DESTDIR)$(PREFIX)/$(NAME)
|
||||
ls $(DESTDIR)/usr/lib/uwufetch/ 2> /dev/null || mkdir $(DESTDIR)/usr/lib/uwufetch/
|
||||
cp res/* $(DESTDIR)/usr/lib/uwufetch/
|
||||
cp ./$(NAME).1.gz $(DESTDIR)/usr/share/man/man1/
|
||||
|
||||
uninstall:
|
||||
rm -f $(DESTDIR)$(PREFIX)/$(NAME)
|
||||
rm -rf $(DESTDIR)/usr/lib/uwufetch/
|
||||
rm -rf $(DESTDIR)/usr/share/man/man1/$(NAME).1.gz
|
||||
|
||||
termux: build
|
||||
cp $(NAME) $(DESTDIR)/data/data/com.termux/files$(PREFIX)/$(NAME)
|
||||
|
@ -30,3 +35,7 @@ termux: build
|
|||
termux_uninstall:
|
||||
rm -rf $(DESTDIR)/data/data/com.termux/files$(PREFIX)/$(NAME)
|
||||
rm -rf $(DESTDIR)/data/data/com.termux/files/usr/lib/uwufetch/
|
||||
|
||||
man_debug: build
|
||||
@clear
|
||||
@man -P cat ./uwufetch.1
|
|
@ -27,6 +27,12 @@ Right now, the package is only available on the AUR:
|
|||
|
||||
##### Via source
|
||||
|
||||
|
||||
Building requisites:
|
||||
- Make
|
||||
- A c compiler
|
||||
- Pandoc to compile man pages
|
||||
|
||||
To install UwUfetch from the source, type these commands in the terminal:
|
||||
|
||||
```shell
|
||||
|
|
BIN
uwufetch.1.gz
Normal file
BIN
uwufetch.1.gz
Normal file
Binary file not shown.
|
@ -282,7 +282,7 @@ void list(char *arg) { // prints distribution list
|
|||
" %sBSD:\n"
|
||||
" freebsd, %sopenbsd\n\n"
|
||||
" %sOther/spare distributions:\n"
|
||||
" %salpine, %sfedora, %sgentoo, %s\"void\", android, %sgnu, guix, %sunknown\n",
|
||||
" %salpine, %sfedora, %sgentoo, %s\"void\", \"opensuse-leap\", android, %sgnu, guix, %sunknown\n",
|
||||
arg,
|
||||
BLUE, NORMAL, BLUE, GREEN, // Arch based colors
|
||||
RED, YELLOW, NORMAL, RED, GREEN, BLUE, RED, // Debian based colors
|
||||
|
|
81
uwufetch_man.md
Normal file
81
uwufetch_man.md
Normal file
|
@ -0,0 +1,81 @@
|
|||
% UWUFETCH(1) uwufetch 1.2
|
||||
% TheDarkBug
|
||||
% April 2021
|
||||
<!---
|
||||
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).
|
||||
--->
|
||||
# NAME
|
||||
uwufetch - A meme system info tool for Linux, based on nyan/uwu trend on r/linuxmasterrace.
|
||||
|
||||
# SYNOPSIS
|
||||
**uwufetch** [*OPTIONS*] [*ARGUMENTS*]\
|
||||
|
||||
## OPTIONS
|
||||
-a --ascii\
|
||||
prints the logo as ascii text (default)
|
||||
|
||||
-c --custom\
|
||||
you can choose a custom image path
|
||||
|
||||
-d --distro\
|
||||
you can choose the logo to print by the distro name
|
||||
|
||||
-h --help\
|
||||
prints a help page
|
||||
|
||||
-i --image\
|
||||
prints image instead of ascii logo
|
||||
|
||||
-l --list\
|
||||
prints a list of all supported distributions
|
||||
|
||||
# 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
|
||||
|
||||
--image/ascii only distributions--\
|
||||
endeavOwO\ \ \ \ \ \ \ \ \ endeavour\
|
||||
KDE NeOwOn\ \ \ \ \ \ \ \ \ neon\
|
||||
nixOwOs\ \ \ \ \ \ \ \ \ \ nixos\
|
||||
Swackwawe\ \ \ \ \ \ \ \ \ slackware\
|
||||
sOwOlus\ \ \ \ \ \ \ \ \ \ solus\
|
||||
FweeBSD\ \ \ \ \ \ \ \ \ \ freebsd\
|
||||
OwOpenBSD\ \ \ \ \ \ \ \ \ openbsd
|
||||
|
||||
# DESCRIPTION
|
||||
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
|
||||
|
||||
# DEPENDANCES
|
||||
lshw\ \ better gpu info\
|
||||
viu\ \ \ print images instead of ascii logo\
|
||||
kitty\ \ better image viewing
|
||||
|
||||
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.
|
Loading…
Reference in a new issue