version 1.93, 2017/06/14 23:24:17 |
version 1.96, 2018/04/10 00:52:30 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010,2011,2013-2015,2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010-2018 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 180 single-character |
|
Line 180 single-character |
|
two-character |
two-character |
.Sq \e*(XX , |
.Sq \e*(XX , |
and N-character |
and N-character |
.Sq \e*[N] . |
.Sq \e* Ns Bq N . |
.Pp |
.Pp |
Examples: |
Examples: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
Line 1348 Currently unsupported. |
|
Line 1348 Currently unsupported. |
|
.It Ic \&nop Ar body |
.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 or macro line. |
Currently unsupported. |
Currently unsupported. |
.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression |
.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression Op Ar stepsize |
Define or change a register. |
Define or change a register. |
A register is an arbitrary string value that defines some sort of state, |
A register is an arbitrary string value that defines some sort of state, |
which influences parsing and/or formatting. |
which influences parsing and/or formatting. |
|
|
If it is prefixed by a sign, the register will be |
If it is prefixed by a sign, the register will be |
incremented or decremented instead of assigned to. |
incremented or decremented instead of assigned to. |
.Pp |
.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 |
The following |
.Ar register |
.Ar register |
is handled specially: |
is handled specially: |
Line 1471 This is a groff extension and currently ignored. |
|
Line 1479 This is a groff extension and currently ignored. |
|
.It Ic \&rchar Ar glyph ... |
.It Ic \&rchar Ar glyph ... |
Remove glyph definitions. |
Remove glyph definitions. |
Currently unsupported. |
Currently unsupported. |
.It Ic \&rd Op Ar prompt Op Ar agument ... |
.It Ic \&rd Op Ar prompt Op Ar argument ... |
Read from standard input. |
Read from standard input. |
Currently ignored. |
Currently ignored. |
.It Ic \&recursionlimit Ar maxrec maxtail |
.It Ic \&recursionlimit Ar maxrec maxtail |
|
|
.Sx Special Characters |
.Sx Special Characters |
with two-letter names, see |
with two-letter names, see |
.Xr mandoc_char 7 . |
.Xr mandoc_char 7 . |
.Ss \e*[ Ns Ar name ] |
.Ss \e* Ns Bq Ar name |
Interpolate the string with the |
Interpolate the string with the |
.Ar name ; |
.Ar name ; |
see |
see |
Line 1874 Special character |
|
Line 1882 Special character |
|
.Ss \e/ |
.Ss \e/ |
Right italic correction (groff extension); ignored by |
Right italic correction (groff extension); ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
.Ss \e[ Ns Ar name ] |
.Ss \e Ns Bq Ar name |
.Sx Special Characters |
.Sx Special Characters |
with names of arbitrary length, see |
with names of arbitrary length, see |
.Xr mandoc_char 7 . |
.Xr mandoc_char 7 . |
Line 1930 Move down by half a line; ignored by |
|
Line 1938 Move down by half a line; ignored by |
|
.Xr mandoc 1 . |
.Xr mandoc 1 . |
.Ss \ee |
.Ss \ee |
Backslash special character. |
Backslash special character. |
.Ss \eF[ Ns Ar name ] |
.Ss \eF Ns Bq Ar name |
Switch font family (groff extension); ignored by |
Switch font family (groff extension); ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |
.No \eF Ns Ar c |
.No \eF Ns Ar c |
and |
and |
.No \eF( Ns Ar cc . |
.No \eF( Ns Ar cc . |
.Ss \ef[ Ns Ar name ] |
.Ss \ef Ns Bq Ar name |
Switch to the font |
Switch to the font |
.Ar name , |
.Ar name , |
see |
see |
Line 1946 For short names, there are variants |
|
Line 1954 For short names, there are variants |
|
.No \ef Ns Ar c |
.No \ef Ns Ar c |
and |
and |
.No \ef( Ns Ar cc . |
.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 |
Interpolate the format of a number register; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |
|
|
Otherwise, it is relative to the current position. |
Otherwise, it is relative to the current position. |
The default scaling unit is |
The default scaling unit is |
.Cm m . |
.Cm m . |
.Ss \ek[ Ns Ar name ] |
.Ss \ek Ns Bq Ar name |
Mark horizontal input place in register; ignored by |
Mark horizontal input place in register; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |
Line 1978 Draw a horizontal line of |
|
Line 1986 Draw a horizontal line of |
|
.Ar width |
.Ar width |
using the glyph |
using the glyph |
.Ar c . |
.Ar c . |
.Ss \eM[ Ns Ar name ] |
.Ss \eM Ns Bq Ar name |
Set fill (background) color (groff extension); ignored by |
Set fill (background) color (groff extension); ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |
.No \eM Ns Ar c |
.No \eM Ns Ar c |
and |
and |
.No \eM( Ns Ar cc . |
.No \eM( Ns Ar cc . |
.Ss \em[ Ns Ar name ] |
.Ss \em Ns Bq Ar name |
Set glyph drawing color (groff extension); ignored by |
Set glyph drawing color (groff extension); ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |
|
|
Character |
Character |
.Ar number |
.Ar number |
on the current font. |
on the current font. |
.Ss \en[ Ns Ar name ] |
.Ss \en Ns Oo +|- Oc Ns Bq Ar name |
Interpolate the number register |
Interpolate the number register |
.Ar name . |
.Ar name . |
For short names, there are variants |
For short names, there are variants |
.No \en Ns Ar c |
.No \en Ns Ar c |
and |
and |
.No \en( Ns Ar cc . |
.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 |
.Ss \eo\(aq Ns Ar string Ns \(aq |
Overstrike, writing all the characters contained in the |
Overstrike, writing all the characters contained in the |
.Ar string |
.Ar string |
Line 2023 Change point size; ignored by |
|
Line 2037 Change point size; ignored by |
|
Alternative forms |
Alternative forms |
.No \es Ns Oo +|- Oc Ns Ar n , |
.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 \(aq Ns Ar number Ns \(aq , |
.No \es Ns [ Oo +|- Oc Ns Ar number ] , |
.No \es Ns Bq Oo +|- Oc Ns Ar number , |
and |
and |
.No \es Ns Oo +|- Oc Ns [ Ar number Ns ] |
.No \es Ns Oo +|- Oc Ns Bq Ar number |
are also parsed and ignored. |
are also parsed and ignored. |
.Ss \et |
.Ss \et |
Horizontal tab; ignored by |
Horizontal tab; ignored by |
Line 2033 Horizontal tab; ignored by |
|
Line 2047 Horizontal tab; ignored by |
|
.Ss \eu |
.Ss \eu |
Move up by half a line; ignored by |
Move up by half a line; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
.Ss \eV[ Ns Ar name ] |
.Ss \eV Ns Bq Ar name |
Interpolate an environment variable; ignored by |
Interpolate an environment variable; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |
Line 2060 as device control function; ignored in nroff mode and |
|
Line 2074 as device control function; ignored in nroff mode and |
|
.Ss \ex\(aq Ns Ar number Ns \(aq |
.Ss \ex\(aq Ns Ar number Ns \(aq |
Extra line space function; ignored by |
Extra line space function; ignored by |
.Xr mandoc 1 . |
.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 |
Output a string as a device control function; ignored in nroff mode and by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
For short names, there are variants |
For short names, there are variants |