mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.239 and 1.246

version 1.239, 2014/10/20 17:59:20

version 1.246, 2014/12/28 15:23:33

Line 433 in the alphabetical

.Ss Document preamble and NAME section macros

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

.It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year

.It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch

.It Sx \&Dt Ta document title: Ar TITLE section Op Ar arch

.It Sx \&Os Ta operating system version: Op Ar system Op Ar version

.It Sx \&Nm Ta document name (one argument)

.It Sx \&Nd Ta document description (one line)

Line 937 The

.Fl width

and

.Fl offset

arguments accept scaling widths as described in

arguments accept macro names as described for

.Xr roff 7

.Sx \&Bd

.Fl offset ,

scaling widths as described in

.Xr roff 7 ,

or use the length of the given string.

The

.Fl offset

Line 1182 See also

Line 1185 See also

and

.Sx \&Dl .

.Ss \&Db

Switch debugging mode.

This macro is obsolete.

Its syntax is as follows:

No replacement is needed.

.Pp

It is ignored by

.D1 Pf \. Sx \&Db Cm on | off

.Xr mandoc 1

.Pp

and groff including its arguments.

This macro is ignored by

It was formerly used to toggle a debugging mode.

.Xr mandoc 1 .

.Ss \&Dc

Close a

.Sx \&Do

Line 1297 Its syntax is as follows:

Line 1299 Its syntax is as follows:

.Pf \. Sx \&Dt

.Ar TITLE

.Ar section

.Op Ar volume | arch

.Op Ar arch

.Ed

.Pp

Its arguments are as follows:

Line 1312 it should by convention be all caps.

Line 1314 it should by convention be all caps.

The manual section.

This may be one of

.Cm 1

.Pq utilities ,

.Pq General Commands ,

.Cm 2

.Pq system calls ,

.Pq System Calls ,

.Cm 3

.Pq libraries ,

.Pq Library Functions ,

.Cm 3p

.Pq Perl libraries ,

.Pq Perl Library ,

.Cm 4

.Pq devices ,

.Pq Device Drivers ,

.Cm 5

.Pq file formats ,

.Pq File Formats ,

.Cm 6

.Pq games ,

.Pq Games ,

.Cm 7

.Pq miscellaneous ,

.Pq Miscellaneous Information ,

.Cm 8

.Pq system utilities ,

.Pq System Manager's Manual ,

.Cm 9

.Pq kernel functions ,

.Cm X11

.Pq X Window System ,

.Cm X11R6

.Pq X Window System ,

.Cm unass

.Pq unassociated ,

.Cm local

.Pq local system ,

.Cm draft

.Pq draft manual ,

.Cm paper

.Cm 9

.Pq paper .

.Pq Kernel Developer's Manual .

It should correspond to the manual's filename suffix and defaults to

the empty string if unspecified.

.It Ar volume

This overrides the volume inferred from

.Ar section .

This field is optional, and if specified, must be one of

.Cm USD

.Pq users' supplementary documents ,

.Cm PS1

.Pq programmers' supplementary documents ,

.Cm AMD

.Pq administrators' supplementary documents ,

.Cm SMM

.Pq system managers' manuals ,

.Cm URM

.Pq users' reference manuals ,

.Cm PRM

.Pq programmers' reference manuals ,

.Cm KM

.Pq kernel manuals ,

.Cm IND

.Pq master index ,

.Cm MMI

.Pq master index ,

.Cm LOCAL

.Pq local manuals ,

.Cm LOC

.Pq local manuals ,

.Cm CON

.Pq contributed manuals .

.It Ar arch

This specifies the machine architecture a manual page applies to,

where relevant, for example

Line 1383 where relevant, for example

Line 1344 where relevant, for example

.Cm i386 ,

.Cm sparc64 .

The list of supported architectures varies by operating system.

The list of valid architectures varies by operating system.

For the full list of all architectures recognized by

.Xr mandoc 1 ,

see the file

.Pa arch.in

in the source distribution.

.El

.Pp

Examples:

.Dl \&.Dt FOO 1

.Dl \&.Dt FOO 4 KM

.Dl \&.Dt FOO 9 i386

.Pp