tools/tools/man/README

   1 man scripts
   2 ===========
   3
   4 checkmlinks.sh
   5 --------------
   6
   7 This is a simple script used to check if a man page's Nm/Fo/Fn macro
   8 names are in the Makefile.
   9
  10 To run, switch to the directory with the pages in it and run the script:
  11 ```
  12 cd /usr/src/share/man/man9
  13 sh /usr/src/tools/tools/man/checkmlinks.sh
  14 ```
  15
  16 The script will output the name that is missing, and the file that it
  17 was sourced from.
  18
  19 There are a number of exceptions, and those should be added to the
  20 script to skip over, e.g. `SDT_PROBE`.  The last one is added because
  21 adding the numbered args is a bit redundant.
  22
  23 $FreeBSD$