share/man/README.md

   1 # Manual pages for nit commands
   2
   3 Pages, in markdown, in this directory where initially generated thanks to the `--stub-man` options of the commands.
   4
   5 Transformation to real man pages (troff) are done with `pandoc -t man -s` command.
   6 See the `Makefile`.
   7
   8
   9 Once generated, manpages can then be checked individually with `man -l`
  10
  11 ~~~
  12 man -l man1/nitc.1
  13 ~~~
  14
  15 For global access, one can set the `MANPATH` environment variable to this `man` directory (not the `man1` subdirectory).
  16 Do not forget to append `$MANPATH` to keep existing manpages accessible.
  17
  18 ~~~
  19 export MANPATH=/path/to/nit/share/man:$MANPATH
  20 man nitc
  21 ~~~