version 1.122, 2010/06/07 11:01:15 |
version 1.128, 2010/07/01 15:38:56 |
|
|
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
.Sq \&.\e" , |
is also ignored. Macro lines with only a control charater and optionally |
is also ignored. Macro lines with only a control character and optionally |
whitespace are stripped from input. |
whitespace are stripped from input. |
.Ss Reserved Characters |
.Ss Reserved Characters |
Within a macro line, the following characters are reserved: |
Within a macro line, the following characters are reserved: |
Line 167 also defined a set of package-specific |
|
Line 167 also defined a set of package-specific |
|
.Dq predefined strings , |
.Dq predefined strings , |
which, like |
which, like |
.Sx Special Characters , |
.Sx Special Characters , |
demark special output characters and strings by way of input codes. |
mark special output characters and strings by way of input codes. |
Predefined strings are escaped with the slash-asterisk, |
Predefined strings are escaped with the slash-asterisk, |
.Sq \e* : |
.Sq \e* : |
single-character |
single-character |
Line 471 dissimilar macros are pair-wise invoked (except for |
|
Line 471 dissimilar macros are pair-wise invoked (except for |
|
before |
before |
.Sx \&Fo |
.Sx \&Fo |
or |
or |
.Sx \&Fn ) , |
.Sx \&Fn ) , |
they are separated by a vertical space, unless in the case of |
they are separated by a vertical space, unless in the case of |
.Sx \&Fo , |
.Sx \&Fo , |
.Sx \&Fn , |
.Sx \&Fn , |
and |
and |
.Sx \&Ft , |
.Sx \&Ft , |
which are always separated by vertical space. |
which are always separated by vertical space. |
|
.Pp |
|
When text and macros following an |
|
.Sx \&Nm |
|
macro starting an input line span multiple output lines, |
|
all output lines but the first will be indented to align |
|
with the text immediately following the |
|
.Sx \&Nm |
|
macro, up to the next |
|
.Sx \&Nm , |
|
.Sx \&Sx , |
|
or |
|
.Sx \&Ss |
|
macro or the end of an enclosing block, whichever comes first. |
.It Em DESCRIPTION |
.It Em DESCRIPTION |
This expands upon the brief, one-line description in |
This expands upon the brief, one-line description in |
.Em NAME . |
.Em NAME . |
Line 672 has multiple heads. |
|
Line 685 has multiple heads. |
|
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
|
.It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.El |
.El |
|
.Pp |
|
Note that the |
|
.Sx \&Nm |
|
macro is a |
|
.Sx Block full-implicit |
|
macro only when invoked as the first macro |
|
in a |
|
.Em SYNOPSIS |
|
section line, else it is |
|
.Sx In-line . |
.Ss Block partial-explicit |
.Ss Block partial-explicit |
Like block full-explicit, but also with single-line scope. |
Like block full-explicit, but also with single-line scope. |
Each has at least a body and, in limited circumstances, a head |
Each has at least a body and, in limited circumstances, a head |
|
|
.Sx \&Aq . |
.Sx \&Aq . |
.Ss \&Ap |
.Ss \&Ap |
Inserts an apostrophe without any surrounding white-space. |
Inserts an apostrophe without any surrounding white-space. |
This is generally used as a grammatic device when referring to the verb |
This is generally used as a grammatical device when referring to the verb |
form of a function: |
form of a function: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Fn execve Ap d |
\&.Fn execve Ap d |
Line 1094 As a scaling unit following the syntax described in |
|
Line 1118 As a scaling unit following the syntax described in |
|
As the calculated string length of the opaque string. |
As the calculated string length of the opaque string. |
.El |
.El |
.Pp |
.Pp |
If unset, it will revert to the value of |
If not provided an argument, it will be ignored. |
.Ar 8n |
|
as described in |
|
.Sx Scaling Widths . |
|
.It Fl compact |
.It Fl compact |
Do not assert a vertical space before the block. |
Do not assert a vertical space before the block. |
.It Fl file Ar file |
.It Fl file Ar file |
|
|
.Sx \&Dl . |
.Sx \&Dl . |
.Ss \&Bf |
.Ss \&Bf |
.Ss \&Bk |
.Ss \&Bk |
|
Begins a keep block, containing a collection of macros or text |
|
to be kept together in the output. |
|
One argument is required; additional arguments are ignored. |
|
Currently, the only argument implemented is |
|
.Fl words , |
|
requesting to keep together all words of the contained text |
|
on the same output line. |
|
A |
|
.Fl lines |
|
argument to keep together all lines of the contained text |
|
on the same page has been desired for a long time, |
|
but has never been implemented. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Bk \-words |
|
\&.Op o Ar output_file |
|
\&.Ek |
|
.Ed |
.Ss \&Bl |
.Ss \&Bl |
Begins a list composed of one or more list entries. |
Begins a list composed of one or more list entries. |
A list is associated with a type, which is a required argument. |
A list is associated with a type, which is a required argument. |
|
|
.Ss \&Ed |
.Ss \&Ed |
.Ss \&Ef |
.Ss \&Ef |
.Ss \&Ek |
.Ss \&Ek |
|
Ends a keep context started by |
|
.Sx \&Bk . |
.Ss \&El |
.Ss \&El |
Ends a list context started by |
Ends a list context started by |
.Sx \&Bl . |
.Sx \&Bl . |
|
|
Subsequent this, only the |
Subsequent this, only the |
.Sq \&Ta |
.Sq \&Ta |
pseudo-macro may be used to delimit phrases. |
pseudo-macro may be used to delimit phrases. |
Furthermore, note that quoted sections propogate over tab-delimited |
Furthermore, note that quoted sections propagate over tab-delimited |
phrases on an |
phrases on an |
.Sx \&It , |
.Sx \&It , |
for example, |
for example, |
|
|
.D1 \&.Mt discuss@manpages.bsd.lv |
.D1 \&.Mt discuss@manpages.bsd.lv |
.Ss \&Nd |
.Ss \&Nd |
.Ss \&Nm |
.Ss \&Nm |
|
The name of the manual page, or \(em in particular in section 1, 6, |
|
and 8 pages \(em of an additional command or feature documented in |
|
the manual page. |
|
When first invoked, the |
|
.Sx \&Nm |
|
macro expects a single argument, the name of the manual page. |
|
Usually, the first invocation happens in the |
|
.Em NAME |
|
section of the page. |
|
The specified name will be remembered and used whenever the macro is |
|
called again without arguments later in the page. |
|
The |
|
.Sx \&Nm |
|
macro uses |
|
.Sx Block full-implicit |
|
semantics when invoked as the first macro on an input line in the |
|
.Em SYNOPSIS |
|
section; otherwise, it uses ordinary |
|
.Sx In-line |
|
semantics. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Sh SYNOPSIS |
|
\&.Nm cat |
|
\&.Op Fl benstuv |
|
\&.Op Ar |
|
.Ed |
|
.Pp |
|
In the |
|
.Em SYNOPSIS |
|
of section 2, 3 and 9 manual pages, use the |
|
.Sx \&Fn |
|
macro rather than |
|
.Sx \&Nm |
|
to mark up the name of the manual page. |
.Ss \&No |
.Ss \&No |
.Ss \&Ns |
.Ss \&Ns |
.Ss \&Nx |
.Ss \&Nx |
Line 2102 This is also used for indicating global variables in t |
|
Line 2180 This is also used for indicating global variables in t |
|
section, in which case a variable name is also specified. |
section, in which case a variable name is also specified. |
Note that it accepts |
Note that it accepts |
.Sx Block partial-implicit |
.Sx Block partial-implicit |
syntax when invoked as the first macro in the |
syntax when invoked as the first macro in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
section, else it accepts ordinary |
section, else it accepts ordinary |
.Sx In-line |
.Sx In-line |
Line 2169 Heirloom troff, the other significant troff implementa |
|
Line 2247 Heirloom troff, the other significant troff implementa |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
|
Old groff fails to assert a newline before |
|
.Sx \&Bd Fl ragged compact . |
|
.It |
groff behaves inconsistently when encountering |
groff behaves inconsistently when encountering |
.Pf non- Sx \&Fa |
.Pf non- Sx \&Fa |
children of |
children of |
|
|
.Sx \&Fn |
.Sx \&Fn |
in the |
in the |
.Em SYNOPSIS : |
.Em SYNOPSIS : |
at times newline(s) are suppressed dependong on whether a prior |
at times newline(s) are suppressed depending on whether a prior |
.Sx \&Fn |
.Sx \&Fn |
has been invoked. |
has been invoked. |
In mandoc, this is not the case. |
In mandoc, this is not the case. |
Line 2243 In quoted literals, groff allowed pair-wise double-quo |
|
Line 2324 In quoted literals, groff allowed pair-wise double-quo |
|
standalone double-quote in formatted output. |
standalone double-quote in formatted output. |
This idiosyncratic behaviour is not applicable in mandoc. |
This idiosyncratic behaviour is not applicable in mandoc. |
.It |
.It |
Display types |
Display offsets |
.Sx \&Bd |
.Sx \&Bd |
.Fl center |
.Fl offset Ar center |
and |
and |
.Fl right |
.Fl offset Ar right |
are aliases for |
are disregarded in mandoc. |
.Fl left |
Furthermore, the |
in manodc. Furthermore, the |
|
.Fl file Ar file |
.Fl file Ar file |
argument is ignored. |
argument is not supported in mandoc. |
Lastly, since text is not right-justified in mandoc (or even groff), |
Lastly, since text is not right-justified in mandoc (or even groff), |
.Fl ragged |
.Fl ragged |
and |
and |