version 1.232, 2014/07/13 10:24:40 |
version 1.233, 2014/08/08 01:52:40 |
|
|
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.Ss \&Dd |
.Ss \&Dd |
Document date. |
Document date for display in the page footer. |
This is the mandatory first macro of any |
This is the mandatory first macro of any |
.Nm |
.Nm |
manual. |
manual. |
Line 1224 the special string |
|
Line 1224 the special string |
|
.Dq $\&Mdocdate$ |
.Dq $\&Mdocdate$ |
can be given as an argument. |
can be given as an argument. |
.It |
.It |
A few alternative date formats are accepted as well |
The traditional, purely numeric |
and converted to the standard form. |
.Xr man 7 |
|
format |
|
.Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day |
|
is accepted, too. |
.It |
.It |
If a date string cannot be parsed, it is used verbatim. |
If a date string cannot be parsed, it is used verbatim. |
.It |
.It |
|
|
and |
and |
.Sx \&Do . |
.Sx \&Do . |
.Ss \&Dt |
.Ss \&Dt |
Document title. |
Document title for display in the page header. |
This is the mandatory second macro of any |
This is the mandatory second macro of any |
.Nm |
.Nm |
file. |
file. |
Its syntax is as follows: |
Its syntax is as follows: |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Pf \. Sx \&Dt |
.Pf \. Sx \&Dt |
.Oo |
.Ar TITLE |
.Ar title |
|
.Oo |
|
.Ar section |
.Ar section |
.Op Ar volume |
.Op Ar volume | arch |
.Op Ar arch |
|
.Oc |
|
.Oc |
|
.Ed |
.Ed |
.Pp |
.Pp |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds -offset Ds |
.Bl -tag -width section -offset 2n |
.It Ar title |
.It Ar TITLE |
The document's title (name), defaulting to |
The document's title (name), defaulting to |
.Dq UNKNOWN |
.Dq UNTITLED |
if unspecified. |
if unspecified. |
It should be capitalised. |
To achieve a uniform appearance of page header lines, |
|
it should by convention be all caps. |
.It Ar section |
.It Ar section |
The manual section. |
The manual section. |
This may be one of |
This may be one of |
|
|
.Cm paper |
.Cm paper |
.Pq paper . |
.Pq paper . |
It should correspond to the manual's filename suffix and defaults to |
It should correspond to the manual's filename suffix and defaults to |
.Cm 1 |
the empty string if unspecified. |
if unspecified. |
|
.It Ar volume |
.It Ar volume |
This overrides the volume inferred from |
This overrides the volume inferred from |
.Ar section . |
.Ar section . |
|
|
See also |
See also |
.Sx \&Oo . |
.Sx \&Oo . |
.Ss \&Os |
.Ss \&Os |
Document operating system version. |
Operating system version for display in the page footer. |
This is the mandatory third macro of |
This is the mandatory third macro of |
any |
any |
.Nm |
.Nm |