1 # Usage: cd $PLAN9; awk -f dist/checkman.awk man?/*.?
4 # - .TH is first line, and has proper name section number
5 # - sections are in order NAME, SYNOPSIS, DESCRIPTION, EXAMPLES,
6 # FILES, SOURCE, SEE ALSO, DIAGNOSTICS, BUGS
7 # - there's a manual page for each cross-referenced page
11 # .SH sections should come in the following order
14 Weight["SYNOPSIS"] = 2
15 Weight["DESCRIPTION"] = 4
17 Weight["EXAMPLES"] = 16
20 Weight["SEE ALSO"] = 128
21 Weight["DIAGNOSTICS"] = 256
22 Weight["SYSTEM CALLS"] = 512
27 # allow references to pages provded
28 # by the underlying Unix system
30 Omitman["bash(1)"] = 1
31 Omitman["chmod(1)"] = 1
32 Omitman["compress(1)"] = 1
34 Omitman["egrep(1)"] = 1
40 Omitman["mail(1)"] = 1
41 Omitman["make(1)"] = 1
43 Omitman["prof(1)"] = 1
48 Omitman["stty(1)"] = 1
50 Omitman["unutf(1)"] = 1
52 Omitman["xterm(1)"] = 1
54 Omitman["access(2)"] = 1
56 Omitman["chdir(2)"] = 1
57 Omitman["close(2)"] = 1
58 Omitman["connect(2)"] = 1
59 Omitman["fork(2)"] = 1
60 Omitman["gethostname(2)"] = 1
61 Omitman["getpid(2)"] = 1
62 Omitman["getuid(2)"] = 1
63 Omitman["open(2)"] = 1
64 Omitman["pipe(2)"] = 1
65 Omitman["ptrace(2)"] = 1
66 Omitman["rmdir(2)"] = 1
67 Omitman["send(2)"] = 1
68 Omitman["signal(2)"] = 1
69 Omitman["sigprocmask(2)"] = 1
70 Omitman["socketpair(2)"] = 1
71 Omitman["unlink(2)"] = 1
73 Omitman["abort(3)"] = 1
74 Omitman["assert(3)"] = 1
75 Omitman["fprintf(3)"] = 1
76 Omitman["fscanf(3)"] = 1
77 Omitman["fopen(3)"] = 1
78 Omitman["isalpha(3)"] = 1
79 Omitman["malloc(3)"] = 1
80 Omitman["perror(3)"] = 1
81 Omitman["remove(3)"] = 1
83 Omitman["strerror(3)"] = 1
85 Omitman["core(5)"] = 1
86 Omitman["passwd(5)"] = 1
88 Omitman["signal(7)"] = 1
90 Omitman["cron(8)"] = 1
92 # don't need documentation for these in bin
93 Omitted[".cvsignore"] = 1
99 Omitted["jukefmt"] = 1
100 Omitted["jukeget"] = 1
101 Omitted["jukeindex"] = 1
102 Omitted["jukeinfo"] = 1
103 Omitted["jukeplay"] = 1
104 Omitted["jukeput"] = 1
105 Omitted["jukesearch"] = 1
106 Omitted["jukesongfile"] = 1
107 Omitted["m4ainfo"] = 1
108 Omitted["mp3info"] = 1
110 Omitted["tcolors"] = 1
113 Omitted["volume"] = 1
114 Omitted["vtdump"] = 1
117 Omittedlib["creadimage"] = 1
118 Omittedlib["pixelbits"] = 1
119 Omittedlib["bouncemouse"] = 1
120 Omittedlib["main"] = 1 # in libthread
122 Omittedlib["opasstokey"] = 1 # in libauthsrv
124 # functions provided for -lthread_db
125 Omittedlib["ps_get_thread_area"] = 1
126 Omittedlib["ps_getpid"] = 1
127 Omittedlib["ps_lcontinue"] = 1
128 Omittedlib["ps_lgetfpregs"] = 1
129 Omittedlib["ps_lgetregs"] = 1
130 Omittedlib["ps_lsetfpregs"] = 1
131 Omittedlib["ps_lsetregs"] = 1
132 Omittedlib["ps_lstop"] = 1
133 Omittedlib["ps_pcontinue"] = 1
134 Omittedlib["ps_pdread"] = 1
135 Omittedlib["ps_pdwrite"] = 1
136 Omittedlib["ps_pglobal_lookup"] = 1
137 Omittedlib["ps_pstop"] = 1
138 Omittedlib["ps_ptread"] = 1
139 Omittedlib["ps_ptwrite"] = 1
141 # libmach includes a small dwarf and elf library
142 Omittedlib["corecmdfreebsd386"] = 1
143 Omittedlib["corecmdlinux386"] = 1
144 Omittedlib["coreregsfreebsd386"] = 1
145 Omittedlib["coreregslinux386"] = 1
146 Omittedlib["coreregsmachopower"] = 1
147 Omittedlib["crackelf"] = 1
148 Omittedlib["crackmacho"] = 1
149 Omittedlib["dwarfaddrtounit"] = 1
150 Omittedlib["dwarfclose"] = 1
151 Omittedlib["dwarfenum"] = 1
152 Omittedlib["dwarfenumunit"] = 1
153 Omittedlib["dwarfget1"] = 1
154 Omittedlib["dwarfget128"] = 1
155 Omittedlib["dwarfget128s"] = 1
156 Omittedlib["dwarfget2"] = 1
157 Omittedlib["dwarfget4"] = 1
158 Omittedlib["dwarfget8"] = 1
159 Omittedlib["dwarfgetabbrev"] = 1
160 Omittedlib["dwarfgetaddr"] = 1
161 Omittedlib["dwarfgetn"] = 1
162 Omittedlib["dwarfgetnref"] = 1
163 Omittedlib["dwarfgetstring"] = 1
164 Omittedlib["dwarflookupfn"] = 1
165 Omittedlib["dwarflookupname"] = 1
166 Omittedlib["dwarflookupnameinunit"] = 1
167 Omittedlib["dwarflookupsubname"] = 1
168 Omittedlib["dwarflookuptag"] = 1
169 Omittedlib["dwarfnextsym"] = 1
170 Omittedlib["dwarfnextsymat"] = 1
171 Omittedlib["dwarfopen"] = 1
172 Omittedlib["dwarfpctoline"] = 1
173 Omittedlib["dwarfseeksym"] = 1
174 Omittedlib["dwarfskip"] = 1
175 Omittedlib["dwarfunwind"] = 1
176 Omittedlib["elfclose"] = 1
177 Omittedlib["elfdl386mapdl"] = 1
178 Omittedlib["elfinit"] = 1
179 Omittedlib["elfmachine"] = 1
180 Omittedlib["elfmap"] = 1
181 Omittedlib["elfopen"] = 1
182 Omittedlib["elfsection"] = 1
183 Omittedlib["elfsym"] = 1
184 Omittedlib["elfsymlookup"] = 1
185 Omittedlib["elftype"] = 1
186 Omittedlib["machoclose"] = 1
187 Omittedlib["machoinit"] = 1
188 Omittedlib["machoopen"] = 1
189 Omittedlib["stabsym"] = 1
190 Omittedlib["symdwarf"] = 1
191 Omittedlib["symelf"] = 1
192 Omittedlib["symmacho"] = 1
193 Omittedlib["symstabs"] = 1
194 Omittedlib["elfcorelinux386"] = 1
195 Omittedlib["linux2ureg386"] = 1
196 Omittedlib["ureg2linux386"] = 1
197 Omittedlib["coreregs"] = 1 # haven't documented mach yet
198 Omittedlib["regdesc"] = 1
200 Omittedlib["auth_attr"] = 1 # not happy about this
202 Omittedlib["ndbnew"] = 1 # private to library
203 Omittedlib["ndbsetval"] = 1
205 Renamelib["chanalt"] = "alt"
206 Renamelib["channbrecv"] = "nbrecv"
207 Renamelib["channbrecvp"] = "nbrecvp"
208 Renamelib["channbrecvul"] = "nbrecvul"
209 Renamelib["channbsend"] = "nbsend"
210 Renamelib["channbsendp"] = "nbsendp"
211 Renamelib["channbsendul"] = "nbsendul"
212 Renamelib["chanrecv"] = "recv"
213 Renamelib["chanrecvp"] = "recvp"
214 Renamelib["chanrecvul"] = "recvul"
215 Renamelib["chansend"] = "send"
216 Renamelib["chansendp"] = "sendp"
217 Renamelib["chansendul"] = "sendul"
218 Renamelib["threadyield"] = "yield"
220 Renamelib["fmtcharstod"] = "charstod"
221 Renamelib["fmtstrtod"] = "strtod"
223 Renamelib["regcomp9"] = "regcomp"
224 Renamelib["regcomplit9"] = "regcomplit"
225 Renamelib["regcompnl9"] = "regcompnl"
226 Renamelib["regerror9"] = "regerror"
227 Renamelib["regexec9"] = "regexec"
228 Renamelib["regsub9"] = "regsub"
229 Renamelib["rregexec9"] = "rregexec"
230 Renamelib["rregsub9"] = "rregsub"
238 # screws up troff headers
239 print lastfile ":$ is a blank line"
246 if(nam !~ /^man\/man(.*)\/(.*)\.(.*)$/){
247 print "nam", nam, "not of form [0-9][0-9]?/*"
251 gsub("[/.]", " ", nam);
256 if($1 != ".TH" || NF != 3)
257 print "First line of", FILENAME, "not a proper .TH"
258 else if(($2 != toupper(name) || substr($3, 1, length(sec)) != sec || $3 != toupper(section)) \
259 && ($2!="INTRO" || name!="0intro") \
260 && (name !~ /^9/ || $2!=toupper(substr(name, 2)))){
261 print ".TH of", FILENAME, "doesn't match filename"
263 Pages[tolower($2) "(" tolower($3) ")"] = 1
267 { lastline=$0; lastfile=FILENAME; }
271 print "Unterminated .EX in", FILENAME, ":", $0
273 if (substr($2, 1, 1) == "\"") {
275 print "Unneeded quote in", FILENAME, ":", $0
276 $2 = substr($2, 2, length($2)-2)
277 } else if (NF == 3) {
278 $2 = substr($2, 2) substr($3, 1, length($3)-1)
282 if(Sh == 0 && $2 != "NAME")
283 print FILENAME, "has no .SH NAME"
287 print "Heading", $2, "out of order in", FILENAME
295 print "Nested .EX in", FILENAME ":" FNR, ":", $0
301 print "Bad .EE in", FILENAME ":" FNR ":", $0
309 $1 == ".PD" || $1 == ".SH" || $1 == ".SS" || $1 == ".TH" {
318 if(smallspace && !lastre)
319 print "Possible missing .PD at " FILENAME ":" FNR
327 sh == "BUGS" && $1 == ".br" {
328 print FILENAME ":" FNR ": .br in BUGS"
331 sh == "SOURCE" && $1 ~ /^\\\*9\// {
332 s = ENVIRON["PLAN9"] substr($1, 4)
336 sh == "SOURCE" && $2 ~ /^\\\*9\// {
337 s = ENVIRON["PLAN9"] substr($2, 4)
341 sh == "SOURCE" && $1 ~ /^\// {
345 sh == "SOURCE" && $2 ~ /^\// {
349 $0 ~ /^\.[A-Z].*\([1-9]\)/ {
350 if ($1 == ".IR" && $3 ~ /\([0-9]\)/) {
353 }else if ($1 == ".RI" && $2 == "(" && $4 ~ /\([0-9]\)/) {
356 }else if ($1 == ".IR" && $3 ~ /9.\([0-9]\)/) {
359 }else if ($1 == ".RI" && $2 == "(" && $4 ~ /9.\([0-9]\)/) {
363 if ($1 == ".HR" && $3 == "\"Section")
365 print "Possible bad cross-reference format in", FILENAME ":" FNR
369 gsub(/[^0-9]/, "", section)
370 Refs[toupper(name) "(" section ")"]++
375 print lastfile ":$ is a blank line"
378 print "Checking Source References"
379 cmd = "xargs -n 100 ls -d 2>&1 >/dev/null | sed 's/^ls: / /; s/: .*//'"
385 print "Checking Cross-Referenced Pages"
387 if (!(tolower(i) in Pages) && !(tolower(i) in Omitman)){
389 gsub("\\(", " \\(", b)
390 gsub("\\)", "\\)", b)
391 split(tolower(i), a, "/")
392 print "egrep -in '^\\.IR.*" b "' $PLAN9/man/man*/* # Need " tolower(i) |"sort"
397 print "Checking commands"
404 if (!(i in Index) && !(i in Omitted))
405 print "Need", i, "(in " List[i] ")" |"sort"
410 if (!(i in Index) && (i in Omitted))
411 print "Omit", i, "(in " List[i] ")" |"sort"
417 print "Checking libraries"
419 getnmlist("lib/lib9.a")
420 getnmlist("lib/lib9p.a")
421 getnmlist("lib/lib9pclient.a")
422 getnmlist("lib/libString.a")
423 getnmlist("lib/libauth.a")
424 getnmlist("lib/libauthsrv.a")
425 getnmlist("lib/libbin.a")
426 getnmlist("lib/libbio.a")
427 getnmlist("lib/libcomplete.a")
428 # getnmlist("lib/libcontrol.a")
429 getnmlist("lib/libdisk.a")
430 getnmlist("lib/libdraw.a")
431 getnmlist("lib/libflate.a")
432 getnmlist("lib/libframe.a")
433 getnmlist("lib/libgeometry.a")
434 getnmlist("lib/libhtml.a")
435 # getnmlist("lib/libhttpd.a")
436 getnmlist("lib/libip.a")
437 getnmlist("lib/libmach.a")
438 # getnmlist("lib/libmemdraw.a")
439 # getnmlist("lib/libmemlayer.a")
440 getnmlist("lib/libmp.a")
441 getnmlist("lib/libmux.a")
442 getnmlist("lib/libndb.a")
443 getnmlist("lib/libplumb.a")
444 getnmlist("lib/libregexp9.a")
445 getnmlist("lib/libsec.a")
446 getnmlist("lib/libthread.a")
447 # getnmlist("lib/libventi.a")
449 if (!(i in Index) && !(i in Omittedlib))
450 print "Need", List[i], i |"sort"
451 # print "Need", i, "(in " List[i] ")" |"sort"
456 if (!(i in Index) && (i in Omittedlib))
457 print "Omit", List[i], i |"sort"
458 # print "Omit", i, "(in " List[i] ")" |"sort"
463 func getindex(dir, fname)
466 while ((getline < fname) > 0)
471 func getbinlist(dir, cmd, subdirs, nsd)
473 cmd = "ls -p -l " dir
475 while (cmd | getline) {
477 if (!($10 in Skipdirs))
479 } else if ($10 !~ "^_")
482 for ( ; nsd > 0 ; nsd--)
483 getbinlist(dir "/" subdirs[nsd])
487 func getnmlist(lib, cmd)
490 while (cmd | getline) {
491 if (($2 == "T" || $2 == "L") && $3 !~ "^_"){
495 List[Renamelib[sym]] = lib " as " sym