version 1.289, 2022/01/13 08:42:15 |
version 1.291, 2024/05/20 18:44:34 |
Line 439 in the alphabetical |
|
Line 439 in the alphabetical |
|
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
.It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
.It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch |
.It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch |
.It Ic \&Os Ta operating system version: Op Ar system Op Ar version |
.It Ic \&Os Ta operating system footer: Op Ar footer text |
.It Ic \&Nm Ta document name (one argument) |
.It Ic \&Nm Ta document name (one argument) |
.It Ic \&Nd Ta document description (one line) |
.It Ic \&Nd Ta document description (one line) |
.El |
.El |
Line 1015 A numbered list. |
|
Line 1015 A numbered list. |
|
No item heads can be specified. |
No item heads can be specified. |
Formatted like |
Formatted like |
.Fl bullet , |
.Fl bullet , |
except that cardinal numbers are used in place of bullets, |
except that ordinal numbers are used in place of bullets, |
starting at 1. |
starting at 1. |
.It Fl hang |
.It Fl hang |
Like |
Like |
|
|
See also |
See also |
.Ic \&Oo . |
.Ic \&Oo . |
.Tg Os |
.Tg Os |
.It Ic \&Os Op Ar system Op Ar version |
.It Ic \&Os Op Ar footer text |
Operating system version for display in the page footer. |
The mandatory third macro of every |
This is the mandatory third macro of |
|
any |
|
.Nm |
.Nm |
file. |
file. |
|
Usually, do not specify any arguments, |
|
in particular not the operating system name and/or version. |
.Pp |
.Pp |
The optional |
If no argument is given, |
.Ar system |
|
parameter specifies the relevant operating system or environment. |
|
It is suggested to leave it unspecified, in which case |
|
.Xr mandoc 1 |
.Xr mandoc 1 |
uses its |
prints its |
.Fl Ios |
.Fl Ios |
argument or, if that isn't specified either, |
argument in the page footer, or |
.Fa sysname |
.Fa sysname |
and |
and |
.Fa release |
.Fa release |
as returned by |
as returned by |
.Xr uname 3 . |
.Xr uname 3 |
|
by default. |
.Pp |
.Pp |
Examples: |
Manual pages that are part of a portable software project can override |
.Dl \&.Os |
the default by giving the project name and version number as arguments, |
.Dl \&.Os KTH/CSC/TCS |
but leaving it blank is never a bad choice. |
.Dl \&.Os BSD 4.3 |
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Dd |
.Ic \&Dd |