bugGNU roff - Bugs: bug #63632, man pages: improve some wording...

 
 

bug #63632: man pages: improve some wording and typesetting

Submitter:  Bjarni Ingi Gislason <bjarniig>
Submitted:  Sun 08 Jan 2023 08:09:53 PM UTC
   
 
Category:  General Severity:  2 - Minor
Item Group:  Lint Status:  None
Privacy:  Public Assigned to:  None
Open/Closed:  Open Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Sat 12 Aug 2023 08:44:05 PM UTC, comment #8: 

comment #7:

> There is no hard rule against use of formatter features not
> listed in groff_man_style(7)'s "Portability" section.


True, but \| and \^ having similar uses, I presumed the one explicitly claimed to be (more) portable would be preferable.

However, I did not render the cited line in refer(1) both ways to see if I thought one looked significantly better.  Or even look at it as-is to see if I thought it needed the typographic nudge at all.

While \| is certainly in a lot more groff man pages, \^ is not unheard of.

$ find . -type f -name *.man* -exec fgrep -l '\|' {} \; | wc
     53      53    1581
$ find . -type f -name *.man* -exec fgrep -l '\^' {} \; | wc
      8       8     227

These may include some false positives, but it's a rough guide.

Dave <barx>
Group Member
Wed 09 Aug 2023 07:14:31 PM UTC, comment #7: 

comment #6:

> original submission:
> > Input file is ./src/preproc/refer/refer.1.man
> >
> > Add a hair space (\^) around "|" to increase readability
>
> The \^ escape sequence is not among the approved escapes listed
> in the Portability section of groff_man(7).  The thin space \|
> is, though, and should offer the legibility benefit you're after
> here.


The groff man pages don't scrupulously adhere to our own portability advice in the referenced section.

The most obvious example is that we use `\[xx]`-style special character escape sequences in our man(7) documents instead of `\(xx`.  However, I am at greater pains to make groff_man(7) (and `_style`) better exemplars of portable page composition, on the theory that man page authors are more likely to consult its source even if they neglect to inspect that of other groff man pages.

There are other places in the groff man page corpus where things of imperfect portability were done.

  • Interpolating the name of the output device in groff_char(7) (I think this was me).
  • Use of eqn in groff(7), groff_diff(7), and eqn(1) itself; the last was my innovation.  (Formally, this isn't unportable; practically speaking, it can make for unintelligible output to terminals.  However, I have an evil idea that would address the former two cases.  [The latter is already safely guarded via a portable technique that "Portability" nevertheless does not countenance.)
  • Use of pic in soelim(1).  Also guarded per the previous item.


There is no hard rule against use of formatter features not listed in groff_man_style(7)'s "Portability" section.  I haven't seen anyone argue for one, and I would oppose it because it's just too limiting.

At the same time I haven't changed my mind about wanting to remove the page-private macros from groff_hdtbl(7), groff_mom(7), groff(7), and groff_out(5).

A better, and limited, use of page-private macros can be found in grodvi(1), grolj4(1), gropdf(1), and grops(1).  These also degrade gracefully in the event the formatting program can't handle macro definitions.

> > Input file is ./src/preproc/tbl/tbl.1.man
> >
> > Add a hair space (\^) around "|" to increase readability
> >
> > 1839:n|n\[rs]f[B]\[rs][tmu]\[rs]f[]n|difference
> > 1856:n|n\f[B]\[tmu]\f[]n|difference
>
> Adding such spaces here would be flat-out wrong.  These vertical
> bars are part of the tbl syntax.  In the latter case they are
> formatted by tbl and do not even appear in the output.  In the
> former, they're tbl input that is typeset in a monospace font,
> where horizontal adjustments are inappropriate because they spoil
> the vertical alignment of the character cells.


I concur.  This head of the hydra (or hecatoncheiris?) in comment #0 should be sliced off and cauterized.

G. Branden Robinson <gbranden>
Group administrator
Wed 09 Aug 2023 05:35:48 PM UTC, comment #6: 

original submission:

> Input file is ./src/preproc/refer/refer.1.man
>
> Add a hair space (\^) around "|" to increase readability


The \^ escape sequence is not among the approved escapes listed in the Portability section of groff_man(7).  The thin space \| is, though, and should offer the legibility benefit you're after here.

> Input file is ./src/preproc/tbl/tbl.1.man
>
> Add a hair space (\^) around "|" to increase readability
>
> 1839:n|n\[rs]f[B]\[rs][tmu]\[rs]f[]n|difference
> 1856:n|n\f[B]\[tmu]\f[]n|difference


Adding such spaces here would be flat-out wrong.  These vertical bars are part of the tbl syntax.  In the latter case they are formatted by tbl and do not even appear in the output.  In the former, they're tbl input that is typeset in a monospace font, where horizontal adjustments are inappropriate because they spoil the vertical alignment of the character cells.

Dave <barx>
Group Member
Wed 15 Feb 2023 07:18:57 PM UTC, comment #5: 

I found it.  GMail, surprisingly, led me straight to it once I poked its into my sent box.

https://lists.gnu.org/archive/html/groff/2022-01/msg00010.html

G. Branden Robinson <gbranden>
Group administrator
Wed 15 Feb 2023 07:16:38 PM UTC, comment #4: 


comment #2:

> Updating Item Group: Branden can correct me if I'm wrong, but I believe "Lint" is intended for coding issues.  Documentation files can include code, roff being a full programming language, but this bug reports only issues with documentation content, making "Documentation" seem more appropriate.


Hi Dave,

Actually, no.

"Lint Some detail of groff is unfastidious, such as non-confusing typos in documentation or code style nits. These matters do not warrant a ChangeLog entry absent a Savannah ticket."

The Item Groups do actually have descriptions.  Perversely, only the administrators of Savannah projects can see them (or the descriptions of the Categories).

This strikes me as supremely unhelpful to Savannah users, but I haven't worked up the anger to thunder about this to the savannah-hackers-public list yet.

I did publish my updates to the groff Item Groups and Categories a while back after grinding through them, so there is some public record of this.  It is apparently the only one.

But it's so hard to find, I can't locate it.  Neither lists.gnu.org's mailing list search (about which Alex Colomar complained) nor Google turns it up.

Great. :-|

G. Branden Robinson <gbranden>
Group administrator
Wed 15 Feb 2023 07:02:59 PM UTC, comment #3: 

comment #2:

> this bug reports only issues with documentation content,


...only DEALS with...

Dave <barx>
Group Member
Wed 15 Feb 2023 06:59:01 PM UTC, comment #2: 

Updating Item Group: Branden can correct me if I'm wrong, but I believe "Lint" is intended for coding issues.  Documentation files can include code, roff being a full programming language, but this bug reports only issues with documentation content, making "Documentation" seem more appropriate.

Dave <barx>
Group Member
Mon 09 Jan 2023 07:48:29 AM UTC, comment #1: 

original submission:

> See a manual of style about the difference between "abc..." and
> "abc ...".


Maybe you could give a specific style manual reference, and say what that manual says about this difference?  As a counterexample, the Chicago Manual of Style, a widely used US style manual, makes no such distinction.  It does distinguish between an ellipsis followed by a period, and a period followed by an ellipsis (see section 13.53 in the latest (17th) edition), which does affect the spacing with the preceding word, but both of these constructions necessarily involve four dots, and therefore apply to none of the 28 instances you've cited throughout this bug report.

(The online CMoS is behind a paywall so I can't give a URL to the above citation.)

Adding Peter to cc, since this item and one other affect a -mom file, and he can decide whether/how he wants to change it.

Dave <barx>
Group Member
Sun 08 Jan 2023 08:09:53 PM UTC, original submission:  

Subject: manpages: improve some wording and typesetting


Input file is ./contrib/gperl/gperl.1.man

Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

347:stores the 1st argument as

#####

Input file is ./contrib/mm/groff_mm.7.man

Split lines longer than 100 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

./contrib/mm/groff_mm.7.man: line 3245 length 129
.BI TC\  "\fR[\fPslevel \fR[\fPspacing \fR[\fPtlevel \fR[\fPtab \fR[\fPh1 \fR[\fPh2 \fR[\fPh3 \fR[\fPh4 \fR[\fPh5\fR]]]]]]]]]\fP"


#####


Add a missing left italic correction in front of \fI, or use a macro

.BI LT\  \fR[\fIarg\/\fR]\fI

#####


Add a zero (0) in front of a decimal fraction that begins with a period
(.)

3321:\&.ds Ci .25i .5i .75i 1i 1i

#####


Use the name of units in text, symbols in tables and calculations

1427:the default amount is 1v.
1842:Default is 2v.
3189:like \[lq]3i\[rq] or \[lq]8v\[rq].
3206:Reset tabs to every\ 5n.
3503:Indent the verbose text by \[lq]5n\[rq].
3549:(\[lq]7v 5v\[rq])
4385:The default is 0.5v in troff mode and 1v in nroff mode.
4617:Default is 5n.

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

951:.I format,
952:.I fill,
3092:.I mode,

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

695:.BI AT\~ title\c
2783:.BI \-I\~ n\c

#####

Input file is ./contrib/mom/groff_mom.7.man

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

142:.\" XXX: but we have PDFPIC now...so -Tps is necessary only for people
1728:  threat, at length I would be avenged.\|.\|.
1863:.RI ( "The most important point.\|.\|.\&" )
2878:.BR \[rs]*[ST].\|.\|.\&\[rs]*[STX] ),
2894:.BR \[rs]*[ST].\|.\|.\&\[rs]*[STX] ).
3137:.B The beginning of a paragraph.\|.\|.\&
3139:.B The beginning of another paragraph.\|.\|.\&

#####


Add a zero (0) in front of a decimal fraction that begins with a period
(.)

1162:.B .B_MARGIN .75i
2220:.B .L_MARGIN .5i

#####

Input file is ./man/groff.7.man

Split a punctuation from a single argument, if a two-fonts macro is meant

491:.I groff,
1091:.B !\&,
2707:.I ident.
4143:.I font.
5318:.I registers.
6654:.I stack,

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

600:.BI \[rs] newline\c
635:.BI \[rs] newline\c
1717:.BI \[rs] space\c
6931:.BI ": ${" var \c

#####


Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

3074:(in multiples of 1/1000th).
3942:.IR N \~12ths
3951:.IR M \~12ths

#####

Input file is ./man/groff_char.7.man

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

802:].\|.\|.]
875:.\" And thereby hangs a tale...
933:.\" XXX: I surmise that...

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

156:.B \e[bs].

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

743:.BI \[rs][u nnnn\c
744:.RI [ n\c
799:.BI \[rs][u base-glyph\c
801:.BI _ combining-component\c
894:.BI \[rs]( xx\c

#####

Input file is ./man/groff_diff.7.man

Find a repeated word

! 770 --> is

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

1018:.B \[rs],
1033:.B \[rs],
1942:.I ident.
3634:.I anything,
3639:.I body.

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

406:.BI \[rs][ xxx\c
408:.BI \[rs]N\[aq] xxx\c
2632:.BI .hpfcode\~ "a b"\c

#####


Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

2334:must a non-negative integer multiple of 1/1000th.

N.B. line 2334 is missing the word "be"

4229:The zoom value of the current font, in multiples of 1/1000th.

#####

Input file is ./man/groff_font.5.man

Split a punctuation from a single argument, if a two-fonts macro is meant

805:.I subfields,

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

211:.BI papersize\~ format-or-dimension-pair-or-file-name\c

#####

Input file is ./man/groff_out.5.man

Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes the "\/" part,
which is in the macro.
So "\/" must be added to the argument before the "\c" string.

  Or

add the italic corrections.
[1] man-pages(7)

67:\fB\\$1\fP\ \fI\,\\$2\/\fP\\$3
71:\fBD\\$1\fP\ \fI\,\\$2\/\fP\|\*[@linebreak]
91:\fBx\\$1\fP\ \fI\\$2\fP\|\*[@linebreak]

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

562:.I n;
799:.I n;

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

447:.BI # anything\c

#####

Input file is ./man/groff_tmac.5.man

Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes the "\/" part,
which is in the macro.
So "\/" must be added to the argument before the "\c" string.

  Or

add the italic corrections.
[1] man-pages(7)

671:|\|\fB\-I\fP\~\fIn\fP] \
672:\fI\|file\fP [\fIwidth\fP [\,\fIheight\/\fP]]

#####

Add a missing left italic correction in front of \fI, or use a macro

\fI\|file\fP [\fIwidth\fP [\,\fIheight\/\fP]]

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

514:.BI \%paper= format\c

#####

Input file is ./man/roff.7.man

Increase size of ~ (tilde) to make it more visible
with "troff" by using character \(ti.

1325:.\" <https://www.cs.princeton.edu/~bwk/202/summer.reconstructed.pdf>.

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

137:.I filling.
228:.I hyphenation.
248:.I break.
330:.I requests.
416:.I arguments,
450:.I interpolation.
589:.I vee.
718:.I characters.
721:.I groff,

#####

Input file is ./src/devices/grodvi/grodvi.1.man

Find a repeated word

! 333 --> are

#####

Input file is ./src/devices/grolbp/grolbp.1.man

An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

60:.BI \-\-copies= num-copies\c
62:.BI \-\-fontdir= font-directory\c
66:.BI \-\-linewidth= width\c
68:.BI \-\-orientation= orientation\c
70:.BI \-\-papersize= paper-format\c

#####

Input file is ./src/devices/gropdf/gropdf.1.man

Split a punctuation from a single argument, if a two-fonts macro is meant

661:.B grops.
1355:.I gropdf.
1672:.I troffrc.

#####

Input file is ./src/devices/grops/grops.1.man

Add a zero (0) in front of a decimal fraction that begins with a period
(.)

1173:\[rs]D\[aq]l .9m 0\[aq]\[rs]h\[aq].05m\[aq]\[aq]\[rs]
1223:{ gsave .9 setgray clippath pathbbox exch 2 copy
1224:  .5 mul exch .5 mul translate atan rotate pop pop

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

347:.I GROPS_PROLOGUE.
1385:.I grops.
1761:.I troffrc.

#####

Input file is ./src/devices/grotty/grotty.1.man

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

261:.\" Version 487 of...

#####


Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

252:.\" double-struck characters as bold nor supports -b, but does render

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

641:.I grotty.

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

288:.IR uri \~[ key\c
289:.BI = value\c

#####


Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

132:.\" ECMA-48, 2nd edition (1979) calls it "negative image".
753:5th\~edition,

#####

Input file is ./src/preproc/eqn/eqn.1.man

Do not use "\s0" but an absolute number, as the size of the string could
be changed.

236:.ds Su \[lq]\s+5\[*S]\s0\[rq]

#####

Input file is ./src/preproc/grn/grn.1.man

Use the name of units in text, symbols in tables and calculations

290:times 0.15pt
296:which corresponds to 0.15pt
297:(0.45pt and 0.75pt,

#####

Input file is ./src/preproc/pic/pic.1.man

Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes the "\/" part,
which is in the macro.
So "\/" must be added to the argument before the "\c" string.

  Or

add the italic corrections.
[1] man-pages(7)

457:\fBfor\fR \fIvariable\fR \fB=\fR \fIexpr1\fR \fBto\fR \fIexpr2\fR \
458:[\fBby\fR [\fB*\fR]\,\fIexpr3\/\fR] \fBdo\fR \fIX\fR \fIbody\fR \fIX\fR
509:\fBif\fR \fIexpr\fR \fBthen\fR \fIX\fR \fIif-true\fR \fIX\fR \
510:[\fBelse\fR \fIY\fR \fIif-false\fR \fIY\fR]
586:\fBsh\fR \fIX\fR \fIcommand\fR \fIX\fR
593:\fBcopy\fR \fB"\,\fIfilename\/\fB"\fR
717:\fBplot\fR \fIexpr\fR [\fB"\,\fItext\*(ic\fB"\fR]
834:\fIe1\fB && \fIe2\fR
836:\fIe1\fB || \fIe2\fR
838:\fIe1\fB == \fIe2\fR
840:\fIe1\fB != \fIe2\fR
842:\fIe1\fB >= \fIe2\fR
844:\fIe1\fB > \fIe2\fR
846:\fIe1\fB <= \fIe2\fR
848:\fIe1\fB < \fIe2\fR
850:\fB"\,\fIstr1\*(ic\fB" == "\,\fIstr2\*(ic\fB"\fR
852:\fB"\,\fIstr1\*(ic\fB" != "\,\fIstr2\*(ic\fB"\fR

#####


Add a missing left italic correction in front of \fI, or use a macro

811:.el   10\[ha]\fIx\fR)

#####


Do not use "\s0" but an absolute number, as the size of the string could
be changed.

41:.  ds lx L\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\*[tx]

#####


Use the name of units in text, symbols in tables and calculations

407:\[rs]centerline{\[rs]raise 1em\[rs]box\[rs]graph}
422:  \[rs]vbox{\[rs]unvbox\[rs]csname #1\[rs]endcsname\[rs]kern 0pt}}
909:x = 5e\-2

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

527:.BI print\~ arg\c
541:.BI command\~ arg\c
695:.BI reset\~ pvar1\c

#####

Input file is ./src/preproc/refer/refer.1.man

Use the correct macro for the font change of a single argument or
split the argument into two.

1050:.IR "et cetera".)

#####


Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

1895:.B refer -p my\-db\-file

#####


Add a hair space (\^) around "|" to increase readability

1788:.B \%label \[dq](A.n|Q) \[aq], \[aq] (D.y|D)\[dq]; \

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

43:.IB field . macro\c
368:.IB m \- \c

#####

Input file is ./src/preproc/soelim/soelim.1.man

Split a punctuation from a single argument, if a two-fonts macro is meant

380:.I included-files.

#####

Input file is ./src/preproc/tbl/tbl.1.man

Add a hair space (\^) around "|" to increase readability

1839:n|n\[rs]f[B]\[rs][tmu]\[rs]f[]n|difference
1856:n|n\f[B]\[tmu]\f[]n|difference

#####


Use the name of units in text, symbols in tables and calculations

1620:\&Lw(2i)0 L.
1631:Lw(2i)0 L.

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

181:.I entries.
392:.I descriptors.
426:.I classifier,
443:.I modifiers;
1210:.I adjustment.

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

1078:.BI \[rs]R x\c

#####

Input file is ./src/roff/groff/groff.1.man

Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-

1948:.\" --help or --version.

#####

Input file is ./src/roff/troff/troff.1.man

Split a punctuation from a single argument, if a two-fonts macro is meant

221:.I text.
359:.I num.
368:.I list,
372:.I n,
387:.I list.
400:.I numeric-expression.
435:.I dev.
476:.I name.
897:.I name.

#####

Input file is ./src/utils/afmtodit/afmtodit.1.man

Split a punctuation from a single argument, if a two-fonts macro is meant

93:.I font-description-file,
409:.I font-description-file.

#####

Input file is ./src/utils/hpftodit/hpftodit.1.man

Split a punctuation from a single argument, if a two-fonts macro is meant

200:.I font-description,

#####

Input file is ./src/utils/tfmtodit/tfmtodit.1.man

Split a punctuation from a single argument, if a two-fonts macro is meant

110:.I tfm-file,
118:.I font-description,
144:.I tfm-file.
241:.I skew-char.

#####

Input file is ./src/utils/xtotroff/xtotroff.1.man

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

123:.B -d

#####


Use the name of units in text, symbols in tables and calculations

160:a resolution of 75dpi is assumed.

#####

Input file is ./tmac/groff_mdoc.7.man

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

807:.\" should be room anyway...bug?
5347:.\" Not a pretty sight...

#####


Use the name of units in text, symbols in tables and calculations

1508:The default width is 12n.
1536:The default width is 12n.
1608:The default width is 12n.
1639:The default width is 12n.
1658:The default width is 10n.
1684:The default width is 12n.
1716:The default width is 17n.
1737:The default width is 15n.
1786:The default width is 12n.
1972:are 12n and 16n,
2004:The default width is 12n.
2087:The default width is 12n.
2287:The default width is 16n.
2346:The default width is 10n.
2420:are 14n and 10n, respectively.
2449:The default width is 32n.
2618:The default width is 12n.
2652:The default width is 10n.
2814:The default width is 10n.
2894:have a default width value of 12n.
2914:The default width value is 12n for both macros.
2940:The default width is 16n.
2952:The default width is 12n.
3039:-compact -offset 15n
3055:The default width is 12n.
3108:The default width is 16n.
3130:The default width is 6n.
3151:The default width is 6n.
3270:The default width is 10n.
3394:The default width is 8n.
3640:The default width is 8n.
3954:The indentation value is normally set to\~6n or about two thirds of an inch
4607:a default indent value (normally set to\~6n,
4687:Its default width is 6n.
4712:Its default width is 12n.
4742:Its default width is 6n.
4755:Its default width is 6n.
4767:Its default width is 6n.
4800:Its default width is 8n.
4819:Its default width is 8n.
5051:The default is \-0.5i.
5093:The default paragraph indentation is 7.2n on typesetters and 7n on
5096:The default subsection heading indentation amount is 3n;
5110:both registers default to 78n for terminal devices and 6.5i otherwise.
5122:To change the document font size to 11p or 12p,

#####


Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

1132:7th, 7, III, 3, V, V.2, V.3, V.4
4841:.\" 2nd and 3rd columns; we had to steal a character cell from each (the

#####

Input file is ./tmac/groff_me.7.man

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

484:.\" 'When I started writing the -me macros it began as something in my
490:.\" finally consented to "-meric" (which I always hated), since it was
492:.\" Berkeley it got shortened to "-me", much to my relief.
494:.\" Of course, if AT&T had been willing to let Berkeley have -ms then
495:.\" most likely -me would never have happened at all.  Without a macro
496:.\" package, nroff/troff is basically unusable; -me stepped into the

#####

Input file is ./tmac/groff_ms.7.man

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

874:.\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper...
1926:.\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper...

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

1038:.I post,
1072:.BR .B ,
1084:.BR .B ,
1092:.BR .B ,
1103:.BR .B ,
1141:.I post,
1587:.I marker,

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

1125:.BI \[rs] space\c
2721:.IB \%module * name\c
2726:.IB \%module @ name\c
2731:.IB \%environment : name\c
2743:.IB \%array ! index\c

#####


Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

1096:.\" possibly 9th, but definitely not Berkeley
1107:.\" possibly 9th, but definitely not Berkeley
2311:Tenth Edition \" possibly 9th
2600:.BR UX ). \" Unix; on 1st use, add footnote identifying trademark owner

#####

Input file is ./tmac/groff_trace.7.man

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

216:.RB $\~ "cat <<EOF | groff -ms > /dev/null"

#####

Input file is ./tmac/groff_man.7.man.in

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

569:.RB "].\|.\|.\& \e\- "\c
674:.\" Also see subsection "History" below...
1198:.\" end-of-sentence detection, and a newline...
2532:.\" end-of-sentence detection is performed, and...
3191:.\" rules (\[br]) as margin characters, as well as...
3222:.\" .5v after, as well as...
3228:.\" <https://lists.gnu.org/archive/html/groff/2019-07/msg00038.html>...
3745:To get a \(lqliteral\(rq.\|.\|. .\|.\|.should be input.
3793:Instead of.\|.\|. .\|.\|.should be considered.
3806:\fR.\|.\|. \fIparagraph
3807:\fR.\|.\|. .RE
3985:Instead of.\|.\|. .\|.\|.should be considered.
4040:Instead of.\|.\|. .\|.\|.do this.

#####


Use the correct macro for the font change of a single argument or
split the argument into two.

569:.RB "].\|.\|.\& \e\- "\c

#####


Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes the "\/" part,
which is in the macro.
So "\/" must be added to the argument before the "\c" string.

  Or

add the italic corrections.
[1] man-pages(7)

3797:\&.BI \(dq\(dq \fIitalic-text bold-text .IB \fIitalic-text bold-text
3805:\fIparagraph .P
3806:\fR.\|.\|. \fIparagraph
3988:\fIparagraph \fIparagraph
3990:\fIanother-paragraph \fIanother-paragraph

#####


Find a repeated word

! 2141 --> is

#####


The name of a manual page is set in bold and the section in roman (see
man-pages(7).

3:material that differs between groff_man(7) and groff_man_style(7) as

#####


Add a zero (0) in front of a decimal fraction that begins with a period
(.)

3222:.\" .5v after, as well as...

#####


Split a punctuation from a single argument, if a two-fonts macro is meant

235:.I break.
413:.I section.
458:.I section,
468:.I header-middle;
528:.I heading-text.
601:.I subheading-text.
701:.I indentation,
722:.I level.
809:.I indentation,
1387:.I trailing-text.
1442:.I trailing-text.
3284:.I adjustment-mode,
3368:.I footer-distance;
3500:.I subsection-indentation.

#####


An italic correction (\/) is missing in front of "\c",
as the correction in the macro will be removed by "\c".

399:.BI .TH " topic section"\c
568:.BI , " another-topic"\c
1320:.BI .MR "\~topic manual-section"\c
1762:.BI .BI " bold-text italic-text "\c
1780:.BI .BR " bold-text roman-text "\c
1800:.BI .IB " italic-text bold-text "\c
1820:.BI .IR " italic-text roman-text "\c
1841:.BI .RB " roman-text bold-text "\c
1863:.BI .RI " roman-text italic-text "\c

#####


Use a word (or exponential notation) instead of a number plus suffix for ordinal numbers

2946:7th edition
3115:4th Berkeley Distribution

#####


Bjarni Ingi Gislason <bjarniig>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Posted a comment)
  • -email is unavailable- added by barx (mom maintainer)
  • -email is unavailable- added by barx (Posted a comment)
  • -email is unavailable- added by bjarniig (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2023-08-09 gbranden Summarymanpages: improve some wording and typesetting man pages: improve some wording and typesetting
    2023-02-15 gbranden Item GroupDocumentation Lint
    2023-02-15 barx Item GroupLint Documentation
    2023-01-09 barx Severity3 - Normal 2 - Minor
    2023-01-09 barx Carbon-Copy- Added ptpi

    Back to the top

    Powered by Savane 3.13-758e.
    Corresponding source code