version 1.4, 2009/03/14 05:21:58 |
version 1.5, 2009/03/16 22:19:19 |
Line 72 Within a macro line, the following characters are rese |
|
Line 72 Within a macro line, the following characters are rese |
|
.It \&? |
.It \&? |
.Pq question |
.Pq question |
.It \&! |
.It \&! |
.Pq exclmamation |
.Pq exclamation |
.El |
.El |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Use of these characters must either be escaped with a non-breaking space |
Use of reserved characters is described in |
.Pq Sq \e& |
|
or, if applicable, an appropriate escape-sequence used. Use of reserved |
|
characters is described in |
|
.Sx Closure . |
.Sx Closure . |
|
For general non-reserved use, characters must either be escaped with a |
|
non-breaking space |
|
.Pq Sq \e& |
|
or, if applicable, an appropriate escape-sequence used. |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special character sequences begin with the escape character |
|
|
.Pp |
.Pp |
Enclosures: |
Enclosures: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(lh |
|
.Pq left hand |
|
.It \\(rh |
|
.Pq right hand |
|
.It \\(<< |
|
.Pq left guillemot |
|
.It \\(>> |
|
.Pq right guillemot |
.It \\(rC |
.It \\(rC |
.Pq right brace |
.Pq right brace |
.It \\(lC |
.It \\(lC |
|
|
.Pq up arrow |
.Pq up arrow |
.It \\(da |
.It \\(da |
.Pq down arrow |
.Pq down arrow |
|
.It \\(<> |
|
.Pq left-right arrow |
|
.It \\(lA |
|
.Pq left double-arrow |
|
.It \\(rA |
|
.Pq right double-arrow |
|
.It \\(uA |
|
.Pq up double-arrow |
|
.It \\(dA |
|
.Pq down double-arrow |
|
.It \\(hA |
|
.Pq left-right double-arrow |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
|
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Diacritics: |
Diacritics and letter combinations: |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Bl -tag -width 12n -offset "XXXX" -compact |
.It \\(ga |
.It \\(ga |
.Pq accent grave |
.Pq accent grave |
.It \\(aa |
.It \\(aa |
.Pq accent accute |
.Pq accent accute |
|
.It \\(ad |
|
.Pq accent dieresis |
|
.It \\(a~ |
|
.Pq accent tilde |
|
.It \\(AE |
|
.Pq upper-case AE |
|
.It \\(ae |
|
.Pq lower-case AE |
|
.It \\(OE |
|
.Pq upper-case OE |
|
.It \\(oe |
|
.Pq lower-case OE |
|
.It \\('A |
|
.Pq upper-case acute A |
|
.It \\('E |
|
.Pq upper-case acute E |
|
.It \\('I |
|
.Pq upper-case acute I |
|
.It \\('O |
|
.Pq upper-case acute O |
|
.It \\('U |
|
.Pq upper-case acute U |
|
.It \\('a |
|
.Pq lower-case acute a |
|
.It \\('e |
|
.Pq lower-case acute e |
|
.It \\('i |
|
.Pq lower-case acute i |
|
.It \\('o |
|
.Pq lower-case acute o |
|
.It \\('u |
|
.Pq lower-case acute u |
|
.It \\(`A |
|
.Pq upper-case grave A |
|
.It \\(`E |
|
.Pq upper-case grave E |
|
.It \\(`I |
|
.Pq upper-case grave I |
|
.It \\(`O |
|
.Pq upper-case grave O |
|
.It \\(`U |
|
.Pq upper-case grave U |
|
.It \\(`a |
|
.Pq lower-case grave a |
|
.It \\(`e |
|
.Pq lower-case grave e |
|
.It \\(`i |
|
.Pq lower-case grave i |
|
.It \\(`o |
|
.Pq lower-case grave o |
|
.It \\(`u |
|
.Pq lower-case grave u |
|
.It \\(~A |
|
.Pq upper-case tilde A |
|
.It \\(~N |
|
.Pq upper-case tilde N |
|
.It \\(~O |
|
.Pq upper-case tilde O |
|
.It \\(~a |
|
.Pq lower-case tilde a |
|
.It \\(~n |
|
.Pq lower-case tilde n |
|
.It \\(~o |
|
.Pq lower-case tilde o |
|
.It \\(:A |
|
.Pq upper-case dieresis A |
|
.It \\(:E |
|
.Pq upper-case dieresis E |
|
.It \\(:I |
|
.Pq upper-case dieresis I |
|
.It \\(:O |
|
.Pq upper-case dieresis O |
|
.It \\(:U |
|
.Pq upper-case dieresis U |
|
.It \\(:a |
|
.Pq lower-case dieresis a |
|
.It \\(:e |
|
.Pq lower-case dieresis e |
|
.It \\(:i |
|
.Pq lower-case dieresis i |
|
.It \\(:o |
|
.Pq lower-case dieresis o |
|
.It \\(:u |
|
.Pq lower-case dieresis u |
|
.It \\(:y |
|
.Pq lower-case dieresis y |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
Line 219 Special symbols: |
|
Line 327 Special symbols: |
|
.Pq bar, deprecated |
.Pq bar, deprecated |
.It \\(co |
.It \\(co |
.Pq copyright |
.Pq copyright |
|
.It \\(rg |
|
.Pq registered |
|
.It \\(tm |
|
.Pq trademarked |
.It \\& |
.It \\& |
.Pq non-breaking space |
.Pq non-breaking space |
.It \\e |
.It \\e |
Line 239 may span multiple lines. |
|
Line 351 may span multiple lines. |
|
.Bl -inset -offset XXXX |
.Bl -inset -offset XXXX |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Full-block |
.It Em Full-block |
macros always span multiple lines. They consist optionally of one or |
macros always span multiple lines. They consist of zero or |
more |
more |
.Qq heads , |
.Qq heads , |
subsequent macros or text on the same line following invocation; a |
subsequent macros or text on the same line following invocation; an |
|
optional |
.Qq body , |
.Qq body , |
which spans subsequent lines of text or macros; and an optional |
which spans subsequent lines of text or macros; and an optional |
.Qq tail , |
.Qq tail , |
macros or text on the same line following closure. |
macros or text on the same line following closure. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Em Partial-block |
.It Em Partial-block |
macros may span multiple lines. They consists optionally of a |
macros may span multiple lines. They consists of a optional |
.Qq head , |
.Qq head , |
text immediately following invocation; always a |
text immediately following invocation; always a |
.Qq body , |
.Qq body , |
Line 307 are followed by non-reserved characters, the behaviour |
|
Line 420 are followed by non-reserved characters, the behaviour |
|
macro. In general, scope of the macro is closed and re-opened: |
macro. In general, scope of the macro is closed and re-opened: |
subsequent tokens are interpreted as if the scope had just been opened. |
subsequent tokens are interpreted as if the scope had just been opened. |
In other circumstances, scope is simply closed out. |
In other circumstances, scope is simply closed out. |
.\" .\" SUB-SECTION |
|
.\" .Ss Examples |
|
.\" The following examples illustrate each macro classification. |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit full-block. Has head, body and no tail. Scope closed by |
|
.\" second |
|
.\" .Sq \&Sh |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Sh SECTION 1 |
|
.\" body... |
|
.\" \&.Sh SECTION 2 |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Nested implicit full-block, where the subsection |
|
.\" .Sq \&Ss |
|
.\" is within the scope of the parent section |
|
.\" .Sq \&Sh |
|
.\" and closed along with its parent by the subsequent |
|
.\" .Sq \&Sh . |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Sh SECTION 1 |
|
.\" \&.Ss Subsection 1 |
|
.\" body... |
|
.\" \&.Sh SECTION 2 |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit full-block. Has a head, a body and no tail. Scope closed by |
|
.\" .Sq \&Ef |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Bf symbolic |
|
.\" body... |
|
.\" \&.Ef |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Nested explicit/implicit scope. |
|
.\" .Sq \&It |
|
.\" macro is an implicit block whose scope is closed by the explicit |
|
.\" .Sq \&El |
|
.\" closure. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Bl \-bullet |
|
.\" \&.It head |
|
.\" body... |
|
.\" \&.El |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit partial-block. Has head, body and tail. Scope closed by |
|
.\" .Sq \&Ec |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Eo head body... \&Ec tail |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit partial-block. Has only body. Scope is closed by end-of-line. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Sq body... |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Explicit partial-block with only body and scope closed by |
|
.\" .Sq \&Ac |
|
.\" invocation. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Ao body... \&Ac |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Implicit partial-block enclosing explicit partial-block. |
|
.\" .Bd -literal -offset XXX |
|
.\" \&.Sq body... \&Ao body... \&Ac |
|
.\" .Ed |
|
.\" .\" PARAGRAPH |
|
.\" .Pp |
|
.\" Inline macros, several in sequence. Scope is closed for |
|
.\" .Sq \&Fl |
|
.\" by the punctuation delimiter and |
|
.\" .Sq \&Ar |
|
.\" by the end-of-line. |
|
.\" .Bd -literal -offset XXXX |
|
.\" \&.Fl text0 text1 ; Ar text0 text1 |
|
.\" .Ed |
|
.\" SECTION |
.\" SECTION |
.Sh SYNTAX |
.Sh SYNTAX |
Macros are generally two and at times three characters in length. The |
Macros are generally two and at times three characters in length. The |
Line 640 compatibility with these systems. |
|
Line 664 compatibility with these systems. |
|
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
|
.Sq \&Fo |
|
and |
|
.Sq \&St |
|
historically weren't always callable. Both are now correctly callable. |
|
.\" LIST-ITEM |
|
.It |
.Sq \&It \-nested |
.Sq \&It \-nested |
is assumed for all lists: any list may be nested and |
is assumed for all lists: any list may be nested and |
.Sq \-enum |
.Sq \-enum |
|
|
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
|
.\" SECTION |
|
.Sh CAVEATS |
|
There are several ambiguous parts of mdoc. |
|
.Pp |
|
.Bl -dash -compact |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Fa |
|
should be |
|
.Sq \&Va |
|
as function arguments are variables. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Ft |
|
should be |
|
.Sq \&Vt |
|
as function return types are still types. Furthermore, the |
|
.Sq \&Ft |
|
should be removed and |
|
.Sq \&Fo , |
|
which ostensibly follows it, should follow the same convention as |
|
.Sq \&Va . |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Va |
|
should formalise that only one or two arguments are acceptable: a |
|
variable name and optional, preceeding type. |
|
.\" LIST-ITEM |
|
.It |
|
.Sq \&Fd |
|
is ambiguous. It's commonly used to indicate an include file in the |
|
synopsis section. |
|
.Sq \&In |
|
should be used, instead. |
|
.\" LIST-ITEM |
|
.It |
|
Only the |
|
.Sq \-literal |
|
argument to |
|
.Sq \&Bd |
|
makes sense. The remaining ones should be removed. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&Xo |
|
and |
|
.Sq \&Xc |
|
macros should be deprecated. |
|
.\" LIST-ITEM |
|
.It |
|
The |
|
.Sq \&Dt |
|
macro lacks clarity. It should be absolutely clear which title will |
|
render when formatting the manual page. |
|
.El |