From eb2471b86f912e6da89c0ae94596ba36280962a5 Mon Sep 17 00:00:00 2001 From: TheDarkBug Date: Mon, 12 Apr 2021 13:16:45 +0200 Subject: [PATCH] Added man pages, close #68 --- .gitignore | 1 + Makefile | 9 ++++++ README.md | 6 ++++ uwufetch.1.gz | Bin 0 -> 1180 bytes uwufetch.c | 2 +- uwufetch_man.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 98 insertions(+), 1 deletion(-) create mode 100644 uwufetch.1.gz create mode 100644 uwufetch_man.md diff --git a/.gitignore b/.gitignore index 4119127..6d00c33 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ uwufetch *.zip *.vscode +*.1 \ No newline at end of file diff --git a/Makefile b/Makefile index 8f5c9af..e9ea402 100644 --- a/Makefile +++ b/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 \ No newline at end of file diff --git a/README.md b/README.md index 3422c37..a93ccb4 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/uwufetch.1.gz b/uwufetch.1.gz new file mode 100644 index 0000000000000000000000000000000000000000..bdd5de8a7ad96ebd66ae910987a0777a4cad8e63 GIT binary patch literal 1180 zcmV;N1Y`RjiwFpSCUjr`19f+GW@U6^Xf81Tg;rZ{;y4t3=T{tcUpi6?)6Uzz(UK`> zTZjl~c2v;HBqs4Tu`|9j@bBl?4wR&jkl#&bNZ_*7#b}KqFGGxd=Dw*R1!@S z*z6%BJP|S6_wT;-`m3v6e=&xu<&Wj}VDUJ)+!m zGO~TIAB|x;dw=jf)78KN8X<7i|TLD^#9JWHjGvj7=0~?~y62XD*2_GOA zw4~gg^yDD7n1Uc%N)pq)QxyH2&cbLCIc2Nu>%;n>5ntwOc*Q@H^(KMs&mMwdk-eK?vbZ+IO0Wikwk# z`fL#-Nt5_Qxt>+CP9Am-yuvLWUsg*<@fX{jrKP6r+6${N=YO!#Uw_24xEPZENhLbC zg+;XQ%7F*NA1~*LuTrg7ulcWa&A%nGs1N0@R=>bNm6S)zD7fgwhdhB$WfZ;5DJd^W z3`GejRdx7Piq>tN6ID*TOGF~%bCF=OxIR~hr;phf1by=kEg17aX>RCsK5Y zs{t+B`5PA%hih$iuD^U~_+k8KKOc@gYv9|F;5Y&s9mPSK3UB~X^4@tBJVY4TWd1V> zU`mn6FNT&=(aHs9yFcU|S!^d%lNMDZeyd2;(Y;jeAhOlJ6spTjw?ZWl(P}Ier4P}l zleU$VZdCHAX7B=ZQtb_KJZ$fyAbOln+$?rUTpl(GW`{&6MJkD1CsfI#Ut=()9)a}& z9(;pyk7&^3jjDPB>DdiL+D*s}l2Z#U?_;c6;cjf=;(`5#tZj1@+226LwAW=% zPUal$HLlqFrV{)+d>uCmIL zHdJG1AuWyD3Y)6m*>R@&9mYvi7gviD>KoH~@0hg)@AEsOIBrsB#1Q>O2|BaIBx$`3 zklfY_#dl_dg9Q~+rHI5{L9sFu!sES9>ht6=m_`8%rz3crg+J$$r^UFLVHANy`py!J zufaYcT`fI@&);yQ#W)G*jaz|ZQSK#6GwoMniO%&htxNUyV31;knN2?y#bA-q5s_~X uCLJ793~))NgMu(VkW>w7JI0HCk$5YI%f)y$k9r^6e(yJY_ +# 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.