mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.107 and 1.109

version 1.107, 2018/10/04 15:32:09

version 1.109, 2018/12/16 00:17:02

Line 132 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 209 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 890 This is a Heirloom extension and currently ignored.

Line 937 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 1844 The escape sequence backslash-space

Line 1876 The escape sequence backslash-space

.Pq Sq \e\ \&

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

.Sx Whitespace .

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

Line 1907 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 Special character

Line 1948 Special character

.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 1914 with names of arbitrary length, see

Line 1964 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 1934 Digit width space character.

Line 1988 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 1961 Draw graphics function; ignored by

Line 2018 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 does the same as

.Ic \e

itself for now.

.It Ic \ee

Backslash special character.

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

Line 1974 and

Line 2038 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 2042 the register is first incremented or decremented by th

Line 2110 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 2052 only the last one of the characters is visible.

Line 2128 only the last one of the characters is visible.

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

CVSweb