mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.235 and 1.247

version 1.235, 2014/08/14 20:57:19

version 1.247, 2014/12/31 20:42:31

Line 388 See

References other manuals with related topics.

This section should exist for most manuals.

Cross-references should conventionally be ordered first by section, then

alphabetically.

alphabetically (ignoring case).

.Pp

References to other documentation concerning the topic of the manual page,

for example authoritative books or journal articles, may also be

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 1245 See also

Line 1247 See also

and

.Sx \&Os .

.Ss \&Dl

One-line intended display.

One-line indented display.

This is formatted as literal text and is useful for commands and

invocations.

It is followed by a newline.

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

See also

Line 1570 arguments are treated as separate utilities.

Line 1525 arguments are treated as separate utilities.

See also

.Sx \&Rv .

.Ss \&Fa

Function argument.

Function argument or parameter.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Fa

Line 2133 Its syntax is as follows:

Line 2088 Its syntax is as follows:

The optional

.Ar system

parameter specifies the relevant operating system or environment.

Left unspecified, it defaults to the local operating system version.

It is suggested to leave it unspecified, in which case

This is the suggested form.

.Xr mandoc 1

uses its

.Fl Ios

argument, or, if that isn't specified either,

.Fa sysname

and

.Fa release

as returned by

.Xr uname 3 .

.Pp

Examples:

.Dl \&.Os

Line 2238 See also

Line 2201 See also

Close quoted context opened by

.Sx \&Qo .

.Ss \&Ql

Format a single-quoted literal.

Request a literal font and enclose in single quotes.

For arguments of three or more characters, formatters other than

.Xr mandoc 1

usually omit the quotes on non-terminal output devices.

See also

.Sx \&Qq

.Sx \&Li

and

.Sx \&Sq .

.Ss \&Qo

Line 2429 The original C standard.

Line 2395 The original C standard.

.Pp

.It \-isoC-99

.St -isoC-99

.It \-ansiC-99

.St -ansiC-99

.br

The second major version of the C language standard.

.Pp

Line 2510 Based on POSIX.1 and POSIX.2, published in 1992.

Line 2474 Based on POSIX.1 and POSIX.2, published in 1992.

.It Single UNIX Specification version 1 and related standards

.Pp

.Bl -tag -width "-p1003.1g-2000" -compact

.It \-susv1

.St -susv1

.It \-xpg4.2

.St -xpg4.2

.br

This standard was published in 1994 and is also called SUSv1.

This standard was published in 1994.

It was used as the basis for UNIX 95 certification.

The following three refer to parts of it.

.Pp

Line 2528 The following three refer to parts of it.

Line 2494 The following three refer to parts of it.

.br

Networking APIs, including sockets.

.Pp

.It \-xpg4.3

.St -xpg4.3

.Pp

.It \-svid4

.St -svid4 ,

.br

Line 2557 The following refer to parts of it.

Line 2520 The following refer to parts of it.

.Pp

.It \-xns5

.St -xns5

.It \-xns5.2d2.0

.St -xns5.2d2.0

.It \-xns5.2

.St -xns5.2

.Pp

.It \-p1387.2

.St -p1387.2

.It \-p1387.2-95

.St -p1387.2-95

.br

POSIX software administration.

.El

.It Single UNIX Specification version 3 and related standards

.It Single UNIX Specification version 3

.Pp

.Bl -tag -width "-p1003.1g-2000X" -compact

.Bl -tag -width "-p1003.1-2001" -compact

.It \-p1003.1d-99

.St -p1003.1d-99

.br

Additional real-time extensions.

.Pp

.It \-p1003.1j-2000

.St -p1003.1j-2000

.br

Advanced real-time extensions.

.Pp

.It \-p1003.1q-2000

.St -p1003.1q-2000

.br

Amendment 7: Tracing [C Language].

.Pp

.It \-p1003.1-2001

.St -p1003.1-2001

.It \-susv3

Line 2606 The second and last Technical Corrigendum.

Line 2545 The second and last Technical Corrigendum.

.Bl -tag -width "-p1003.1g-2000" -compact

.It \-p1003.1-2008

.St -p1003.1-2008

.It \-susv4

.St -susv4

.br

This standard is also called SUSv4 and

This standard is also called

X/Open Portability Guide version 7.

.Pp

.It \-p1003.1-2013

Line 2700 A variable name.

Line 2641 A variable name.

Examples:

.Dl \&.Va foo

.Dl \&.Va const char *bar ;

.Pp

For function arguments and parameters, use

.Sx \&Fa

instead.

For declarations of global variables in the

.Em SYNOPSIS

section, use

.Sx \&Vt .

.Ss \&Vt

A variable type.

.Pp

This is also used for indicating global variables in the

.Em SYNOPSIS

section, in which case a variable name is also specified.

Line 2716 In the former case, this macro starts a new output lin

Line 2666 In the former case, this macro starts a new output lin

and a blank line is inserted in front if there is a preceding

function definition or include directive.

.Pp

Note that this should not be confused with

.Sx \&Ft ,

which is used for function return types.

.Pp

Examples:

.Dl \&.Vt unsigned char

.Dl \&.Vt extern const char * const sys_signame[] \&;

.Pp

For parameters in function prototypes, use

.Sx \&Fa

instead, for function return types

.Sx \&Ft ,

and for variable names outside the

.Em SYNOPSIS

section

.Sx \&Va ,

even when including a type with the name.

See also

.Sx MANUAL STRUCTURE

.Sx MANUAL STRUCTURE .

and

.Sx \&Va .

.Ss \&Xc

Close a scope opened by

.Sx \&Xo .

CVSweb