mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.261 and 1.273

version 1.261, 2017/02/05 22:30:29

version 1.273, 2018/12/23 16:55:34

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 449 in the alphabetical

.It Sx \&Ss Ta subsection header (one line)

.It Sx \&Sx Ta internal cross reference to a section or subsection

.It Sx \&Xr Ta cross reference to another manual page: Ar name section

.It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)

.It Sx \&Pp Ta start a text paragraph (no arguments)

.El

.Ss Displays and lists

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

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 490 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 511 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 524 in the alphabetical

Line 522 in the alphabetical

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

.It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)

.It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)

.It Sx \&Li Ta typewriter font (literal) (>0 arguments)

.It Sx \&No Ta return to roman font (normal) (no arguments)

.It Sx \&Bf , \&Ef Ta font block:

.Op Fl Ar type | Cm \&Em | \&Li | \&Sy

Line 676 Examples:

Line 673 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 691 Examples:

Line 686 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 737 A version of

Line 758 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 974 argument.

Line 995 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 1214 The

Line 1233 The

.Ar month

is the full English month name, the

.Ar day

is an optionally zero-padded numeral, and the

is an integer number, and the

.Ar year

is the full four-digit year.

.Pp

Line 1244 If no date string is given, the current date is used.

Line 1263 If no date string is given, the current date is used.

.Pp

Examples:

.Dl \&.Dd $\&Mdocdate$

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

.Dl \&.Dd $\&Mdocdate: July 2 2018$

.Dl \&.Dd July 21, 2007

.Dl \&.Dd July 2, 2018

.Pp

See also

.Sx \&Dt

Line 1454 to save the pattern space for subsequent retrieval.

Line 1473 to save the pattern space for subsequent retrieval.

.Ed

.Pp

See also

.Sx \&Bf ,

.Sx \&Li ,

.Sx \&No ,

.Sx \&Ql ,

and

.Sx \&Sy .

.Ss \&En

Line 1756 Examples:

Line 1774 Examples:

.Dl \&.Ic alias

.Pp

Note that using

.Sx \&Bd Fl literal

.Sx \&Ql ,

.Sx \&Dl ,

.Sx \&D1

.Sx \&Bd Fl literal

is preferred for displaying code; the

is preferred for displaying code samples; the

.Sx \&Ic

macro is used when referring to specific instructions.

macro is used when referring to an individual command name.

.Ss \&In

The name of an include file.

This macro is most often used in section 2, 3, and 9 manual pages.

Line 1854 The tab cell delimiter may only be used within the

Line 1873 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 1895 Examples:

Line 1914 Examples:

.Dl \&.Lb libz

.Dl \&.Lb libmandoc

.Ss \&Li

Denotes text that should be in a

Request a typewriter (literal) font.

.Li literal

Deprecated because on terminal output devices, this is usually

font mode.

indistinguishable from normal text.

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

For literal displays, use

stylistically decorating technical terms.

.Sx \&Ql Pq in-line ,

.Pp

.Sx \&Dl Pq single line ,

On terminal output devices, this is often indistinguishable from

normal text.

.Sx \&Bd Fl literal Pq multi-line

.Pp

instead.

See also

.Sx \&Bf ,

.Sx \&Em ,

.Sx \&No ,

and

.Sx \&Sy .

.Ss \&Lk

Format a hyperlink.

Its syntax is as follows:

Line 1923 Examples:

Line 1936 Examples:

See also

.Sx \&Mt .

.Ss \&Lp

Synonym for

Deprecated synonym for

.Sx \&Pp .

.Ss \&Ms

Display a mathematical symbol.

Line 2026 Examples:

Line 2039 Examples:

.Pp

See also

.Sx \&Em ,

.Sx \&Li ,

.Sx \&Ql ,

and

.Sx \&Sy .

.Ss \&Ns

Line 2224 Close quoted context opened by

Line 2237 Close quoted context opened by

.Sx \&Qo .

.Ss \&Ql

In-line literal display.

This can for example be used for complete command invocations and

This can be used for complete command invocations and for multi-word

for multi-word code fragments when more specific markup is not

code examples when an indented display is not desired.

appropriate and an indented display is not desired.

While

.Xr mandoc 1

always encloses the arguments in single quotes, other formatters

usually omit the quotes on non-terminal output devices when the

arguments have three or more characters.

.Pp

See also

.Sx \&Dl

Line 2579 The second and last Technical Corrigendum.

Line 2586 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 2640 program.

Line 2642 program.

.Ed

.Pp

See also

.Sx \&Bf ,

.Sx \&Em ,

.Sx \&Li ,

.Sx \&No ,

and

.Sx \&No .

.Sx \&Ql .

.Ss \&Ta

Table cell separator in

.Sx \&Bl Fl column

Line 2738 Examples:

Line 2739 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 3045 then the macro accepts an arbitrary number of argument

Line 3023 then the macro accepts an arbitrary number of argument

.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 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 3232 but produces large indentations.

Line 3208 but produces large indentations.

.Xr tbl 7

.Pp

The web page

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

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

CVSweb