version 1.74, 2009/11/05 08:40:16 |
version 1.82, 2010/01/07 19:10:10 |
|
|
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). A numerical representation 3, 2, or 1 |
(revert to previous mode): |
(bold, italic, and Roman, respectively) may be used instead. This form |
.Pp |
is not recommended for |
.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 valid within |
|
the current font scope only: if a macro opens a font scope alongside |
|
its own scope, such as |
|
.Sx \&Bf |
|
.Cm \&Sy , |
|
in-scope invocations of |
|
.Sq \ef |
|
are only valid within the font scope of the macro. If |
|
.Sq \ef |
|
is specified outside of any font scope, such as in unenclosed, free-form |
|
text, it will affect the remainder of the document. |
|
.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 |
|
Note these forms are |
|
.Em not |
|
recommended for |
.Nm , |
.Nm , |
which encourages semantic annotation. |
which encourages semantic annotation. |
. |
. |
. |
. |
.Ss Predefined Strings |
.Ss Predefined Strings |
Historically, |
Historically, |
.Xr groff 1 |
.Xr groff 1 |
also defined a set of package-specific |
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. |
demark 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, |
|
|
.Sx \&Os |
.Sx \&Os |
macros, is required for every document. |
macros, is required for every document. |
.Pp |
.Pp |
The first section (sections are denoted by |
The first section (sections are denoted by |
.Sx \&Sh ) |
.Sx \&Sh ) |
must be the NAME section, consisting of at least one |
must be the NAME section, consisting of at least one |
.Sx \&Nm |
.Sx \&Nm |
|
|
macro(s) must precede the |
macro(s) must precede the |
.Sx \&Nd |
.Sx \&Nd |
macro. |
macro. |
|
.Pp |
|
See |
|
.Sx \&Nm |
|
and |
|
.Sx \&Nd . |
. |
. |
.It Em LIBRARY |
.It Em LIBRARY |
The name of the library containing the documented material, which is |
The name of the library containing the documented material, which is |
Line 391 this is as follows: |
|
Line 434 this is as follows: |
|
.Ed |
.Ed |
.Pp |
.Pp |
See |
See |
.Sx \&Lb |
.Sx \&Lb . |
for details. |
|
. |
. |
.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 427 And for the third, configurations (section 4): |
|
Line 469 And for the third, configurations (section 4): |
|
\&.Cd \*qit* at isa? port 0x4e\*q |
\&.Cd \*qit* at isa? port 0x4e\*q |
.Ed |
.Ed |
.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 . |
|
.Pp |
|
See |
|
.Sx \&Op , |
|
.Sx \&Cd , |
|
.Sx \&Fn , |
|
.Sx \&Ft , |
|
and |
|
.Sx \&Vt . |
. |
. |
.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), such as: |
command), such as: |
Line 442 The arguments are as follows: |
|
Line 492 The arguments are as follows: |
|
Print verbose information. |
Print verbose information. |
\&.El |
\&.El |
.Ed |
.Ed |
|
.Pp |
Manuals not documenting a command won't include the above fragment. |
Manuals not documenting a command won't include the above fragment. |
. |
. |
.It Em IMPLEMENTATION NOTES |
.It Em IMPLEMENTATION NOTES |
Line 497 for manuals in sections 1, 6, and 8; however, this pra |
|
Line 548 for manuals in sections 1, 6, and 8; however, this pra |
|
discouraged. |
discouraged. |
.Pp |
.Pp |
See |
See |
.Sx \&Bl No \-diag . |
.Sx \&Bl |
|
.Fl diag . |
. |
. |
.It Em ERRORS |
.It Em ERRORS |
Documents error handling in sections 2, 3, and 9. |
Documents error handling in sections 2, 3, and 9. |
Line 631 All macros have bodies; some |
|
Line 683 All macros have bodies; some |
|
don't have heads; only one |
don't have heads; only one |
.Po |
.Po |
.Sx \&It Fl column |
.Sx \&It Fl column |
.Pc |
.Pc |
has multiple heads. |
has multiple heads. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
Line 814 then the macro accepts an arbitrary number of argument |
|
Line 866 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
. |
. |
. |
. |
.Sh REFERENCE |
.Sh REFERENCE |
|
|
.Ed |
.Ed |
. |
. |
.Ss \&Aq |
.Ss \&Aq |
Encloses its arguments in angled brackets. |
Encloses its arguments in angled brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 1021 Note that these parameters do not begin with a hyphen. |
|
Line 1073 Note that these parameters do not begin with a hyphen. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.At |
\&.At |
\&.At V.1 |
\&.At V.1 |
.Ed |
.Ed |
.Pp |
.Pp |
|
|
.Ss \&Bf |
.Ss \&Bf |
.Ss \&Bk |
.Ss \&Bk |
.Ss \&Bl |
.Ss \&Bl |
. |
.\" Begins a list composed of one or more list entries. A list entry is |
|
.\" specified by the |
|
.\" .Sx \&It |
|
.\" macro, which consists of a head and optional body. By default, a list |
|
.\" is preceded by a blank line. A list must specify one of the following |
|
.\" list types: |
|
.\" .Bl -tag -width 12n |
|
.\" .It Fl bullet |
|
.\" A list offset by a bullet. The head of list entries must be empty. |
|
.\" List entry bodies are justified after the bullet. |
|
.\" .It Fl column |
|
.\" A columnated list. The number of columns is specified as arguments to |
|
.\" the |
|
.\" .Sx \&Bl |
|
.\" macro (the deprecated form of following the invocation of |
|
.\" .Fl column |
|
.\" is also accepted). Arguments dictate the width of columns specified in |
|
.\" list entries. List entry bodies must be left empty. Columns specified |
|
.\" in the list entry head are justified to their position in the sequence |
|
.\" of columns. |
|
.\" .It Fl dash |
|
.\" A list offset by a dash (hyphen). The head of list entries must be |
|
.\" empty. List entry bodies are justified past the dash. |
|
.\" .It Fl diag |
|
.\" Like |
|
.\" .Fl inset |
|
.\" lists, but with additional formatting to the head. |
|
.\" .It Fl enum |
|
.\" A list offset by a number indicating list entry position. The head of |
|
.\" list entries must be empty. List entry bodies are justified past the |
|
.\" enumeration. |
|
.\" .It Fl hang |
|
.\" Like |
|
.\" .Fl tag , |
|
.\" but instead of list bodies justifying to the head on the first line, |
|
.\" they trail the head text. |
|
.\" .It Fl hyphen |
|
.\" Synonym for |
|
.\" .Fl dash . |
|
.\" .It Fl inset |
|
.\" Like |
|
.\" .Fl tag , |
|
.\" but list entry bodies aren't justified. |
|
.\" .It Fl item |
|
.\" An un-justified list. This produces blocks of text. |
|
.\" .It Fl ohang |
|
.\" List bodies are placed on the line following the head. |
|
.\" .It Fl tag |
|
.\" A list offset by list entry heads. List entry bodies are justified |
|
.\" after the head. |
|
.\" .El |
|
.\" .Pp |
|
.\" More... |
|
.\" . |
.Ss \&Bo |
.Ss \&Bo |
Begins a block enclosed by square brackets. Does not have any head |
Begins a block enclosed by square brackets. Does not have any head |
arguments. |
arguments. |
|
|
.Sx \&Bq . |
.Sx \&Bq . |
. |
. |
.Ss \&Bq |
.Ss \&Bq |
Encloses its arguments in square brackets. |
Encloses its arguments in square brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 1284 manual. Its calling syntax is as follows: |
|
Line 1389 manual. Its calling syntax is as follows: |
|
.Pp |
.Pp |
.D1 \. Ns Sx \&Dd Cm date |
.D1 \. Ns Sx \&Dd Cm date |
.Pp |
.Pp |
The |
The |
.Cm date |
.Cm date |
field may be either |
field may be either |
.Ar $\&Mdocdate$ , |
.Ar $\&Mdocdate$ , |
|
|
.Sx \&Dq . |
.Sx \&Dq . |
. |
. |
.Ss \&Dq |
.Ss \&Dq |
Encloses its arguments in double quotes. |
Encloses its arguments in double quotes. |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
|
|
.Ss \&Fc |
.Ss \&Fc |
.Ss \&Fd |
.Ss \&Fd |
.Ss \&Fl |
.Ss \&Fl |
|
Command-line flag. Used when listing arguments to command-line |
|
utilities. Prints a fixed-width hyphen |
|
.Sq \- |
|
before each delimited argument. If no arguments are provided, a hyphen |
|
is still printed. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Fl a b c |
|
\&.Fl |
|
\&.Op Fl o Ns Ar file |
|
.Ed |
|
.Pp |
|
See also |
|
.Sx \&Cm . |
|
. |
.Ss \&Fn |
.Ss \&Fn |
.Ss \&Fo |
.Ss \&Fo |
.Ss \&Fr |
.Ss \&Fr |
|
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
|
The comment syntax |
|
.Sq \e." |
|
is no longer accepted. |
|
.It |
|
In |
|
.Xr groff 1 , |
|
the |
|
.Sx \&Pa |
|
macro does not format its arguments when used in the FILES section under |
|
certain list types. This irregular behaviour has been discontinued. |
|
.It |
|
Historic |
|
.Xr groff 1 |
|
does not print a dash for empty |
|
.Sx \&Fl |
|
arguments. This behaviour has been discontinued. |
|
.It |
|
.Xr groff 1 |
|
behaves strangely (even between versions) when specifying |
|
.Sq \ef |
|
escapes within line-macro scopes. These aberrations have been |
|
normalised. |
|
.It |
Negative scaling units are now truncated to zero instead of creating |
Negative scaling units are now truncated to zero instead of creating |
interesting conditions, such as with |
interesting conditions, such as with |
.Sq \&sp -1i . |
.Sx \&sp |
|
.Fl 1i . |
Furthermore, the |
Furthermore, the |
.Sq f |
.Sq f |
scaling unit, while accepted, is rendered as the default unit. |
scaling unit, while accepted, is rendered as the default unit. |
Line 1804 standalone double-quote in formatted output. This idi |
|
Line 1949 standalone double-quote in formatted output. This idi |
|
behaviour is no longer applicable. |
behaviour is no longer applicable. |
.It |
.It |
Display types |
Display types |
.Sx \&Bd Fl center |
.Sx \&Bd |
|
.Fl center |
and |
and |
.Fl right |
.Fl right |
are aliases for |
are aliases for |
Line 1834 made historic groff |
|
Line 1980 made historic groff |
|
.Qq go orbital |
.Qq go orbital |
but is a proper delimiter in this implementation. |
but is a proper delimiter in this implementation. |
.It |
.It |
.Sx \&It Fl nested |
.Sx \&It |
|
.Fl nested |
is assumed for all lists (it wasn't in historic groff): any list may be |
is assumed for all lists (it wasn't in historic groff): any list may be |
nested and |
nested and |
.Fl enum |
.Fl enum |