version 1.125, 2010/06/12 10:09:19 |
version 1.137, 2010/07/19 10:48:36 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2010 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 51 manuals must have |
|
Line 52 manuals must have |
|
line terminators. |
line terminators. |
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e" , |
.Sq \e\*q , |
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. A macro line with only a control character and comment escape, |
.Sq \&.\e" , |
.Sq \&.\e\*q , |
is also ignored. Macro lines with only a control character and optionally |
is also ignored. Macro lines with only a control character and optionally |
whitespace are stripped from input. |
whitespace are stripped from input. |
.Ss Reserved Characters |
.Ss Reserved Characters |
|
|
is specified outside of any font scope, such as in unenclosed, free-form |
is specified outside of any font scope, such as in unenclosed, free-form |
text, it will affect the remainder of the document. |
text, it will affect the remainder of the document. |
.Pp |
.Pp |
Text may also be sized with the |
Note this form is |
.Sq \es |
|
escape, whose syntax is one of |
|
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
|
.D1 \es+1bigger\es-1 |
|
.D1 \es[+10]much bigger\es[-10] |
|
.D1 \es+(10much bigger\es-(10 |
|
.D1 \es+'100'much much bigger\es-'100' |
|
.Pp |
|
Note these forms are |
|
.Em not |
.Em not |
recommended for |
recommended for |
.Nm , |
.Nm , |
Line 478 they are separated by a vertical space, unless in the |
|
Line 458 they are separated by a vertical space, unless in the |
|
and |
and |
.Sx \&Ft , |
.Sx \&Ft , |
which are always separated by vertical space. |
which are always separated by vertical space. |
|
.Pp |
|
When text and macros following an |
|
.Sx \&Nm |
|
macro starting an input line span multiple output lines, |
|
all output lines but the first will be indented to align |
|
with the text immediately following the |
|
.Sx \&Nm |
|
macro, up to the next |
|
.Sx \&Nm , |
|
.Sx \&Sx , |
|
or |
|
.Sx \&Ss |
|
macro or the end of an enclosing block, whichever comes first. |
.It Em DESCRIPTION |
.It Em DESCRIPTION |
This expands upon the brief, one-line description in |
This expands upon the brief, one-line description in |
.Em NAME . |
.Em NAME . |
Line 672 has multiple heads. |
|
Line 665 has multiple heads. |
|
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh |
|
.It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
.El |
.El |
|
.Pp |
|
Note that the |
|
.Sx \&Nm |
|
macro is a |
|
.Sx Block full-implicit |
|
macro only when invoked as the first macro |
|
in a |
|
.Em SYNOPSIS |
|
section line, else it is |
|
.Sx In-line . |
.Ss Block partial-explicit |
.Ss Block partial-explicit |
Like block full-explicit, but also with single-line scope. |
Like block full-explicit, but also with single-line scope. |
Each has at least a body and, in limited circumstances, a head |
Each has at least a body and, in limited circumstances, a head |
|
|
block. Does not have any tail arguments. |
block. Does not have any tail arguments. |
.Ss \&Bd |
.Ss \&Bd |
Begins a display block. |
Begins a display block. |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Bd |
|
.Fl type |
|
.Op Fl offset Ar width |
|
.Op Fl compact |
|
.Ed |
|
.Pp |
A display is collection of macros or text which may be collectively |
A display is collection of macros or text which may be collectively |
offset or justified in a manner different from that |
offset or justified in a manner different from that |
of the enclosing context. |
of the enclosing context. |
Line 1063 Centre-justify each line. |
|
Line 1075 Centre-justify each line. |
|
The type must be provided first. |
The type must be provided first. |
Secondary arguments are as follows: |
Secondary arguments are as follows: |
.Bl -tag -width 12n -offset indent |
.Bl -tag -width 12n -offset indent |
.It Fl offset Ar width |
.It Fl offset Ar val |
Offset by the value of |
Offset by the value of |
.Ar width , |
.Ar val , |
which is interpreted as one of the following, specified in order: |
which is interpreted as one of the following, specified in order: |
.Bl -item |
.Bl -item |
.It |
.It |
Line 1076 the width of standard indentation; |
|
Line 1088 the width of standard indentation; |
|
twice |
twice |
.Ar indent ; |
.Ar indent ; |
.Ar left , |
.Ar left , |
which has no effect ; |
which has no effect; |
.Ar right , |
.Ar right , |
which justifies to the right margin; and |
which justifies to the right margin; and |
.Ar center , |
.Ar center , |
Line 1094 As a scaling unit following the syntax described in |
|
Line 1106 As a scaling unit following the syntax described in |
|
As the calculated string length of the opaque string. |
As the calculated string length of the opaque string. |
.El |
.El |
.Pp |
.Pp |
If unset, it will revert to the value of |
If not provided an argument, it will be ignored. |
.Ar 8n |
|
as described in |
|
.Sx Scaling Widths . |
|
.It Fl compact |
.It Fl compact |
Do not assert a vertical space before the block. |
Do not assert a vertical space before the block. |
.It Fl file Ar file |
|
Prepend the file |
|
.Ar file |
|
before any text or macros within the block. |
|
.El |
.El |
.Pp |
.Pp |
Examples: |
Examples: |
|
|
and |
and |
.Sx \&Dl . |
.Sx \&Dl . |
.Ss \&Bf |
.Ss \&Bf |
|
Change the font mode for a scoped block of text. |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Bf |
|
.Oo |
|
.Fl emphasis | literal | symbolic | |
|
.Cm \&Em | \&Li | \&Sy |
|
.Oc |
|
.Ed |
|
.Pp |
|
The |
|
.Fl emphasis |
|
and |
|
.Cm \&Em |
|
argument are equivalent, as are |
|
.Fl symbolic |
|
and |
|
.Cm \&Sy, |
|
and |
|
.Fl literal |
|
and |
|
.Cm \&Li . |
|
Without an argument, this macro does nothing. |
|
The font mode continues until broken by a new font mode in a nested |
|
scope or |
|
.Sx \&Ef |
|
is encountered. |
|
.Pp |
|
See also |
|
.Sx \&Li , |
|
.Sx \&Ef , |
|
and |
|
.Sx \&Sy . |
.Ss \&Bk |
.Ss \&Bk |
|
Begins a collection of macros or text not breaking the line. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Bk Fl words |
|
.Pp |
|
Subsequent arguments are ignored. |
|
The |
|
.Fl words |
|
argument is required. |
|
.Pp |
|
Each line within a keep block is kept intact, so the following example |
|
will not break within each |
|
.Sx \&Op |
|
macro line: |
|
.Bd -literal -offset indent |
|
\&.Bk \-words |
|
\&.Op Fl f Ar flags |
|
\&.Op Fl o Ar output |
|
\&.Ek |
|
.Ed |
|
.Pp |
|
Be careful in using over-long lines within a keep block! |
|
Doing so will clobber the right margin. |
.Ss \&Bl |
.Ss \&Bl |
Begins a list composed of one or more list entries. |
Begins a list composed of one or more list entries. |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Bl |
|
.Fl type |
|
.Op Fl width Ar val |
|
.Op Fl offset Ar val |
|
.Op Fl compact |
|
.Op HEAD ... |
|
.Ed |
|
.Pp |
A list is associated with a type, which is a required argument. |
A list is associated with a type, which is a required argument. |
Other arguments are |
Other arguments are |
.Fl width , |
.Fl width , |
|
|
and |
and |
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Ec |
.Ss \&Ec |
|
Close a scope started by |
|
.Sx \&Eo . |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Ec Op Cm TERM |
|
.Pp |
|
The |
|
.Cm TERM |
|
argument is used as the enclosure tail, for example, specifying \e(rq |
|
will emulate |
|
.Sx \&Dc . |
.Ss \&Ed |
.Ss \&Ed |
|
End a display context started by |
|
.Sx \&Bd . |
.Ss \&Ef |
.Ss \&Ef |
|
Ends a font mode context started by |
|
.Sx \&Bf . |
.Ss \&Ek |
.Ss \&Ek |
|
Ends a keep context started by |
|
.Sx \&Bk . |
.Ss \&El |
.Ss \&El |
Ends a list context started by |
Ends a list context started by |
.Sx \&Bl . |
.Sx \&Bl . |
|
|
.D1 \&.Em Warnings! |
.D1 \&.Em Warnings! |
.D1 \&.Em Remarks : |
.D1 \&.Em Remarks : |
.Ss \&En |
.Ss \&En |
|
This macro is obsolete and not implemented. |
.Ss \&Eo |
.Ss \&Eo |
|
An arbitrary enclosure. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Eo Op Cm TERM |
|
.Pp |
|
The |
|
.Cm TERM |
|
argument is used as the enclosure head, for example, specifying \e(lq |
|
will emulate |
|
.Sx \&Do . |
.Ss \&Er |
.Ss \&Er |
Display error constants. |
Display error constants. |
.Pp |
.Pp |
|
|
See also |
See also |
.Sx \&Dv . |
.Sx \&Dv . |
.Ss \&Es |
.Ss \&Es |
|
This macro is obsolete and not implemented. |
.Ss \&Ev |
.Ss \&Ev |
Environmental variables such as those specified in |
Environmental variables such as those specified in |
.Xr environ 7 . |
.Xr environ 7 . |
|
|
See also |
See also |
.Sx \&Fo . |
.Sx \&Fo . |
.Ss \&Fc |
.Ss \&Fc |
|
Ends a function context started by |
|
.Sx \&Fo . |
.Ss \&Fd |
.Ss \&Fd |
Historically used to document include files. |
Historically used to document include files. |
This usage has been deprecated in favour of |
This usage has been deprecated in favour of |
|
|
and |
and |
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Hf |
.Ss \&Hf |
|
This macro is obsolete and not implemented. |
.Ss \&Ic |
.Ss \&Ic |
|
Designate an internal or interactive command. |
|
This is similar to |
|
.Sx \&Cm |
|
but used for instructions rather than values. |
|
.Pp |
|
Examples: |
|
.D1 \&.Ic hash |
|
.D1 \&.Ic alias |
|
.Pp |
|
Note that using |
|
.Sx \&Bd No Fl literal |
|
or |
|
.Sx \&D1 |
|
is preferred for displaying code; the |
|
.Sx \&Ic |
|
macro is used when referring to specific instructions. |
.Ss \&In |
.Ss \&In |
An |
An |
.Qq include |
.Qq include |
|
|
.D1 \&.Lb libz |
.D1 \&.Lb libz |
.D1 \&.Lb mdoc |
.D1 \&.Lb mdoc |
.Ss \&Li |
.Ss \&Li |
|
Denotes text that should be in a literal font mode. |
|
Note that this is a presentation term and should not be used for |
|
stylistically decorating technical terms. |
.Ss \&Lk |
.Ss \&Lk |
Format a hyperlink. |
Format a hyperlink. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
See also |
See also |
.Sx \&Mt . |
.Sx \&Mt . |
.Ss \&Lp |
.Ss \&Lp |
|
Synonym for |
|
.Sx \&Pp . |
.Ss \&Ms |
.Ss \&Ms |
.Ss \&Mt |
.Ss \&Mt |
Format a |
Format a |
Line 1939 Its syntax is as follows: |
|
Line 2063 Its syntax is as follows: |
|
Examples: |
Examples: |
.D1 \&.Mt discuss@manpages.bsd.lv |
.D1 \&.Mt discuss@manpages.bsd.lv |
.Ss \&Nd |
.Ss \&Nd |
|
A one-line description of the manual's content. |
|
This may only be invoked in the |
|
.Em SYNOPSIS |
|
section subsequent the |
|
.Sx \&Nm |
|
macro. |
|
.Pp |
|
Examples: |
|
.D1 \&.Sx \&Nd mdoc language reference |
|
.D1 \&.Sx \&Nd format and display UNIX manuals |
|
.Pp |
|
The |
|
.Sx \&Nd |
|
macro technically accepts child macros and terminates with a subsequent |
|
.Sx \&Sh |
|
invocation. |
|
Do not assume this behaviour: some |
|
.Xr whatis 1 |
|
database generators are not smart enough to parse more than the line |
|
arguments and will display macros verbatim. |
|
.Pp |
|
See also |
|
.Sx \&Nm . |
.Ss \&Nm |
.Ss \&Nm |
|
The name of the manual page, or \(em in particular in section 1, 6, |
|
and 8 pages \(em of an additional command or feature documented in |
|
the manual page. |
|
When first invoked, the |
|
.Sx \&Nm |
|
macro expects a single argument, the name of the manual page. |
|
Usually, the first invocation happens in the |
|
.Em NAME |
|
section of the page. |
|
The specified name will be remembered and used whenever the macro is |
|
called again without arguments later in the page. |
|
The |
|
.Sx \&Nm |
|
macro uses |
|
.Sx Block full-implicit |
|
semantics when invoked as the first macro on an input line in the |
|
.Em SYNOPSIS |
|
section; otherwise, it uses ordinary |
|
.Sx In-line |
|
semantics. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Sh SYNOPSIS |
|
\&.Nm cat |
|
\&.Op Fl benstuv |
|
\&.Op Ar |
|
.Ed |
|
.Pp |
|
In the |
|
.Em SYNOPSIS |
|
of section 2, 3 and 9 manual pages, use the |
|
.Sx \&Fn |
|
macro rather than |
|
.Sx \&Nm |
|
to mark up the name of the manual page. |
.Ss \&No |
.Ss \&No |
|
A |
|
.Qq noop |
|
macro used to terminate prior macro contexts. |
|
.Pp |
|
Examples: |
|
.D1 \&.Sx \&Fl ab \&No cd \&Fl ef |
.Ss \&Ns |
.Ss \&Ns |
.Ss \&Nx |
.Ss \&Nx |
Format the NetBSD version provided as an argument, or a default value if |
Format the NetBSD version provided as an argument, or a default value if |
|
|
and |
and |
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Oc |
.Ss \&Oc |
|
Closes multi-line |
|
.Sx \&Oo |
|
context. |
.Ss \&Oo |
.Ss \&Oo |
|
Multi-line version of |
|
.Sx \&Op . |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent |
|
\&.Oo |
|
\&.Op Fl flag Ns Ar value |
|
\&.Oc |
|
.Ed |
.Ss \&Op |
.Ss \&Op |
|
Command-line option. |
|
Used when listing options to command-line utilities. |
|
Prints the argument(s) in brackets. |
|
.Pp |
|
Examples: |
|
.D1 \&.Op \&Fl a \&Ar b |
|
.D1 \&.Op \&Ar a | b |
|
.Pp |
|
See also |
|
.Sx \&Oo . |
.Ss \&Os |
.Ss \&Os |
Document operating system version. |
Document operating system version. |
This is the mandatory third macro of |
This is the mandatory third macro of |
|
|
and |
and |
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Pa |
.Ss \&Pa |
|
A file-system path. |
|
.Pp |
|
Examples: |
|
.D1 \&.Pa /usr/bin/mandoc |
|
.D1 \&.Pa /usr/share/man/man7/mdoc.7 |
|
.Pp |
|
See also |
|
.Sx \&Lk . |
.Ss \&Pc |
.Ss \&Pc |
|
Close parenthesised context opened by |
|
.Sx \&Po . |
.Ss \&Pf |
.Ss \&Pf |
|
Removes the space |
|
.Pq Qq prefix |
|
between its arguments. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. \&Pf Cm prefix suffix |
|
.Pp |
|
The |
|
.Cm suffix |
|
argument may be a macro. |
|
.Pp |
|
Examples: |
|
.D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix |
.Ss \&Po |
.Ss \&Po |
|
Multi-line version of |
|
.Sx \&Pq . |
.Ss \&Pp |
.Ss \&Pp |
|
Break a paragraph. |
|
This will assert vertical space between prior and subsequent macros |
|
and/or text. |
.Ss \&Pq |
.Ss \&Pq |
|
Parenthesised enclosure. |
|
.Pp |
|
See also |
|
.Sx \&Po . |
.Ss \&Qc |
.Ss \&Qc |
.Ss \&Ql |
.Ss \&Ql |
.Ss \&Qo |
.Ss \&Qo |
|
|
.Ss \&Sc |
.Ss \&Sc |
.Ss \&Sh |
.Ss \&Sh |
.Ss \&Sm |
.Ss \&Sm |
|
Switches the spacing mode for output generated from macros. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&Sm Cm on | off |
|
.Pp |
|
By default, spacing is |
|
.Cm on . |
|
When switched |
|
.Cm off , |
|
no white space is inserted between macro arguments and between the |
|
output generated from adjacent macros, but free-form text lines |
|
still get normal spacing between words and sentences. |
.Ss \&So |
.Ss \&So |
.Ss \&Sq |
.Ss \&Sq |
.Ss \&Ss |
.Ss \&Ss |
|
|
and |
and |
.Sx \&Ox . |
.Sx \&Ox . |
.Ss \&Va |
.Ss \&Va |
|
A variable name. |
|
.Pp |
|
Examples: |
|
.D1 \&.Va foo |
|
.D1 \&.Va const char *bar ; |
.Ss \&Vt |
.Ss \&Vt |
A variable type. |
A variable type. |
This is also used for indicating global variables in the |
This is also used for indicating global variables in the |
Line 2169 Heirloom troff, the other significant troff implementa |
|
Line 2429 Heirloom troff, the other significant troff implementa |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
groff supports a |
The \es (font size), \em (font colour), and \eM (font filling colour) |
.Fl file Ar filename |
font decoration escapes are all discarded in mandoc. |
argument to |
|
.Sx \&Bd . |
|
mandoc does not. |
|
.It |
.It |
|
Old groff fails to assert a newline before |
|
.Sx \&Bd Fl ragged compact . |
|
.It |
groff behaves inconsistently when encountering |
groff behaves inconsistently when encountering |
.Pf non- Sx \&Fa |
.Pf non- Sx \&Fa |
children of |
children of |
Line 2219 pseudo-macro as a line macro. |
|
Line 2479 pseudo-macro as a line macro. |
|
mandoc does. |
mandoc does. |
.It |
.It |
The comment syntax |
The comment syntax |
.Sq \e." |
.Sq \e\." |
is no longer accepted. |
is no longer accepted. |
.It |
.It |
In groff, the |
In groff, the |
Line 2249 In quoted literals, groff allowed pair-wise double-quo |
|
Line 2509 In quoted literals, groff allowed pair-wise double-quo |
|
standalone double-quote in formatted output. |
standalone double-quote in formatted output. |
This idiosyncratic behaviour is not applicable in mandoc. |
This idiosyncratic behaviour is not applicable in mandoc. |
.It |
.It |
Display types |
Display offsets |
.Sx \&Bd |
.Sx \&Bd |
.Fl center |
.Fl offset Ar center |
and |
and |
.Fl right |
.Fl offset Ar right |
are aliases for |
are disregarded in mandoc. |
.Fl left |
Furthermore, troff specifies a |
in mandoc. Furthermore, the |
|
.Fl file Ar file |
.Fl file Ar file |
argument is ignored. |
argument that is not supported in mandoc. |
Lastly, since text is not right-justified in mandoc (or even groff), |
Lastly, since text is not right-justified in mandoc (or even groff), |
.Fl ragged |
.Fl ragged |
and |
and |