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.243

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

version 1.243, 2014/11/28 18:09:01

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 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 1383 where relevant, for example

Line 1385 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:

Line 1570 arguments are treated as separate utilities.

Line 1567 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 2510 Based on POSIX.1 and POSIX.2, published in 1992.

Line 2507 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 2557 The following refer to parts of it.

Line 2556 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

.Pp

Line 2577 POSIX software administration.

Line 2567 POSIX software administration.

.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 2586 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 2682 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 2707 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.