From a3f02e4adf030a737ecc17d935a92a403ea6e1f7 Mon Sep 17 00:00:00 2001 From: Asperatus Date: Wed, 10 May 2023 16:06:11 -0400 Subject: [PATCH] man: create xdg-ninja.1 man page --- Makefile | 4 +++- man/xdg-ninja.1 | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 man/xdg-ninja.1 diff --git a/Makefile b/Makefile index bde9174..7ecc1be 100644 --- a/Makefile +++ b/Makefile @@ -11,8 +11,10 @@ install: cp -r programs $(DESTDIR)$(PREFIX)/share/xdg-ninja/ install -d $(DESTDIR)$(PREFIX)/share/doc/xdg-ninja/ install -m 0644 LICENSE README.md $(DESTDIR)$(PREFIX)/share/doc/xdg-ninja/ + install -m 0644 man/xdg-ninja.1 $(DESTDIR)$(PREFIX)/share/man/man1/ uninstall: rm -rf $(DESTDIR)$(PREFIX)/bin/xdg-ninja \ $(DESTDIR)$(PREFIX)/share/xdg-ninja \ - $(DESTDIR)$(PREFIX)/share/doc/xdg-ninja + $(DESTDIR)$(PREFIX)/share/doc/xdg-ninja \ + $(DESTDIR)$(PREFIX)/share/man/man1/xdg-ninja.1 diff --git a/man/xdg-ninja.1 b/man/xdg-ninja.1 new file mode 100644 index 0000000..2685919 --- /dev/null +++ b/man/xdg-ninja.1 @@ -0,0 +1,52 @@ +.nh +.TH "xdg-ninja" "1" "May 2023" "b3nj5m1n" "xdg-ninja manual" + +.SH NAME +.PP +\fBxdg-ninja\fP — because you wouldn't let just anyone into your $HOME + +.SH SYNOPSIS +.PP +\fBxdg-ninja\fP [\fI\,OPTIONS\/\fR] +.br +\fBxdg-ninja\fP -h|--help + +.SH DESCRIPTION +.PP +A shell script which checks your $HOME for unwanted files and directories. + +.PP +The script is designed to provide change recommendations and does not make any +modifications to the system itself. + +.PP +This program has optional runtime dependencies that can modify and improve the +visual output. The recommended dependency for best results is \fIglow\fP. + +.SH OPTIONS +.TP +\fB-v\fP, \fB--no-skip-ok\fP +Display messages for all files checked (verbose) +.TP +\fB--skip-ok\fP +Don't display anything for files that do not exist (default behavior) +.TP +\fB--skip-unsupported\fP +Don't display anything for files that do not have fixes available + +.SH ENVIRONMENT VARIABLES +.TP +\fBXN_PROGRAMS_DIR\fP= +Overwrites the path where programs information are located (default: programs/ +or ../share/xdg-ninja/programs/) + +.SH COPYRIGHT +.PP +Licensed under the MIT license . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +.SH SEE ALSO +.PP +Sources, bug report, and more are available at . \ No newline at end of file -- 2.47.3