mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.289 and 1.290

version 1.289, 2022/01/13 08:42:15

version 1.290, 2024/05/20 18:15:57

Line 439 in the alphabetical

.Bl -column "Brq, Bro, Brc" description

.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 \&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 \&Nd Ta document description (one line)

.El

Line 2074 Examples:

See also

.Ic \&Oo .

.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

file.

Usually, do not specify any arguments,

in particular not the operating system name and/or version.

.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

uses its

prints its

.Fl Ios

argument or, if that isn't specified either,

argument in the page footer, or

.Fa sysname

and

.Fa release

as returned by

.Xr uname 3 .

.Xr uname 3

by default.

.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