mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.91 and 1.97

version 1.91, 2017/06/14 19:39:18

version 1.97, 2018/08/10 04:41:25

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 180 single-character

two-character

.Sq \e*(XX ,

and N-character

.Sq \e*[N] .

.Sq \e* Ns Bq N .

.Pp

Examples:

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

Line 206 Unescaped trailing spaces are stripped from text line

literal context.

In general, trailing whitespace on any input line is discouraged for

reasons of portability.

In the rare case that a blank character is needed at the end of an

In the rare case that a space character is needed at the end of an

input line, it may be forced by

.Sq \e\ \e& .

.Pp

Line 665 produces

.Pp

in the input stream, and thus in the output: \fI\^XtFree\^\fP.

Each occurrence of \e\e$* is replaced with all the arguments,

joined together with single blank characters.

joined together with single space characters.

.Pp

Since macros and user-defined strings share a common string table,

defining a macro

Line 1346 Currently unsupported.

Temporarily turn off line numbering.

Currently unsupported.

.It Ic \&nop Ar body

Execute the rest of the input line as a request or macro line.

Execute the rest of the input line as a request, macro, or text line,

Currently unsupported.

skipping the

.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression

.Ic \&nop

request and any space characters immediately following it.

This is mostly used to indent text lines inside macro definitions.

.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression Op Ar stepsize

Define or change a register.

A register is an arbitrary string value that defines some sort of state,

which influences parsing and/or formatting.

Line 1360 below.

Line 1363 below.

If it is prefixed by a sign, the register will be

incremented or decremented instead of assigned to.

.Pp

The

.Ar stepsize

is used by the

.Ic \en+

auto-increment feature.

It remains unchanged when omitted while changing an existing register,

and it defaults to 0 when defining a new register.

.Pp

The following

.Ar register

is handled specially:

Line 1441 Currently ignored.

Line 1452 Currently ignored.

Print all number registers on standard error output.

Currently ignored.

.It Ic \&po Op Oo Cm + Ns | Ns Cm - Oc Ns Ar offset

Set horizontal page offset.

Set a horizontal page offset.

Currently ignored.

If no argument is specified, the page offset is reverted to its

previous value.

If a sign is specified, the new page offset is calculated relative

to the current one; otherwise, it is absolute.

The argument follows the syntax of

.Sx Scaling Widths

and the default scaling unit is

.Cm m .

.It Ic \&ps Op Oo Cm + Ns | Ns Cm - Oc Ns size

Change point size.

Currently ignored.

Line 1464 This is a groff extension and currently ignored.

Line 1482 This is a groff extension and currently ignored.

.It Ic \&rchar Ar glyph ...

Remove glyph definitions.

Currently unsupported.

.It Ic \&rd Op Ar prompt Op Ar agument ...

.It Ic \&rd Op Ar prompt Op Ar argument ...

Read from standard input.

Currently ignored.

.It Ic \&recursionlimit Ar maxrec maxtail

Line 1847 instead.

Line 1865 instead.

.Sx Special Characters

with two-letter names, see

.Xr mandoc_char 7 .

.Ss \e*[ Ns Ar name ]

.Ss \e* Ns Bq Ar name

Interpolate the string with the

.Ar name ;

see

Line 1867 Special character

Line 1885 Special character

.Ss \e/

Right italic correction (groff extension); ignored by

.Xr mandoc 1 .

.Ss \e[ Ns Ar name ]

.Ss \e Ns Bq Ar name

.Sx Special Characters

with names of arbitrary length, see

.Xr mandoc_char 7 .

Line 1923 Move down by half a line; ignored by

Line 1941 Move down by half a line; ignored by

.Xr mandoc 1 .

.Ss \ee

Backslash special character.

.Ss \eF[ Ns Ar name ]

.Ss \eF Ns Bq Ar name

Switch font family (groff extension); ignored by

.Xr mandoc 1 .

For short names, there are variants

.No \eF Ns Ar c

and

.No \eF( Ns Ar cc .

.Ss \ef[ Ns Ar name ]

.Ss \ef Ns Bq Ar name

Switch to the font

.Ar name ,

see

Line 1939 For short names, there are variants

Line 1957 For short names, there are variants

.No \ef Ns Ar c

and

.No \ef( Ns Ar cc .

.Ss \eg[ Ns Ar name ]

.Ss \eg Ns Bq Ar name

Interpolate the format of a number register; ignored by

.Xr mandoc 1 .

For short names, there are variants

Line 1949 and

Line 1967 and

.Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq

Set the height of the current font; ignored by

.Xr mandoc 1 .

.Ss \eh\(aq Ns Ar width Ns \(aq

.Ss \eh\(aq Ns Oo Cm \&| Oc Ns Ar width Ns \(aq

Horizontal motion relative to the current position.

Horizontal motion.

If the vertical bar is given, the motion is relative to the current

indentation.

Otherwise, it is relative to the current position.

The default scaling unit is

.Cm m .

.Ss \ek[ Ns Ar name ]

.Ss \ek Ns Bq Ar name

Mark horizontal input place in register; ignored by

.Xr mandoc 1 .

For short names, there are variants

Line 1968 Draw a horizontal line of

Line 1989 Draw a horizontal line of

.Ar width

using the glyph

.Ar c .

.Ss \eM[ Ns Ar name ]

.Ss \eM Ns Bq Ar name

Set fill (background) color (groff extension); ignored by

.Xr mandoc 1 .

For short names, there are variants

.No \eM Ns Ar c

and

.No \eM( Ns Ar cc .

.Ss \em[ Ns Ar name ]

.Ss \em Ns Bq Ar name

Set glyph drawing color (groff extension); ignored by

.Xr mandoc 1 .

For short names, there are variants

Line 1986 and

Line 2007 and

Character

.Ar number

on the current font.

.Ss \en[ Ns Ar name ]

.Ss \en Ns Oo +|- Oc Ns Bq Ar name

Interpolate the number register

.Ar name .

For short names, there are variants

.No \en Ns Ar c

and

.No \en( Ns Ar cc .

If the optional sign is specified,

the register is first incremented or decremented by the

.Ar stepsize

that was specified in the relevant

.Ic \&nr

request, and the changed value is interpolated.

.Ss \eo\(aq Ns Ar string Ns \(aq

Overstrike, writing all the characters contained in the

.Ar string

Line 2013 Change point size; ignored by

Line 2040 Change point size; ignored by

Alternative forms

.No \es Ns Oo +|- Oc Ns Ar n ,

.No \es Ns Oo +|- Oc Ns \(aq Ns Ar number Ns \(aq ,

.No \es Ns [ Oo +|- Oc Ns Ar number ] ,

.No \es Ns Bq Oo +|- Oc Ns Ar number ,

and

.No \es Ns Oo +|- Oc Ns [ Ar number Ns ]

.No \es Ns Oo +|- Oc Ns Bq Ar number

are also parsed and ignored.

.Ss \et

Horizontal tab; ignored by

Line 2023 Horizontal tab; ignored by

Line 2050 Horizontal tab; ignored by

.Ss \eu

Move up by half a line; ignored by

.Xr mandoc 1 .

.Ss \eV[ Ns Ar name ]

.Ss \eV Ns Bq Ar name

Interpolate an environment variable; ignored by

.Xr mandoc 1 .

For short names, there are variants

Line 2050 as device control function; ignored in nroff mode and

Line 2077 as device control function; ignored in nroff mode and

.Ss \ex\(aq Ns Ar number Ns \(aq

Extra line space function; ignored by

.Xr mandoc 1 .

.Ss \eY[ Ns Ar name ]

.Ss \eY Ns Bq Ar name

Output a string as a device control function; ignored in nroff mode and by

.Xr mandoc 1 .

For short names, there are variants

CVSweb