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

Commit

Permalink
Updated man page
Browse files Browse the repository at this point in the history
  • Loading branch information
ad-oliviero committed Feb 13, 2023
1 parent 9403f4c commit 2f2a1ac
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 20 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
uwufetch
uwufetch_*
*.gz
*.core
*.zip
*.idea
Expand Down
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion default.config
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ gpu=0
gpu=3
gpu=1
ram=true
resolution=true
resolution=false
shell=true
pkgs=true
uptime=true
Expand Down
36 changes: 22 additions & 14 deletions uwufetch.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,23 +30,22 @@ 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.
.TP
.SH EXAMPLE
.EX
distro=arch
image=~/Pictures/picture.png
ascii=true
image=path/to/custom/image.png
user=true
os=true
host=true
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Binary file removed uwufetch.1.gz
Binary file not shown.

0 comments on commit 2f2a1ac

Please sign in to comment.