-.\" $Id: mdoc.7,v 1.47 2009/07/18 18:49:19 kristaps Exp $
+.\" $Id: mdoc.7,v 1.50 2009/07/20 13:45:11 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.\"
-.Dd $Mdocdate: July 18 2009 $
+.\"
+.Dd $Mdocdate: July 20 2009 $
.Dt MDOC 7
.Os
.\" SECTION---------------------------------------------
.Sh DESCRIPTION
The
.Nm mdoc
-language is used to format
-.Bx
+language is used to format
+.Bx
.Ux
manuals. In this reference document, we describe its syntax, structure,
and usage. Our reference implementation is
.Xr mandoc 1 .
The
.Sx COMPATIBILITY
-section describes compatibility with
+section describes compatibility with
.Xr groff 1 .
.\" PARAGRAPH------------
.Pp
An
.Nm
document follows simple rules: lines beginning with the control
-character
+character
.Sq \.
are parsed for macros. Other lines are interpreted within the scope of
prior macros:
character, and, in certain circumstances, the tab character. All
manuals must have
.Ux
-line terminators.
+line terminators.
.\" SUB-SECTION----------------------
.Ss Comments
Text following a
.It \&?
.Pq question
.It \&!
-.Pq exclamation
+.Pq exclamation
.It \&|
-.Pq vertical bar
+.Pq vertical bar
.El
.\" PARAGRAPH------------
.Pp
For general use in macro lines, these characters must either be escaped
with a non-breaking space
.Pq Sq \e&
-or, if applicable, an appropriate escape sequence used.
+or, if applicable, an appropriate escape sequence used.
.\" SUB-SECTION----------------------
.Ss Special Characters
Special characters may occur in both macro and free-form lines.
Sequences begin with the escape character
.Sq \e
-followed by either an open-parenthesis
+followed by either an open-parenthesis
.Sq \&(
for two-character sequences; an open-bracket
.Sq \&[
.Sq \&] ) ;
or a single one-character sequence. See
.Xr mandoc_char 1
-for a complete list. Examples include
-.Sq \e(em
-.Pq em-dash
-and
+for a complete list. Examples include
+.Sq \e(em
+.Pq em-dash
+and
.Sq \ee
.Pq back-slash .
.\" PARAGRAPH------------
.Sq \ef
escape followed by an indicator: B (bold), I, (italic), or P and R
(Roman, or reset). This form is not recommended.
-.Pp
-Lastly, a standalone double-quote may be produced in a macro line by
-using two consecutive double-quotes within a quoted literal. See
-.Sx Quotation
-for details.
.\" SUB-SECTION----------------------
.Ss Whitespace
In non-literal free-form lines, consecutive blocks of whitespace are
pruned from input and added later in the output filter, if applicable:
.Bd -literal -offset indent
These spaces are pruned from input.
-\&.Bd \-literal
+\&.Bd \-literal
These are not.
\&.Ed
.Ed
.Pp
Blank lines are only permitted within literal contexts, as are lines
containing only whitespace. Tab characters are only acceptable when
-delimiting
+delimiting
.Sq \&Bl \-column
or when in a literal context.
.\" SUB-SECTION----------------------
Macro arguments may be quoted with a double-quote to group
space-delimited terms or to retain blocks of whitespace. A quoted
argument begins with a double-quote preceded by whitespace. The next
-double-quote that is
-.Em
-preceded by a double-quote terminates the term, regardless of
-surrounding whitespace. Thus, the following construction produces
-.Sq "a""b" ,
-since, as mentioned in
-.Sx Special Characters ,
-two consecutive double-quotes in a quoted literal produce a standalone
-double-quote:
-.Bd -literal -offset indent
-\&.Em "a""""b"
-.Ed
+double-quote not pair-wise adjacent to another double-quote terminates
+the literal, regardless of surrounding whitespace.
.\" PARAGRAPH------------
.Pp
-This produces tokens
+This produces tokens
.Sq a" ,
.Sq b c ,
.Sq de ,
and
.Sq fg" .
Note that any quoted term, be it argument or macro, is indiscriminately
-considered literal text. Thus, the following produces
+considered literal text. Thus, the following produces
.Sq \&Em a :
.Bd -literal -offset indent
\&.Em "Em a"
.Sh MANUAL STRUCTURE
Each
.Nm
-document must begin with a document prologue, containing, in order,
+document must begin with a document prologue, containing, in order,
.Sq \&Dd ,
.Sq \&Dt ,
and
.Sq \&Os ,
then the NAME section containing at least one
.Sq \&Nm
-followed by
+followed by
.Sq \&Nd :
.Bd -literal -offset indent
\&.Dd $\&Mdocdate$
.\" PARAGRAPH------------
.Pp
Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
-but non-compulsory.
+but non-compulsory.
.\" SECTION---------------------------------------------
.Sh MACRO SYNTAX
-Every line beginning with the control character
+Every line beginning with the control character
.Sq \.
is processed for macros, two- or three-character sequences.
.\" PARAGRAPH------------
.Pp
The syntax of a macro depends on its classification. In this section,
-.Sq \-arg
+.Sq \-arg
refers to macro arguments, which may be followed by zero or more
.Sq parm
parameters;
The
.Em Callable
column indicates that the macro may be called subsequent to the initial
-line-macro. The
+line-macro. The
.Em Parsable
column indicates whether the macro may be followed by further
(ostensibly callable) macros. The
.Pq Sq \&Bf
contains a head.
.Bd -literal -offset indent
-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
-\(lBbody...\(rB
+\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
+\(lBbody...\(rB
\&.Yc
.Ed
.\" PARAGRAPH------------
.\" SUB-SECTION----------------------
.Ss Block full-implicit
Multi-line scope closed by end-of-file or implicitly by another macro.
-All macros have bodies; some
+All macros have bodies; some
.Po
-.Sq \&It \-bullet ,
-.Sq \-hyphen ,
+.Sq \&It \-bullet ,
+.Sq \-hyphen ,
.Sq \-dash ,
.Sq \-enum ,
-.Sq \-item
+.Sq \-item
.Pc
-don't have heads, while
+don't have heads, while
.Sq \&It \-column
may have multiple heads.
.Bd -literal -offset indent
-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
-\(lBbody...\(rB
+\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
+\(lBbody...\(rB
.Ed
.\" PARAGRAPH------------
.Pp
.\" SUB-SECTION----------------------
.Ss Block partial-explicit
Like block full-explicit, but also with single-line scope. Each
-has at least a body and, in limited circumstances, a head
+has at least a body and, in limited circumstances, a head
.Pq So \&Fo Sc , So \&Eo Sc
-and/or tail
+and/or tail
.Pq So \&Ec Sc .
.Bd -literal -offset indent
-\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
-\(lBbody...\(rB
-\&.Yc \(lBtail...\(rB
+\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
+\(lBbody...\(rB
+\&.Yc \(lBtail...\(rB
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
-\(lBbody...\(rB \&Yc \(lBtail...\(rB
+\(lBbody...\(rB \&Yc \(lBtail...\(rB
.Ed
.\" PARAGRAPH------------
.Pp
.El
.\" SUB-SECTION----------------------
.Ss Block partial-implicit
-Like block full-implicit, but with single-line scope closed by
-.Sx Reserved Characters
+Like block full-implicit, but with single-line scope closed by
+.Sx Reserved Characters
or end of line.
.Bd -literal -offset indent
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
.El
.\" SUB-SECTION----------------------
.Ss In-line
-Closed by
+Closed by
.Sx Reserved Characters ,
end of line, fixed argument lengths, and/or subsequent macros. In-line
macros have only text children. If a number (or inequality) of
arguments is
-.Pq n ,
+.Pq n ,
then the macro accepts an arbitrary number of arguments.
.Bd -literal -offset indent
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb
.It \&Bsx Ta Yes Ta Yes Ta n
.It \&Bt Ta \&No Ta \&No Ta 0
.It \&Bx Ta Yes Ta Yes Ta n
-.It \&Cd Ta Yes Ta \&No Ta >0
+.It \&Cd Ta Yes Ta Yes Ta >0
.It \&Cm Ta Yes Ta Yes Ta n
.It \&Db Ta \&No Ta \&No Ta 1
.It \&Dd Ta \&No Ta \&No Ta >0
.\" SECTION---------------------------------------------
.Sh COMPATIBILITY
This section documents compatibility with other roff implementations, at
-this time limited to
+this time limited to
.Xr groff 1 .
-The term
+The term
.Qq historic groff
-refers to those versions before the
+refers to those versions before the
.Pa doc.tmac
-file re-write
+file re-write
.Pq somewhere between 1.15 and 1.19 .
.\" PARAGRAPH------------
.Pp
.Bl -dash -compact
.\" LIST-ITEM
.It
-The
+In quoted literals, groff allowed pair-wise double-quotes to produce a
+standalone double-quote in formatted output. This idiosyncratic
+behaviour is no longer applicable.
+.\" LIST-ITEM
+.It
+The
.Sq \&sp
macro does not accept negative numbers.
.\" LIST-ITEM
.It
Some character sequences in groff are not handled depending on escape
-style, e.g.,
+style, e.g.,
.Sq \e(ba
and
.Sq \e*(Ba
non-historic groff version.
.\" LIST-ITEM
.It
-The vertical bar
+The vertical bar
.Sq \(ba
made historic groff
.Qq go orbital
of proceeded) is not supported.
.\" LIST-ITEM
.It
-The
+The
.Sq \&At
macro only accepts a single parameter.
.\" LIST-ITEM
versions of groff seem to dither on this.
.\" LIST-ITEM
.It
-In groff, the
+In groff, the
.Sq \&Fo
macro only produces the first parameter. This is no longer the case.
.El
.Sh AUTHORS
The
.Nm
-reference was written by
+reference was written by
.An Kristaps Dzonsons Aq kristaps@kth.se .
.\" SECTION---------------------------------------------
.Sh CAVEATS
.\" LIST-ITEM
.It
.Sq \&Fa
-should be
+should be
.Sq \&Va
as function arguments are variables.
.\" LIST-ITEM
.It
.Sq \&Fd
is ambiguous. It's commonly used to indicate an include file in the
-synopsis section.
+synopsis section.
.Sq \&In
should be used, instead.
.\" LIST-ITEM
makes sense. The remaining ones should be removed.
.\" LIST-ITEM
.It
-The
+The
.Sq \&Xo
and
.Sq \&Xc
.It
A
.Sq \&Lx
-should be provided for Linux (\(`a la
+should be provided for Linux (\(`a la
.Sq \&Ox ,
-.Sq \&Nx
+.Sq \&Nx
etc.).
.\" LIST-ITEM
.It
blocks.
.\" LIST-ITEM
.It
-The \-split and \-nosplit arguments to
+The \-split and \-nosplit arguments to
.Sq \&An
are inane.
.El
git.ckatri.com / mandoc.git / blobdiff