Date: Sat, 23 Jan 1999 05:16:31 +0900 (JST) From: Kaneda Hiloshi <vanitas@ma3.seikyou.ne.jp> To: FreeBSD-gnats-submit@FreeBSD.ORG Subject: docs/9618: [send-pr]: many typos in groff_mm(7) Message-ID: <199901222016.FAA02927@hiloshi.seikyou.ne.jp>
next in thread | raw e-mail | index | archive | help
>Number: 9618 >Category: docs >Synopsis: many typos in groff_mm(7) >Confidential: no >Severity: serious >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Fri Jan 22 12:20:01 PST 1999 >Closed-Date: >Last-Modified: >Originator: Kanenda >Release: FreeBSD 2.2.1-RELEASE i386 >Organization: FreeBSD jp-man project >Environment: .\" $Id: groff_mm.man,v 1.27 1995/04/24 05:37:46 jh Exp $ http://www.freebsd.org/cgi/cvsweb.cgi/src/contrib/groff/mm/groff_mm.man?rev=1.1.1.1 >Description: Problems I found are listed below. (I provide some test examples too. Please try these with: ``groff -Tascii -mm file_name'' ) Numbers indicate each line number. (1) 98-99, 677-678: .br should be here. (2) 140, 232, 245, 732, 747, 763, 1100, 1117, 1264: unbalanced brackets. (3) 182: con the -> on the (4) 206: It says, "AU must appear before TL." But in fact, AU before TL causes an error. An examle on line 274-281 also shows AU after TL. try: .AU author .TL title text. This will be fixed in one of ways: (a) must -> must not (b) before -> after (c) TL must appear before AU. (The accompanying patch choose (a).) (5) 207: intials -> initials (6) 215: prev-font-tex -> prev-font-text (7) 216, 222, 456, 748, 764, 816, 1066, 1122, 1126: Dots at the end of sentences are missing. (8) 250, 460: wich -> which (9) 253: Although the text on line 254-262 describes about `text-indent', `mark-indent' and `third argument', these arguments don't present at the syntax heading: .B BVL Probably, this should be: .B "BVL text-indent [mark-indent [1]]" try: .BVL 5 1 1 list start .LI mark1 1st list item .LI mark2 2nd list item .LE (10) 316: is there is -> if there is (11) 339-340: The description, A third argument will prohibit printing of a blank line before each item. would be unnecessary, because DL doesn't take the third argument. try: .DL 5 1 1 .LI 1st list item .LI 2nd list item .LE (12) 495: It says, "Argument greater than or equal to 11 is considered as arg 0." But arg 11 (line 491) differs from arg 0 (line 480). -> Argument greater than 11 is considered as arg 0. (13) 519, 525: varname -> \fIvarname\fP (14) 584-585: .sp should be here. (15) 605: fontnam -> fontname (16) 626: ar -> are (17) 686: be turned -> be turned off (18) 740, 1341: unbalanced double quotes. (19) 827: LS -> LI (20) 873: begins -> begin (21) 880-881: Subject and writer'sidentification is -> Subject and writer's identification are (22) 889-890: RESTRICTED -> CONFIDENTIAL try: .LT BL .LO CN LetCN is \*[LetCN]. (23) 929: Addresse -> Addressee (24) 957, 959, 961: MULB -> \fBMULB\fP (25) 957: MULE -> \fBMULE\fP (26) 970, 1612, 1663, 1667: Se -> See (27) 1065: get rid off -> get rid of (28) 1088, 1283, 1285: There are words: \fB@TMAC@pic\fP, \fB@TMAC@tbl\fP and \fBm@TMAC@m\fP. And these @TMAC@ parts would be supposed to be replaced with something (probably empty) at installation. But they will remain. To fix this, it may need to change the makefile: http://www.freebsd.org/cgi/cvsweb.cgi/src/gnu/usr.bin/groff/Makefile.cfg?rev=2.6 (29) 1118, 1267: is -> are (30) 1134: be resetted -> be reset (31) 1181: refname -> \fIrefname\fP (32) 1191: The description, It will be printed at the first author, otherwise at the last. is vague, and to be accurate: It will be printed at the first author if the second argument is given, otherwise at the last. try: .AU name1 i1 l1 d1 .AU name2 i2 l2 d2 .AU name3 i3 l3 d3 .SG SGarg 1 (33) 1194: Letter internals -> INTERNALS (as shown on line 1678.) (34) 1242: It says, "RX is called before the printing of CONTENTS". It would be TX, not RX (as described on line 1290). RX -> TX (35) 1251: contains -> contain (36) 1305: control -> controls (37) 1314, 1316: en -> an (38) 1422, 1425: .AV. -> .AV (39) 1594: unexpected `.TP' line. (40) 1683: It says, ".LT will set the number variables Pt and Pi to 5 and 0." `5 and 0' should be `0 and 5'. try: .LT Pt is \n[Pt]. Pi is \n[Pi]. >How-To-Repeat: man 7 groff_mm >Fix: To fix these bugs other than (28), apply the following patch: --- groff_mm.man.orig Wed Dec 30 07:19:54 1998 +++ groff_mm.man Mon Jan 18 07:56:58 1999 @@ -96,6 +96,7 @@ a double-quote. (Strings are used in the text as \fB\e*[YYY]\fP.) .sp \fBSpecial formatting of number registers\fP +.br A number register is printed with normal digits if no format has been given. Set the format with \fBaf\fP: @@ -137,7 +138,7 @@ .B "AF [name of firm]" Authors firm, should be called before \fBAU\fP, see also \fBCOVER\fP. .TP -.B "AL [type [text-indent [1]]]]" +.B "AL [type [text-indent [1]]]" Start autoincrement list. Items are numbered beginning on one. The \fItype\fP argument controls the type of numbers. .in +.5i @@ -179,7 +180,7 @@ .T2 Arg Placement .T2 0 -Abstract will be printed on page 1 and con the cover sheet if +Abstract will be printed on page 1 and on the cover sheet if used in the released-paper style (\fBMT 4\fP), otherwise it will be printed on page 1 without a cover sheet. .T2 1 @@ -203,8 +204,8 @@ .B "AU name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]" Author information, specifies the author of the memo or paper, and will be printed on the cover sheet and on other similar places. -\fBAU\fP must appear before \fBTL\fP. The author information -can contain intials, location, department, telephone extension, +\fBAU\fP must not appear before \fBTL\fP. The author information +can contain initials, location, department, telephone extension, room number or name and up to three extra arguments. .TP .B "AV [name [1]]" @@ -212,14 +213,14 @@ signature and date. The string \fBAPPROVED:\fP can be changed with variable \fBLetapp\fP, and the string \fBDate\fP in \fBLetdate\fP. .TP -.B "B [bold-text [prev-font-tex [bold...]]]" -Begin boldface +.B "B [bold-text [prev-font-text [bold...]]]" +Begin boldface. No limit on the number of arguments. All arguments will be concatenated to one word, the first, third and so on will be printed in boldface. .TP .B B1 -Begin box (as the ms macro) +Begin box (as the ms macro). Draws a box around the text. The text will be indented one character, and the right margin will be one character shorter. .TP @@ -229,7 +230,7 @@ .B BE End bottom block, see \fBBS\fP. .TP -.B "BI [bold-text [italic-text [bold-text [...]]]" +.B "BI [bold-text [italic-text [bold-text [...]]]]" Bold-italic. No limit on the number of arguments, see \fBB\fP. .TP @@ -242,15 +243,15 @@ A third argument will prohibit printing of a blank line before each item. .TP -.B "BR [bold-text [roman-text [bold-text [...]]]" +.B "BR [bold-text [roman-text [bold-text [...]]]]" Bold-roman. No limit on the number of arguments. .TP .B BS -Bottom block start. Begins the definition of a text block wich is +Bottom block start. Begins the definition of a text block which is printed at the bottom of each page. Block ends with \fBBE\fP. .TP -.B BVL +.B "BVL text-indent [mark-indent [1]]" Start of broken variable-item list. Broken variable-item list has no fixed mark, it assumes that @@ -313,7 +314,7 @@ Displays are printed at the end of each section (when section-page numbering is active) or at the end of the document. .T2 1 -A new display will be printed on the current page is there is enough +A new display will be printed on the current page if there is enough space, otherwise it will be printed at the end of the document. .T2 2 One display will be printed at the top of each page or column @@ -336,8 +337,6 @@ after a dash. \fIText-indent\fP changes the default indentation of the list items set by number register \fBPi\fP. -A third argument will prohibit printing of a blank line before each -item. A second argument prevents the empty line between each list item to be printed. See \fBLI\fP. .TP @@ -453,11 +452,11 @@ left margin. .TP .B "EX [title [override [flag [refname]]]]" -Exhibit title, arguments are the same as for \fBEC\fP +Exhibit title, arguments are the same as for \fBEC\fP. \fBEX\fP uses the number register \fBEx\fP as counter. The string \fBLx\fP controls the title of the List of Exhibits, default is \fILIST OF EXHIBITS\fP. -The string \fBLiex\fP contains the word \fIExhibit\fP, wich +The string \fBLiex\fP contains the word \fIExhibit\fP, which is printed before the number. If \fIrefname\fP is used, then the exhibitnumber is saved with \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP. @@ -492,7 +491,7 @@ .sp .fi .DT -Argument greater than or equal to 11 is considered as arg 0. +Argument greater than 11 is considered as arg 0. Default for m@TMAC_M_PREFIX@mm is 10. .TP .B FE @@ -516,13 +515,13 @@ .B "GETHN refname [varname]" Includes the headernumber where the corresponding \fBSETR\fP \fIrefname\fP was placed. Will be X.X.X. in pass 1. See \fBINITR\fP. -If varname is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the +If \fIvarname\fP is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the headernumber. .TP .B "GETPN refname [varname]" Includes the pagenumber where the corresponding \fBSETR\fP \fIrefname\fP was placed. Will be 9999 in pass 1. See \fBINITR\fP. -If varname is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP +If \fIvarname\fP is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP to the pagenumber. .TP .B "GETR refname" @@ -582,6 +581,7 @@ .br Indentation of the text after the heading is controlled by number register \fBHi\fP, default value 0. +.sp \fBHi\fP .in +.5i .T2 0 @@ -602,7 +602,7 @@ \fBFont control of the heading\fP .br The font of each heading level is controlled by string \fBHF\fP. -It contains a fontnumber or fontnam for each level. Default +It contains a fontnumber or fontname for each level. Default is \fB2\ 2\ 2\ 2\ 2\ 2\ 2\fP (all headings in italic). Could also be written as \fBI\ I\ I\ I\ I\ I\ I\fP. All omitted values are presumed to be a 1. @@ -623,7 +623,7 @@ the counter for each heading level. The values are printed using arabic numerals, this can be changed with the macro \fBHM\fP (see below). -All marks ar concatenated before printing. To avoid this, set +All marks are concatenated before printing. To avoid this, set number register \fBHt\fP to 1. That will only print the current heading counter at each heading. .sp @@ -675,6 +675,7 @@ might be used to change indentation. .sp \fBHZ\ \fP\fIdlevel\ rlevel\ heading-text\fP +.br \fBHZ\fP is called after the printing of the heading, just before \fBH\fP or \fBHU\fP exits. Could be used to change the page header according to the section heading. @@ -683,7 +684,7 @@ Set hyphenation character. Default value is \e%. Resets to the default if called without argument. -Hyphenation can be turned by setting number +Hyphenation can be turned off by setting number register \fBHy\fP to 0 in the beginning of the file. .TP .B "HM [arg1 [arg2 [... [arg7]]]]" @@ -729,7 +730,7 @@ Called just after printing the header. See \fBH\fP. .TP -.B "I [italic-text [prev-font-text [italic-text [...]]]" +.B "I [italic-text [prev-font-text [italic-text [...]]]]" Italic. Changes the font to italic if called without arguments. With one argument it will set the word in italic. @@ -737,15 +738,15 @@ word in italic and the second in the previous font. There is no limit on the number of argument, all will be concatenated. .TP -.B "IA [addressee-name [title]] +.B "IA [addressee-name [title]]" Begins specification of the addressee and addressee's address in letter style. Several names can be specified with empty \fBIA\fP/\fBIE\fP-pairs, but only one address. See \fBLT\fP. .TP -.B "IB [italic-text [bold-text [italic-text [...]]]" -Italic-bold +.B "IB [italic-text [bold-text [italic-text [...]]]]" +Italic-bold. Even arguments is printed in italic, odd in boldface. See \fBI\fP. .TP @@ -760,8 +761,8 @@ occurrence of \fBINITR\fP that is active. See also \fBSETR\fP, \fBGETPN\fP and \fBGETHN\fP. .TP -.B "IR [italic-text [roman-text [italic-text [...]]]" -Italic-roman +.B "IR [italic-text [roman-text [italic-text [...]]]]" +Italic-roman. Even arguments is printed in italic, odd in roman. See \fBI\fP. .TP @@ -813,7 +814,7 @@ \fBLB\fP itself will print \fILB-space\fP blank lines. Default is 0. .TP .B "LC [list-level]" -List-status clear +List-status clear. Terminates all current active lists down to \fIlist-level\fP, or 0 if no argmuent is given. This is used by \fBH\fP to clear any active list. @@ -824,7 +825,7 @@ if an argument is given. .TP .B "LI [mark [1]]" -List item precedes every item in a list. Without argument \fBLS\fP +List item precedes every item in a list. Without argument \fBLI\fP will print the mark determined by the current list type. By giving \fBLI\fP one argument, it will use that as the mark instead. Two arguments to \fBLI\fP will make \fImark\fP a prefix to @@ -870,7 +871,7 @@ Style\fP .T2 BL Blocked. Date line, return address, writer's address and closing -begins at the center of the line. All other lines begins at the left margin. +begins at the center of the line. All other lines begin at the left margin. .T2 SB Semi-blocked. Same as blocked, except that the first line in every paragraph is indented five spaces. @@ -878,7 +879,7 @@ Full-blocked. All lines begin at the left margin. .T2 SP Simplified. Almost the same as the full-blocked style. Subject and -the writer'sidentification is printed in all-capital. +the writer's identification are printed in all-capital. .in .TP .B "LO type [arg]" @@ -886,8 +887,8 @@ This is a list of the standard options: .in +.5i .T2 CN -Confidential notation. Prints \fBRESTRICTED\fP on the second line -below the date line. Any argument replaces \fBRESTRICTED\fP. +Confidential notation. Prints \fBCONFIDENTIAL\fP on the second line +below the date line. Any argument replaces \fBCONFIDENTIAL\fP. See also string variable \fBLetCN\fP. .T2 RN Reference notation. Prints \fBIn reference to:\fP and the argument @@ -926,7 +927,7 @@ Memorandum type. The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP. Memorandum type 0 thru 5 are supported, including \fI"string"\fP. -\fIAddresse\fP just sets a variable, used in the AT&T macros. +\fIAddressee\fP just sets a variable, used in the AT&T macros. .br \fBarg\fP .in +.5i @@ -954,11 +955,11 @@ .B "MULB cw1 space1 [cw2 space2 [cw3 ...]]" Begin a special multi-column mode. Every columns width must be specified. Also the space between the columns must be specified. The last column -does not need any space-definition. MULB starts a diversion and MULE +does not need any space-definition. \fBMULB\fP starts a diversion and \fBMULE\fP ends the diversion and prints the columns. -The unit for width and space is 'n', but MULB accepts all +The unit for width and space is 'n', but \fBMULB\fP accepts all normal unitspecifications like 'c' and 'i'. -MULB operates in a separate environment. +\fBMULB\fP operates in a separate environment. .TP .B "MULN" Begin the next column. This is the only way to switch column. @@ -967,7 +968,7 @@ End the multi-column mode and print the columns. .TP .B "nP [type]" -Print numbered paragraph with header level two. Se \fB.P\fP. +Print numbered paragraph with header level two. See \fB.P\fP. .TP .B "NS [arg [1]]" Prints different types of notations. The argument selects between @@ -1062,8 +1063,8 @@ new width and length. .TP .B PGNH -No header is printed on the next page. Used to get rid off -the header in letters or other special texts +No header is printed on the next page. Used to get rid of +the header in letters or other special texts. This macro must be used before any text to inhibit the pageheader on the first page. .TP @@ -1097,7 +1098,7 @@ Roman. Return to roman font, see also \fBI\fP. .TP -.B "RB [roman-text [bold-text [roman-text [...]]]" +.B "RB [roman-text [bold-text [roman-text [...]]]]" Roman-bold. Even arguments is printed in roman, odd in boldface. See \fBI\fP. @@ -1114,16 +1115,16 @@ Reference end. Ends a reference definition and returns to normal processing. See \fBRS\fP. .TP -.B "RI [roman-text [italic-text [roman-text [...]]]" -Even arguments is printed in roman, odd in italic. +.B "RI [roman-text [italic-text [roman-text [...]]]]" +Even arguments are printed in roman, odd in italic. See \fBI\fP. .TP .B "RL [text-indent [1]]" -Reference list start +Reference list start. Begins a list where each item is preceded with a automatically incremented number between square brackets. -\fIText-indent\fP changes the default indentation +\fIText-indent\fP changes the default indentation. .TP .B "RP [arg1 [arg2]]" Produce reference page. @@ -1131,7 +1132,7 @@ document. It is not needed if \fBTC\fP is used to produce a table of content. The reference page will then be printed automatically. .sp -The reference counter will not be resetted if \fIarg1\fP is 1. +The reference counter will not be reset if \fIarg1\fP is 1. .sp \fIArg2\fP tells \fBRP\fP whether to eject a page or not. .br @@ -1178,7 +1179,7 @@ justification. .TP .B "SETR refname [string]" -Remember the current header and page-number as refname. +Remember the current header and page-number as \fIrefname\fP. Saves \fIstring\fP if \fIstring\fP is defined. \fIstring\fP is retrieved with \fB.GETST\fP. See \fBINITR\fP. @@ -1188,10 +1189,11 @@ The argument will be appended to the reference data, printed at either the first or last author. The reference data is the location, department and initials specified with \fB.AU\fP. -It will be printed at the first author, otherwise at the last. +It will be printed at the first author if the second argument is given, +otherwise at the last. No reference data will be printed if the author(s) is specifed thru \fB.WA\fP/\fB.WE\fP. -See \fBLetter internals\fP. +See \fBINTERNALS\fP. .TP .B "SK [pages]" Skip pages. @@ -1239,7 +1241,7 @@ table of contents. .sp The user-defined macros \fBTX\fP and \fBTY\fP are used if \fBTC\fP is called -with at most four arguments. \fBRX\fP is called before the printing +with at most four arguments. \fBTX\fP is called before the printing of \fICONTENTS\fP, and \fBTY\fP is called instead of printing \fICONTENTS\fP. .sp String \fBCi\fP can be set to control the indentations for each heading-level. @@ -1248,7 +1250,7 @@ in each level. .sp All texts can be redefined, new stringvariables -\fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contains +\fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contain "Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS". These can be redefined to other languages. .TP @@ -1261,10 +1263,10 @@ be printed again if a page-break occurs. Argument \fIN\fP isn't implemented yet. .TP -.B TL [charging-case number(s) [filing-case number(s)] +.B TL [charging-case number(s) [filing-case number(s)]] Begin title of memorandum. All text up to the next \fBAU\fP is included in the title. -\fICharging-case number\fP and \fIfiling-case\fP is saved +\fICharging-case number\fP and \fIfiling-case\fP are saved for use in the front page processing. .TP .B TM [num1 [num2 [...]]] @@ -1302,7 +1304,7 @@ The pointsize can be changed with the second argument. By specifying the font-argument it is possible to use another font instead of courier. -\fIflag\fP control several special features. +\fIflag\fP controls several special features. It contains the sum of all wanted features. .in +.5i .T2 Value @@ -1311,9 +1313,9 @@ Disable the escape-character (\e). This is normally turned on during verbose output. .T2 2 -Add en empty line before the verbose text. +Add an empty line before the verbose text. .T2 4 -Add en empty line after the verbose text. +Add an empty line after the verbose text. .T2 8 Print the verbose text with numbered lines. This adds four digitsized spaces in the beginning of each line. Finer control is available with @@ -1338,7 +1340,7 @@ .B "VM [top [bottom]]" Vertical margin. .TP -.B "WA [writer-name [title]] +.B "WA [writer-name [title]]" Begins specification of the writer and writer's address. Several names can be specified with empty \fBWA\fP/\fBWE\fP-pairs, but only one address. @@ -1419,10 +1421,10 @@ Contains "Yours very truly,", used in \fB.FC\fP. .TP .B Letapp -Contains "APPROVED:", used in \fB.AV.\fP. +Contains "APPROVED:", used in \fB.AV\fP. .TP .B Letdate -Contains "Date", used in \fB.AV.\fP. +Contains "Date", used in \fB.AV\fP. .TP .B LetCN Contains "CONFIDENTIAL", used in \fB.LO CN\fP. @@ -1591,7 +1593,6 @@ Default 99. .TP .B Lsp -.TP The size of an empty line. Normally 0.5v, but it is 1v if \fBn\fP is set (\fB.nroff\fP). .TP @@ -1609,7 +1610,7 @@ 4\ ==\ page header is removed on the first page. .br 5\ ==\ "section-page" and "section-figure" numbering enabled. -Se also the number-register Sectf and Sectp. +See also the number-register Sectf and Sectp. .TP .B Np Numbered paragraphs, default 0. @@ -1660,11 +1661,11 @@ .TP .B Sectf Flag controlling "section-figures". A non-zero value enables this. -Se also register N. +See also register N. .TP .B Sectp Flag controlling "section-page-numbers". A non-zero value enables this. -Se also register N. +See also register N. .TP .B Si Display indent, default 5. @@ -1680,7 +1681,7 @@ the letter type. The name of the submacro has the letter type as suffix. It is therefore possible to define other letter types, either in the national macro-file, or as local additions. -\&\fB.LT\fP will set the number variables \fBPt\fP and \fBPi\fP to 5 and 0. +\&\fB.LT\fP will set the number variables \fBPt\fP and \fBPi\fP to 0 and 5. The following strings and macros must be defined for a new letter type: .TP \fBlet@init_\fP\fItype\fP >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199901222016.FAA02927>