version 1.33, 2011/09/26 23:07:31 |
version 1.43, 2013/10/14 01:43:14 |
Line 83 depends on the respective processing context. |
|
Line 83 depends on the respective processing context. |
|
.Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters, the space |
documents may contain only graphable 7-bit ASCII characters, the space |
character, and, in certain circumstances, the tab character. |
character, and, in certain circumstances, the tab character. |
The back-space character |
The backslash character |
.Sq \e |
.Sq \e |
indicates the start of an escape sequence for |
indicates the start of an escape sequence for |
.Sx Comments , |
.Sx Comments , |
Line 143 escape followed by an indicator: B (bold), I (italic), |
|
Line 143 escape followed by an indicator: B (bold), I (italic), |
|
(revert to previous mode). |
(revert to previous mode). |
A numerical representation 3, 2, or 1 (bold, italic, and regular, |
A numerical representation 3, 2, or 1 (bold, italic, and regular, |
respectively) may be used instead. |
respectively) may be used instead. |
|
The indicator or numerical representative may be preceded by C |
|
(constant-width), which is ignored. |
.Pp |
.Pp |
|
The two-character indicator |
|
.Sq BI |
|
requests a font that is both bold and italic. |
|
It may not be portable to old roff implementations. |
|
.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 |
Write in bold, then switch to regular font mode. |
Write in \fBbold\fP, then switch to regular font mode. |
.It Li \efIitalic\efP |
.It Li \efIitalic\efP |
Write in italic, then return to previous font mode. |
Write in \fIitalic\fP, then return to previous font mode. |
|
.It Li \ef(BIbold italic\efP |
|
Write in \f(BIbold italic\fP, then return to previous font mode. |
.El |
.El |
.Pp |
.Pp |
Text decoration is |
Text decoration is |
Line 415 The syntax of this request is the same as that of |
|
Line 424 The syntax of this request is the same as that of |
|
It is currently ignored by |
It is currently ignored by |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
as are its children. |
as are its children. |
|
.Ss \&cc |
|
Changes the control character. |
|
Its syntax is as follows: |
|
.Bd -literal -offset indent |
|
.Pf . Cm \&cc Op Ar c |
|
.Ed |
|
.Pp |
|
If |
|
.Ar c |
|
is not specified, the control character is reset to |
|
.Sq \&. . |
|
Trailing characters are ignored. |
.Ss \&de |
.Ss \&de |
Define a |
Define a |
.Nm |
.Nm |
Line 617 Begin an equation block. |
|
Line 638 Begin an equation block. |
|
See |
See |
.Xr eqn 7 |
.Xr eqn 7 |
for a description of the equation language. |
for a description of the equation language. |
|
.Ss \&fam |
|
Change the font family. |
|
This line-scoped request is intended to have one argument specifying |
|
the font family to be selected. |
|
It is a groff extension, and currently, it is ignored including its |
|
arguments, and the number of arguments is not checked. |
.Ss \&hy |
.Ss \&hy |
Set automatic hyphenation mode. |
Set automatic hyphenation mode. |
This line-scoped request is currently ignored. |
This line-scoped request is currently ignored. |
Line 842 only accepts relative paths not containing the strings |
|
Line 869 only accepts relative paths not containing the strings |
|
.Qq ../ |
.Qq ../ |
and |
and |
.Qq /.. . |
.Qq /.. . |
|
.Pp |
|
This request requires |
|
.Xr man 1 |
|
to change to the right directory before calling |
|
.Xr mandoc 1 , |
|
per convention to the root of the manual tree. |
|
Typical usage looks like: |
|
.Pp |
|
.Dl \&.so man3/Xcursor.3 |
|
.Pp |
|
As the whole concept is rather fragile, the use of |
|
.Sx \&so |
|
is discouraged. |
|
Use |
|
.Xr ln 1 |
|
instead. |
.Ss \&ta |
.Ss \&ta |
Set tab stops. |
Set tab stops. |
This line-scoped request can take an arbitrary number of arguments. |
This line-scoped request can take an arbitrary number of arguments. |
|
|
.Xr tbl 7 |
.Xr tbl 7 |
for a description of the tbl language. |
for a description of the tbl language. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other other |
This section documents compatibility between mandoc and other |
.Nm |
.Nm |
implementations, at this time limited to GNU troff |
implementations, at this time limited to GNU troff |
.Pq Qq groff . |
.Pq Qq groff . |
Line 943 using the next-line syntax. |
|
Line 986 using the next-line syntax. |
|
.%U http://heirloom.sourceforge.net/doctools/troff.pdf |
.%U http://heirloom.sourceforge.net/doctools/troff.pdf |
.Re |
.Re |
.Sh HISTORY |
.Sh HISTORY |
The RUNOFF typesetting system was written in PL/1 for the CTSS |
The RUNOFF typesetting system, whose input forms the basis for |
operating system by Jerome ("Jerry") E. Saltzer in 1961. |
|
It was first used as the main documentation tool by Multics since 1963. |
|
Robert ("Bob") H. Morris ported it to the GE-635 and called it |
|
.Nm , |
.Nm , |
Doug McIlroy rewrote it in BCPL in 1969, |
was written in MAD and FAP for the CTSS operating system by Jerome E. |
Joseph F. Ossanna rewrote it in PDP-11 assembly in 1973, |
Saltzer in 1964. |
and Brian W. Kernighan rewrote it in C in 1975. |
Doug McIlroy rewrote it in BCPL in 1969, renaming it |
|
.Nm . |
|
Dennis M. Ritchie rewrote McIlroy's |
|
.Nm |
|
in PDP-11 assembly for |
|
.At v1 , |
|
Joseph F. Ossanna improved roff and renamed it nroff |
|
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. |
.Sh AUTHORS |
.Sh AUTHORS |
.An -nosplit |
.An -nosplit |
This |
This |
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
.Mt kristaps@bsd.lv ; |
|
and |
and |
.An Ingo Schwarze , |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |
.Mt schwarze@openbsd.org . |
|