Skip to content
This repository was archived by the owner on Apr 23, 2024. It is now read-only.

Commit 2f2a1ac

Browse files
committed
Updated man page
1 parent 9403f4c commit 2f2a1ac

File tree

6 files changed

+29
-20
lines changed

6 files changed

+29
-20
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
uwufetch
22
uwufetch_*
3+
*.gz
34
*.core
45
*.zip
56
*.idea

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ lib: $(LIB_FILES)
8383
$(AR) rcs lib$(LIB_FILES:.c=.a) $(LIB_FILES:.c=.o)
8484
$(CC) $(CFLAGS) -shared -o lib$(LIB_FILES:.c=.so) $(LIB_FILES:.c=.o)
8585

86-
release: build
86+
release: build man
8787
mkdir -pv $(NAME)_$(UWUFETCH_VERSION)-$(PLATFORM_ABBR)
8888
cp $(RELEASE_SCRIPTS) $(NAME)_$(UWUFETCH_VERSION)-$(PLATFORM_ABBR)
8989
cp -r res $(NAME)_$(UWUFETCH_VERSION)-$(PLATFORM_ABBR)
@@ -102,7 +102,7 @@ debug: CFLAGS = $(CFLAGS_DEBUG)
102102
debug: build
103103
./$(NAME) $(ARGS)
104104

105-
install: build
105+
install: build man
106106
mkdir -pv $(DESTDIR)/$(PREFIX) $(DESTDIR)/$(LIBDIR)/$(NAME) $(DESTDIR)/$(MANDIR) $(ETC_DIR)/$(NAME)
107107
cp $(NAME) $(DESTDIR)/$(PREFIX)
108108
cp lib$(LIB_FILES:.c=.so) $(DESTDIR)/$(LIBDIR)
@@ -127,8 +127,8 @@ ascii_debug:
127127
ls res/ascii/$(ASCII).txt | entr -c ./$(NAME) -d $(ASCII)
128128

129129
man:
130-
gzip --keep $(NAME).1
130+
sed "s/{DATE}/$(shell date '+%d %B %Y')/g" $(NAME).1 | sed "s/{UWUFETCH_VERSION}/$(UWUFETCH_VERSION)/g" | gzip > $(NAME).1.gz
131131

132132
man_debug:
133133
@clear
134-
man -P cat ./uwufetch.1
134+
man -P cat ./$(NAME).1

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ AmogOwOS, Nyalpine, Nyarch Linuwu, ArcOwO, Nyartix Linuwu, Debinyan, endevaOwO,
1515

1616
### Partial support (Either no ASCII art, or no image is provided)
1717

18-
Dewepyn, FemboyOS, KDE NeOwOn, nixOwOs, xuwulinux, Wocky Linuwu; Plus FweeBSD, OwOpenBSD, macOwOS and iOwOS; Plus WinyandOwOws.
18+
Dewepyn, FemboyOWOS, KDE NeOwOn, nixOwOs, xuwulinux, Wocky Linuwu; Plus FweeBSD, OwOpenBSD, macOwOS and iOwOS; Plus WinyandOwOws.
1919

2020
## Building and installation
2121

default.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ gpu=0
99
gpu=3
1010
gpu=1
1111
ram=true
12-
resolution=true
12+
resolution=false
1313
shell=true
1414
pkgs=true
1515
uptime=true

uwufetch.1

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@
77
.\" I makes text appear in italic face
88
.\" inline versions would look like \fBthis\fR and \fIthis\fR
99
.\" EX and EE surrounds example section with text as is, with no empty lines in between the actual lines
10-
.TH UWUFETCH 1 "27 August 2021" "1.4" "A meme system info tool for Linux"
10+
.TH UWUFETCH 1 "{DATE}" "{UWUFETCH_VERSION}" "A meme system info tool for Linux"
1111
.SH DESCRIPTION
1212
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.
1313
.SH SYNOPSYS
1414
\fBuwufetch\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
1515
.SH OPTIONS
1616
.TP
17-
.B -a --ascii
18-
prints the logo as ascii text (default)
19-
.TP
2017
.B -c --config
2118
you can change config path
2219
.TP
@@ -33,23 +30,22 @@ works in most terminals, read README.md for more info
3330
.B -l --list
3431
prints a list of all supported distributions
3532
.TP
33+
.B -r --read-cache
34+
reads the cache file (~/.cache/uwufetch.cache)
35+
.TP
3636
.B -v --version
3737
prints the current uwufetch version
3838
.TP
39-
.B -w --write-cache writes to the cache file (~/.cache/uwufetch.cache)
39+
.B -w --write-cache
4040
writes to the cache file (~/.cache/uwufetch.cache)
41-
.TP
42-
.B -w --write-cache writes to the cache file (~/.cache/uwufetch.cache)
43-
reads from the cache file (~/.cache/uwufetch.cache)
4441
.SH CONFIGURATION
4542
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.
4643
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.
4744
.TP
4845
.SH EXAMPLE
4946
.EX
5047
distro=arch
51-
image=~/Pictures/picture.png
52-
ascii=true
48+
image=path/to/custom/image.png
5349
user=true
5450
os=true
5551
host=true
@@ -70,6 +66,7 @@ Distribution name -d \fBoption\fR
7066
.TP
7167
.SH FULLY SUPPORTED
7268
.EX
69+
AmogOwOs \fBamogos\fR
7370
Nyalpine \fBalpine\fR
7471
Nyarch Linuwu \fBarch\fR
7572
ArcOwO Linuwu \fBarcolinux\fR
@@ -95,10 +92,12 @@ Unknown (tux logo) \fBunknown\fR
9592
.TP
9693
.SH IMAGE OR ASCII ONLY
9794
.EX
98-
AmogOwOs \fBamogos\fR
95+
Dewepyn \fBdeepin\fR
96+
FemboyOWOS \fBfemboyos\fR
9997
KDE NeOwOn \fBneon\fR
10098
nixOwOs \fBnixos\fR
10199
xuwulinux \fBxerolinux\fR
100+
Wocky Linuwu \fBrocky\fR
102101
FweeBSD \fBfreebsd\fR
103102
OwOpenBSD \fBopenbsd\fR
104103
macOwOS \fBmacos\fR
@@ -113,15 +112,24 @@ uwufetch -id artix # uses Artix image logo (which is also uwu)
113112
.EE
114113
.SH DEPENDENCIES
115114
.TP 8
116-
.B lshw
117-
better gpu info
115+
.B freecolor
116+
ram usage on FreeBSD
117+
.TP
118+
.B libc (required)
119+
glibc on gnu systems or musl on non-gnu systems
118120
.TP
119121
.B viu
120122
print images instead of ascii logo
121123
.TP
124+
.B xwininfo
125+
get screen resolution
126+
.TP
127+
.B lshw
128+
better gpu info
129+
.TP
122130
.B kitty
123131
better image viewing
124132
.P
125-
All of these dependencies are optional. There are no required dependencies.
133+
All of these dependencies are optional. There are no required dependencies (except libc).
126134
.SH LICENSE AND COPYRIGHT
127135
uwufetch is provided under the GPL3 license, for copyright info read https://github.com/TheDarkBug/uwufetch/tree/main/res/COPYRIGHT.md.

uwufetch.1.gz

-1.69 KB
Binary file not shown.

0 commit comments

Comments
 (0)