mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.108 and 1.110

version 1.108, 2018/12/15 19:30:26

version 1.110, 2018/12/16 01:34:56

Line 44 utility supports a subset of

requests and escapes.

Even though this manual page lists all

.Nm

requests, it only has partial information about requests not supported by

requests and escape sequences, it only contains partial information

about requests not supported by

.Xr mandoc 1

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

For complete

Line 86 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 132 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 156 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 199 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 221 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 593 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 890 This is a Heirloom extension and currently ignored.

Line 938 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 1817 The

Line 1850 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 1830 described in the

Line 1859 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 1843 on both lines together as if it were on a single input

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

Line 1865 Macro argument expansion, see

Line 1894 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 1912 Left italic correction (groff extension); ignored by

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

Line 1966 if

Line 2006 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 1990 Move down by half a line; ignored by

Line 2030 Move down by half a line; ignored by

Escape character intended to not be interpreted in copy mode.

.Xr mandoc 1 ,

it does the same as

it currently does the same as

.Ic \e

itself for now.

itself.

.It Ic \ee

Backslash special character.

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

Line 2006 and

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

CVSweb