Solved the critics to man1-sync0. Notes: Sat Dec 10 11:36:07 EST 2005 rsc Not all of my comments about man1-sync0 were addressed. I applied the changes and then made my own fixes. Please diff the current pages against what you submitted to see what I changed. Some comments: - There were still ".BI onearg" lines in the edited lines you submitted. - You don't seem to like the [this | that] syntax, but it's okay (and useful!). It means you can specify one or the other but not both. You dropped it in the acme usage and in the awk usage. - There are no spaces around brackets in the usage strings printed by programs. - The acme(4) page you started with appears to have been out-of-date, since you removed the menu and nomenu ctl messages in the patch. Please make sure you're up to date, and after creating a patch, run patch/diff your-patch and look through the diffs just to double-check that they're what you expected. - There were still multiple instances where you changed the usage message but did not update the text to reflect new names. This happened in both acme(1) and awk(1). If you change the names in the SYNOPSIS, make sure you update the text. - I named the -l option to acid "library" rather than "module". The man page used "library" a lot more than module (used only once). Don't blindly follow what the program prints for a usage message. Often the documentation has better names. The fact that you had to rename a whole subsubsection of the manual was my tip-off that I should just leave the name as it was. - When you document a new option or argument, make sure you get all its effects. It turns out that awk's -safe does more than just disable ENVIRON. Thanks for going through these. I really appreciate it. The above comments are very small things, but all in all I'm very happy to see these getting checked and fixed. Russ Reference: /n/sources/patch/applied/man1-sync1 Date: Fri Dec 9 19:34:51 CET 2005 Reviewed-by: rsc --- /sys/src/cmd/acid/main.c Fri Dec 9 19:25:27 2005 +++ /sys/src/cmd/acid/main.c Fri Dec 9 19:25:19 2005 @@ -22,7 +22,7 @@ void usage(void) { - fprint(2, "usage: acid [-l module] [-m machine] [-qrw] [-k] [pid] [file]\n"); + fprint(2, "usage: acid [-kqw] [-l module] [-m machine] [pid] [textfile]\n"); exits("usage"); } --- /sys/man/1/acid Fri Dec 9 19:25:57 2005 +++ /sys/man/1/acid Fri Dec 9 19:25:51 2005 @@ -4,14 +4,15 @@ .SH SYNOPSIS .B acid [ -.BI -l " libfile +.B -kqw +] +[ +.BI -l " module +] +[ +.BI -m " machine ] [ -.B -wq -] [ -.B -m -.I machine -] [ .I pid ] [ @@ -52,9 +53,9 @@ .B -q Print variable renamings at startup. .TP -.BI -l " library +.BI -l " module Load from -.I library +.I module at startup; see below. .TP .BI -m " machine @@ -77,7 +78,7 @@ .PP At startup, .I acid -obtains standard function definitions from the library file +obtains standard function definitions from the module file .BR /sys/lib/acid/port , architecture-dependent functions from .BR /sys/lib/acid/$objtype , @@ -313,10 +314,10 @@ Escape to the shell, .IR rc (1), to execute the command string. -.SS Libraries +.SS Modules There are a number of .I acid -`libraries' that provide higher-level debugging facilities. Two notable +`modules' that provide higher-level debugging facilities. Two notable examples are .I truss and --- /sys/src/cmd/acme/acme.c Fri Dec 9 19:26:32 2005 +++ /sys/src/cmd/acme/acme.c Fri Dec 9 19:26:24 2005 @@ -101,7 +101,7 @@ break; default: Usage: - fprint(2, "usage: acme -a -c ncol -f fontname -F fixedwidthfontname -l loadfile\n"); + fprint(2, "usage: acme [ -ab ] [ -c ncol ] [ -f varfont ] [ -F fixfont ] [ -l loadfile ] [ file ... ]\n"); exits("usage"); }ARGEND --- /sys/man/1/acme Fri Dec 9 19:27:13 2005 +++ /sys/man/1/acme Fri Dec 9 19:27:04 2005 @@ -7,6 +7,10 @@ .B -ab ] [ +.B -c +.I ncol +] +[ .B -f .I varfont ] @@ -15,13 +19,10 @@ .I fixfont ] [ -.B -c -.I ncol +.B -l +.I loadfile ] [ -.B -l -.I file -| .I file \&... ] .LP --- /sys/man/4/acme Fri Dec 9 19:27:58 2005 +++ /sys/man/4/acme Fri Dec 9 19:27:52 2005 @@ -4,13 +4,25 @@ .SH SYNOPSIS .B acme [ +.B -ab +] +[ +.B -c +.I ncol +] +[ .B -f .I varfont -] [ +] +[ .B -F .I fixfont ] [ +.B -l +.I loadfile +] +[ .I file \&... ] .SH DESCRIPTION @@ -230,15 +242,6 @@ returning the window to the usual state wherein each modification to the body must be undone individually. .TP -.B menu -Maintain -.BR Undo , -.BR Redo , -and -.B Put -in the left half of the tag. -(This is the default for file windows.) -.TP .BI name " name Set the name of the window to .IR name . @@ -248,15 +251,6 @@ may be undone in a single .B Undo interactive command. -.TP -.B nomenu -Do not maintain -.BR Undo , -.BR Redo , -and -.B Put -in the left half of the tag. -(This is the default for directory and error windows.) .TP .B noscroll Turn off automatic `scrolling' of the window to show text written to the body. --- /sys/src/cmd/bc.y Fri Dec 9 19:28:49 2005 +++ /sys/src/cmd/bc.y Fri Dec 9 19:28:43 2005 @@ -956,7 +956,7 @@ sflag++; break; default: - fprint(2, "Usage: bc [-l] [-c] [file ...]\n"); + fprint(2, "Usage: bc [-cdls] [file ...]\n"); exits("usage"); } argc--; --- /sys/man/1/bc Fri Dec 9 19:29:40 2005 +++ /sys/man/1/bc Fri Dec 9 19:29:34 2005 @@ -4,13 +4,7 @@ .SH SYNOPSIS .B bc [ -.B -c -] -[ -.B -l -] -[ -.B -s +.B -cdls ] [ .I file ... @@ -32,6 +26,9 @@ of calculation results; all output is via the .B print command. +The +.B -d +argument enables debugging output. .PP The following syntax for .I bc --- /sys/src/cmd/ascii.c Fri Dec 9 19:30:36 2005 +++ /sys/src/cmd/ascii.c Fri Dec 9 19:30:31 2005 @@ -112,7 +112,7 @@ void usage(void) { - fprint(2, "usage: %s [-8] [-xod | -b8] [-ncst] [--] [text]\n", argv0); + fprint(2, "usage: %s [-8] [-dox] [-cnt] [-b n] [text]\n", argv0); exits("usage"); } void --- /sys/man/1/ascii Fri Dec 9 19:31:32 2005 +++ /sys/man/1/ascii Fri Dec 9 19:31:27 2005 @@ -7,10 +7,14 @@ .B -8 ] [ -.BI -oxdb n +.B -dox ] [ -.B -nct +.B -cnt +] +[ +.B -b +.I n ] [ .I text --- /sys/man/1/awk Fri Dec 9 19:32:36 2005 +++ /sys/man/1/awk Fri Dec 9 19:32:29 2005 @@ -4,23 +4,30 @@ .SH SYNOPSIS .B awk [ -.BI -F fs +.BI -safe ] [ -.BI -v -.I var=value +.BI -d ] [ -.BI -mr n +.B -f +.I prog ] [ -.BI -mf n +.BI -F +.I fs ] [ -.B -f -.I prog +.BI -mf +.I n +] [ -.I prog +.BI -mr +.I n +] +[ +.BI -v +.I var=value ] [ .I file ... @@ -66,6 +73,9 @@ .IR fs option defines the input field separator to be the regular expression .IR fs . +The +.B \-safe +option specifies to not set the ENVIRON variable. .PP An input line is normally made up of fields separated by white space, or by regular expression --- /sys/src/cmd/awk/main.c Fri Dec 9 19:33:46 2005 +++ /sys/src/cmd/awk/main.c Fri Dec 9 19:33:40 2005 @@ -57,7 +57,7 @@ cmdname = argv[0]; if (argc == 1) { - fprintf(stderr, "Usage: %s [-f programfile | 'program'] [-Ffieldsep] [-v var=value] [files]\n", cmdname); + fprintf(stderr, "Usage: %s [ -safe ] [ -d ] [ -f prog ] [ -F fs ] [ -mf n ] [ -mr n ] [ -v var=value ] [ file ... ]\n", cmdname); exit(1); } signal(SIGFPE, fpecatch);