version 1.42, 2009/10/31 08:37:26 |
version 1.52, 2009/11/12 08:21:05 |
Line 67 line termination. |
|
Line 67 line termination. |
|
Blank lines are acceptable; where found, the output will assert a |
Blank lines are acceptable; where found, the output will assert a |
vertical space. |
vertical space. |
. |
. |
.Pp |
|
The |
|
.Sq \ec |
|
escape is common in historical |
|
.Nm |
|
documents; if encountered at the end of a word, it ensures that the |
|
subsequent word isn't off-set by whitespace. |
|
. |
. |
. |
|
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e\*" , |
.Sq \e\*" , |
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 |
is also ignored. Macro lines with only a control character and |
optionally whitespace are stripped from input. |
optionally whitespace are stripped from input. |
. |
. |
. |
. |
|
|
.Ss Text Decoration |
.Ss Text Decoration |
Terms may be text-decorated using the |
Terms may be text-decorated using the |
.Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I, (italic), or P and R |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
(Roman, or reset). |
(revert to previous mode): |
|
.Pp |
|
.D1 \efBbold\efR \efIitalic\efP |
|
.Pp |
|
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
|
respectively) may be used instead. A text decoration is only valid, if |
|
specified in free-form text, until the next macro invocation; if |
|
specified within a macro, it's only valid until the macro closes scope. |
|
.Pp |
|
Text may also be sized with the |
|
.Sq \es |
|
escape, whose syntax is one of |
|
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
|
.D1 \es+1bigger\es-1 |
|
.D1 \es[+10]much bigger\es[-10] |
|
.D1 \es+(10much bigger\es-(10 |
|
.D1 \es+'100'much much bigger\es-'100' |
|
.Pp |
|
Both |
|
.Sq \es |
|
and |
|
.Sq \ef |
|
attributes are forgotten when exiting a subsequent (or current) macro |
|
invocation. |
. |
. |
. |
. |
.Ss Whitespace |
.Ss Whitespace |
Line 119 from input. These are later re-added, if applicable, |
|
Line 146 from input. These are later re-added, if applicable, |
|
utility such as |
utility such as |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
. |
. |
|
. |
|
.Ss Dates |
|
The |
|
.Sx \&TH |
|
macro is the only |
|
.Nm |
|
macro that requires a date. The form for this date is the ISO-8601 |
|
standard |
|
.Cm YYYY-MM-DD . |
|
. |
|
. |
.Ss Scaling Widths |
.Ss Scaling Widths |
Many macros support scaled widths for their arguments, such as |
Many macros support scaled widths for their arguments, such as |
stipulating a two-inch paragraph indentation with the following: |
stipulating a two-inch paragraph indentation with the following: |
Line 170 Using anything other than |
|
Line 208 Using anything other than |
|
.Sq u , |
.Sq u , |
or |
or |
.Sq v |
.Sq v |
is necessarily non-portable across output media. See |
is necessarily non-portable across output media. |
.Sx COMPATIBILITY . |
|
. |
. |
.Pp |
.Pp |
If a scaling unit is not provided, the numerical value is interpreted |
If a scaling unit is not provided, the numerical value is interpreted |
|
|
at least one macro or text node must appear in the document. Documents |
at least one macro or text node must appear in the document. Documents |
are generally structured as follows: |
are generally structured as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH FOO 1 "13 Aug 2009" |
\&.TH FOO 1 2009-10-10 |
\&. |
\&. |
\&.SH NAME |
\&.SH NAME |
\efBfoo\efR \e(en a description goes here |
\efBfoo\efR \e(en a description goes here |
Line 265 generally structured as follows: |
|
Line 302 generally structured as follows: |
|
.Pp |
.Pp |
For the second, function calls (sections 2, 3, 9): |
For the second, function calls (sections 2, 3, 9): |
.Pp |
.Pp |
.D1 \. Ns Sx \&B No char *name(char *\efIarg\efR); |
.D1 \&.B char *name(char *\efIarg\efR); |
.Pp |
.Pp |
And for the third, configurations (section 4): |
And for the third, configurations (section 4): |
.Pp |
.Pp |
.D1 \. Ns Sx \&B No name* at cardbus ? function ? |
.D1 \&.B name* at cardbus ? function ? |
.Pp |
.Pp |
Manuals not in these sections generally don't need a |
Manuals not in these sections generally don't need a |
.Em SYNOPSIS . |
.Em SYNOPSIS . |
Line 308 short description of how the file is used (created, mo |
|
Line 345 short description of how the file is used (created, mo |
|
.It Em EXAMPLES |
.It Em EXAMPLES |
Example usages. This often contains snippets of well-formed, |
Example usages. This often contains snippets of well-formed, |
well-tested invocations. Make doubly sure that your examples work |
well-tested invocations. Make doubly sure that your examples work |
properly! Assume that users will skip to this section and use your |
properly! |
example verbatim. |
|
. |
. |
.It Em DIAGNOSTICS |
.It Em DIAGNOSTICS |
Documents error conditions. This is most useful in section 4 manuals. |
Documents error conditions. This is most useful in section 4 manuals. |
Line 323 Documents error handling in sections 2, 3, and 9. |
|
Line 359 Documents error handling in sections 2, 3, and 9. |
|
. |
. |
.It Em SEE ALSO |
.It Em SEE ALSO |
References other manuals with related topics. This section should exist |
References other manuals with related topics. This section should exist |
for most manuals. Cross-references should conventionally be ordered |
for most manuals. |
first by section, then alphabetically. |
|
.Pp |
.Pp |
.D1 \. Ns Sx \&BR No bar \&( 1 \&), |
.D1 \&.BR bar \&( 1 \&), |
.D1 \. Ns Sx \&BR No foo \&( 1 \&), |
.Pp |
.D1 \. Ns Sx \&BR No baz \&( 2 \&). |
Cross-references should conventionally be ordered |
|
first by section, then alphabetically. |
. |
. |
.It Em STANDARDS |
.It Em STANDARDS |
References any standards implemented or used, such as |
References any standards implemented or used, such as |
|
|
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.I foo . |
.Sq \&.I foo . |
If next-line macros are invoked consecutively, only the last is used. |
If next-line macros are invoked consecutively, only the last is used; in |
If a next-line macro is proceded by a block macro, it is ignored. |
other words, if a next-line macro is preceded by a block macro, it is |
|
ignored. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
\&.YO \(lBbody...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
Line 510 This section is a canonical reference to all macros, a |
|
Line 547 This section is a canonical reference to all macros, a |
|
alphabetically. For the scoping of individual macros, see |
alphabetically. For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
. |
. |
|
. |
.Ss \&B |
.Ss \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
|
.Pp |
|
See also |
|
.Sx \&I , |
|
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
.Ss \&BI |
.Ss \&BI |
Text is rendered alternately in bold face and italic. Thus, |
Text is rendered alternately in bold face and italic. Thus, |
.Sq .BI this word and that |
.Sq .BI this word and that |
Line 524 to render in bold face, while |
|
Line 572 to render in bold face, while |
|
and |
and |
.Sq that |
.Sq that |
render in italics. Whitespace between arguments is omitted in output. |
render in italics. Whitespace between arguments is omitted in output. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.D1 \&.BI bold italic bold italic |
|
.Pp |
|
The output of this example will be emboldened |
|
.Dq bold |
|
and italicised |
|
.Dq italic , |
|
with spaces stripped between arguments. |
|
.Pp |
|
See also |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
.Ss \&BR |
.Ss \&BR |
Text is rendered alternately in bold face and roman (the default font). |
Text is rendered alternately in bold face and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
.Ss \&DT |
.Ss \&DT |
Has no effect. Included for compatibility. |
Has no effect. Included for compatibility. |
|
. |
|
. |
.Ss \&HP |
.Ss \&HP |
Begin a paragraph whose initial output line is left-justified, but |
Begin a paragraph whose initial output line is left-justified, but |
subsequent output lines are indented, with the following syntax: |
subsequent output lines are indented, with the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.HP [width] |
.Pf \. Sx \&HP |
|
.Op Cm width |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
If scaling width |
The |
.Va width |
.Cm width |
is specified, it's saved for later paragraph left-margins; if |
argument must conform to |
unspecified, the saved or default width is used. |
.Sx Scaling Widths . |
|
If specified, it's saved for later paragraph left-margins; if unspecified, the |
|
saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
.Ss \&I |
.Ss \&I |
Text is rendered in italics. |
Text is rendered in italics. |
|
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
.Ss \&IB |
.Ss \&IB |
Text is rendered alternately in italics and bold face. Whitespace |
Text is rendered alternately in italics and bold face. Whitespace |
between arguments is omitted in output. |
between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
.Ss \&IP |
.Ss \&IP |
Begin a paragraph with the following syntax: |
Begin an indented paragraph with the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.IP [head [width]] |
.Pf \. Sx \&IP |
|
.Op Cm head Op Cm width |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
This follows the behaviour of the |
The |
.Sx \&TP |
.Cm width |
except for the macro syntax (all arguments on the line, instead of |
argument defines the width of the left margin and is defined by |
having next-line scope). If |
.Sx Scaling Widths , |
.Va width |
It's saved for later paragraph left-margins; if unspecified, the saved or |
is specified, it's saved for later paragraph left-margins; if |
default width is used. |
unspecified, the saved or default width is used. |
.Pp |
|
The |
|
.Cm head |
|
argument is used as a leading term, flushed to the left margin. This is |
|
useful for bulleted paragraphs and so on. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
.Ss \&IR |
.Ss \&IR |
Text is rendered alternately in italics and roman (the default font). |
Text is rendered alternately in italics and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&RI . |
|
. |
|
. |
.Ss \&LP |
.Ss \&LP |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
subsequent paragraph, sub-section, section, or end of file. The saved |
subsequent paragraph, sub-section, section, or end of file. The saved |
paragraph left-margin width is re-set to the default. |
paragraph left-margin width is re-set to the default. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
.Ss \&P |
.Ss \&P |
Synonym for |
Synonym for |
.Sx \&LP . |
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
.Ss \&PP |
.Ss \&PP |
Synonym for |
Synonym for |
.Sx \&LP . |
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
.Ss \&R |
.Ss \&R |
Text is rendered in roman (the default font). |
Text is rendered in roman (the default font). |
|
.Pp |
|
See also |
|
.Sx \&I , |
|
.Sx \&B , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
.Ss \&RB |
.Ss \&RB |
Text is rendered alternately in roman (the default font) and bold face. |
Text is rendered alternately in roman (the default font) and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
.Ss \&RE |
.Ss \&RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
.Sx \&RS . |
.Sx \&RS . |
|
. |
|
. |
.Ss \&RI |
.Ss \&RI |
Text is rendered alternately in roman (the default font) and italics. |
Text is rendered alternately in roman (the default font) and italics. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
.Ss \&RS |
.Ss \&RS |
Begin a part setting the left margin. The left margin controls the |
Begin a part setting the left margin. The left margin controls the |
offset, following an initial indentation, to un-indented text such as |
offset, following an initial indentation, to un-indented text such as |
that of |
that of |
.Sx \&PP . |
.Sx \&PP . |
A scaling width may be specified as following: |
This has the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.RS [width] |
.Pf \. Sx \&Rs |
|
.Op Cm width |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
If |
The |
.Va width |
.Cm width |
is not specified, the saved or default width is used. |
argument must conform to |
|
.Sx Scaling Widths . |
|
If not specified, the saved or default width is used. |
|
. |
|
. |
.Ss \&SB |
.Ss \&SB |
Text is rendered in small size (one point smaller than the default font) |
Text is rendered in small size (one point smaller than the default font) |
bold face. |
bold face. |
|
. |
|
. |
.Ss \&SH |
.Ss \&SH |
Begin a section. The scope of a section is only closed by another |
Begin a section. The scope of a section is only closed by another |
section or the end of file. The paragraph left-margin width is re-set |
section or the end of file. The paragraph left-margin width is re-set |
to the default. |
to the default. |
|
. |
|
. |
.Ss \&SM |
.Ss \&SM |
Text is rendered in small size (one point smaller than the default |
Text is rendered in small size (one point smaller than the default |
font). |
font). |
|
. |
|
. |
.Ss \&SS |
.Ss \&SS |
Begin a sub-section. The scope of a sub-section is closed by a |
Begin a sub-section. The scope of a sub-section is closed by a |
subsequent sub-section, section, or end of file. The paragraph |
subsequent sub-section, section, or end of file. The paragraph |
left-margin width is re-set to the default. |
left-margin width is re-set to the default. |
|
. |
|
. |
.Ss \&TH |
.Ss \&TH |
Sets the title of the manual page with the following syntax: |
Sets the title of the manual page with the following syntax: |
.Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.TH title section [date [source [volume]]] |
.Pf \. Sx \&TH |
|
.Cm title section |
|
.Op Cm date Op Cm source Op Cm volume |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
At least the |
At least the upper-case document title |
.Va title |
.Cm title |
and |
and numeric manual section |
.Va section |
.Cm section |
arguments must be provided. The |
arguments must be provided. The |
.Va date |
.Cm date |
argument should be formatted as |
argument should be formatted as described in |
.Qq %b [%d] %Y |
.Sx Dates : |
format, described in |
if it does not conform, the current date is used instead. The |
.Xr strptime 3 . |
.Cm source |
The |
|
.Va source |
|
string specifies the organisation providing the utility. The |
string specifies the organisation providing the utility. The |
.Va volume |
.Cm volume |
replaces the default rendered volume as dictated by the manual section. |
string replaces the default rendered volume, which is dictated by the |
|
manual section. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.D1 \&.TH CVS 5 "1992-02-12" GNU |
|
. |
|
. |
.Ss \&TP |
.Ss \&TP |
Begin a paragraph where the head, if exceeding the indentation width, is |
Begin a paragraph where the head, if exceeding the indentation width, is |
followed by a newline; if not, the body follows on the same line after a |
followed by a newline; if not, the body follows on the same line after a |
buffer to the indentation width. Subsequent output lines are indented. |
buffer to the indentation width. Subsequent output lines are indented. |
. |
The syntax is as follows: |
.Pp |
.Bd -filled -offset indent |
The indentation scaling width may be set as follows: |
.Pf \. Sx \&TP |
.Bd -literal -offset indent |
.Op Cm width |
\&.TP [width] |
|
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
If |
The |
.Va width |
.Cm width |
is specified, it's saved for later paragraph left-margins; if |
argument must conform to |
|
.Sx Scaling Widths . |
|
If specified, it's saved for later paragraph left-margins; if |
unspecified, the saved or default width is used. |
unspecified, the saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
and |
|
.Sx \&PP . |
|
. |
|
. |
.Ss \&PD |
.Ss \&PD |
Has no effect. Included for compatibility. |
Has no effect. Included for compatibility. |
|
. |
|
. |
.Ss \&UC |
.Ss \&UC |
Has no effect. Included for compatibility. |
Has no effect. Included for compatibility. |
|
. |
|
. |
.Ss \&br |
.Ss \&br |
Breaks the current line. Consecutive invocations have no further effect. |
Breaks the current line. Consecutive invocations have no further effect. |
|
.Pp |
|
See also |
|
.Sx \&sp . |
|
. |
|
. |
.Ss \&fi |
.Ss \&fi |
End literal mode begun by |
End literal mode begun by |
.Sx \&nf . |
.Sx \&nf . |
|
. |
|
. |
.Ss \&i |
.Ss \&i |
Italicise arguments. If no arguments are specified, all subsequent text |
Italicise arguments. Synonym for |
is italicised. |
.Sx \&I . |
|
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R . |
|
.Sx \&b , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
.Ss \&na |
.Ss \&na |
Don't align to the right margin. |
Don't align to the right margin. |
|
. |
|
. |
.Ss \&nf |
.Ss \&nf |
Begin literal mode: all subsequent free-form lines have their end of |
Begin literal mode: all subsequent free-form lines have their end of |
line boundaries preserved. May be ended by |
line boundaries preserved. May be ended by |
.Sx \&fi . |
.Sx \&fi . |
|
. |
|
. |
.Ss \&r |
.Ss \&r |
Fonts and styles (bold face, italics) reset to roman (default font). |
Fonts and styles (bold face, italics) reset to roman (default font). |
|
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R , |
|
.Sx \&b , |
|
and |
|
.Sx \&i . |
|
. |
|
. |
.Ss \&sp |
.Ss \&sp |
Insert n spaces, where n is the macro's positive numeric argument. If |
Insert vertical spaces into output with the following syntax: |
0, this is equivalent to the |
.Bd -filled -offset indent |
|
.Pf \. Sx \&sp |
|
.Op Cm height |
|
.Ed |
|
.Pp |
|
Insert |
|
.Cm height |
|
spaces, which must conform to |
|
.Sx Scaling Widths . |
|
If 0, this is equivalent to the |
.Sx \&br |
.Sx \&br |
macro. |
macro. Defaults to 1, if unspecified. |
|
.Pp |
|
See also |
|
.Sx \&br . |
. |
. |
. |
. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility with other roff implementations, at |
This section documents compatibility with other roff implementations, at |
this time limited to |
this time limited to |
.Xr groff 1 . |
.Xr groff 1 . |
.Bl -hyphen |
.Pp |
|
.Bl -dash -compact |
.It |
.It |
|
The |
|
.Xr groff 1 |
|
.Sx \&i |
|
macro will italicise all subsequent text if a line argument is not |
|
provided. This behaviour is not implemented. |
|
.It |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
standalone double-quote in formatted output. This idiosyncratic |
standalone double-quote in formatted output. This idiosyncratic |
behaviour is no longer applicable. |
behaviour is no longer applicable. |
.It |
.It |
The |
The |
.Sq sp |
.Sx \&sp |
macro does not accept negative numbers. |
macro does not accept negative numbers. |
.It |
.It |
Blocks of whitespace are stripped from both macro and free-form text |
Blocks of whitespace are stripped from both macro and free-form text |