Omit dot before macro names except when presenting their definitions. --- doc/groff.texi.in | 2 +- doc/ms.ms | 190 ++++++++++++++++++++++---------------------- tmac/groff_ms.7.man | 170 +++++++++++++++++++-------------------- 3 files changed, 181 insertions(+), 181 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in index eed816104..3b87a5b90 100644 --- a/doc/groff.texi.in +++ b/doc/groff.texi.in @@ -4312,7 +4312,7 @@ @node ms Footnotes was used for the line length in footnotes; however, setting this register at document initialization time had no effect on the footnote line length in multi-column arrangements.@footnote{You could reset it -after each call to @code{.1C}, @code{.2C}, or @code{.MC}.} +after each call to @code{1C}, @code{2C}, or @code{MC}.} @code{FR} should be used in preference to the old @code{FL} register in contemporary documents. The footnote line length is effectively diff --git a/doc/ms.ms b/doc/ms.ms index d35146086..7b88c922d 100644 --- a/doc/ms.ms +++ b/doc/ms.ms @@ -1,7 +1,7 @@ .\" groff -ept -ms .\" .\" Copyright (C) 2001 Larry Kollar -.\" Copyright (C) 2020-2024 G. Branden Robinson +.\" Copyright (C) 2020-2025 G. Branden Robinson .\" .\" This file is part of groff. .\" @@ -170,10 +170,10 @@ is a formatting instruction to Put a macro call on a line by itself. . Use -.CW .PP +.CW PP if you want your paragraph's first line indented, or -.CW .LP +.CW LP if you don't. .KE . @@ -673,9 +673,9 @@ at the top of the first page. . .PP Define these data by calling the macros below in the order shown; -.CW .DA +.CW DA or -.CW .ND +.CW ND can be called to set the document date (or other identifier) at any time before (a) the abstract, @@ -684,18 +684,18 @@ or (b) its information is required in a header or footer. . Use of these macros is optional, except that -.CW .TL +.CW TL is mandatory if any of -.CW .RP , -.CW .AU , -.CW .AI , +.CW RP , +.CW AU , +.CW AI , or -.CW .AB +.CW AB is called, and -.CW .AE +.CW AE is mandatory if -.CW .AB +.CW AB is called. . . @@ -727,7 +727,7 @@ subsequently macro below regarding the date). . Normally, -.CW .RP +.CW RP sets the page number following the cover page to\~1. . Specifying the optional @@ -748,8 +748,8 @@ Specify the document title. .I ms collects text on input lines following this call into the title until reaching -.CW .AU , -.CW .AB , +.CW AU , +.CW AB , or a heading or paragraphing macro call. T} _ @@ -759,10 +759,10 @@ Specify an author's name. .I ms collects text on input lines following this call into the author's name until reaching -.CW .AI , -.CW .AB , +.CW AI , +.CW AB , another -.CW .AU , +.CW AU , or a heading or paragraphing macro call. . Call it repeatedly to specify multiple authors. @@ -772,20 +772,20 @@ _ Specify the preceding author's institutional affiliation. . An -.CW .AU +.CW AU call is usefully followed by at most one -.CW .AI +.CW AI call; if there are more, the last -.CW .AI +.CW AI call controls. . .I ms collects text on input lines following this call into the author's institution until reaching -.CW .AU , -.CW .AB , +.CW AU , +.CW AB , or a heading or paragraphing macro call. T} _ @@ -796,7 +796,7 @@ or any in the center footer, and, if -.CW .RP +.CW RP is also called, left-aligned at the end of the document description on the cover page. T} @@ -806,7 +806,7 @@ Typeset the current date, or any .I x , arguments\~ if -.CW .RP +.CW RP is also called, left-aligned at the end of the document description on the cover page. . @@ -821,7 +821,7 @@ Begin the abstract. .I ms collects text on input lines following this call into the abstract until reaching an -.CW .AE +.CW AE call. . By default, @@ -1104,7 +1104,7 @@ its default unit is Once specified, .I width applies to further -.CW .IP +.CW IP calls until specified again or a heading or different paragraphing macro is called. T} @@ -1127,9 +1127,9 @@ a region where each paragraph is indented from both margins by .CW \[rs]n[QI] . . The text between -.CW .QS +.CW QS and -.CW .QE +.CW QE can be structured further by use of other paragraphing macros. T} _ @@ -1327,7 +1327,7 @@ T} . .PP After -.CW .NH +.CW NH is called, the assigned number is made available in the strings .CW SN\-DOT @@ -1368,7 +1368,7 @@ lf(CR). .LP Any such change in numbering style becomes effective from the next use of -.CW .NH +.CW NH following redefinition of the alias for .CW \[rs]*[SN\-STYLE] . . @@ -1380,9 +1380,9 @@ for example, table captions, equation labels, and -.CW .XS /\c -.CW .XA /\c -.CW .XE +.CW XS /\c +.CW XA /\c +.CW XE table of contents entries. . . @@ -1401,7 +1401,7 @@ argument is a GNU extension indicating the heading depth corresponding to the .I depth argument of -.CW .NH . +.CW NH . . It matches the type size at which the heading is set to that of a numbered heading at the same depth when the @@ -1464,9 +1464,9 @@ if the value of register is greater than the .I depth argument to a -.CW .NH +.CW NH or -.CW .SH +.CW SH call, the type size of a heading produced by these macros increases by .CW \[rs]n[PSINCR] @@ -1618,7 +1618,7 @@ T} _ \&.R \f[R][\f[I]text\f[] [\f[I]post\f[] [\f[I]pre\f[]]]] T{ As -.CW .B , +.CW B , but use the roman style (upright text of normal weight) instead of bold. @@ -1628,7 +1628,7 @@ T} _ \&.I \f[R][\f[I]text\f[] [\f[I]post\f[] [\f[I]pre\f[]]]] T{ As -.CW .B , +.CW B , but use an .I italic or oblique style instead of bold. @@ -1636,7 +1636,7 @@ T} _ \&.BI \f[R][\f[I]text\f[] [\f[I]post\f[] [\f[I]pre\f[]]]] T{ As -.CW .B , +.CW B , but use a .BI "bold italic" or bold oblique style instead of upright bold. @@ -1647,7 +1647,7 @@ T} _ \&.CW \f[R][\f[I]text\f[] [\f[I]post\f[] [\f[I]pre\f[]]]] T{ As -.CW .B , +.CW B , but use a .CW constant-width (monospaced) roman typeface instead of bold. @@ -1835,7 +1835,7 @@ Because changes to .CW \[rs]*[FAM] take effect only at the next paragraph, this document uses -.CW .CW +.CW CW to \[lq]inline\[rq] a change to the font family, marking syntactical elements of .I ms @@ -2281,7 +2281,7 @@ _ Boxed keep macros cause breaks; to box words within a line, recall -.CW .BX +.CW BX in section \[lq]Typeface and decoration\[rq] above. . Box lines are drawn as close as possible to the text they enclose so @@ -2289,12 +2289,12 @@ that they are usable within paragraphs. . When boxing entire paragraphs thus, you may improve their appearance by calling -.CW .B1 +.CW B1 after the first paragraphing macro, and invoking the .CW sp request before calling -.CW .B2 . +.CW B2 . . . .TS @@ -2313,13 +2313,13 @@ Happy Fun Ball may suddenly accelerate to dangerous speeds. .LP If you want a boxed keep to float, enclose the -.CW .B1 +.CW B1 and -.CW .B2 +.CW B2 calls within a pair of -.CW .KF +.CW KF and -.CW .KE +.CW KE calls. . . @@ -2388,15 +2388,15 @@ The .CW DI register is a GNU extension; its value is an indentation applied to displays created with -.CW .DS +.CW DS and -.CW .ID +.CW ID without arguments, to -.CW .DS\~I \[rq] \[lq] +.CW DS\~I \[rq] \[lq] without an indentation argument, and to equations set with -.CW .EQ\~I \[rq]. \[lq] +.CW EQ\~I \[rq]. \[lq] . Changes to either register take effect at the next display boundary. . @@ -2482,7 +2482,7 @@ preprocessor. The optional .CW H argument to -.CW .TS +.CW TS instructs .I ms to repeat table rows @@ -2513,9 +2513,9 @@ marks the start of a preprocessor diagram; either of -.CW .PE +.CW PE or -.CW .PF +.CW PF ends it, the latter with \[lq]flyback\[rq] to the vertical position at its top. . @@ -2593,7 +2593,7 @@ emits collected references it interpolates the string .CW \[rs]*[REFERENCES] as an unnumbered heading -.CW .SH ). ( +.CW SH ). ( . . .KS @@ -2818,7 +2818,7 @@ as an argument to the macro. . Such manual marks should be repeated as arguments to -.CW .FS +.CW FS or as part of the footnote text to disambiguate their correspondence. . You may wish to use @@ -2888,15 +2888,15 @@ You can place a second interpolation between a .CW \[rs]** and its corresponding -.CW .FS +.CW FS call as long as each -.CW .FS +.CW FS call occurs .I after the corresponding .CW \[rs]** and occurrences of -.CW .FS +.CW FS are in the same order as corresponding occurrences of .CW \[rs]** . . @@ -2932,7 +2932,7 @@ The register controls the formatting of automatically numbered footnote paragraphs, and those for which -.CW .FS +.CW FS is given a .I marker argument, @@ -2952,12 +2952,12 @@ or surrounded by square brackets (on terminals). . The footnote paragraph is indented as with -.CW .PP +.CW PP if there is an -.CW .FS +.CW FS argument or an automatic number, and as with -.CW .LP +.CW LP otherwise. . This is the default. @@ -2973,14 +2973,14 @@ As .CW 1 , but without indentation (like -.CW .LP ). +.CW LP ). T} 3 T{ As .CW 1 , but set the footnote paragraph with the marker hanging (like -.CW .IP ). +.CW IP ). T} .TE .KE @@ -3016,10 +3016,10 @@ the footnote line length in multi-column arrangements.\** . .FS You could reset it after each call to -.CW .1C , -.CW .2C , +.CW 1C , +.CW 2C , or -.CW .MC . +.CW MC . .FE . . @@ -3315,7 +3315,7 @@ in practice, unless your page numbering is unusual, this means that you should call it early, before -.CW .TL +.CW TL or any heading or paragraphing macro. . This is a Berkeley extension. @@ -3350,9 +3350,9 @@ sets up to format the header also calls the (normally undefined) .CW HD macro after -.CW .PT ; +.CW PT ; you can define -.CW .HD +.CW HD if you need additional processing after setting the header (for example, to draw a line below it). @@ -3540,8 +3540,8 @@ The .CW XA macro, used within -.CW .XS /\c -.CW .XE +.CW XS /\c +.CW XE pairs, supplements an entry\[em]for instance, when it requires multiple output lines, @@ -3556,9 +3556,9 @@ or by providing a second argument to the .CW XA macro. . -.CW .XS +.CW XS and -.CW .XA +.CW XA automatically associate the page number where they are called with the text following them, but they accept arguments to override this behavior. @@ -3569,7 +3569,7 @@ call or .CW PX to emit the table of contents; -.CW .TC +.CW TC resets the page number .B i "" to\~ (Roman numeral one), @@ -3599,10 +3599,10 @@ of prevents a leader and page number from being emitted for that entry. . Use of -.CW .XA +.CW XA within -.CW .XS /\c -.CW .XE +.CW XS /\c +.CW XE is optional; it can be repeated. . @@ -3613,11 +3613,11 @@ a supplemental entry is indented by that amount; ens are assumed if no unit is indicated. . Text on input lines between -.CW .XS +.CW XS and -.CW .XE +.CW XE is stored for later recall by -.CW .PX . +.CW PX . T} \&.XA \f[R][\f[I]page-number\f[] [\f[I]indentation\f[]]] \^ \&.XE \^ @@ -3783,7 +3783,7 @@ call. T} \&.XH \f[I]depth heading-text T{ As -.CW .XN , +.CW XN , but use .I depth to determine the indentation. @@ -3805,9 +3805,9 @@ Macro Description _ \&.XN\-REPLACEMENT \f[I]heading-text T{ These hook macros implement -.CW .XN +.CW XN and -.CW .XH , +.CW XH , respectively. . They call @@ -3816,7 +3816,7 @@ and pass their .I heading-text arguments to -.CW .\%XH\-UPDATE\-TOC . +.CW \%XH\-UPDATE\-TOC . T} \&.XH\-REPLACEMENT \f[I]depth heading-text \^ \&.XH\-INIT T{ @@ -4073,9 +4073,9 @@ This can cause problems for documents that define additional macros of their own that manipulate indentation. . Use -.CW .RS +.CW RS and -.CW .RE +.CW RE instead of the .CW in request. @@ -4191,7 +4191,7 @@ and desire special treatment of certain page numbers you may need to handle a non-Arabic page number format, as .I "groff ms" 's -.CW .PT +.CW PT does; see the macro package source. . @@ -4213,14 +4213,14 @@ and as setting the default column width and \[lq]intercolumn gap\[rq], respectively, and which applied when -.CW .MC +.CW MC was called with fewer than two arguments. . .I "groff ms" instead treats -.CW .MC +.CW MC without arguments as synonymous with -.CW .2C ; +.CW 2C ; there is thus no occasion for a default column width register. . Further, @@ -4228,7 +4228,7 @@ the .CW MINGW register and the second argument to -.CW .MC +.CW MC specify a .I minimum space between columns, diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man index e32fb0989..6242ce957 100644 --- a/tmac/groff_ms.7.man +++ b/tmac/groff_ms.7.man @@ -130,9 +130,9 @@ .SH "Document structure" .\" information" section from ms.ms. To compose a simple document from scratch, begin it by calling -.B .LP +.B LP or -.BR .PP . +.BR PP . . Organize longer documents as follows. . @@ -448,9 +448,9 @@ .SS "Document description macros" . Define information describing the document by calling the macros below in the order shown; -.B .DA +.B DA or -.B .ND +.B ND can be called to set the document date (or other identifier) at any time before (a) the abstract, @@ -459,18 +459,18 @@ .SS "Document description macros" . Use of these macros is optional, except that -.B .TL +.B TL is mandatory if any of -.BR .RP , -.BR .AU , -.BR .AI , +.BR RP , +.BR AU , +.BR AI , or -.B .AB +.B AB is called, and -.B .AE +.B AE is mandatory if -.B .AB +.B AB is called. . . @@ -499,7 +499,7 @@ .SS "Document description macros" macro below regarding the date). . Normally, -.B .RP +.B RP sets the page number following the cover page to\~1. . Specifying the optional @@ -521,8 +521,8 @@ .SS "Document description macros" .I ms collects text on input lines following this call into the title until reaching -.BR .AU , -.BR .AB , +.BR AU , +.BR AB , or a heading or paragraphing macro call. . . @@ -533,10 +533,10 @@ .SS "Document description macros" .I ms collects text on input lines following this call into the author's name until reaching -.BR .AI , -.BR .AB , +.BR AI , +.BR AB , another -.BR .AU , +.BR AU , or a heading or paragraphing macro call. . Call it repeatedly to specify multiple authors. @@ -547,20 +547,20 @@ .SS "Document description macros" Specify the preceding author's institutional affiliation. . An -.B .AU +.B AU call is usefully followed by at most one -.B .AI +.B AI call; if there are more, the last -.B .AI +.B AI call controls. . .I ms collects text on input lines following this call into the author's institution until reaching -.BR .AU , -.BR .AB , +.BR AU , +.BR AB , or a heading or paragraphing macro call. . . @@ -573,7 +573,7 @@ .SS "Document description macros" in the center footer, and, if -.B .RP +.B RP is also called, left-aligned at the end of the document description on the cover page. . @@ -585,7 +585,7 @@ .SS "Document description macros" or any .RI arguments\~ x , if -.B .RP +.B RP is also called, left-aligned at the end of the document description on the cover page. . @@ -601,7 +601,7 @@ .SS "Document description macros" .I ms collects text on input lines following this call into the abstract until reaching an -.B .AE +.B AE call. . By default, @@ -775,7 +775,7 @@ .SS Paragraphs Once specified, .I width applies to further -.B .IP +.B IP calls until specified again or a heading or different paragraphing macro is called. . @@ -798,9 +798,9 @@ .SS Paragraphs .BR \[rs]n[QI] . . The text between -.B .QS +.B QS and -.B .QE +.B QE can be structured further by use of other paragraphing macros. . . @@ -898,7 +898,7 @@ .SS Headings .ne 3v .P After -.B .NH +.B NH is called, the assigned number is made available in the strings .B SN\-DOT @@ -931,7 +931,7 @@ .SS Headings . Any such change in numbering style becomes effective from the next use of -.B .NH +.B NH following redefinition of the alias for .BR \[rs]*[SN\-STYLE] . . @@ -943,7 +943,7 @@ .SS Headings table captions, equation labels, and -.BR .XS / .XA / .XE +.BR XS / XA / XE table of contents entries. . . @@ -958,7 +958,7 @@ .SS Headings to the .I depth argument of -.BR .NH . +.BR NH . . It matches the type size at which the heading is set to that of a numbered heading at the same depth when the @@ -1007,9 +1007,9 @@ .SS Headings register is greater than the .I depth argument to a -.B .NH +.B NH or -.B .SH +.B SH call, the type size of a heading produced by these macros increases by .B \[rs]n[PSINCR] @@ -1101,7 +1101,7 @@ .SS "Typeface and decoration" .BR .R \~[\c .IR text \~[ post \~[ pre ]]] As -.BR .B , +.BR B , but use the roman style (upright text of normal weight) instead of bold. @@ -1113,7 +1113,7 @@ .SS "Typeface and decoration" .BR .I \~[\c .IR text \~[ post \~[ pre ]]] As -.BR .B , +.BR B , but use an italic or oblique style instead of bold. . . @@ -1121,7 +1121,7 @@ .SS "Typeface and decoration" .BR .BI \~[\c .IR text \~[ post \~[ pre ]]] As -.BR .B , +.BR B , but use a bold italic or bold oblique style instead of upright bold. . This is a Research Tenth Edition Unix extension. @@ -1132,7 +1132,7 @@ .SS "Typeface and decoration" .BR .CW \~[\c .IR text \~[ post \~[ pre ]]] As -.BR .B , +.BR B , but use a constant-width (monospaced) roman typeface instead of bold. . This is a Research Tenth Edition Unix extension. @@ -1346,7 +1346,7 @@ .SS "Keeps, boxed keeps, and displays" Boxed keep macros cause breaks; to box words within a line, recall -.B .BX +.B BX in section \[lq]Highlighting\[rq] above. . Box lines are drawn as close as possible to the text they enclose so @@ -1354,24 +1354,24 @@ .SS "Keeps, boxed keeps, and displays" . When boxing entire paragraphs thus, you may improve their appearance by calling -.B .B1 +.B B1 after the first paragraphing macro, and invoking the .B sp request before calling -.B .B2 . +.B B2 . . . .P If you want a boxed keep to float, enclose the -.B .B1 +.B B1 and -.B .B2 +.B B2 calls within a pair of -.B .KF +.B KF and -.B .KE +.B KE calls. . . @@ -1472,9 +1472,9 @@ .SS "Keeps, boxed keeps, and displays" .B DI register is a GNU extension; its value is an indentation applied to displays created with -.B .DS +.B DS and -.B .ID +.B ID without arguments, to .RB \[lq] .DS\~I \[rq] @@ -1548,15 +1548,15 @@ .SS "Tables, figures, equations, and references" .B .PE .TQ .B .PF -.B .PS +.B PS marks the start of a .MR @g@pic @MAN1EXT@ preprocessor diagram; either of -.B .PE +.B PE or -.B .PF +.B PF ends it, the latter with \[lq]flyback\[rq] to the vertical position at its top. . @@ -1680,7 +1680,7 @@ .SS Footnotes Begin a footnote. . The -.B .FS\-MARK +.B FS\-MARK hook (see below) is called with any supplied @@ -1712,13 +1712,13 @@ .SS Footnotes macro is called. . It is passed the same arguments as -.B .FS +.B FS itself. . By default, this macro has an empty definition. . -.B .FS\-MARK +.B FS\-MARK is a GNU extension. . . @@ -1752,7 +1752,7 @@ .SS Footnotes register controls the formatting of automatically numbered footnote paragraphs, and those for which -.B .FS +.B FS is given a .I marker argument, @@ -1773,12 +1773,12 @@ .SS Footnotes (on terminals). . The footnote paragraph is indented as with -.B .PP +.B PP if there is an -.B .FS +.B FS argument or an automatic number, and as with -.B .LP +.B LP otherwise. . This is the default. @@ -1798,7 +1798,7 @@ .SS Footnotes .BR 1 , but without indentation (like -.BR .LP ). +.BR LP ). . . .TP @@ -1807,7 +1807,7 @@ .SS Footnotes .BR 1 , but set the footnote paragraph with the marker hanging (like -.BR .IP ). +.BR IP ). .RE . . @@ -1981,9 +1981,9 @@ .SS "Headers and footers" (normally undefined) .B HD macro after -.BR .PT ; +.BR PT ; you can define -.B .HD +.B HD if you need additional processing after setting the header. . .\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper... @@ -2105,7 +2105,7 @@ .SS "Creating a table of contents" .B XA macro, used within -.BR .XS / .XE +.BR XS / XE pairs, supplements an entry\[em]for instance, when it requires multiple output lines, @@ -2120,9 +2120,9 @@ .SS "Creating a table of contents" .B XA macro. . -.B .XS +.B XS and -.B .XA +.B XA automatically associate the page number where they are called with the text following them, but they accept arguments to override this behavior. @@ -2133,7 +2133,7 @@ .SS "Creating a table of contents" or .B PX to emit the table of contents; -.B .TC +.B TC resets the page number .RB to\~ i (Roman numeral one), @@ -2165,9 +2165,9 @@ .SS "Creating a table of contents" prevents a leader and page number from being emitted for that entry. . Use of -.B .XA +.B XA within -.BR .XS / .XE +.BR XS / XE is optional; it can be repeated. . @@ -2178,11 +2178,11 @@ .SS "Creating a table of contents" ens are assumed if no unit is indicated. . Text on input lines between -.B .XS +.B XS and -.B .XE +.B XE is stored for later recall by -.BR .PX . +.BR PX . . . .TP @@ -2216,17 +2216,17 @@ .SS "Creating a table of contents" . .I groff ms obviates the need to repeat heading text after -.B .XS +.B XS calls. . Call -.B .XN +.B XN and -.B .XH +.B XH after -.B .NH +.B NH and -.BR .SH , +.BR SH , respectively. . Text to be appended to the formatted section heading, @@ -2249,7 +2249,7 @@ .SS "Creating a table of contents" .TP .BI .XH\~ "depth heading-text" As -.BR .XN , +.BR XN , but use .I depth to determine the indentation. @@ -2267,9 +2267,9 @@ .SS "Creating a table of contents" .TQ .BI \%.XH\-REPLACEMENT\~ "depth heading-text" These hook macros implement -.B .XN +.B XN and -.BR .XH , +.BR XH , and call .B \%XN\-INIT and @@ -2437,9 +2437,9 @@ .SH "Differences from AT&T \f[I]ms\f[]" their own that manipulate indentation. . Use -.B .RS +.B RS and -.B .RE +.B RE instead of the .B in request. @@ -2554,7 +2554,7 @@ .SH "Differences from AT&T \f[I]ms\f[]" may need to handle a non-Arabic page number format, as .IR "groff ms" 's -.B .PT +.B PT does; see the macro package source. . @@ -2575,14 +2575,14 @@ .SH "Differences from AT&T \f[I]ms\f[]" as setting the default column width and \[lq]intercolumn gap\[rq], respectively, and which applied when -.B .MC +.B MC was called with fewer than two arguments. . .I groff ms instead treats -.B .MC +.B MC without arguments as synonymous with -.BR .2C ; +.BR 2C ; there is thus no occasion for a default column width register. . Further, @@ -2590,7 +2590,7 @@ .SH "Differences from AT&T \f[I]ms\f[]" .B MINGW register and the second argument to -.B .MC +.B MC specify a .I minimum space between columns, -- 2.30.2
signature.asc
Description: PGP signature
_______________________________________________ groff-commit mailing list groff-commit@gnu.org https://lists.gnu.org/mailman/listinfo/groff-commit