version 1.108, 2018/12/15 19:30:26 |
version 1.109, 2018/12/16 00:17:02 |
Line 132 One-letter backslash escape. |
|
Line 132 One-letter backslash escape. |
|
See |
See |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
for a complete list. |
for a complete list. |
.Ss Text Decoration |
.Ss Font Selection |
Terms may be text-decorated using the |
In |
.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 |
.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 |
.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: |
Examples: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
.It Li \efBbold\efR |
.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 |
.It Li \ef(BIbold italic\efP |
Write in \f(BIbold italic\fP, then return to previous font mode. |
Write in \f(BIbold italic\fP, then return to previous font mode. |
.El |
.El |
.Pp |
|
Text decoration is |
|
.Em not |
|
recommended for |
|
.Xr mdoc 7 , |
|
which encourages semantic annotation. |
|
.Ss Whitespace |
.Ss Whitespace |
Whitespace consists of the space character. |
Whitespace consists of the space character. |
In text lines, whitespace is preserved within a line. |
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. |
Conditionally define a special font. |
This is a groff extension and currently ignored. |
This is a groff extension and currently ignored. |
.It Ic \&ft Op Ar font |
.It Ic \&ft Op Ar font |
Change the font. |
Change the font; see |
The following |
.Sx Font Selection . |
|
The |
.Ar font |
.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 |
.It Ic \&ftr Ar newname Op Ar oldname |
Translate font name. |
Translate font name. |
This is a groff extension and currently ignored. |
This is a groff extension and currently ignored. |
|
|
Switch to the font |
Switch to the font |
.Ar name , |
.Ar name , |
see |
see |
.Sx Text Decoration . |
.Sx Font Selection . |
For short names, there are variants |
For short names, there are variants |
.Ic \ef Ns Ar c |
.Ic \ef Ns Ar c |
and |
and |
.Ic \ef( Ns Ar cc . |
.Ic \ef( Ns Ar cc . |
|
An empty name |
|
.Ic \ef[] |
|
defaults to |
|
.Ic \efP . |
.It Ic \eg[ Ns Ar name Ns Ic \&] |
.It Ic \eg[ Ns Ar name Ns Ic \&] |
Interpolate the format of a number register; ignored by |
Interpolate the format of a number register; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |