mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.255 and 1.270

version 1.255, 2015/09/24 18:41:22

version 1.270, 2017/10/23 13:54:41

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 304 Print verbose information.

\&.El

.Ed

.Pp

List the options in alphabetical order,

uppercase before lowercase for each letter and

with no regard to whether an option takes an argument.

Put digits in ascending order before all letter options.

.Pp

Manuals not documenting a command won't include the above fragment.

.Pp

Since the

Line 471 in the alphabetical

Line 476 in the alphabetical

.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)

.It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off

.It Sx \&Bk , \&Ek Ta keep block: Fl words

.It Sx \&br Ta force output line break in text mode (no arguments)

.It Sx \&sp Ta force vertical space: Op Ar height

.El

.Ss Semantic markup for command line utilities:

.Ss Semantic markup for command line utilities

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

.It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility

.It Sx \&Fl Ta command line options (flags) (>=0 arguments)

Line 485 in the alphabetical

Line 488 in the alphabetical

.It Sx \&Ev Ta environmental variable (>0 arguments)

.It Sx \&Pa Ta file system path (>=0 arguments)

.El

.Ss Semantic markup for function libraries:

.Ss Semantic markup for function libraries

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

.It Sx \&Lb Ta function library (one argument)

.It Sx \&In Ta include file (one argument)

Line 506 in the alphabetical

Line 509 in the alphabetical

.It Sx \&Er Ta error constant (>0 arguments)

.It Sx \&Ev Ta environmental variable (>0 arguments)

.El

.Ss Various semantic markup:

.Ss Various semantic markup

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

.It Sx \&An Ta author name (>0 arguments)

.It Sx \&Lk Ta hyperlink: Ar uri Op Ar name

Line 671 Examples:

Line 674 Examples:

.Ss \&Ao

Begin a block enclosed by angle brackets.

Does not have any head arguments.

.Pp

This macro is almost never useful.

Examples:

See

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

.Sx \&Aq

.Pp

for more details.

See also

.Sx \&Aq .

.Ss \&Ap

Inserts an apostrophe without any surrounding whitespace.

This is generally used as a grammatical device when referring to the verb

Line 686 Examples:

Line 687 Examples:

.Dl \&.Fn execve \&Ap d

.Ss \&Aq

Encloses its arguments in angle brackets.

The only important use case is for email addresses.

See

.Sx \&Mt

for an example.

.Pp

Examples:

Occasionally, it is used for names of characters and keys, for example:

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

.Bd -literal -offset indent

Press the

\&.Aq escape

key to ...

.Ed

.Pp

.Em Remarks :

For URIs, use

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

.Sx \&Lk

instead, and

.Sx \&In

for

.Dq #include

directives.

Never wrap

.Sx \&Ar

.Sx \&Aq .

.Pp

Since

.Sx \&Aq

usually renders with non-ASCII characters in non-ASCII output modes,

do not use it where the ASCII characters

.Sq <

and

.Sq >

are required as syntax elements.

Instead, use these characters directly in such cases, combining them

with the macros

.Sx \&Pf ,

.Sx \&Ns ,

.Sx \&Mt ,

.Sx \&Eo

or to note pre-processor

as needed.

.Dq Li #include

statements, which should use

.Sx \&In .

.Pp

See also

.Sx \&Ao .

Line 732 A version of

Line 759 A version of

.At .

.It Cm III

.At III .

.It Cm V[.[1-4]]?

.It Cm V | V.[1-4]

A version of

.At V .

.El

Line 969 argument.

Line 996 argument.

A columnated list.

The

.Fl width

argument has no effect; instead, each argument specifies the width

argument has no effect; instead, the string length of each argument

of one column, using either the scaling width syntax described in

specifies the width of one column.

.Xr roff 7

or the string length of the argument.

If the first line of the body of a

.Fl column

list is not an

Line 1826 The

Line 1851 The

list is the most complicated.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...

.D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...

.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...

.Pp

The arguments consist of one or more lines of text and macros

representing a complete table line.

Cells within the line are delimited by tabs or by the special

Cells within the line are delimited by the special

.Sx \&Ta

block macro.

block macro or by literal tab characters.

.Pp

Using literal tabs is strongly discouraged because they are very

hard to use correctly and

.Nm

code using them is very hard to read.

In particular, a blank character is syntactically significant

before and after the literal tab character.

If a word precedes or follows the tab without an intervening blank,

that word is never interpreted as a macro call, but always output

literally.

.Pp

The tab cell delimiter may only be used within the

.Sx \&It

line itself; on following lines, only the

.Sx \&Ta

macro can be used to delimit cells, and

macro can be used to delimit cells, and portability requires that

.Sx \&Ta

is only recognised as a macro when called by other macros,

is called by other macros: some parsers do not recognize it when

not as the first macro on a line.

it appears as the first macro on a line.

.Pp

Note that quoted strings may span tab-delimited cells on an

.Sx \&It

line.

For example,

.Pp

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

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

.Pp

will preserve the semicolon whitespace except for the last.

will preserve the whitespace before both commas,

but not the whitespace before the semicolon.

.Pp

See also

.Sx \&Bl .

Line 2155 See also

Line 2192 See also

Close parenthesised context opened by

.Sx \&Po .

.Ss \&Pf

Removes the space between its argument

Removes the space between its argument and the following macro.

.Pq Dq prefix

and the following macro.

Its syntax is as follows:

.Pp

.D1 .Pf Ar prefix macro arguments ...

.Pp

This is equivalent to:

.Pp

.D1 .No Ar prefix No \&Ns Ar macro arguments ...

.D1 .No \e& Ns Ar prefix No \&Ns Ar macro arguments ...

.Pp

The

.Ar prefix

argument is not parsed for macro names or delimiters,

but used verbatim as if it were escaped.

.Pp

Examples:

.Dl ".Pf $ Ar variable_name"

.Dl ".Pf . Ar macro_name"

.Dl ".Pf 0x Ar hex_digits"

.Pp

See also

Line 2558 The second and last Technical Corrigendum.

Line 2599 The second and last Technical Corrigendum.

.br

This standard is also called

X/Open Portability Guide version 7.

.Pp

.It \-p1003.1-2013

.St -p1003.1-2013

.br

This is the first Technical Corrigendum.

.El

.It Other standards

.Pp

Line 2705 Link to another manual

Line 2741 Link to another manual

.Pq Qq cross-reference .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Xr Ar name Op section

.D1 Pf \. Sx \&Xr Ar name section

.Pp

Cross reference the

.Ar name

and

.Ar section

number of another man page;

number of another man page.

omitting the section number is rarely useful.

.Pp

Examples:

.Dl \&.Xr mandoc 1

.Dl \&.Xr mandoc 1 \&;

.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

historical manuals.

.Pp

Consider using

.Sx \&Pp

in the event of natural paragraph breaks.

.Ss \&sp

Emits vertical space.

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

historical manuals.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&sp Op Ar height

.Pp

The

.Ar height

argument is a scaling width as described in

.Xr roff 7 .

If unspecified,

.Sx \&sp

asserts a single vertical space.

.Sh MACRO SYNTAX

The syntax of a macro depends on its classification.

In this section,

Line 3024 then the macro accepts an arbitrary number of argument

Line 3036 then the macro accepts an arbitrary number of argument

.It Sx \&Ux Ta Yes Ta Yes Ta n

.It Sx \&Va Ta Yes Ta Yes Ta n

.It Sx \&Vt Ta Yes Ta Yes Ta >0

.It Sx \&Xr Ta Yes Ta Yes Ta >0

.It Sx \&Xr Ta Yes Ta Yes Ta 2

.It Sx \&br Ta \&No Ta \&No Ta 0

.It Sx \&sp Ta \&No Ta \&No Ta 1

.El

.Ss Delimiters

When a macro argument consists of one single input character

Line 3044 For many macros, when the leading arguments are openin

Line 3054 For many macros, when the leading arguments are openin

these delimiters are put before the macro scope,

and when the trailing arguments are closing delimiters,

these delimiters are put after the macro scope.

Spacing is suppressed after opening delimiters

and before closing delimiters.

For example,

.Pp

.D1 Pf \. \&Aq "( [ word ] ) ."

Line 3100 renders as:

Line 3112 renders as:

.D1 Fl a ( b | c \*(Ba d ) e

.Pp

This applies to both opening and closing delimiters,

and also to the middle delimiter:

and also to the middle delimiter, which does not suppress spacing:

.Pp

.Bl -tag -width Ds -offset indent -compact

.It \&|

Line 3208 but produces large indentations.

Line 3220 but produces large indentations.

.Xr mandoc_char 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Pp

The web page

.Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"

provides a few tutorial-style pages for beginners, an extensive style

guide for advanced authors, and an alphabetic index helping to choose

the best macros for various kinds of content.

.Sh HISTORY

The

.Nm

CVSweb