man/xdg-ninja.1

   1 .nh
   2 .TH "xdg-ninja" "1" "May 2023" "b3nj5m1n" "xdg-ninja manual"
   3
   4 .SH NAME
   5 .PP
   6 \fBxdg-ninja\fP — because you wouldn't let just anyone into your $HOME
   7
   8 .SH SYNOPSIS
   9 .PP
  10 \fBxdg-ninja\fP [\fI\,OPTIONS\/\fR]
  11 .br
  12 \fBxdg-ninja\fP -h|--help
  13
  14 .SH DESCRIPTION
  15 .PP
  16 A shell script which checks your $HOME for unwanted files and directories.
  17
  18 .PP
  19 The script is designed to provide change recommendations and does not make any
  20 modifications to the system itself.
  21
  22 .PP
  23 This program has optional runtime dependencies that can modify and improve the
  24 visual output. The recommended dependency for best results is \fIglow\fP.
  25
  26 .SH OPTIONS
  27 .TP
  28 \fB-v\fP, \fB--no-skip-ok\fP
  29 Display messages for all files checked (verbose)
  30 .TP
  31 \fB--skip-ok\fP
  32 Don't display anything for files that do not exist (default behavior)
  33 .TP
  34 \fB--skip-unsupported\fP
  35 Don't display anything for files that do not have fixes available
  36
  37 .SH ENVIRONMENT VARIABLES
  38 .TP
  39 \fBXN_PROGRAMS_DIR\fP=
  40 Overwrites the path where programs information are located (default: programs/
  41 or ../share/xdg-ninja/programs/)
  42
  43 .SH COPYRIGHT
  44 .PP
  45 Licensed under the MIT license <http://opensource.org/licenses/MIT>.
  46 .br
  47 This is free software: you are free to change and redistribute it.
  48 There is NO WARRANTY, to the extent permitted by law.
  49
  50 .SH SEE ALSO
  51 .PP
  52 Sources, bug report, and more are available at <https://github.com/b3nj5m1n/xdg-ninja>.