[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 05/07: groff_mdoc(7): Make style fixes.
|
From: |
G. Branden Robinson |
|
Subject: |
[groff] 05/07: groff_mdoc(7): Make style fixes. |
|
Date: |
Sun, 20 Dec 2020 03:38:55 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 11676f034f8cb186b191560d5cf18f990859ba30
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Dec 20 15:09:24 2020 +1100
groff_mdoc(7): Make style fixes.
* Improve man page cross references.
+ Use ./configured prefix for pages that bear them.
+ Use ./configured manual section suffixes.
+ Don't include the section suffix again in repeated cross references.
* Consistently set "troff" and "nroff" as cross references.
* Use one empty request between sentences.
* Use two empty requests where vertical space is expected (between
paragraphs, sections, and subsections).
* Break input lines after commas.
* Break input lines around multi-word parentheticals.
* Use comma after Latin abbreviation "i.e.".
* Use the Oxford comma.
* Refer to macro packages without using a leading hyphen. Tastes
differ, but I find the practice superfluous and mildly uncouth.
* Use an em dash glyph as an em dash, not an en dash. (Also, AT&T troff
supported \(em but not \(en, so \(en lacks even an offsetting virtue
of greater portability.) Also remove spaces around the em dash.
* Make miscellaneous style fixes to wording.
* Wrap updated lines at 72 characters.
---
tmac/groff_mdoc.7.man | 984 +++++++++++++++++++++++++++++++++++++-------------
1 file changed, 737 insertions(+), 247 deletions(-)
diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index dedc65a..0a631d4 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -68,25 +68,33 @@
A complete reference for writing
.Ux
manual pages with the
-.Nm \-mdoc
-macro package; a
+.Nm mdoc
+macro package;
+a
.Em content Ns -based
and
.Em domain Ns -based
formatting package for
.Tn GNU
-.Xr troff 1 .
-Its predecessor, the
-.Xr \-man 7
-package, addressed page layout leaving the manipulation of fonts and other
+.Xr @g@troff @MAN1EXT@ .
+.
+Its predecessor,
+the
+.Xr man 7
+package,
+addressed page layout leaving the manipulation of fonts and other
typesetting details to the individual author.
+.
In
-.Nm \-mdoc ,
+.Nm mdoc ,
page layout macros make up the
.Em "page structure domain"
-which consists of macros for titles, section headers, displays and lists
-\(en essentially items which affect the physical position of text on a
-formatted page.
+which consists of macros for titles,
+section headers,
+displays,
+and lists\[em]essentially items which affect the physical position of
+text on a formatted page.
+.
In addition to the page structure domain, there are two more domains, the
.Em manual
domain and the
@@ -105,11 +113,14 @@ These domain items have value for both the author and the
future user of the
manual page.
Hopefully, the consistency gained across the manual set will provide easier
translation to future documentation tools.
+.
+.
.Pp
Throughout the
.Ux
-manual pages, a manual entry is simply referred to as a man page, regardless
-of actual length and without sexist intention.
+manual pages,
+a manual entry is simply referred to as a man page,
+regardless of actual length and without sexist intention.
.
.
.Sh "Getting started"
@@ -245,24 +256,29 @@ as follows:
.Sh "troff idiosyncrasies"
.
The
-.Nm \-mdoc
+.Nm mdoc
package attempts to simplify the process of writing a man page.
-Theoretically, one should not have to learn the tricky details of
+.
+Theoretically,
+one should not have to learn the tricky details of
.Tn GNU
-.Xr troff 1
+.Xr @g@troff @MAN1EXT@
to use
-.Nm \-mdoc ;
-however, there are a few limitations which are unavoidable and best gotten
-out of the way.
+.Nm mdoc ;
+however,
+there are a few limitations which are unavoidable and best gotten out of
+the way.
+.
And, too, be forewarned, this package is
.Em not
fast.
.
+.
.Ss "Macro Usage"
.
As in
.Tn GNU
-.Xr troff 1 ,
+.Xr @g@troff ,
a macro is called by placing a
.Ql .\&
(dot character) at the beginning of a line followed by the two-character
@@ -273,7 +289,7 @@ Arguments may follow the macro separated by spaces (but
tabs).
It is the dot character at the beginning of the line which causes
.Tn GNU
-.Xr troff 1
+.Xr @g@troff
to interpret the next two (or more) characters as a macro name.
A single starting dot followed by nothing is ignored.
To place a
@@ -285,12 +301,16 @@ a macro invocation, precede the
.Ql \e&
escape sequence which causes a non-printing input break, and is never
displayed in the output.
+.
+.
.Pp
In general,
.Tn GNU
-.Xr troff 1
-macros accept an unlimited number of arguments (contrary to other versions
-of troff which can't handle more than nine arguments).
+.Xr @g@troff
+macros accept an unlimited number of arguments
+(contrary to other versions of
+.Xr troff
+which can't handle more than nine arguments).
In limited cases, arguments may be continued or extended on the next
line (See
.Sx Extended Arguments
@@ -298,9 +318,11 @@ below).
Almost all macros handle quoted arguments (see
.Sx Passing Space Characters in an Argument
below).
+.
+.
.Pp
Most of the
-.Nm \-mdoc
+.Nm mdoc
general text domain and manual domain macros are special in that their
argument lists are
.Em parsed
@@ -328,9 +350,10 @@ is produced by
.Ql ".Op Fl s Ar bytes"
.El
.
+.
.Pp
-To prevent a string from being interpreted as a macro name, precede the
-string with the escape sequence
+To prevent a string from being interpreted as a macro name,
+precede the string with the escape sequence
.Ql \e& :
.
.Bl -tag -width ".Op \&Fl s \&Ar bytes" -offset indent
@@ -339,6 +362,7 @@ is produced by
.Ql ".Op \e&Fl s \e&Ar bytes"
.El
.
+.
.Pp
Here the strings
.Ql \&Fl
@@ -354,59 +378,88 @@ throughout this document.
This is a technical
.Em faux pas
as almost all of the macros in
-.Nm \-mdoc
+.Nm mdoc
are parsed, but as it was cumbersome to constantly refer to macros as
being callable and being able to call other macros, the term parsed
has been used.
.
+.
.Pp
-In the following, we call an
-.Nm \-mdoc
-macro which starts a line (with a leading dot) a
+In the following,
+we call an
+.Nm mdoc
+macro which starts a line
+(with a leading dot)
+a
.Em command
if this distinction is necessary.
.
+.
.Ss "Passing Space Characters in an Argument"
.
-Sometimes it is desirable to give as an argument a string containing one or
-more blank space characters, say, to specify arguments to commands which
-expect particular arrangement of items in the argument list.
-Additionally, it makes
-.Nm \-mdoc
-working faster.
-For example, the function command
+Sometimes it is desirable to give as an argument a string containing one
+or more blank space characters,
+say,
+to specify arguments to commands which expect particular arrangement of
+items in the argument list.
+.
+Additionally,
+it makes
+.Nm mdoc
+work faster.
+.
+For example,
+the function command
.Ql .Fn
-expects the first argument to be the name of a function and any remaining
-arguments to be function parameters.
+expects the first argument to be the name of a function and any
+remaining arguments to be function parameters.
+.
As
.Tn ANSI\~C
stipulates the declaration of function parameters in the parenthesized
-parameter list, each parameter is guaranteed to be at minimum a two word
-string.
+parameter list,
+each parameter is guaranteed to be at minimum a two word string.
+.
For example,
.Fa int foo .
+.
+.
.Pp
-There are two possible ways to pass an argument which contains
-an embedded space.
-One way of passing a string containing blank spaces is to use the hard or
-unpaddable space character
+There are two possible ways to pass an argument which contains an
+embedded space.
+.
+One way of passing a string containing blank spaces is to use the hard
+or unpaddable space character
.Ql \e\ ,
-that is, a blank space preceded by the escape character
+that is,
+a blank space preceded by the escape character
.Ql \e .
+.
This method may be used with any macro but has the side effect of
interfering with the adjustment of text over the length of a line.
-.Xr Troff
-sees the hard space as if it were any other printable character and cannot
-split the string into blank or newline separated pieces as one would expect.
-This method is useful for strings which are not expected to overlap a line
-boundary.
+.
+.Xr @g@troff
+sees the hard space as if it were any other printable character and
+cannot split the string into blank or newline separated pieces as one
+would expect.
+.
+This method is useful for strings which are not expected to overlap a
+line boundary.
+.
An alternative is to use
.Ql \e\[ti] ,
-a paddable (i.e.\& stretchable), unbreakable space (this is a
+a paddable
+(i.e.,
+stretchable),
+unbreakable space
+(this is a
.Tn GNU
-.Xr troff 1
+.Xr @g@troff
extension).
+.
The second method is to enclose the string with double quotes.
+.
+.
.Pp
For example:
.
@@ -419,6 +472,7 @@ can also be created by
.Ql ".Fn fetch \[dq]char *str\[dq]"
.El
.
+.
.Pp
If the
.Ql \e
@@ -426,19 +480,27 @@ before the space in the first example
or double quotes in the second example
were omitted,
.Ql .Fn
-would see three arguments, and the result would be:
+would see three arguments,
+and the result would be:
+.
+.
.Pp
.Dl Fn fetch char *str
+.
+.
.Pp
-.\" For an example of what happens when the parameter list overlaps a newline
-.\" boundary, see the
+.\" For an example of what happens when the parameter list overlaps a
+.\" newline boundary,
+.\" see the
.\" .Sx Bugs
.\" section.
.
+.
.Ss "Trailing Blank Space Characters"
.
-.Xr Troff
+.Xr @g@troff
can be confused by blank space characters at the end of a line.
+.
It is a wise preventive measure to globally remove all blank spaces
from
.Ao blank-space Ac Ns Ao end-of-line Ac
@@ -450,6 +512,7 @@ escape character.
For example,
.Ql string\e\ \e& .
.
+.
.Ss "Escaping Special Characters"
.
Special characters like the newline character
@@ -462,16 +525,22 @@ with
.Ql \een )
to preserve the backslash.
.
+.
.Ss "Other Possible Pitfalls"
.
-A warning is emitted when an empty input line is found outside of displays
+A warning is emitted when an empty input line is found outside of
+displays
(see below).
+.
Use
.Ql .sp
instead.
-(Well, it is even better to use
-.Nm \-mdoc
+.
+(It is even better to use
+.Nm mdoc
macros to avoid the usage of low-level commands.)
+.
+.
.Pp
Leading spaces will cause a break and are output directly.
Avoid this behaviour if possible.
@@ -479,6 +548,8 @@ Similarly, do not use more than one space character between
words in an
ordinary text line; contrary to other text formatters, they are
.Em not
replaced with a single space.
+.
+.
.Pp
You can't pass
.Ql \[dq]
@@ -491,14 +562,18 @@ instead.
.
.Pp
By default,
-.Xr troff 1
-inserts two space characters after a punctuation mark closing a sentence;
+.Xr @g@troff
+inserts two space characters after a punctuation mark ending a
+sentence;
characters like
.Ql \&)
or
.Ql \&'
-are treated transparently, not influencing the sentence-ending behaviour.
-To change this, insert
+are treated transparently,
+not influencing the sentence-ending behaviour.
+.
+To change this,
+insert
.Ql \e&
before or after the dot:
.
@@ -517,29 +592,37 @@ test
\&.No test.
test
.Ed
-.Pp
.
+.
+.Pp
gives
.
.Bd -filled -offset indent
The
.Ql .
character
+.
+.
.Pp
The
.Ql \&.
character.
+.
+.
.Pp
.No test .
test
+.
+.
.Pp
.No test.
test
.Ed
-.Pp
.
+.
+.Pp
As can be seen in the first and third line,
-.Nm \-mdoc
+.Nm mdoc
handles punctuation characters specially in macro arguments.
This will be explained in section
.Sx General Syntax
@@ -547,6 +630,8 @@ below.
In the same way, you have to protect trailing full stops of
abbreviations with a trailing non-printing input break:
.Ql e.g.\e& .
+.
+.
.Pp
A comment in the source file of a man page can be either started with
.Ql .\e"
@@ -554,10 +639,12 @@ on a single line,
.Ql \e"
after some input, or
.Ql \e#
-anywhere (the latter is a
+anywhere
+(the last is a
.Tn GNU
-.Xr troff 1
-extension); the rest of such a line is ignored.
+.Xr @g@troff
+extension);
+the rest of such a line is ignored.
.
.
.Sh "A manual page template"
@@ -603,8 +690,9 @@ The body of a man page is easily constructed from a basic
template:
\&.\e" .Sh Caveats
\&.\e" .Sh Bugs
.Ed
-.Pp
.
+.
+.Pp
The first items in the template are the commands
.Ql .Dd ,
.Ql .Dt ,
@@ -650,6 +738,8 @@ If there are alternative values for a mandatory parameter,
braces are used
.Ql | )
to enclose the value set.
Meta-variables are specified within angles.
+.
+.
.Pp
Example:
.
@@ -662,8 +752,10 @@ Example:
.Xc
.El
.
+.
.Pp
-Except stated explicitly, all macros are parsed and callable.
+Except where explicitly stated,
+all macros are parsed and callable.
.
.
.Pp
@@ -699,7 +791,7 @@ and
macros.
It is recommended not to use this rather obscure feature to avoid
dependencies on local modifications of the
-.Nm \-mdoc
+.Nm mdoc
package.
.
.
@@ -733,9 +825,12 @@ or
If it is specified, and no volume name is given, a default volume name is
used.
.
+.
.Pp
In this implementation,
the following sections are defined:
+.
+.
.Pp
.TS
l l l.
@@ -749,10 +844,12 @@ l l l.
8 \*[doc-volume-operating-system] \*[doc-volume-ds-8]
9 \*[doc-volume-operating-system] \*[doc-volume-ds-9]
.TE
-.Pp
.
+.
+.Pp
A volume name may be arbitrary or one of the following:
.
+.
.Pp
.TS
l l.
@@ -767,8 +864,9 @@ IND \*[doc-volume-ds-IND]
LOCAL \*[doc-volume-ds-LOCAL]
CON \*[doc-volume-ds-CON]
.TE
-.Pp
.
+.
+.Pp
For compatibility,
.Ql MMI
can be used for
@@ -798,14 +896,21 @@ By default, the following architecture keywords are
defined:
.No socppc , solbourne , sparc , sparc64 , sun2 , sun3 ,
.No tahoe , vax , x68k , x86_64 , xen , zaurus
.Ed
+.
+.
.Pp
+If the section number is neither a numeric expression in the range 1
+to\~9
+nor one of the above described keywords,
+the third parameter is used verbatim as the volume name.
+.
.
-If the section number is neither a numeric expression in the range 1 to\~9
-nor one of the above described keywords, the third parameter is used
-verbatim as the volume name.
.Pp
-In the following examples, the left (which is identical to the right) and
-the middle part of the manual page header strings are shown.
+In the following examples,
+the left
+(which is identical to the right)
+and the middle part of the manual page header strings are shown.
+.
Note how
.Ql \e&
prevents the digit\~7 from being a valid numeric expression.
@@ -829,9 +934,11 @@ prevents the digit\~7 from being a valid numeric
expression.
.Ql bar
.El
.Ed
-.Pp
.
-Local, OS-specific additions might be found in the file
+.
+.Pp
+Local,
+OS-specific additions might be found in the file
.Pa mdoc.local ;
look for strings named
.Ql volume\-ds\-XXX
@@ -942,32 +1049,47 @@ the release ID.
18.2.0, 18.3.0, 18.4.0, 18.5.0, 18.6.0, 18.7.0, 19.0.0, 19.1.0, 19.2.0
.El
.Ed
-.Pp
.
+.
+.Pp
For
.Tn ATT ,
an unknown second parameter will be replaced with the string
.Tn UNIX ;
-for the other predefined acronyms it will be ignored and a warning message
-emitted.
+for the other predefined acronyms it will be ignored and a warning
+message emitted.
+.
Unrecognized arguments are displayed as given in the page footer.
-For instance, a typical footer might be:
+For instance,
+a typical footer might be:
+.
+.
.Pp
.Dl .Os BSD 4.3
+.
+.
.Pp
giving
.Ql 4.3\~Berkeley Distribution ,
or for a locally produced set
+.
+.
.Pp
.Dl .Os CS Department
+.
+.
.Pp
which will produce
.Ql CS\~Department .
+.
+.
.Pp
If the
.Ql .Os
-macro is not present, the bottom left corner of the manual page will be
-ugly.
+macro is not present,
+the bottom left corner of the manual page will be ugly.
+.
+.
.Pp
This macro is neither callable nor parsed.
.
@@ -977,23 +1099,33 @@ This macro is neither callable nor parsed.
.Aq year
.Xc
The document date for display in the page footer.
+.
This is the mandatory first macro of any
-.Nm \-mdoc
+.Nm mdoc
manual.
The
.Aq Month
-is the full English month name, the
+is the full English month name,
+the
.Aq day
-is an integer number without a leading zero, and the
+is an integer number without a leading zero,
+and the
.Aq year
-is the full four-digit year, for example:
+is the full four-digit year,
+for example:
+.
+.
.Pp
.Dl .Dd January 25, 2001
.Pp
-The arguments are concatenated, separated with space characters,
+The arguments are concatenated,
+separated with space characters,
even if they do not match the recommended format.
+.
+.
.Pp
-As a special exception, the format
+As a special exception,
+the format
.Bd -filled -offset indent
.Li .Dd $Mdocdate:
.Aq Month
@@ -1001,11 +1133,16 @@ As a special exception, the format
.Aq year
.Li $
.Ed
+.
+.
.Pp
is also recognized.
+.
It is used in
.Ox
manuals to automatically insert the current date when committing.
+.
+.
.Pp
This macro is neither callable nor parsed.
.El
@@ -1013,6 +1150,7 @@ This macro is neither callable nor parsed.
.
.Sh "Introduction of manual and general text domains"
.
+.
.Ss "What's in a Name" Ns ...
.
The manual domain macro names are derived from the day to day informal
@@ -1020,24 +1158,30 @@ language used to describe commands, subroutines and
related files.
Slightly different variations of this language are used to describe the
three different aspects of writing a man page.
First, there is the description of
-.Nm \-mdoc
+.Nm mdoc
macro command usage.
Second is the description of a
.Ux
command
.Em with
-.Nm \-mdoc
+.Nm mdoc
macros, and third, the description of a command to a user in the verbal
sense; that is, discussion of a command in the text of a man page.
+.
+.
.Pp
In the first case,
-.Xr troff 1
-macros are themselves a type of command; the general syntax for a troff
+.Xr @g@troff
+macros are themselves a type of command;
+the general syntax for a
+.Xr troff
command is:
.
.Bd -filled -offset indent
.Li ".Xx argument1 argument2" ...
.Ed
+.
+.
.Pp
.
.Ql .Xx
@@ -1054,8 +1198,9 @@ command line might be displayed as:
.Op Fl flag
.Ao Ar infile Ac Ao Ar outfile Ac
.Ed
-.Pp
.
+.
+.Pp
Here,
.Nm filter
is the command name and the
@@ -1065,7 +1210,7 @@ is a
.Em flag
argument designated as optional by the option brackets.
In
-.Nm \-mdoc
+.Nm mdoc
terms,
.Ao Ar infile Ac
and
@@ -1075,7 +1220,7 @@ are called
in this example, the user has to replace the meta expressions given in angle
brackets with real file names.
Note that in this document meta arguments are used to describe
-.Nm \-mdoc
+.Nm mdoc
commands; in most man pages, meta variables are not specifically written
with angle brackets.
The macros which formatted the above example:
@@ -1085,10 +1230,13 @@ The macros which formatted the above example:
\&.Op Fl flag
\&.Ao Ar infile Ac Ao Ar outfile Ac
.Ed
+.
+.
.Pp
+In the third case,
+discussion of commands and command syntax includes both examples above,
+but may add more detail.
.
-In the third case, discussion of commands and command syntax includes both
-examples above, but may add more detail.
The arguments
.Ao Ar infile Ac
and
@@ -1097,6 +1245,7 @@ from the example above might be referred to as
.Em operands
or
.Em file arguments .
+.
Some command-line argument lists are quite long:
.
.Bd -ragged
@@ -1114,8 +1263,9 @@ Some command-line argument lists are quite long:
.Ek
.El
.Ed
-.Pp
.
+.
+.Pp
Here one might talk about the command
.Nm make
and qualify the argument,
@@ -1125,7 +1275,7 @@ as an argument to the flag,
or discuss the optional file operand
.Ar target .
In the verbal context, such detail can prevent confusion, however the
-.Nm \-mdoc
+.Nm mdoc
package does not have a macro for an argument
.Em to
a flag.
@@ -1150,8 +1300,9 @@ The make command line was produced from:
\&.Op Ar target ...
\&.Ek
.Ed
-.Pp
.
+.
+.Pp
The
.Ql .Bk
and
@@ -1159,10 +1310,12 @@ and
macros are explained in
.Sx Keeps .
.
+.
.Ss "General Syntax"
.
-The manual domain and general text domain macros share a similar syntax with
-a few minor deviations; most notably,
+The manual domain and general text domain macros share a similar syntax
+with a few minor deviations;
+most notably,
.Ql .Ar ,
.Ql .Fl ,
.Ql .Nm ,
@@ -1173,68 +1326,104 @@ differ only when called without arguments; and
and
.Ql .Xr
impose an order on their argument lists.
+.
All content macros are capable of recognizing and properly handling
-punctuation, provided each punctuation character is separated by a leading
-space.
+punctuation,
+provided each punctuation character is separated by a leading space.
+.
If a command is given:
+.
+.
.Pp
.Dl \&.Ar sptr, ptr),
+.
+.
.Pp
The result is:
+.
+.
.Pp
.Dl Ar sptr, ptr),
+.
+.
.Pp
The punctuation is not recognized and all is output in the
font used by
.Ql .Ar .
If the punctuation is separated by a leading white space:
+.
+.
.Pp
.Dl \&.Ar "sptr , ptr ) ,"
+.
+.
.Pp
The result is:
+.
+.
.Pp
.Dl Ar sptr , ptr ) ,
+.
+.
.Pp
The punctuation is now recognized and output in the default font
distinguishing it from the argument strings.
-To remove the special meaning from a punctuation character escape it with
+.
+To remove the special meaning from a punctuation character,
+escape it with
.Ql \e& .
+.
+.
.Pp
The following punctuation characters are recognized by
-.Nm \-mdoc :
+.Nm mdoc :
.
.Bl -column -offset indent-two XXXXXX XXXXXX XXXXXX XXXXXX
.It Li .\& Ta Li ,\& Ta Li :\& Ta Li ;\& Ta Li (\&
.It Li )\& Ta Li [\& Ta Li ]\& Ta Li ?\& Ta Li !\&
.El
+.
+.
.Pp
.
-.Xr Troff
-is limited as a macro language, and has difficulty when presented with a
-string containing a member of the mathematical, logical or quotation set:
+.Xr troff
+is limited as a macro language,
+and has difficulty when presented with a string containing certain
+mathematical,
+logical,
+or quotation character sequences:
.
.Bd -literal -offset indent-two
{+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
.Ed
-.Pp
.
+.
+.Pp
The problem is that
.Xr troff
-may assume it is supposed to actually perform the operation or evaluation
-suggested by the characters.
-To prevent the accidental evaluation of these characters, escape them with
+may assume it is supposed to actually perform the operation or
+evaluation suggested by the characters.
+.
+To prevent the accidental evaluation of these characters,
+escape them with
.Ql \e& .
+.
Typical syntax is shown in the first content macro displayed below,
.Ql .Ad .
.
.
.Sh "Manual domain"
.
+.
.Ss Addresses
.
The address macro identifies an address construct.
+.
+.
.Pp
.Dl Usage: .Ad Ao address Ac ...
+.
+.
.Pp
.Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n
.It Li ".Ad addr1"
@@ -1248,8 +1437,9 @@ The address macro identifies an address construct.
.It Li ".Ad addr ) ) ,"
.Ad addr ) ) ,
.El
-.Pp
.
+.
+.Pp
The default width is 12n.
.
.Ss "Author Name"
@@ -1258,8 +1448,12 @@ The
.Ql .An
macro is used to specify the name of the author of the item being
documented, or the name of the author of the actual manual page.
+.
+.
.Pp
.Dl Usage: .An Ao author name Ac ...
+.
+.
.Pp
.Bl -tag -width ".Li .An\ \[dq]Joe\ Author\[dq]\ )\ )\ ," -offset 15n
.It Li ".An \[dq]Joe Author\[dq]"
@@ -1271,9 +1465,12 @@ documented, or the name of the author of the actual
manual page.
.It Li ".An \[dq]Joe Author\[dq] ) ) ,"
.An "Joe Author" ) ) ,
.El
-.Pp
.
+.
+.Pp
The default width is 12n.
+.
+.
.Pp
In the
.Em Authors
@@ -1286,6 +1483,8 @@ If this is not desirable,
.Bd -literal -offset indent
\&.An \-nosplit
.Ed
+.
+.
.Pp
.
call will turn this off.
@@ -1295,6 +1494,7 @@ To turn splitting back on, write
\&.An \-split
.Ed
.
+.
.Ss "Arguments"
.
The
@@ -1303,8 +1503,12 @@ argument macro may be used whenever an argument is
referenced.
If called without arguments, the
.Sq Ar
string is output.
+.
+.
.Pp
.Dl Usage: .Ar Oo Ao argument Ac Oc ...
+.
+.
.Pp
.Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n
.It Li .Ar
@@ -1320,10 +1524,13 @@ string is output.
.It Li ".Ar file ) ) ,"
.Ar file ) ) ,
.El
+.
+.
.Pp
.
The default width is 12n.
.
+.
.Ss "Configuration Declaration (Section Four Only)"
.
The
@@ -1331,23 +1538,32 @@ The
macro is used to demonstrate a
.Xr config 8
declaration for a device interface in a section four manual.
+.
+.
.Pp
.Dl Usage: .Cd Ao argument Ac ...
+.
+.
.Pp
.Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n
.It Li ".Cd \[dq]device le0 at scode?\[dq]"
.Cd "device le0 at scode?"
.El
+.
+.
.Pp
In the
.Sx Synopsis
section a
.Ql .Cd
command causes a line break before and after its arguments are printed.
+.
+.
.Pp
.
The default width is 12n.
.
+.
.Ss "Command Modifiers"
.
The command modifier is identical to the
@@ -1361,16 +1577,24 @@ Command modifiers may also be specified in conjunction
with interactive
commands such as editor commands.
See
.Sx Flags .
+.
+.
.Pp
The default width is 10n.
.
+.
.Ss "Defined Variables"
.
-A variable (or constant) which is defined in an include file
-is specified by the macro
+A variable
+(or constant)
+which is defined in an include file is specified by the macro
.Ql .Dv .
+.
+.
.Pp
-.Dl Usage: .Dv Ao defined variable Ac ...
+.Dl Usage: .Dv Ao defined-variable Ac ...
+.
+.
.Pp
.Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n
.It Li ".Dv MAXHOSTNAMELEN"
@@ -1378,21 +1602,29 @@ is specified by the macro
.It Li ".Dv TIOCGPGRP )"
.Dv TIOCGPGRP )
.El
+.
+.
.Pp
.
The default width is 12n.
.
+.
.Ss Errnos
.
The
.Ql .Er
-errno macro specifies the error return value for section 2, 3, and\~9 library
-routines.
+errno macro specifies the error return value for section 2,
+3,
+and\~9 library routines.
+.
The second example below shows
.Ql .Er
used with the
.Ql .Bq
-general text domain macro, as it would be used in a section two manual page.
+general text domain macro,
+as it would be used in a section two manual page.
+.
+.
.Pp
.Dl Usage: .Er Ao errno type Ac ...
.Pp
@@ -1408,6 +1640,7 @@ general text domain macro, as it would be used in a
section two manual page.
.
The default width is 17n.
.
+.
.Ss "Environment Variables"
.
The
@@ -1428,6 +1661,7 @@ macro specifies an environment variable.
.
The default width is 15n.
.
+.
.Ss Flags
.
The
@@ -1471,6 +1705,7 @@ a single dash will result in two dashes.
.Pp
The default width is 12n.
.
+.
.Ss "Function Declarations"
.
The
@@ -1522,6 +1757,7 @@ section, it represents the header file enclosed in angle
brackets.
.In stdio.h
.El
.
+.
.Ss "Function Types"
.
This macro is intended for the
@@ -1540,6 +1776,7 @@ name to appear on the next line).
.Ft struct stat
.El
.
+.
.Ss "Functions (Library Routines)"
.
The
@@ -1624,6 +1861,7 @@ and
.Ql .Fo
are 12n and 16n, respectively.
.
+.
.Ss "Function Arguments"
.
The
@@ -1654,6 +1892,7 @@ may also be used to refer to structure members.
.
The default width is 12n.
.
+.
.Ss "Return Values"
.
The
@@ -1684,6 +1923,7 @@ Currently, this macro does nothing if used without the
.Fl std
flag.
.
+.
.Ss "Exit Status"
.
The
@@ -1714,6 +1954,7 @@ Currently, this macro does nothing if used without the
.Fl std
flag.
.
+.
.Ss "Interactive Commands"
.
The
@@ -1734,6 +1975,7 @@ macro designates an interactive or internal command.
.
The default width is 12n.
.
+.
.Ss "Library Names"
.
The
@@ -1908,6 +2150,7 @@ section an
command causes a line break before and after its arguments are printed.
.Pp
.
+.
.Ss Literals
.
The
@@ -1931,6 +2174,7 @@ literal macro may be used for special characters,
variable constants, etc.\&
.
The default width is 16n.
.
+.
.Ss Names
.
The
@@ -1986,6 +2230,7 @@ it can not recall the first argument it was invoked with.
.
The default width is 10n.
.
+.
.Ss Options
.
The
@@ -2055,6 +2300,7 @@ and
.Ql .Oo
are 14n and 10n, respectively.
.
+.
.Ss Pathnames
.
The
@@ -2078,6 +2324,7 @@ string is output, which represents the current user's
home directory.
.
The default width is 32n.
.
+.
.Ss Standards
.
The
@@ -2198,6 +2445,7 @@ Miscellaneous
.St -iso8802-3
.El
.
+.
.Ss "Variable Types"
.
The
@@ -2216,6 +2464,7 @@ section, it causes a line break (useful for old style
variable declarations).
.Vt FILE *
.El
.
+.
.Ss Variables
.
Generic variable reference.
@@ -2236,15 +2485,24 @@ Generic variable reference.
.
The default width is 12n.
.
+.
.Ss "Manual Page Cross References"
.
The
.Ql .Xr
macro expects the first argument to be a manual page name.
-The optional second argument, if a string (defining the manual section), is
+.
+The optional second argument,
+if a string
+(defining the manual section),
+is
put into parentheses.
+.
+.
.Pp
.Dl Usage: .Xr Ao man page name Ac Oo Ao section Ac Oc ...
+.
+.
.Pp
.Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n
.It Li ".Xr mdoc"
@@ -2256,13 +2514,15 @@ put into parentheses.
.It Li ".Xr xinit 1x ;"
.Xr xinit 1x ;
.El
-.Pp
.
+.
+.Pp
The default width is 10n.
.
.
.Sh "General text domain"
.
+.
.Ss "AT&T Macro"
.
.Pp
@@ -2281,6 +2541,7 @@ are possible:
.Pp
.Dl 32v, v1, v2, v3, v4, v5, v6, v7, III, V, V.1, V.2, V.3, V.4
.
+.
.Ss "BSD Macro"
.
.Pp
@@ -2305,6 +2566,7 @@ are possible:
.Pp
.Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
.
+.
.Ss "NetBSD Macro"
.
.Pp
@@ -2324,6 +2586,7 @@ see the description of the
command above in section
.Sx "Title macros" .
.
+.
.Ss "FreeBSD Macro"
.
.Pp
@@ -2343,6 +2606,7 @@ see the description of the
command above in section
.Sx "Title macros" .
.
+.
.Ss "DragonFly Macro"
.
.Pp
@@ -2362,6 +2626,7 @@ see the description of the
command above in section
.Sx "Title macros" .
.
+.
.Ss "OpenBSD Macro"
.
.Pp
@@ -2372,6 +2637,7 @@ command above in section
.Ox 1.0
.El
.
+.
.Ss "BSD/OS Macro"
.
.Pp
@@ -2382,6 +2648,7 @@ command above in section
.Bsx 1.0
.El
.
+.
.Ss "UNIX Macro"
.
.Pp
@@ -2392,6 +2659,7 @@ command above in section
.Ux
.El
.
+.
.Ss "Emphasis Macro"
.
Text may be stressed or emphasized with the
@@ -2413,6 +2681,7 @@ The usual font for emphasis is italic.
.
The default width is 10n.
.
+.
.Ss "Font Mode"
.
The
@@ -2447,6 +2716,7 @@ macro was used for the entire block of text.
.Pp
Both macros are neither callable nor parsed.
.
+.
.Ss "Enclosure and Quoting Macros"
.
The concept of enclosure is similar to quoting.
@@ -2491,30 +2761,48 @@ have a default width value of 12n.
.
.Bl -tag -width ".Li .Ec , .Eo"
.It Li .Eo , .Ec
-These macros expect the first argument to be the opening and closing strings
+These macros expect the first argument to be the opening and closing
+strings,
respectively.
+.
.It Li .Es , .En
-Due to the nine-argument limit in the original troff program two other
-macros have been implemented which are now rather obsolete:
+Due to the nine-argument limit in the original
+.Xr troff
+program two other macros have been implemented which are now rather
+obsolete:
.Ql .Es
-takes the first and second parameter as the left and right enclosure string,
+takes the first and second parameter as the left and right enclosure
+string,
which are then used to enclose the arguments of
.Ql .En .
+.
The default width value is 12n for both macros.
+.
.It Li .Eq
The first and second arguments of this macro are the opening and
closing strings respectively, followed by the arguments to be enclosed.
.It Li .Ql
-The quoted literal macro behaves differently in troff and nroff mode.
+The quoted literal macro behaves differently in
+.Xr troff
+and
+.Xr nroff
+mode.
If formatted with
-.Xr nroff ,
+.Xr @g@nroff @MAN1EXT@ ,
a quoted literal is always quoted.
-If formatted with troff, an item is only quoted if the width of the item is
-less than three constant width characters.
-This is to make short strings more visible where the font change to literal
-(constant width) is less noticeable.
+.
+If formatted with
+.Xr troff ,
+an item is only quoted if the width of the item is less than three
+constant-width characters.
+.
+This is to make short strings more visible where the font change to
+literal (constant-width) is less noticeable.
+.
+.
.Pp
The default width is 16n.
+.
.It Li .Pf
The prefix macro suppresses the whitespace between its first and second
argument:
@@ -2585,6 +2873,7 @@ and
.Ql .Xc
extended argument list macros are discussed below.
.
+.
.Ss "No-Op or Normal Text Macro"
.
The
@@ -2608,6 +2897,7 @@ if you really want that English word (and not the macro)
as a parameter.
.
The default width is 12n.
.
+.
.Ss "No-Space Macro"
.
The
@@ -2637,6 +2927,7 @@ line),
is identical to
.Ql .No .
.
+.
.Ss "Section Cross References"
.
The
@@ -2653,6 +2944,7 @@ macro designates a reference to a section header within
the same document.
.
The default width is 16n.
.
+.
.Ss Symbolics
.
The symbolic emphasis macro is generally a boldface macro in either the
@@ -2668,7 +2960,8 @@ symbolic sense or the traditional English usage.
.
The default width is 6n.
.
-.Ss Mathematical Symbols
+.
+.Ss "Mathematical Symbols"
.
Use this macro for mathematical symbols and similar things.
.Pp
@@ -2685,9 +2978,13 @@ The default width is 6n.
.Ss "References and Citations"
.
The following macros make a modest attempt to handle references.
-At best, the macros make it convenient to manually drop in a subset of
-.Xr refer 1
+.
+At best,
+the macros make it convenient to manually drop in a subset of
+.Xr @g@refer @MAN1EXT@
style references.
+.
+.
.Pp
.Bl -tag -width 6n -offset indent -compact
.It Li .Rs
@@ -2788,6 +3085,7 @@ Its intended use is to imitate a small caps fonts for
uppercase acronyms.
.
The default width is 10n.
.
+.
.Ss "Extended Arguments"
.
The
@@ -2886,6 +3184,7 @@ produces
.
.Sh "Page structure domain"
.
+.
.Ss "Section Headers"
.
The following
@@ -3061,21 +3360,28 @@ The
macro is used to specify an error (errno).
.
.It Li ".Sh See also"
-References to other material on the man page topic and cross references to
-other relevant man pages should be placed in the
+References to other material on the man page topic and cross references
+to other relevant man pages should be placed in the
.Sx "See also"
section.
+.
Cross references are specified using the
.Ql .Xr
macro.
+.
Currently
-.Xr refer 1
+.Xr @g@refer @MAN1EXT@
style references are not accommodated.
+.
+.
.Pp
-It is recommended that the cross references are sorted on the section
-number, then alphabetically on the names within a section, and placed
-in that order and comma separated.
+It is recommended that the cross references be sorted by section number,
+then alphabetically by name within each section,
+then separated by commas.
+.
Example:
+.
+.
.Pp
.Xr ls 1 ,
.Xr ps 1 ,
@@ -3083,14 +3389,16 @@ Example:
.Xr passwd 5
.
.It Li ".Sh Standards"
-If the command, library function or file adheres to a specific
-implementation such as
+If the command,
+library function,
+or file adheres to a specific implementation such as
.St -p1003.2
or
.St -ansiC
this should be noted here.
-If the command does not adhere to any standard, its history should be noted
-in the
+.
+If the command does not adhere to any standard,
+its history should be noted in the
.Em History
section.
.
@@ -3100,11 +3408,13 @@ outlined historically in this section.
.
.It Li ".Sh Authors"
Credits should be placed here.
+.
Use the
.Ql .An
macro for names and the
.Ql .Aq
-macro for e-mail addresses within optional contact information.
+macro for email addresses within optional contact information.
+.
Explicitly indicate whether the person authored the initial manual page
or the software or whatever the person is being credited for.
.It Li ".Sh Bugs"
@@ -3120,6 +3430,7 @@ sections may be added; for example, this section was set
with:
\&.Sh "Page structure domain"
.Ed
.
+.
.Ss "Subsection Headers"
.
Subsection headers have exactly the same syntax as section headers:
@@ -3132,6 +3443,7 @@ only; it then reactivates the default font for
.Pp
The default width is 8n.
.
+.
.Ss "Paragraphs and Line Spacing"
.
.Bl -tag -width ".Li .Pp"
@@ -3277,44 +3589,62 @@ alternative name is
.\" .De
.\" .Pp
.
+.
.Ss Keeps
.
The only keep that is implemented at this time is for words.
+.
The macros are
.Ql .Bk
(begin keep)
and
.Ql .Ek
(end keep).
+.
The only option that
.Ql .Bk
accepts currently is
.Fl words
-(this is also the default if no option is given) which is useful for
-preventing line breaks in the middle of options.
-In the example for the make command-line arguments (see
+(this is also the default if no option is given)
+which is useful for preventing line breaks in the middle of options.
+.
+In the example for the make command-line arguments
+(see
.Sx What's in a Name ) ,
-the keep prevented
-.Xr nroff
-from placing up the flag and the argument on separate lines.
+the keep prevents
+.Xr @g@nroff
+from placing the flag and the argument on separate lines.
+.
+.
.Pp
-Both macros are neither callable nor parsed.
+Neither macro is callable or parsed.
+.
+.
.Pp
-More work needs to be done with the keep macros; specifically, a
+More work needs to be done on the keep macros;
+specifically,
+a
.Fl line
option should be added.
.
+.
.Ss "Examples and Displays"
.
There are seven types of displays.
+.
+.
.Pp
.Bl -tag -width ".Li .D1"
.It Li .D1
(This is D-one.)
Display one line of indented text.
This macro is parsed but not callable.
+.
+.
.Pp
.D1 Fl ldghfstru
+.
+.
.Pp
The above was produced by:
.Li ".D1 Fl ldghfstru" .
@@ -3331,8 +3661,12 @@ It allows the indentation (display) of one line of text.
Its default font is set to constant width (literal).
.Ql .Dl
is parsed but not callable.
+.
+.
.Pp
.Dl % ls \-ldg /usr/local/bin
+.
+.
.Pp
The above was produced by:
.Li ".Dl % ls \e\-ldg /usr/local/bin" .
@@ -3345,6 +3679,8 @@ display must be ended with the
.Ql .Ed
macro.
It has the following syntax:
+.
+.
.Pp
.Bd -ragged -compact
.Bl -tag -width ".Li .Bd" -offset indent
@@ -3353,6 +3689,8 @@ It has the following syntax:
.Oo \-offset Ao string Ac Oc Oo \-file Ao file name Ac Oc Oo \-compact Oc Xc
.El
.Ed
+.
+.
.Pp
.
.Bl -tag -width ".Fl file Ao Ar file name Ac " -compact
@@ -3380,15 +3718,18 @@ flag is read and displayed before any data enclosed with
and
.Ql .Ed ,
using the selected display type.
+.
Any
-.Xr troff/ Ns Nm \-mdoc
+.Xr @g@troff/ Ns Nm mdoc
commands in the file will be processed.
+.
.It Fl offset Ao Ar string Ac
If
.Fl offset
is specified with one of the following strings, the string is interpreted to
indicate the level of indentation for the forthcoming block of text:
.
+.
.Pp
.Bl -tag -width ".Ar indent-two" -compact
.It Ar left
@@ -3414,10 +3755,11 @@ This
.Em left
aligns the block about two inches from the right side of the page.
This macro needs work and perhaps may never do the right thing within
-.Xr troff .
+.Xr @g@troff .
.El
-.Pp
.
+.
+.Pp
If
.Ao string Ac
is a valid numeric expression instead
@@ -3432,17 +3774,22 @@ specifying the so-called
.Em \&Em
and
.Em "En square" .
+.
This is approximately the width of the letters
.Sq m
and
.Sq n
respectively
-of the current font (for nroff output, both scale indicators give the same
-values).
+of the current font
+(for
+.Xr nroff
+output,
+both scale indicators give the same values).
+.
If
.Ao string Ac
isn't a numeric expression, it is tested whether it is an
-.Nm \-mdoc
+.Nm mdoc
macro name, and the default offset value associated with this macro is used.
Finally, if all tests fail,
the width of
@@ -3456,27 +3803,41 @@ Suppress insertion of vertical space before begin of
display.
End display (takes no arguments).
.El
.
+.
.Ss "Lists and Columns"
.
There are several types of lists which may be initiated with the
.Ql .Bl
begin-list macro.
+.
Items within the list are specified with the
.Ql .It
-item macro, and each list must end with the
+item macro,
+and each list must end with the
.Ql .El
macro.
+.
Lists may be nested within themselves and within displays.
-The use of columns inside of lists or lists inside of columns is unproven.
+.
+The use of columns inside of lists or lists inside of columns is
+untested.
+.
+.
.Pp
-In addition, several list attributes may be specified such as the width of a
-tag, the list offset, and compactness (blank lines between items allowed or
-disallowed).
+In addition,
+several list attributes may be specified such as the width of a tag,
+the list offset,
+and compactness
+(blank lines between items allowed or disallowed).
+.
Most of this document has been formatted with a tag style list
.Pf ( Fl tag ) .
+.
+.
.Pp
It has the following syntax forms:
.
+.
.Pp
.Bd -ragged -compact
.Bl -tag -width ".Li .Bl" -offset indent -compact
@@ -3492,10 +3853,12 @@ It has the following syntax forms:
.Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
.El
.Ed
-.Pp
.
+.
+.Pp
And now a detailed description of the list types.
.
+.
.Pp
.Bl -tag -width ".Fl column" -compact
.It Fl bullet
@@ -3509,10 +3872,12 @@ Bullet one goes here.
Bullet two here.
\&.El
.Ed
-.Pp
.
+.
+.Pp
Produces:
.
+.
.Pp
.Bl -bullet -offset indent -compact
.It
@@ -3520,6 +3885,8 @@ Bullet one goes here.
.It
Bullet two here.
.El
+.
+.
.Pp
.
.It Fl dash No ( or Fl hyphen )
@@ -3533,10 +3900,12 @@ Dash one goes here.
Dash two here.
\&.El
.Ed
-.Pp
.
+.
+.Pp
Produces:
.
+.
.Pp
.Bl -dash -offset indent -compact
.It
@@ -3544,8 +3913,9 @@ Dash one goes here.
.It
Dash two here.
.El
-.Pp
.
+.
+.Pp
.It Fl enum
An enumerated list.
.
@@ -3557,10 +3927,12 @@ Item one goes here.
And item two here.
\&.El
.Ed
-.Pp
.
+.
+.Pp
The result:
.
+.
.Pp
.Bl -enum -offset indent -compact
.It
@@ -3568,11 +3940,14 @@ Item one goes here.
.It
And item two here.
.El
-.Pp
.
-If you want to nest enumerated lists, use the
+.
+.Pp
+If you want to nest enumerated lists,
+use the
.Fl nested
-flag (starting with the second-level list):
+flag
+(starting with the second-level list):
.
.Bd -literal -offset indent
\&.Bl \-enum \-offset indent \-compact
@@ -3588,10 +3963,12 @@ And item three here.
And item four here.
\&.El
.Ed
-.Pp
.
+.
+.Pp
Result:
.
+.
.Pp
.Bl -enum -offset indent -compact
.It
@@ -3605,6 +3982,8 @@ And item three here.
.It
And item four here.
.El
+.
+.
.Pp
.
.It Fl item
@@ -3624,10 +4003,12 @@ Item two here.
Item two here.
\&.El
.Ed
-.Pp
.
+.
+.Pp
Produces:
.
+.
.Pp
.Bl -item -offset indent
.It
@@ -3639,14 +4020,16 @@ Item two here.
Item two here.
Item two here.
.El
-.Pp
.
+.
+.Pp
.It Fl tag
A list with tags.
Use
.Fl width
to specify the tag width.
.
+.
.Pp
.Bl -tag -width "PPID" -compact -offset indent
.It SL
@@ -3660,8 +4043,9 @@ numerical user-id of process owner
numerical id of parent of process priority
(non-positive when in non-interruptible wait)
.El
-.Pp
.
+.
+.Pp
The raw text:
.
.Bd -literal -offset indent
@@ -3678,14 +4062,17 @@ numerical id of parent of process priority
(non\-positive when in non\-interruptible wait)
\&.El
.Ed
-.Pp
.
+.
+.Pp
.It Fl diag
Diag lists create section four diagnostic lists and are similar to inset
lists except callable macros are ignored.
The
.Fl width
flag is not meaningful in this context.
+.
+.
.Pp
Example:
.
@@ -3695,16 +4082,18 @@ Example:
The message says all.
\&.El
.Ed
-.Pp
.
+.
+.Pp
produces
.
.Bl -diag
.It You can't use Sy here.
The message says all.
.El
-.Pp
.
+.
+.Pp
.It Fl hang
A list with hanging tags.
.
@@ -3716,6 +4105,8 @@ label is smaller than the label width.
blend into the paragraph unlike
tagged paragraph labels.
.El
+.
+.
.Pp
And the unformatted text which created it:
.
@@ -3729,11 +4120,14 @@ blend into the paragraph unlike
tagged paragraph labels.
\&.El
.Ed
-.Pp
.
+.
+.Pp
.It Fl ohang
Lists with overhanging tags do not use indentation for the items;
tags are written to a separate line.
+.
+.
.Pp
.Bl -ohang -offset indent
.It Sy SL
@@ -3747,8 +4141,9 @@ numerical user-id of process owner
numerical id of parent of process priority
(non-positive when in non-interruptible wait)
.El
-.Pp
.
+.
+.Pp
The raw text:
.
.Bd -literal -offset indent
@@ -3765,8 +4160,9 @@ numerical id of parent of process priority
(non\-positive when in non\-interruptible wait)
\&.El
.Ed
-.Pp
.
+.
+.Pp
.It Fl inset
Here is an example of inset labels:
.Bl -inset -offset indent
@@ -3788,9 +4184,11 @@ Overhanging labels are nice when space is constrained.
.It Em Inset
Inset labels are useful for controlling blocks of
paragraphs and are valuable for converting
-.Nm \-mdoc
+.Nm mdoc
manuals to other formats.
.El
+.
+.
.Pp
Here is the source text which produced the above example:
.
@@ -3811,10 +4209,12 @@ Overhanging labels are nice when space is constrained.
\&.It Em Inset
Inset labels are useful for controlling blocks of
paragraphs and are valuable for converting
-\&.Nm \-mdoc
+\&.Nm mdoc
manuals to other formats.
\&.El
.Ed
+.
+.
.Pp
.
.It Fl column
@@ -3831,7 +4231,7 @@ If
starts with a
.Ql .\&
(dot) immediately followed by a valid
-.Nm \-mdoc
+.Nm mdoc
macro name, interpret
.Aq Ar stringN
and use the width of the result.
@@ -3840,6 +4240,8 @@ Otherwise, the width of
(typeset with a fixed-width font) is taken as the
.Ar N Ns th
column width.
+.
+.
.Pp
Each
.Ql .It
@@ -3847,6 +4249,8 @@ argument is parsed to make a row, each column within the
row is a separate
argument separated by a tab or the
.Ql .Ta
macro.
+.
+.
.Pp
The table:
.
@@ -3855,8 +4259,9 @@ The table:
.It Li <= Ta <= Ta \*(<=
.It Li >= Ta >= Ta \*(>=
.El
-.Pp
.
+.
+.Pp
was produced by:
.
.Bd -literal
@@ -3866,15 +4271,18 @@ was produced by:
\&.It Li >= Ta >= Ta \e*(>=
\&.El
.Ed
-.Pp
.
+.
+.Pp
Don't abuse this list type!
+.
For more complicated cases it might be far better and easier to use
-.Xr tbl 1 ,
+.Xr @g@tbl @MAN1EXT@ ,
the table preprocessor.
.El
-.Pp
.
+.
+.Pp
Other keywords:
.
.Bl -tag -width ".Fl indent Ao Ar string Ac"
@@ -3884,11 +4292,14 @@ If
starts with a
.Ql .\&
(dot) immediately followed by a valid
-.Nm \-mdoc
+.Nm mdoc
macro name, interpret
.Aq Ar string
and use the width of the result.
+.
Almost all lists in this document use this option.
+.
+.
.Pp
Example:
.
@@ -3900,8 +4311,9 @@ This is a longer sentence to show how the
flag works in combination with a tag list.
\&.El
.Ed
-.Pp
.
+.
+.Pp
gives:
.
.Bl -tag -width ".Fl test Ao Ar string Ac"
@@ -3910,26 +4322,39 @@ This is a longer sentence to show how the
.Fl width
flag works in combination with a tag list.
.El
-.Pp
.
+.
+.Pp
(Note that the current state of
-.Nm \-mdoc
+.Nm mdoc
is saved before
.Aq Ar string
-is interpreted; afterwards, all variables are restored again.
-However, boxes (used for enclosures) can't be saved in
+is interpreted;
+afterwards,
+all variables are restored again.
+.
+However,
+boxes
+(used for enclosures)
+can't be saved in
.Tn GNU
-.Xr troff 1 ;
-as a consequence, arguments must always be
+.Xr @g@troff @MAN1EXT@ ;
+as a consequence,
+arguments must always be
.Em balanced
to avoid nasty errors.
-For example, do not write
+.
+For example,
+do not write
.Ql ".Ao Ar string"
but
.Ql ".Ao Ar string Xc"
instead if you really need only an opening angle bracket.)
+.
+.
.Pp
-Otherwise, if
+Otherwise,
+if
.Aq Ar string
is a valid numeric expression
.Em ( with a scale indicator other than
@@ -3948,17 +4373,23 @@ This is approximately the width of the letters
and
.Sq n
respectively
-of the current font (for nroff output, both scale indicators give the same
-values).
+of the current font
+(for
+.Xr @g@nroff
+output,
+both scale indicators give the same values).
+.
If
.Aq Ar string
isn't a numeric expression, it is tested whether it is an
-.Nm \-mdoc
+.Nm mdoc
macro name, and the default width value associated with this macro is used.
Finally, if all tests fail,
the width of
.Aq Ar string
(typeset with a fixed-width font) is taken as the width.
+.
+.
.Pp
If a width is not specified for the tag list type,
.Sq 6n
@@ -3987,17 +4418,22 @@ specifying the so-called
.Em \&Em
and
.Em "En square" .
+.
This is approximately the width of the letters
.Sq m
and
.Sq n
respectively
-of the current font (for nroff output, both scale indicators give the same
-values).
+of the current font
+(for
+.Xr nroff
+output,
+both scale indicators give the same values).
+.
If
.Aq Ar string
isn't a numeric expression, it is tested whether it is an
-.Nm \-mdoc
+.Nm mdoc
macro name, and the default offset value associated with this macro is used.
Finally, if all tests fail,
the width of
@@ -4010,14 +4446,17 @@ Suppress insertion of vertical space before the list
and between list items.
.
.Sh "Miscellaneous macros"
.
-Here a list of the remaining macros which do not fit well into one of the
-above sections.
+Here a list of the remaining macros which do not fit well into one of
+the above sections.
+.
We couldn't find real examples for the following macros:
.Ql .Me
and
.Ql .Ot .
-They are documented here for completeness \- if you know how to use them
-properly please send a mail to
+.
+They are documented here for completeness\(emif you know how to use them
+properly,
+please send a mail to
.Mt groff@gnu.org
(including an example).
.
@@ -4028,12 +4467,18 @@ prints
.Bd -ragged -offset indent
.Bt
.Ed
+.
+.
.Pp
It is neither callable nor parsed and takes no arguments.
.
.It Li .Fr
+.
+.
.Pp
.Dl Usage: .Fr Ao function return value Ac ...
+.
+.
.Pp
Don't use this macro.
It allows a break right before the return value (usually a single digit)
@@ -4048,8 +4493,12 @@ It first prints
.Ql File:
followed by the file name, then the contents of
.Ao file Ac .
+.
+.
.Pp
.Dl Usage: .Hf Ao file Ac
+.
+.
.Pp
It is neither callable nor parsed.
.
@@ -4064,9 +4513,11 @@ Embed hyperlink.
.It Li .Me
Exact usage unknown.
The documentation in the
-.Nm \-mdoc
+.Nm mdoc
source file describes it as a macro for
.Dq "menu entries" .
+.
+.
.Pp
Its default width is 6n.
.
@@ -4081,14 +4532,18 @@ Embed email address.
.It Li .Ot
Exact usage unknown.
The documentation in the
-.Nm \-mdoc
+.Nm mdoc
source file describes it as
.Dq old function type (fortran) .
.
.It Li .Sm
Activate (toggle) space mode.
+.
+.
.Pp
.Dl Usage: .Sm Oo on | off Oc ...
+.
+.
.Pp
If space mode is off, no spaces between macro arguments are inserted.
If called without a parameter (or if the next parameter is neither
@@ -4104,6 +4559,8 @@ prints
.Bd -ragged -offset indent
.Ud
.Ed
+.
+.
.Pp
It is neither callable nor parsed and takes no arguments.
.El
@@ -4112,7 +4569,7 @@ It is neither callable nor parsed and takes no arguments.
.Sh "Predefined strings"
.
The following strings are predefined for compatibility with legacy
-.Nm \-mdoc
+.Nm mdoc
documents.
.
Contemporary ones should use the alternatives shown in the
@@ -4175,7 +4632,7 @@ Old typesetters lacked directional double quotes, \" like
the C/A/T
and would produce repeated directional single quotes,
\[oq]\[oq]like this\[cq]\[cq];
early versions of
-.Nm \-mdoc
+.Nm mdoc
in fact defined the
.Ql Lq
and
@@ -4197,7 +4654,7 @@ A general syntax for a string name of any length is
.Ql \[rs]*[xxx]
(this is a
.Tn GNU
-.Xr troff 1
+.Xr @g@troff @MAN1EXT@
extension).
.
.
@@ -4209,13 +4666,16 @@ extension).
The debugging macro
.Ql .Db
available in previous versions of
-.Nm \-mdoc
+.Nm mdoc
has been removed since
.Tn GNU
-.Xr troff 1
-provides better facilities to check parameters; additionally, many error and
-warning messages have been added to this macro package, making it both more
-robust and verbose.
+.Xr @g@troff @MAN1EXT@
+provides better facilities to check parameters;
+additionally,
+many error and warning messages have been added to this macro package,
+making it both more robust and verbose.
+.
+.
.Pp
The only remaining debugging macro is
.Ql .Rd
@@ -4240,7 +4700,7 @@ This behavior can be changed to format the page as if for
66-line
output by setting the continuous rendering register
.Ql cR
to zero while calling
-.Xr groff 1 .
+.Xr groff @MAN1EXT@ .
.
.
.Pp
@@ -4286,29 +4746,44 @@ swapping places with the arguments to
To change the document font size to 11pt or 12pt, set register
.Ql S
accordingly:
+.
+.
.Pp
.Dl groff \-Tdvi \-rS11 \-mdoc foo.man > foo.dvi
+.
+.
.Pp
Register
.Ql S
is ignored for
.Tn TTY
devices.
+.
+.
.Pp
The line and title length can be changed by setting the registers
.Ql LL
and
.Ql LT ,
respectively:
+.
+.
.Pp
.Dl groff \-Tutf8 \-rLL=100n \-rLT=100n \-mdoc foo.man | less
+.
+.
.Pp
-If not set, both registers default to 78n for TTY devices and 6.5i
-otherwise.
+If not set,
+both registers default to 78n for terminal devices and 6.5i otherwise.
+.
+.
.Pp
Hyphenation can be disabled with the
.Ql HY
-register (though any permissible hyphenation mode may be used).
+register
+(though any permissible hyphenation mode may be used).
+.
+.
.Pp
.Dl groff \-Tutf8 -rHY=0 \-mdoc foo.man | less
.
@@ -4333,7 +4808,7 @@ registers,
are also recognized
(but ignored)
for compatibility with
-.Xr groff_man 7 .
+.Xr groff_man @MAN7EXT@ .
.
.
.Sh Files
@@ -4356,9 +4831,9 @@ Definitions used for all other devices.
Local additions and customizations.
.It Pa andoc.tmac
Use this file if you don't know whether the
-.Nm \-mdoc
+.Nm mdoc
or the
-.Nm \-man
+.Nm man
package should be used.
Multiple man pages (in either format) can be handled.
.El
@@ -4376,47 +4851,60 @@ of
.
.
.Pp
-.Xr groff 1 ,
+.Xr groff @MAN1EXT@ ,
.Xr man 1 ,
-.Xr troff 1 ,
-.Xr groff_man 7
+.Xr @g@troff @MAN1EXT@ ,
+.Xr groff_man @MAN7EXT@ ,
+.Xr mdoc 7
.
.
.Sh Bugs
.
Section 3f has not been added to the header routines.
+.
+.
.Pp
.Ql \&.Nm
font should be changed in
.Em Name
section.
+.
+.
.Pp
.Ql \&.Fn
-needs to have a check to prevent splitting up
-if the line length is too short.
-Occasionally it
-separates the last parenthesis, and sometimes
-looks ridiculous if a line is in fill mode.
-.Pp
-The list and display macros do not do any keeps
-and certainly should be able to.
+needs to have a check to prevent splitting up the line if its length is
+too short.
+.
+Occasionally it separates the last parenthesis,
+and sometimes looks ridiculous if a line is in fill mode.
+.
+.
+.Pp
+The list and display macros do not do any keeps and certainly should be
+able to.
.\" Note what happens if the parameter list overlaps a newline
.\" boundary.
.\" to make sure a line boundary is crossed:
.\" .Bd -literal
.\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\
dictionarytable\e\ *tab[]
.\" .Ed
+.\" .
+.\" .
.\" .Pp
.\" produces, nudge nudge,
.\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\
dictionarytable\ *tab[] ,
.\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\
dictionarytable\ *tab[] ,
.\" nudge
.\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\
dictionarytable\ *tab[] .
+.\" .
+.\" .
.\" .Pp
.\" If double quotes are used, for example:
.\" .Bd -literal
.\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q
\*qstruct dictionarytable *tab[]\*q
.\" .Ed
+.\" .
+.\" .
.\" .Pp
.\" produces, nudge nudge,
.\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct
dictionarytable *tab[]" ,
@@ -4424,18 +4912,20 @@ and certainly should be able to.
.\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct
dictionarytable *tab[]" ,
.\" nudge
.\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct
dictionarytable *tab[]" .
+.\" .
+.\" .
.\" .Pp
.\" Not a pretty sight...
.\" In a paragraph, a long parameter containing unpaddable spaces as
.\" in the former example will cause
-.\" .Xr troff
+.\" .Xr @g@troff
.\" to break the line and spread
.\" the remaining words out.
.\" The latter example will adjust nicely to
.\" justified margins, but may break in between an argument and its
.\" declaration.
.\" In
-.\" .Xr nroff
+.\" .Xr @g@nroff
.\" the right margin adjustment is normally ragged and the problem is
.\" not as severe.
.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 05/07: groff_mdoc(7): Make style fixes.,
G. Branden Robinson <=