mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

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

version 1.121, 2023/10/23 20:25:02

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 315 delimiters

The proper spacing is also intelligently preserved if a sentence ends at

the boundary of a macro line.

.Pp

If an input line happens to end with a period, exclamation or question

mark that isn't the end of a sentence, append a zero-width space

.Pq Sq \e& .

.Pp

Examples:

.Bd -literal -offset indent -compact

Do not end sentences mid-line like this. Instead,

end a sentence like this.

A macro would end like this:

\&.Xr mandoc 1 \&.

An abbreviation at the end of an input line needs escaping, e.g.\e&

like this.

.Ed

.Sh REQUEST SYNTAX

A request or macro line consists of:

Line 503 This is a Heirloom extension and currently unsupported

Line 509 This is a Heirloom extension and currently unsupported

.It Ic \&br

Break the output line.

.It Ic \&break

Break out of a

Break out of the innermost

.Ic \&while

loop.

Currently unsupported.

.It Ic \&breakchar Ar char ...

Optional line break characters.

This is a Heirloom extension and currently ignored.

Line 619 Its syntax can be either

Line 624 Its syntax can be either

.Pp

.Bd -literal -offset indent

.Pf . Ic \&de Ar macroname Ar endmacro

.Pf . Ic \&de Ar macroname endmacro

.Ar definition

.Pf . Ar endmacro

.Ed

Line 908 This is a Heirloom extension and currently ignored.

Line 913 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 1347 Declare the need for the specified minimum vertical sp

Line 1364 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 1993 End conditional input; see

Line 2021 End conditional input; see

Paddable non-breaking space character.

.It Ic \e0

Digit width space character.

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

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

Anchor definition; ignored by

Interpolate

.Sq 1

.Ar name

is a syntactically valid identifier that can be used

as a name for a macro or user-defined string, or

.Sq 0

otherwise.

This is a thoroughly non-portable groff extension.

Heirloom troff uses the same escape sequence with the same syntax

for a completely different purpose,

defining a hyperlink target position, also called an

.Dq anchor ,

with the given

.Ar name .

The Heirloom semantics is not supported by

.Xr mandoc 1 .

.It Ic \ea

Leader character; ignored by

Line 2057 defaults to

Line 2100 defaults to

.Ic \efP .

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

Interpolate the format of a number register; ignored by

.Xr mandoc 1 .

.Xr mandoc 1 ,

which interpolates an empty string instead.

For short names, there are variants

.Ic \eg Ns Ar c

and

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

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

Set number register; ignored by

.Xr mandoc 1 .

.It Ic \er

Move up by one line; ignored by

Reverse line feed: move up by one output line.

.Xr mandoc 1 .

Currently unsupported.

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

Slant output; ignored by

.Xr mandoc 1 .

Line 2160 Horizontal tab; ignored by

Line 2204 Horizontal tab; ignored by

Move up by half a line; ignored by

.Xr mandoc 1 .

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

Interpolate an environment variable; ignored by

Interpolate an environment variable.

.Xr mandoc 1 .

For short names, there are variants

.Ic \eV Ns Ar c

and

.Ic \eV( Ns Ar cc .

This escape sequence is intentionally unsupported;

.Xr mandoc 1

prints the string

.Dq Pf $ Brq Ar name

instead of inspecting the environment.

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

Vertical motion; ignored by

.Xr mandoc 1 .

Line 2176 The

Line 2224 The

.Xr mandoc 1

implementation assumes that after expansion of user-defined strings, the

.Ar string

only contains normal characters, no escape sequences, and that each

only contains normal characters, characters expressed as escape sequences,

and zero-width escape sequences, and that each

character has a width of 24 basic units.

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

Output

Line 2256 code.

Line 2305 code.

.Pp

The special semantics of the

.Cm nS

number register is an idiosyncracy of

number register is an idiosyncrasy of

.Ox

manuals and not supported by other

.Xr mdoc 7

Line 2303 for

Line 2352 for

.At v2 ,

then ported nroff to C as troff, which Brian W. Kernighan released with

.At v7 .

In 1989, James Clarke re-implemented troff in C++, naming it groff.

In 1989, James Clark re-implemented troff in C++, naming it groff.

.Sh AUTHORS

.An -nosplit

This

CVSweb