mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.106 and 1.111

version 1.106, 2018/10/04 15:16:23

version 1.111, 2019/01/01 03:45:29

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 39 or

code.

To properly format such manuals, the

.Xr mandoc 1

utility supports a tiny subset of

utility supports a subset of

.Nm

requests and escapes.

Only these requests and escapes supported by

Even though this manual page lists all

.Nm

requests and escape sequences, it only contains partial information

about requests not supported by

.Xr mandoc 1

are documented in the present manual,

and about language features that do not matter for manual pages.

together with the basic language syntax shared by

.Nm ,

.Xr mdoc 7 ,

and

.Xr man 7 .

For complete

.Nm

manuals, consult the

Line 89 indicates the start of an escape sequence, used for ex

Line 87 indicates the start of an escape sequence, used for ex

.Sx Comments

and

.Sx Special Characters .

For a listing of escape sequences, consult the

For a complete listing of escape sequences, consult the

.Sx ESCAPE SEQUENCE REFERENCE

below.

.Ss Comments

Line 135 One-letter backslash escape.

Line 133 One-letter backslash escape.

See

.Xr mandoc_char 7

for a complete list.

.Ss Text Decoration

.Ss Font Selection

Terms may be text-decorated using the

.Sq \ef

.Xr mdoc 7

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

and

(revert to previous mode).

.Xr man 7

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

documents, fonts are usually selected with macros.

respectively) may be used instead.

The

The indicator or numerical representative may be preceded by C

.Ic \ef

(constant-width), which is ignored.

escape sequence and the

.Ic \&ft

request can be used to manually change the font,

but this is not recommended in

.Xr mdoc 7

documents.

Such manual font changes are overridden by many subsequent macros.

.Pp

The two-character indicator

The following fonts are supported:

.Sq BI

requests a font that is both bold and italic.

It may not be portable to old roff implementations.

.Pp

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

.It Cm B

Bold font.

.It Cm BI

A font that is both bold and italic.

.It Cm CB

Bold constant width font.

Same as

.Cm B

in terminal output.

.It Cm CI

Italic constant width font.

Same as

.Cm I

in terminal output.

.It Cm CR

Regular constant width font.

Same as

.Cm R

in terminal output.

.It Cm CW

An alias for

.Cm CR .

.It Cm I

Italic font.

.It Cm P

Return to the previous font.

If a macro caused a font change since the last

.Ic \ef

eascape sequence or

.Ic \&ft

request, this returns to the font before the last font change in

the macro rather than to the font before the last manual font change.

.It Cm R

Roman font.

This is the default font.

.It Cm 1

An alias for

.Cm R .

.It Cm 2

An alias for

.Cm I .

.It Cm 3

An alias for

.Cm B .

.It Cm 4

An alias for

.Cm BI .

.El

.Pp

Examples:

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

.It Li \efBbold\efR

Line 159 Write in \fIitalic\fP, then return to previous font mo

Line 210 Write in \fIitalic\fP, then return to previous font mo

.It Li \ef(BIbold italic\efP

Write in \f(BIbold italic\fP, then return to previous font mode.

.El

.Pp

Text decoration is

.Em not

recommended for

.Xr mdoc 7 ,

which encourages semantic annotation.

.Ss Whitespace

Whitespace consists of the space character.

In text lines, whitespace is preserved within a line.

Line 193 Many requests and macros support scaled widths for the

Line 238 Many requests and macros support scaled widths for the

The syntax for a scaled width is

.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,

where a decimal must be preceded or followed by at least one digit.

Negative numbers, while accepted, are truncated to zero.

.Pp

The following scaling units are accepted:

.Pp

Line 203 centimetre

Line 247 centimetre

.It i

inch

.It P

pica (~1/6 inch)

pica (1/6 inch)

.It p

point (~1/72 inch)

point (1/72 inch)

.It f

scale

.Sq u

Line 225 character

Line 269 character

.It u

default horizontal span for the terminal

.It M

mini-em (~1/100 em)

mini-em (1/100 em)

.El

.Pp

Using anything other than

Line 597 macros, whichever applies to the document in question.

Line 641 macros, whichever applies to the document in question.

.Pp

Specifying a custom

.Ar endmacro

macro works in the same way as for

works in the same way as for

.Ic \&ig ;

namely, the call to

.Sq Pf . Ar endmacro

Line 864 This is a Heirloom extension and currently ignored.

Line 908 This is a Heirloom extension and currently ignored.

Enable or disable an OpenType feature.

This is a Heirloom extension and currently ignored.

.It Ic \&fi

Switch to fill mode.

Break the output line and switch to fill mode,

See

which is active by default but can be ended with the

.Xr man 7 .

.Ic \&nf

Ignored in

request.

.Xr mdoc 7 .

In fill mode, input from subsequent input lines is added to

the same output line until the next word no longer fits,

at which point the output line is broken.

This request is implied by the

.Xr mdoc 7

.Ic \&Sh

macro and by the

.Xr man 7

.Ic \&SH ,

.Ic \&SS ,

and

.Ic \&EE

macros.

.It Ic \&fkern Ar font minkern

Control the use of kerning tables for a font.

This is a Heirloom extension and currently ignored.

Line 894 This is a Heirloom extension and currently ignored.

Line 950 This is a Heirloom extension and currently ignored.

Conditionally define a special font.

This is a groff extension and currently ignored.

.It Ic \&ft Op Ar font

Change the font.

Change the font; see

The following

.Sx Font Selection .

The

.Ar font

arguments are supported:

argument defaults to

.Bl -tag -width 4n -offset indent

.Cm P .

.It Cm B , BI , CB , 3 , 4

switches to

.Sy bold

font

.It Cm I , CI , 2

switches to

.Em underlined

font

.It Cm R , CR , CW , 1

switches to normal font

.It Cm P No "or no argument"

switches back to the previous font

.El

.Pp

This request takes effect only locally and may be overridden

by macros and escape sequences.

.It Ic \&ftr Ar newname Op Ar oldname

Translate font name.

This is a groff extension and currently ignored.

Line 1318 Declare the need for the specified minimum vertical sp

Line 1359 Declare the need for the specified minimum vertical sp

before the next trap or the bottom of the page.

Currently ignored.

.It Ic \&nf

Switch to no-fill mode.

Break the output line and switch to no-fill mode.

See

Subsequent input lines are kept together on the same output line

.Xr man 7 .

even when exceeding the right margin,

Ignored by

and line breaks in subsequent input cause output line breaks.

.Xr mdoc 7 .

This request is implied by the

.Xr mdoc 7

.Ic \&Bd Fl unfilled

and

.Ic \&Bd Fl literal

macros and by the

.Xr man 7

.Ic \&EX

macro.

The

.Ic \&fi

request switches back to the default fill mode.

.It Ic \&nh

Turn off automatic hyphenation mode.

Currently ignored.

Line 1821 The

Line 1873 The

.Xr mandoc 1

.Nm

parser recognises the following escape sequences.

Note that the

.Nm

language defines more escape sequences not implemented in

.Xr mandoc 1 .

.Xr mdoc 7

and

Line 1834 described in the

Line 1882 described in the

.Sx LANGUAGE SYNTAX

section above.

.Pp

A backslash followed by any character not listed here

.Xr mandoc 1 ,

a backslash followed by any character not listed here

simply prints that character itself.

.Bl -tag -width Ds

.It Ic \e<newline>

Line 1847 on both lines together as if it were on a single input

Line 1893 on both lines together as if it were on a single input

The escape sequence backslash-space

.Pq Sq \e\ \&

is an unpaddable space-sized non-breaking space character; see

.Sx Whitespace .

.Sx Whitespace

and

.Xr mandoc_char 7 .

.It Ic \e!

Embed text up to and including the end of the input line into the

current diversion or into intermediate output without interpreting

requests, macros, and escapes.

Currently unsupported.

.It Ic \e\(dq

The rest of the input line is treated as

.Sx Comments .

Line 1864 Macro argument expansion, see

Line 1917 Macro argument expansion, see

Hyphenation allowed at this point of the word; ignored by

.Xr mandoc 1 .

.It Ic \e&

Non-printing zero-width character; see

Non-printing zero-width character,

.Sx Whitespace .

often used for various kinds of escaping; see

.Sx Whitespace ,

.Xr mandoc_char 7 ,

and the

.Dq MACRO SYNTAX

and

.Dq Delimiters

sections in

.Xr mdoc 7 .

.It Ic \e\(aq

Acute accent special character; use

.Ic \e(aa

Line 1874 instead.

Line 1935 instead.

.Sx Special Characters

with two-letter names, see

.Xr mandoc_char 7 .

.It Ic \e)

Zero-width space transparent to end-of-sentence detection;

ignored by

.Xr mandoc 1 .

.It Ic \e*[ Ns Ar name Ns Ic \&]

Interpolate the string with the

.Ar name .

Line 1907 Left italic correction (groff extension); ignored by

Line 1972 Left italic correction (groff extension); ignored by

.Xr mandoc 1 .

.It Ic \e-

Special character

.Dq mathematical minus sign .

.Dq mathematical minus sign ;

see

.Xr mandoc_char 7

for details.

.It Ic \e/

Right italic correction (groff extension); ignored by

.Xr mandoc 1 .

.It Ic \e:

Breaking the line is allowed at this point of the word

without inserting a hyphen.

.It Ic \e?

Embed the text up to the next

.Ic \e?

into the current diversion without interpreting requests, macros,

and escapes.

This is a groff extension and currently unsupported.

.It Ic \e[ Ns Ar name Ns Ic \&]

.Sx Special Characters

with names of arbitrary length, see

Line 1918 with names of arbitrary length, see

Line 1995 with names of arbitrary length, see

.It Ic \e^

One-twelfth em half-narrow space character, effectively zero-width in

.Xr mandoc 1 .

.It Ic \e_

Underline special character; use

.Ic \e(ul

instead.

.It Ic \e`

Grave accent special character; use

.Ic \e(ga

Line 1938 Digit width space character.

Line 2019 Digit width space character.

.It Ic \eA\(aq Ns Ar string Ns Ic \(aq

Anchor definition; ignored by

.Xr mandoc 1 .

.It Ic \ea

Leader character; ignored by

.Xr mandoc 1 .

.It Ic \eB\(aq Ns Ar string Ns Ic \(aq

Interpolate

.Sq 1

Line 1945 if

Line 2029 if

.Ar string

conforms to the syntax of

.Sx Numerical expressions

explained above and

explained above or

.Sq 0

otherwise.

.It Ic \eb\(aq Ns Ar string Ns Ic \(aq

Line 1965 Draw graphics function; ignored by

Line 2049 Draw graphics function; ignored by

.It Ic \ed

Move down by half a line; ignored by

.Xr mandoc 1 .

.It Ic \eE

Escape character intended to not be interpreted in copy mode.

.Xr mandoc 1 ,

it currently does the same as

.Ic \e

itself.

.It Ic \ee

Backslash special character.

.It Ic \eF[ Ns Ar name Ns Ic \&]

Line 1978 and

Line 2069 and

Switch to the font

.Ar name ,

see

.Sx Text Decoration .

.Sx Font Selection .

For short names, there are variants

.Ic \ef Ns Ar c

and

.Ic \ef( Ns Ar cc .

An empty name

.Ic \ef[]

defaults to

.Ic \efP .

.It Ic \eg[ Ns Ar name Ns Ic \&]

Interpolate the format of a number register; ignored by

.Xr mandoc 1 .

Line 2046 the register is first incremented or decremented by th

Line 2141 the register is first incremented or decremented by th

that was specified in the relevant

.Ic \&nr

request, and the changed value is interpolated.

.It Ic \eO Ns Ar digit , Ic \eO[5 Ns arguments Ns Ic \&]

Suppress output.

This is a groff extension and currently unsupported.

With an argument of

.Ic 1 , 2 , 3 ,

.Ic 4 ,

it is ignored.

.It Ic \eo\(aq Ns Ar string Ns Ic \(aq

Overstrike, writing all the characters contained in the

.Ar string

Line 2057 Break the output line at the end of the current word.

Line 2160 Break the output line at the end of the current word.

.It Ic \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns Ic \(aq

Set number register; ignored by

.Xr mandoc 1 .

.It Ic \er

Move up by one line; ignored by

.Xr mandoc 1 .

.It Ic \eS\(aq Ns Ar number Ns Ic \(aq

Slant output; ignored by

.Xr mandoc 1 .

Line 2123 The

Line 2229 The

.Xr mandoc 1

implementation of the

.Nm

language is intentionally incomplete.

language is incomplete.

Unimplemented features include:

Major unimplemented features include:

.Pp

.Bl -dash -compact

.It

Line 2135 never reads or writes external files except via

Line 2241 never reads or writes external files except via

requests with safe relative paths.

.It

There is no automatic hyphenation, no adjustment to the right margin,

and no centering; the output is always set flush-left.

and very limited support for centering; the output is always set flush-left.

.It

Support for setting tabulator positions

Support for setting tabulator and leader characters is missing,

and tabulator and leader characters is missing,

and support for manually changing indentation is limited.

.It

The

Line 2149 output media.

Line 2254 output media.

.It

Width measurements are implemented in a crude way

and often yield wrong results.

Explicit movement requests and escapes are ignored.

Support for explicit movement requests and escapes is limited.

.It

There is no concept of output pages, no support for floats,

graphics drawing, and picture inclusion;

terminal output is always continuous.

.It

Requests regarding color, font families, and glyph manipulation

Requests regarding color, font families, font sizes,

are ignored.

and glyph manipulation are ignored.

Font support is very limited.

Kerning is not implemented, and no ligatures are produced.

.It

Line 2164 The

Line 2269 The

.Qq \(aq

macro control character does not suppress output line breaks.

.It

Diversions are not implemented,

Diversions and environments are not implemented,

and support for traps is very incomplete.

.It

Use of macros is not supported inside

.Xr tbl 7

code.

.El

.Pp

The special semantics of the

CVSweb