xref: /freebsd/tools/tools/man/README (revision 05248206f720394d95c2a7475429311df670a2e9)
1*bbbefa33SJohn-Mark Gurneyman scripts
2*bbbefa33SJohn-Mark Gurney===========
3*bbbefa33SJohn-Mark Gurney
4*bbbefa33SJohn-Mark Gurneycheckmlinks.sh
5*bbbefa33SJohn-Mark Gurney--------------
6*bbbefa33SJohn-Mark Gurney
7*bbbefa33SJohn-Mark GurneyThis is a simple script used to check if a man page's Nm/Fo/Fn macro
8*bbbefa33SJohn-Mark Gurneynames are in the Makefile.
9*bbbefa33SJohn-Mark Gurney
10*bbbefa33SJohn-Mark GurneyTo run, switch to the directory with the pages in it and run the script:
11*bbbefa33SJohn-Mark Gurney```
12*bbbefa33SJohn-Mark Gurneycd /usr/src/share/man/man9
13*bbbefa33SJohn-Mark Gurneysh /usr/src/tools/tools/man/checkmlinks.sh
14*bbbefa33SJohn-Mark Gurney```
15*bbbefa33SJohn-Mark Gurney
16*bbbefa33SJohn-Mark GurneyThe script will output the name that is missing, and the file that it
17*bbbefa33SJohn-Mark Gurneywas sourced from.
18*bbbefa33SJohn-Mark Gurney
19*bbbefa33SJohn-Mark GurneyThere are a number of exceptions, and those should be added to the
20*bbbefa33SJohn-Mark Gurneyscript to skip over, e.g. `SDT_PROBE`.  The last one is added because
21*bbbefa33SJohn-Mark Gurneyadding the numbered args is a bit redundant.
22