mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.172 and 1.173

version 1.172, 2010/12/27 20:39:46

version 1.173, 2010/12/29 16:16:50

Line 125 Terms may be text-decorated using the

escape followed by an indicator: B (bold), I (italic), R (Roman), or P

(revert to previous mode):

.Pp

.D1 \efBbold\efR \efIitalic\efP

.Dl \efBbold\efR \efIitalic\efP

.Pp

A numerical representation 3, 2, or 1 (bold, italic, and Roman,

respectively) may be used instead.

Line 293 The proper spacing is also intelligently preserved if

the boundary of a macro line.

For example:

.Pp

.D1 \&Xr mandoc 1 \.

.Dl \&Xr mandoc 1 \.

.D1 \&Fl T \&Ns \&Cm ascii \.

.Dl \&Fl T \&Ns \&Cm ascii \.

.Sh MANUAL STRUCTURE

A well-formed

.Nm

Line 939 Memory address.

Do not use this for postal addresses.

.Pp

Examples:

.D1 \&.Ad [0,$]

.Dl \&.Ad [0,$]

.D1 \&.Ad 0x00000000

.Dl \&.Ad 0x00000000

.Ss \&An

Author name.

Requires either the name of an author or one of the following arguments:

Line 970 for the first author listing and

for all other author listings.

.Pp

Examples:

.D1 \&.An -nosplit

.Dl \&.An -nosplit

.D1 \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv

.Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv

.Ss \&Ao

Begin a block enclosed by angle brackets.

Does not have any head arguments.

.Pp

Examples:

.D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac

.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac

.Pp

See also

.Sx \&Aq .

Line 987 This is generally used as a grammatical device when re

form of a function.

.Pp

Examples:

.D1 \&.Fn execve \&Ap d

.Dl \&.Fn execve \&Ap d

.Ss \&Aq

Encloses its arguments in angle brackets.

.Pp

Examples:

.D1 \&.Fl -key= \&Ns \&Aq \&Ar val

.Dl \&.Fl -key= \&Ns \&Aq \&Ar val

.Pp

.Em Remarks :

this macro is often abused for rendering URIs, which should instead use

Line 1013 If an argument is not provided, the string

is used as a default.

.Pp

Examples:

.D1 \&.Fl o \&Ns \&Ar file1

.Dl \&.Fl o \&Ns \&Ar file1

.D1 \&.Ar

.Dl \&.Ar

.D1 \&.Ar arg1 , arg2 .

.Dl \&.Ar arg1 , arg2 .

.Ss \&At

Formats an AT&T version.

Accepts one optional argument:

Line 1032 A version of

Note that these arguments do not begin with a hyphen.

.Pp

Examples:

.D1 \&.At

.Dl \&.At

.D1 \&.At V.1

.Dl \&.At V.1

.Pp

See also

.Sx \&Bsx ,

Line 1336 See also

Encloses its arguments in square brackets.

.Pp

Examples:

.D1 \&.Bq 1 , \&Dv BUFSIZ

.Dl \&.Bq 1 , \&Dv BUFSIZ

.Pp

.Em Remarks :

this macro is sometimes abused to emulate optional arguments for

Line 1369 See also

Encloses its arguments in curly braces.

.Pp

Examples:

.D1 \&.Brq 1 , ... , \&Va n

.Dl \&.Brq 1 , ... , \&Va n

.Pp

See also

.Sx \&Bro .

Line 1378 Format the BSD/OS version provided as an argument, or

no argument is provided.

.Pp

Examples:

.D1 \&.Bsx 1.0

.Dl \&.Bsx 1.0

.D1 \&.Bsx

.Dl \&.Bsx

.Pp

See also

.Sx \&At ,

Line 1398 Format the BSD version provided as an argument, or a d

argument is provided.

.Pp

Examples:

.D1 \&.Bx 4.4

.Dl \&.Bx 4.4

.D1 \&.Bx

.Dl \&.Bx

.Pp

See also

.Sx \&At ,

Line 1416 This denotes strings accepted by

.Xr config 8 .

.Pp

Examples:

.D1 \&.Cd device le0 at scode?

.Dl \&.Cd device le0 at scode?

.Pp

.Em Remarks :

this macro is commonly abused by using quoted literals to retain

Line 1429 Command modifiers.

Useful when specifying configuration options or keys.

.Pp

Examples:

.D1 \&.Cm ControlPath

.Dl \&.Cm ControlPath

.D1 \&.Cm ControlMaster

.Dl \&.Cm ControlMaster

.Pp

See also

.Sx \&Fl .

Line 1441 statements.

It is followed by a newline.

.Pp

Examples:

.D1 \&.D1 \&Fl abcdefgh

.Dl \&.D1 \&Fl abcdefgh

.Pp

See also

.Sx \&Bd

Line 1480 or instead a valid canonical date as specified by

If a date does not conform or is empty, the current date is used.

.Pp

Examples:

.D1 \&.Dd $\&Mdocdate$

.Dl \&.Dd $\&Mdocdate$

.D1 \&.Dd $\&Mdocdate: July 21 2007$

.Dl \&.Dd $\&Mdocdate: July 21 2007$

.D1 \&.Dd July 21, 2007

.Dl \&.Dd July 21, 2007

.Pp

See also

.Sx \&Dt

Line 1495 invocations.

It is followed by a newline.

.Pp

Examples:

.D1 \&.Dl % mandoc mdoc.7 \e(ba less

.Dl \&.Dl % mandoc mdoc.7 \e(ba less

.Pp

See also

.Sx \&Bd

Line 1663 or

.El

.Pp

Examples:

.D1 \&.Dt FOO 1

.Dl \&.Dt FOO 1

.D1 \&.Dt FOO 4 KM

.Dl \&.Dt FOO 4 KM

.D1 \&.Dt FOO 9 i386

.Dl \&.Dt FOO 9 i386

.Pp

See also

.Sx \&Dd

Line 1675 and

Defined variables such as preprocessor constants.

.Pp

Examples:

.D1 \&.Dv BUFSIZ

.Dl \&.Dv BUFSIZ

.D1 \&.Dv STDOUT_FILENO

.Dl \&.Dv STDOUT_FILENO

.Pp

See also

.Sx \&Er .

Line 1685 Format the DragonFly BSD version provided as an argume

value if no argument is provided.

.Pp

Examples:

.D1 \&.Dx 2.4.1

.Dl \&.Dx 2.4.1

.D1 \&.Dx

.Dl \&.Dx

.Pp

See also

.Sx \&At ,

Line 1732 Note that this is a presentation term and should not b

stylistically decorating technical terms.

.Pp

Examples:

.D1 \&.Em Warnings!

.Dl \&.Em Warnings!

.D1 \&.Em Remarks :

.Dl \&.Em Remarks :

.Pp

See also

.Sx \&Bf ,

Line 1758 will emulate

Display error constants.

.Pp

Examples:

.D1 \&.Er EPERM

.Dl \&.Er EPERM

.D1 \&.Er ENOENT

.Dl \&.Er ENOENT

.Pp

See also

.Sx \&Dv .

Line 1770 Environmental variables such as those specified in

.Xr environ 7 .

.Pp

Examples:

.D1 \&.Ev DISPLAY

.Dl \&.Ev DISPLAY

.D1 \&.Ev PATH

.Dl \&.Ev PATH

.Ss \&Ex

Insert a standard sentence regarding exit values.

Its syntax is as follows:

Line 1811 Furthermore, if the following macro is another

the last argument will also have a trailing comma.

.Pp

Examples:

.D1 \&.Fa \(dqconst char *p\(dq

.Dl \&.Fa \(dqconst char *p\(dq

.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq

.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq

.D1 \&.Fa foo

.Dl \&.Fa foo

.Pp

See also

.Sx \&Fo .

Line 1841 If the argument is a macro, a hyphen is prefixed to th

output.

.Pp

Examples:

.D1 \&.Fl a b c

.Dl \&.Fl a b c

.D1 \&.Fl \&Pf a b

.Dl \&.Fl \&Pf a b

.D1 \&.Fl

.Dl \&.Fl

.D1 \&.Op \&Fl o \&Ns \&Ar file

.Dl \&.Op \&Fl o \&Ns \&Ar file

.Pp

See also

.Sx \&Cm .

Line 1863 are delimited by commas.

If no arguments are specified, blank parenthesis are output.

.Pp

Examples:

.D1 \&.Fn "int funcname" "int arg0" "int arg1"

.Dl \&.Fn "int funcname" "int arg0" "int arg1"

.D1 \&.Fn funcname "int arg0"

.Dl \&.Fn funcname "int arg0"

.D1 \&.Fn funcname arg0

.Dl \&.Fn funcname arg0

.Bd -literal -offset indent -compact

\&.Ft functype

\&.Fn funcname

Line 1916 Its syntax is as follows:

.D1 Pf \. Sx \&Ft Cm functype

.Pp

Examples:

.D1 \&.Ft int

.Dl \&.Ft int

.Bd -literal -offset indent -compact

\&.Ft functype

\&.Fn funcname

Line 1934 version provided as an argument, or a default value

if no argument is provided.

.Pp

Examples:

.D1 \&.Fx 7.1

.Dl \&.Fx 7.1

.D1 \&.Fx

.Dl \&.Fx

.Pp

See also

.Sx \&At ,

Line 1955 This is similar to

but used for instructions rather than values.

.Pp

Examples:

.D1 \&.Ic hash

.Dl \&.Ic hash

.D1 \&.Ic alias

.Dl \&.Ic alias

.Pp

Note that using

.Sx \&Bd Fl literal

Line 1977 preceded by

the arguments is enclosed in angle brackets.

.Pp

Examples:

.D1 \&.In sys/types

.Dl \&.In sys/types

.Pp

See also

.Sx MANUAL STRUCTURE .

Line 2057 phrases on an

.Sx \&It ,

for example,

.Pp

.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&;

.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;

.Pp

will preserve the semicolon whitespace except for the last.

.Pp

Line 2084 section as described in

.Sx MANUAL STRUCTURE .

.Pp

Examples:

.D1 \&.Lb libz

.Dl \&.Lb libz

.D1 \&.Lb mdoc

.Dl \&.Lb mdoc

.Ss \&Li

Denotes text that should be in a literal font mode.

Note that this is a presentation term and should not be used for

Line 2103 Its syntax is as follows:

.D1 Pf \. Sx \&Lk Cm uri Op Cm name

.Pp

Examples:

.D1 \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q

.Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q

.D1 \&.Lk http://bsd.lv

.Dl \&.Lk http://bsd.lv

.Pp

See also

.Sx \&Mt .

Line 2118 Its syntax is as follows:

.D1 Pf \. Sx \&Ms Cm symbol

.Pp

Examples:

.D1 \&.Ms sigma

.Dl \&.Ms sigma

.D1 \&.Ms aleph

.Dl \&.Ms aleph

.Ss \&Mt

Format a

.Dq mailto:

Line 2129 Its syntax is as follows:

.D1 Pf \. Sx \&Mt Cm address

.Pp

Examples:

.D1 \&.Mt discuss@manpages.bsd.lv

.Dl \&.Mt discuss@manpages.bsd.lv

.Ss \&Nd

A one line description of the manual's content.

This may only be invoked in the

Line 2139 section subsequent the

macro.

.Pp

Examples:

.D1 \&.Sx \&Nd mdoc language reference

.Dl \&.Sx \&Nd mdoc language reference

.D1 \&.Sx \&Nd format and display UNIX manuals

.Dl \&.Sx \&Nd format and display UNIX manuals

.Pp

The

.Sx \&Nd

Line 2197 A

macro used to terminate prior macro contexts.

.Pp

Examples:

.D1 \&.Sx \&Fl ab \&No cd \&Fl ef

.Dl \&.Sx \&Fl ab \&No cd \&Fl ef

.Ss \&Ns

Suppress a space.

Following invocation, text is interpreted as free-form text until a

macro is encountered.

.Pp

Examples:

.D1 \&.Fl o \&Ns \&Ar output

.Dl \&.Fl o \&Ns \&Ar output

.Pp

See also

.Sx \&No

Line 2217 version provided as an argument, or a default value if

no argument is provided.

.Pp

Examples:

.D1 \&.Nx 5.01

.Dl \&.Nx 5.01

.D1 \&.Nx

.Dl \&.Nx

.Pp

See also

.Sx \&At ,

Line 2249 Used when listing options to command-line utilities.

Prints the argument(s) in brackets.

.Pp

Examples:

.D1 \&.Op \&Fl a \&Ar b

.Dl \&.Op \&Fl a \&Ar b

.D1 \&.Op \&Ar a | b

.Dl \&.Op \&Ar a | b

.Pp

See also

.Sx \&Oo .

Line 2271 Left unspecified, it defaults to the local operating s

This is the suggested form.

.Pp

Examples:

.D1 \&.Os

.Dl \&.Os

.D1 \&.Os KTH/CSC/TCS

.Dl \&.Os KTH/CSC/TCS

.D1 \&.Os BSD 4.3

.Dl \&.Os BSD 4.3

.Pp

See also

.Sx \&Dd

Line 2291 version provided as an argument, or a default value

if no argument is provided.

.Pp

Examples:

.D1 \&.Ox 4.5

.Dl \&.Ox 4.5

.D1 \&.Ox

.Dl \&.Ox

.Pp

See also

.Sx \&At ,

Line 2310 If an argument is not provided, the string

is used as a default.

.Pp

Examples:

.D1 \&.Pa /usr/bin/mandoc

.Dl \&.Pa /usr/bin/mandoc

.D1 \&.Pa /usr/share/man/man7/mdoc.7

.Dl \&.Pa /usr/share/man/man7/mdoc.7

.Pp

See also

.Sx \&Lk .

Line 2331 The

argument may be a macro.

.Pp

Examples:

.D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix

.Dl \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix

.Ss \&Po

Multi-line version of

.Sx \&Pq .

Line 2591 The referenced section or sub-section name must be ide

enclosed argument, including whitespace.

.Pp

Examples:

.D1 \&.Sx MANUAL STRUCTURE

.Dl \&.Sx MANUAL STRUCTURE

.Pp

See also

.Sx \&Sh

Line 2612 and

Format a tradename.

.Pp

Examples:

.D1 \&.Tn IBM

.Dl \&.Tn IBM

.Ss \&Ud

Prints out

.Dq currently under development .

Line 2621 Format the UNIX name.

Accepts no argument.

.Pp

Examples:

.D1 \&.Ux

.Dl \&.Ux

.Pp

See also

.Sx \&At ,

Line 2636 and

A variable name.

.Pp

Examples:

.D1 \&.Va foo

.Dl \&.Va foo

.D1 \&.Va const char *bar ;

.Dl \&.Va const char *bar ;

.Ss \&Vt

A variable type.

This is also used for indicating global variables in the

Line 2656 Note that this should not be confused with

which is used for function return types.

.Pp

Examples:

.D1 \&.Vt unsigned char

.Dl \&.Vt unsigned char

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

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

.Pp

See also

.Sx MANUAL STRUCTURE

Line 2695 This behaviour is for compatibility with

GNU troff.

.Pp

Examples:

.D1 \&.Xr mandoc 1

.Dl \&.Xr mandoc 1

.D1 \&.Xr mandoc 1 \&;

.Dl \&.Xr mandoc 1 \&;

.D1 \&.Xr mandoc 1 \&Ns s behaviour

.Dl \&.Xr mandoc 1 \&Ns s behaviour

.Ss \&br

Emits a line-break.

This macro should not be used; it is implemented for compatibility with

CVSweb