From 2f2a1ac9bc4f58ab883f845b38c696d43d9b54cf Mon Sep 17 00:00:00 2001 From: TheDarkBug Date: Mon, 13 Feb 2023 13:38:44 +0100 Subject: [PATCH] Updated man page --- .gitignore | 1 + Makefile | 8 ++++---- README.md | 2 +- default.config | 2 +- uwufetch.1 | 36 ++++++++++++++++++++++-------------- uwufetch.1.gz | Bin 1730 -> 0 bytes 6 files changed, 29 insertions(+), 20 deletions(-) delete mode 100644 uwufetch.1.gz diff --git a/.gitignore b/.gitignore index 8e15fe7..35ba267 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ uwufetch uwufetch_* +*.gz *.core *.zip *.idea diff --git a/Makefile b/Makefile index 76faa1b..8a02105 100644 --- a/Makefile +++ b/Makefile @@ -83,7 +83,7 @@ lib: $(LIB_FILES) $(AR) rcs lib$(LIB_FILES:.c=.a) $(LIB_FILES:.c=.o) $(CC) $(CFLAGS) -shared -o lib$(LIB_FILES:.c=.so) $(LIB_FILES:.c=.o) -release: build +release: build man mkdir -pv $(NAME)_$(UWUFETCH_VERSION)-$(PLATFORM_ABBR) cp $(RELEASE_SCRIPTS) $(NAME)_$(UWUFETCH_VERSION)-$(PLATFORM_ABBR) cp -r res $(NAME)_$(UWUFETCH_VERSION)-$(PLATFORM_ABBR) @@ -102,7 +102,7 @@ debug: CFLAGS = $(CFLAGS_DEBUG) debug: build ./$(NAME) $(ARGS) -install: build +install: build man mkdir -pv $(DESTDIR)/$(PREFIX) $(DESTDIR)/$(LIBDIR)/$(NAME) $(DESTDIR)/$(MANDIR) $(ETC_DIR)/$(NAME) cp $(NAME) $(DESTDIR)/$(PREFIX) cp lib$(LIB_FILES:.c=.so) $(DESTDIR)/$(LIBDIR) @@ -127,8 +127,8 @@ ascii_debug: ls res/ascii/$(ASCII).txt | entr -c ./$(NAME) -d $(ASCII) man: - gzip --keep $(NAME).1 + sed "s/{DATE}/$(shell date '+%d %B %Y')/g" $(NAME).1 | sed "s/{UWUFETCH_VERSION}/$(UWUFETCH_VERSION)/g" | gzip > $(NAME).1.gz man_debug: @clear - man -P cat ./uwufetch.1 + man -P cat ./$(NAME).1 diff --git a/README.md b/README.md index 1af398d..ce8ebde 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ AmogOwOS, Nyalpine, Nyarch Linuwu, ArcOwO, Nyartix Linuwu, Debinyan, endevaOwO, ### Partial support (Either no ASCII art, or no image is provided) -Dewepyn, FemboyOS, KDE NeOwOn, nixOwOs, xuwulinux, Wocky Linuwu; Plus FweeBSD, OwOpenBSD, macOwOS and iOwOS; Plus WinyandOwOws. +Dewepyn, FemboyOWOS, KDE NeOwOn, nixOwOs, xuwulinux, Wocky Linuwu; Plus FweeBSD, OwOpenBSD, macOwOS and iOwOS; Plus WinyandOwOws. ## Building and installation diff --git a/default.config b/default.config index 7d86344..e6cb990 100644 --- a/default.config +++ b/default.config @@ -9,7 +9,7 @@ gpu=0 gpu=3 gpu=1 ram=true -resolution=true +resolution=false shell=true pkgs=true uptime=true diff --git a/uwufetch.1 b/uwufetch.1 index e8ac3e3..2e8c059 100644 --- a/uwufetch.1 +++ b/uwufetch.1 @@ -7,16 +7,13 @@ .\" 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" +.TH UWUFETCH 1 "{DATE}" "{UWUFETCH_VERSION}" "A meme system info tool for Linux" .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 @@ -33,14 +30,14 @@ works in most terminals, read README.md for more info .B -l --list prints a list of all supported distributions .TP +.B -r --read-cache +reads the cache file (~/.cache/uwufetch.cache) +.TP .B -v --version prints the current uwufetch version .TP -.B -w --write-cache writes to the cache file (~/.cache/uwufetch.cache) +.B -w --write-cache writes to the cache file (~/.cache/uwufetch.cache) -.TP -.B -w --write-cache writes to the cache file (~/.cache/uwufetch.cache) -reads from the cache file (~/.cache/uwufetch.cache) .SH CONFIGURATION 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. @@ -48,8 +45,7 @@ The user config file is located in $HOME/.config/uwufetch/config (you need to cr .SH EXAMPLE .EX distro=arch -image=~/Pictures/picture.png -ascii=true +image=path/to/custom/image.png user=true os=true host=true @@ -70,6 +66,7 @@ Distribution name -d \fBoption\fR .TP .SH FULLY SUPPORTED .EX +AmogOwOs \fBamogos\fR Nyalpine \fBalpine\fR Nyarch Linuwu \fBarch\fR ArcOwO Linuwu \fBarcolinux\fR @@ -95,10 +92,12 @@ Unknown (tux logo) \fBunknown\fR .TP .SH IMAGE OR ASCII ONLY .EX -AmogOwOs \fBamogos\fR +Dewepyn \fBdeepin\fR +FemboyOWOS \fBfemboyos\fR KDE NeOwOn \fBneon\fR nixOwOs \fBnixos\fR xuwulinux \fBxerolinux\fR +Wocky Linuwu \fBrocky\fR FweeBSD \fBfreebsd\fR OwOpenBSD \fBopenbsd\fR macOwOS \fBmacos\fR @@ -113,15 +112,24 @@ uwufetch -id artix # uses Artix image logo (which is also uwu) .EE .SH DEPENDENCIES .TP 8 -.B lshw -better gpu info +.B freecolor +ram usage on FreeBSD +.TP +.B libc (required) +glibc on gnu systems or musl on non-gnu systems .TP .B viu print images instead of ascii logo .TP +.B xwininfo +get screen resolution +.TP +.B lshw +better gpu info +.TP .B kitty better image viewing .P -All of these dependencies are optional. There are no required dependencies. +All of these dependencies are optional. There are no required dependencies (except libc). .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. diff --git a/uwufetch.1.gz b/uwufetch.1.gz deleted file mode 100644 index 138c2d238f270dd63ef862c8d41120f918ca2416..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1730 zcmV;z20i&7iwFoOek)@D19f+GW@U6^Xf81TtyfELsJtI7YUHqcjjK87X@bF z#7bf`u?;)MOwcI`TB0o0lBkkYWN+?o?{^L*zh)LK&@3G3@H{@Aw+7#@#7Gp{`$CD- zBu%L*FTFOE$czJYHCOdU8Mk{ zQdqHaV`ZI-R{LBOa;*yHzXyn|0yeetLe{mC7E)quid1AW33r?PoJo6G=;X+zt3p>w zd?@Px%Zb)B&{7z)g%`I#sGTh9;^-F! zA5b{>;x-T}BUD-Yy&&_B;dkyMpUT8HvIu9<05Ms8T|LHc56^J!)#ty6QL||fq0hg3 z{&Xd-J`H}u??{xYgxS6Gs)WMK2yaZmaevWOv%880h{iZxJ}f5lx5;c8t=d(le3JJe zGH^GEx>{QVV7(WWGJ%7x+3@2n5K1pRd-ueeEkm9WC!$>;pxV>Lyt1XPa2-vD0!BqE z_njXUew1aRbcxmiXpt$%uflB1fFUp6r?dI;eHkGbO&d^9K>m(s%=jity#9mVM~kP` zYdn2p3QKn!aN|50+>1LY?(W!B)S)DYlQD`+=J53hq=pZ%tHCcC$!sj8jL8-UL^PwRCW}3DIXMy>8f@l`PdkXAYgY zD(X|{^v)G|;L_k?ANFj)p@^$T)lngbYcd4%0`39GCsX#E8K5Z23gpCxP66#2pyav; zAoXl{6Sc-}IdMyaRP2L{{I+Cd5s${N@t{mO|4L&OC&>Y00gMIi*+Z0q-WXd^pqlF1 zSZV^NzHkTW4@h?~$yF?}s;Acl+U~#5p8pV74$8f-} z!(LZ-#kK!;k^iH0@~sn@MX3IJ^C*Ic+4OPpv|5a~?%(phPu#VLZlAua2SFb~`k-YP z4sW@x`?N>WP;mo!IOUUxgMqzHB_y#o(Oa5FUD+OCDD*FYiY^?3(Fb7Bvmi zlRpRtA_;>5ZsTFpHYW_0+j%sy$*i6I?AR1Ezj_s3@6MQ*2Shp_tF^B7i1#^$6lBR4 zP}nZy2iZAe2xO!t@jR;3v{Hx*B^k(862lXk%()6?*nn&dGgLItHuwS76NVs8 z0lB-4PQ?!lA4aELdQ_=3XDpN+fyfrBZAIPZ+BZ8MfH%QHAajaSk#uQ3c^y5)Vzv;Y z<-=qmX498#g+e#J_Z)cR^%_ROZy06lj5{>Oh=ZY65PQn z$6mN(Hym0%+60&O4}X8^_6y!OM#MrsKM~ZznNt0eTPgKT66q%T*-CPag*j`m8gTc< zc%X)_(wkFN1i~K+?hL_*PmY_VxNdXZZN7ywG`(&PmmJ6Qcsh=!50jYpM)5n%@51G6 zge@JbjzCvF+h;y>6BdzR!u@>N>bbZ0KHK-I0;UhGTK*oIMd05dOBU;qFB