version 1.80, 2010/07/26 10:00:03 |
version 1.90, 2010/12/05 16:14:16 |
Line 219 Documents are generally structured as follows: |
|
Line 219 Documents are generally structured as follows: |
|
\&.TH FOO 1 2009-10-10 |
\&.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 |
\&.\e\*q The next is for sections 2 & 3 only. |
|
\&.\e\*q .SH LIBRARY |
\&.\e\*q .SH LIBRARY |
|
\&.\e\*q For sections 2 & 3 only. |
|
\&.\e\*q Not used in OpenBSD. |
\&.SH SYNOPSIS |
\&.SH SYNOPSIS |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\&.SH DESCRIPTION |
\&.SH DESCRIPTION |
The \efBfoo\efR utility processes files... |
The \efBfoo\efR utility processes files... |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q Not used in OpenBSD. |
\&.\e\*q .SH RETURN VALUES |
\&.\e\*q .SH RETURN VALUES |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH ENVIRONMENT |
|
\&.\e\*q For sections 1, 6, 7, & 8 only. |
\&.\e\*q .SH FILES |
\&.\e\*q .SH FILES |
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
\&.\e\*q .SH EXIT STATUS |
|
\&.\e\*q For sections 1, 6, & 8 only. |
\&.\e\*q .SH EXAMPLES |
\&.\e\*q .SH EXAMPLES |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
|
\&.\e\*q .SH DIAGNOSTICS |
\&.\e\*q .SH DIAGNOSTICS |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q For sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH ERRORS |
|
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q .BR foo ( 1 ) |
\&.\e\*q .BR foo ( 1 ) |
\&.\e\*q .SH STANDARDS |
\&.\e\*q .SH STANDARDS |
Line 246 The \efBfoo\efR utility processes files... |
|
Line 248 The \efBfoo\efR utility processes files... |
|
\&.\e\*q .SH CAVEATS |
\&.\e\*q .SH CAVEATS |
\&.\e\*q .SH BUGS |
\&.\e\*q .SH BUGS |
\&.\e\*q .SH SECURITY CONSIDERATIONS |
\&.\e\*q .SH SECURITY CONSIDERATIONS |
|
\&.\e\*q Not used in OpenBSD. |
.Ed |
.Ed |
.Pp |
.Pp |
The sections in a |
The sections in a |
Line 338 If not adhering to any standards, the |
|
Line 341 If not adhering to any standards, the |
|
.Em HISTORY |
.Em HISTORY |
section should be used. |
section should be used. |
.It Em HISTORY |
.It Em HISTORY |
The history of any manual without a |
A brief history of the subject, including where support first appeared. |
.Em STANDARDS |
|
section should be described in this section. |
|
.It Em AUTHORS |
.It Em AUTHORS |
Credits to authors, if applicable, should appear in this section. |
Credits to the person or persons who wrote the code and/or documentation. |
Authors should generally be noted by both name and email address. |
Authors should generally be noted by both name and email address. |
.It Em CAVEATS |
.It Em CAVEATS |
Common misuses and misunderstandings should be explained |
Common misuses and misunderstandings should be explained |
Line 429 The syntax is as follows: |
|
Line 430 The syntax is as follows: |
|
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&r Ta 0 Ta current Ta compat |
.It Sx \&r Ta 0 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current Ta compat |
.\" .It Sx \&Sp Ta <1 Ta current Ta compat |
|
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
|
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
|
.El |
.El |
.Pp |
.Pp |
Macros marked as |
Macros marked as |
|
|
.Sx \&P , |
.Sx \&P , |
and |
and |
.Sx \&PP . |
.Sx \&PP . |
.\" . |
|
.\" . |
|
.\" .Ss \&PD |
|
.\" Has no effect. Included for compatibility. |
|
.\" . |
|
.\" . |
|
.Ss \&UC |
.Ss \&UC |
Sets the volume for the footer for compatibility with man pages from |
Sets the volume for the footer for compatibility with man pages from |
BSD releases. |
BSD releases. |
Line 896 Defaults to 1, if unspecified. |
|
Line 888 Defaults to 1, if unspecified. |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&br . |
.Sx \&br . |
.\" .Ss \&Sp |
|
.\" A synonym for |
|
.\" .Sx \&sp |
|
.\" .Cm 0.5v . |
|
.\" . |
|
.\" .Ss \&Vb |
|
.\" A synonym for |
|
.\" .Sx \&nf . |
|
.\" Accepts an argument (the height of the formatted space) which is |
|
.\" disregarded. |
|
.\" . |
|
.\" .Ss \&Ve |
|
.\" A synonym for |
|
.\" .Sx \&fi . |
|
.\" . |
|
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents areas of questionable portability between |
This section documents areas of questionable portability between |
implementations of the |
implementations of the |
|
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
The \es (font size), \em (font colour), and \eM (font filling colour) |
|
font decoration escapes are all discarded in mandoc. |
|
.It |
|
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
a standalone double-quote in formatted output. |
a standalone double-quote in formatted output. |
It is not known whether this behaviour is exhibited by other formatters. |
It is not known whether this behaviour is exhibited by other formatters. |
.It |
.It |
|
troff suppresses a newline before |
|
.Sq \(aq |
|
macro output; in mandoc, it is an alias for the standard |
|
.Sq \&. |
|
control character. |
|
.It |
The |
The |
|
.Sq \eh |
|
.Pq horizontal position , |
|
.Sq \ev |
|
.Pq vertical position , |
|
.Sq \em |
|
.Pq text colour , |
|
.Sq \eM |
|
.Pq text filling colour , |
|
.Sq \ez |
|
.Pq zero-length character , |
|
.Sq \ew |
|
.Pq string length , |
|
.Sq \ek |
|
.Pq horizontal position marker , |
|
.Sq \eo |
|
.Pq text overstrike , |
|
and |
|
.Sq \es |
|
.Pq text size |
|
escape sequences are all discarded in mandoc. |
|
.It |
|
The |
|
.Sq \ef |
|
scaling unit is accepted by mandoc, but rendered as the default unit. |
|
.It |
|
The |
.Sx \&sp |
.Sx \&sp |
macro does not accept negative values in mandoc. |
macro does not accept negative values in mandoc. |
In GNU troff, this would result in strange behaviour. |
In GNU troff, this would result in strange behaviour. |
.It |
|
The |
|
.Sq \(aq |
|
macro control character, in GNU troff (and prior troffs) suppresses a |
|
newline before macro output; in mandoc, it is an alias for the standard |
|
.Sq \&. |
|
control character. |
|
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 , |
|
.Xr mdoc 7 |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm |
.Nm |