version 1.42, 2009/10/31 08:37:26 |
version 1.43, 2009/11/02 06:22:45 |
Line 119 from input. These are later re-added, if applicable, |
|
Line 119 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 list indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.Bl -tag -width 2i |
|
.Ed |
|
. |
|
. |
|
.Ss Scaling Widths |
|
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: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.HP 2i |
\&.HP 2i |
|
|
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 614 subsequent sub-section, section, or end of file. The |
|
Line 631 subsequent sub-section, section, or end of file. The |
|
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 |
|
\&.TH title section [date [source [volume]]] |
|
.Ed |
|
. |
|
.Pp |
.Pp |
At least the |
.D1 \. Ns Sx \&TH No Cm title msec Op Cm date Op Cm src Op Cm vol |
.Va title |
.Pp |
and |
At least the upper-case document title |
.Va section |
.Cm title |
|
and numeric manual section |
|
.Cm msec |
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 src |
The |
|
.Va source |
|
string specifies the organisation providing the utility. The |
string specifies the organisation providing the utility. The |
.Va volume |
.Cm vol |
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: |
|
.Bd -literal -offset indent |
|
\&.TH CVS 5 "1992-02-12" GNU |
|
.Ed |
|
. |
.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 |