version 1.50, 2009/11/12 05:50:12 |
version 1.55, 2010/01/07 19:10:09 |
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\*" , |
|
|
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), R (Roman), or P |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
(revert to previous mode): |
(revert to previous mode): |
.Pp |
.Pp |
.D1 \efBbold\efR \efIitalic\efP |
.D1 \efBbold\efR \efIitalic\efP |
.Pp |
.Pp |
Line 118 A numerical representation 3, 2, or 1 (bold, italic, a |
|
Line 110 A numerical representation 3, 2, or 1 (bold, italic, a |
|
respectively) may be used instead. A text decoration is only valid, if |
respectively) may be used instead. A text decoration is only valid, if |
specified in free-form text, until the next macro invocation; 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. |
specified within a macro, it's only valid until the macro closes scope. |
|
Note that macros like |
|
.Sx \&BR |
|
open and close a font scope with each argument. |
.Pp |
.Pp |
Text may also be sized with the |
Text may also be sized with the |
.Sq \es |
.Sq \es |
|
|
.Sq \es |
.Sq \es |
and |
and |
.Sq \ef |
.Sq \ef |
attributes are forgotten when exiting a subsequent (or current) macro |
attributes are forgotten when entering or exiting a macro block. |
invocation. |
|
. |
. |
. |
. |
.Ss Whitespace |
.Ss Whitespace |
Line 301 the C library, this may be as follows: |
|
Line 295 the C library, this may be as follows: |
|
.D1 Standard C Library (libc, -lc) |
.D1 Standard C Library (libc, -lc) |
.It Em SYNOPSIS |
.It Em SYNOPSIS |
Documents the utility invocation syntax, function call syntax, or device |
Documents the utility invocation syntax, function call syntax, or device |
configuration. |
configuration. |
.Pp |
.Pp |
For the first, utilities (sections 1, 6, and 8), this is |
For the first, utilities (sections 1, 6, and 8), this is |
generally structured as follows: |
generally structured as follows: |
Line 316 And for the third, configurations (section 4): |
|
Line 310 And for the third, configurations (section 4): |
|
.Pp |
.Pp |
.D1 \&.B 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 . |
.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 . |
It usually contains a break-down of the options (if documenting a |
It usually contains a break-down of the options (if documenting a |
command). |
command). |
Line 367 Documents error handling in sections 2, 3, and 9. |
|
Line 361 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. |
for most manuals. |
.Pp |
.Pp |
.D1 \&.BR bar \&( 1 \&), |
.D1 \&.BR bar \&( 1 \&), |
.Pp |
.Pp |
Line 510 sub-section, closed by a section or |
|
Line 504 sub-section, closed by a section or |
|
.Sx \&SS ; |
.Sx \&SS ; |
part, closed by a section, sub-section, or |
part, closed by a section, sub-section, or |
.Sx \&RE ; |
.Sx \&RE ; |
or paragraph, closed by a section, sub-section, part, |
or paragraph, closed by a section, sub-section, part, |
.Sx \&HP , |
.Sx \&HP , |
.Sx \&IP , |
.Sx \&IP , |
.Sx \&LP , |
.Sx \&LP , |
|
|
. |
. |
. |
. |
.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 |
causes |
causes |
.Sq this |
.Sq this |
and |
and |
.Sq and |
.Sq and |
to render in bold face, while |
to render in bold face, while |
.Sq word |
.Sq word |
and |
and |
.Sq that |
.Sq that |
|
|
.Cm width |
.Cm width |
argument must conform to |
argument must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
. |
. |
. |
. |
.Ss \&SB |
.Ss \&SB |
Line 925 End literal mode begun by |
|
Line 919 End literal mode begun by |
|
. |
. |
. |
. |
.Ss \&i |
.Ss \&i |
Italicise arguments. If no arguments are specified, all subsequent text |
Italicise arguments. Synonym for |
is italicised. |
.Sx \&I . |
.Pp |
.Pp |
See also |
See also |
.Sx \&B , |
.Sx \&B , |
Line 966 Insert vertical spaces into output with the following |
|
Line 960 Insert vertical spaces into output with the following |
|
.Op Cm height |
.Op Cm height |
.Ed |
.Ed |
.Pp |
.Pp |
Insert |
Insert |
.Cm height |
.Cm height |
spaces, which must conform to |
spaces, which must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
|
|
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 |