Fix issue of non-NAME sections triggering "no sections" error, reported by Christian...

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 03915d01cd2615ddefa010c0eb25e97c8432c41c..ffbc18c273b16633bfef02e8a3e49ddc5b5fda95 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc.1,v 1.26 2009/07/20 13:45:11 kristaps Exp $
+.\"    $Id: mandoc.1,v 1.56 2010/03/29 10:10:35 kristaps Exp $

 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"


@@ -14,53 +14,62 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" 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 20 2009 $
+.Dd $Mdocdate: March 29 2010 $

 .Dt MANDOC 1
 .Os
 .Dt MANDOC 1
 .Os

-.\" SECTION
+.
+.

 .Sh NAME
 .Nm mandoc
 .Nd format and display UNIX manuals
 .Sh NAME
 .Nm mandoc
 .Nd format and display UNIX manuals

-.\" SECTION
+.
+.

 .Sh SYNOPSIS
 .Nm mandoc
 .Sh SYNOPSIS
 .Nm mandoc

-.Op Fl V

 .Op Fl f Ns Ar option...
 .Op Fl m Ns Ar format
 .Op Fl f Ns Ar option...
 .Op Fl m Ns Ar format

-.Op Fl W Ns Ar err...
+.Op Fl O Ns Ar option...

 .Op Fl T Ns Ar output
 .Op Fl T Ns Ar output

+.Op Fl V
+.Op Fl W Ns Ar err...

 .Op Ar infile...
 .Op Ar infile...

-.\" SECTION
+.
+.

 .Sh DESCRIPTION
 The
 .Nm
 utility formats
 .Ux
 manual pages for display.  The arguments are as follows:
 .Sh DESCRIPTION
 The
 .Nm
 utility formats
 .Ux
 manual pages for display.  The arguments are as follows:

+.

 .Bl -tag -width Ds
 .Bl -tag -width Ds

-.\" ITEM

 .It Fl f Ns Ar option...
 .It Fl f Ns Ar option...

-Override default compiler behaviour.  See
+Comma-separated compiler options.  See

 .Sx Compiler Options
 for details.
 .Sx Compiler Options
 for details.

-.\" ITEM
+.

 .It Fl m Ns Ar format
 Input format.  See
 .Sx Input Formats
 for available formats.  Defaults to
 .Fl m Ns Ar andoc .
 .It Fl m Ns Ar format
 Input format.  See
 .Sx Input Formats
 for available formats.  Defaults to
 .Fl m Ns Ar andoc .

-.\" ITEM
+.
+.It Fl O Ns Ar option...
+Comma-separated output options.  See
+.Sx Output Options
+for details.
+.

 .It Fl T Ns Ar output
 Output format.  See
 .Sx Output Formats
 for available formats.  Defaults to
 .Fl T Ns Ar ascii .
 .It Fl T Ns Ar output
 Output format.  See
 .Sx Output Formats
 for available formats.  Defaults to
 .Fl T Ns Ar ascii .

-.\" ITEM
+.

 .It Fl V
 Print version and exit.
 .It Fl V
 Print version and exit.

-.\" ITEM
+.

 .It Fl W Ns Ar err...
 .It Fl W Ns Ar err...

-Configure warning messages.  Use
+Comma-separated warning options.  Use

 .Fl W Ns Ar all
 to print warnings,
 .Fl W Ns Ar error
 .Fl W Ns Ar all
 to print warnings,
 .Fl W Ns Ar error


@@ -69,7 +78,7 @@ termination.  Multiple
 .Fl W
 arguments may be comma-separated, such as
 .Fl W Ns Ar error,all .
 .Fl W
 arguments may be comma-separated, such as
 .Fl W Ns Ar error,all .

-.\" ITEM
+.

 .It Ar infile...
 Read input from zero or more
 .Ar infile .
 .It Ar infile...
 Read input from zero or more
 .Ar infile .


@@ -77,7 +86,7 @@ If unspecified, reads from stdin.  If multiple files are specified,
 .Nm
 will halt with the first failed parse.
 .El
 .Nm
 will halt with the first failed parse.
 .El

-.\" PARAGRAPH
+.

 .Pp
 By default,
 .Nm
 .Pp
 By default,
 .Nm


@@ -87,53 +96,14 @@ or
 .Xr man 7
 text from stdin, implying
 .Fl m Ns Ar andoc ,
 .Xr man 7
 text from stdin, implying
 .Fl m Ns Ar andoc ,

-and prints 78-column backspace-encoded output to stdout as if
+and produces

 .Fl T Ns Ar ascii
 .Fl T Ns Ar ascii

-were provided.
-.\" PARAGRAPH
+output.
+.

 .Pp
 .Ex -std mandoc
 .Pp
 .Ex -std mandoc

-.\" SUB-SECTION
-.Ss Punctuation and Spacing
-If punctuation is set apart from words, such as in the phrase
-.Dq to be \&, or not to be ,
-it's processed by
-.Nm
-according to the following rules:  opening punctuation
-.Po
-.Sq \&( ,
-.Sq \&[ ,
-and
-.Sq \&{
-.Pc
-is not followed by a space; closing punctuation
-.Po
-.Sq \&. ,
-.Sq \&, ,
-.Sq \&; ,
-.Sq \&: ,
-.Sq \&? ,
-.Sq \&! ,
-.Sq \&) ,
-.Sq \&]
-and
-.Sq \&}
-.Pc
-is not preceded by whitespace.
-.Pp
-If the input is
-.Xr mdoc 7 ,
-these rules are also applied to macro arguments when appropriate.
-.Pp
-White-space, in non-literal (normal) mode, is stripped from input and
-replaced on output by a single space.  Thus, if you wish to preserve
-multiple spaces, they must be space-escaped
-.Sq \e\
-or used in a literal display mode, e.g.,
-.Sq \&.Bd \-literal
-in
-.Xr mdoc 7 .
-.\" SUB-SECTION
+.
+.

 .Ss Input Formats
 The
 .Nm
 .Ss Input Formats
 The
 .Nm


@@ -152,19 +122,21 @@ format is
 recommended;
 .Xr man 7
 should only be used for legacy manuals.
 recommended;
 .Xr man 7
 should only be used for legacy manuals.

+.

 .Pp
 A third option,
 .Fl m Ns Ar andoc ,
 which is also the default, determines encoding on-the-fly: if the first
 non-comment macro is
 .Pp
 A third option,
 .Fl m Ns Ar andoc ,
 which is also the default, determines encoding on-the-fly: if the first
 non-comment macro is

-.Sq \&.Dd
+.Sq \&Dd

 or
 or

-.Sq \&.Dt ,
+.Sq \&Dt ,

 the
 .Xr mdoc 7
 parser is used; otherwise, the
 .Xr man 7
 parser is used.
 the
 .Xr mdoc 7
 parser is used; otherwise, the
 .Xr man 7
 parser is used.

+.

 .Pp
 If multiple
 files are specified with
 .Pp
 If multiple
 files are specified with


@@ -175,108 +147,416 @@ specified and
 or
 .Fl m Ns Ar an
 is specified, then this format is used exclusively.
 or
 .Fl m Ns Ar an
 is specified, then this format is used exclusively.

-.\" .Pp
-.\" The following escape sequences are recognised, although the per-format
-.\" compiler may not allow certain sequences.
-.\" .Bl -tag -width Ds -offset XXXX
-.\" .It \efX
-.\" sets the font mode to X (B, I, R or P, where P resets the font)
-.\" .It \eX, \e(XX, \e[XN]
-.\" queries the special-character table for a corresponding symbol
-.\" .It \e*X, \e*(XX, \e*[XN]
-.\" deprecated special-character format
-.\" .El
-.\" SUB-SECTION
+.
+.

 .Ss Output Formats
 The
 .Nm
 utility accepts the following
 .Fl T
 .Ss Output Formats
 The
 .Nm
 utility accepts the following
 .Fl T

-arguments:
+arguments (see
+.Sx OUTPUT ) :
+.

 .Bl -tag -width Ds
 .It Fl T Ns Ar ascii
 Produce 7-bit ASCII output, backspace-encoded for bold and underline
 .Bl -tag -width Ds
 .It Fl T Ns Ar ascii
 Produce 7-bit ASCII output, backspace-encoded for bold and underline

-styles.  This is the default.
+styles.  This is the default.  See
+.Sx ASCII Output .
+.
+.It Fl T Ns Ar html
+Produce strict HTML-4.01 output, with a sane default style.  See
+.Sx HTML Output .
+.
+.It Fl T Ns Ar xhtml
+Produce strict XHTML-1.0 output, with a sane default style.  See
+.Sx XHTML Output .
+.

 .It Fl T Ns Ar tree
 Produce an indented parse tree.
 .It Fl T Ns Ar tree
 Produce an indented parse tree.

+.

 .It Fl T Ns Ar lint
 Parse only: produce no output.
 .It Fl T Ns Ar lint
 Parse only: produce no output.

+Implies
+.Fl W Ns Ar all
+and
+.Fl f Ns Ar strict .

 .El
 .El

+.

 .Pp
 If multiple input files are specified, these will be processed by the
 corresponding filter in-order.
 .Pp
 If multiple input files are specified, these will be processed by the
 corresponding filter in-order.

-.\" SUB-SECTION
+.
+.

 .Ss Compiler Options
 .Ss Compiler Options

-Default compiler behaviour may be overriden with the
+Default compiler behaviour may be overridden with the

 .Fl f
 flag.
 .Fl f
 flag.

+.

 .Bl -tag -width Ds
 .It Fl f Ns Ar ign-scope
 When rewinding the scope of a block macro, forces the compiler to ignore
 scope violations.  This can seriously mangle the resulting tree.
 .Pq mdoc only
 .Bl -tag -width Ds
 .It Fl f Ns Ar ign-scope
 When rewinding the scope of a block macro, forces the compiler to ignore
 scope violations.  This can seriously mangle the resulting tree.
 .Pq mdoc only

+.
+.It Fl f Ns Ar ign-escape
+Ignore invalid escape sequences.
+This is the default, but the option can be used to override an earlier
+.Fl f Ns Ar strict .
+.

 .It Fl f Ns Ar no-ign-escape
 Don't ignore invalid escape sequences.
 .It Fl f Ns Ar no-ign-escape
 Don't ignore invalid escape sequences.

+.

 .It Fl f Ns Ar no-ign-macro
 Do not ignore unknown macros at the start of input lines.
 .It Fl f Ns Ar no-ign-macro
 Do not ignore unknown macros at the start of input lines.

+.

 .It Fl f Ns Ar no-ign-chars
 Do not ignore disallowed characters.
 .It Fl f Ns Ar no-ign-chars
 Do not ignore disallowed characters.

+.

 .It Fl f Ns Ar strict
 Implies
 .Fl f Ns Ar no-ign-escape ,
 .Fl f Ns Ar no-ign-macro
 and
 .Fl f Ns Ar no-ign-chars .
 .It Fl f Ns Ar strict
 Implies
 .Fl f Ns Ar no-ign-escape ,
 .Fl f Ns Ar no-ign-macro
 and
 .Fl f Ns Ar no-ign-chars .

+.
+.It Fl f Ns Ar ign-errors
+When parsing multiple files, don't halt when one errors out.  Useful
+with
+.Fl T Ns Ar lint
+over a large set of manuals passed on the command line.
+.El
+.
+.
+.Ss Output Options
+For the time being, only
+.Fl T Ns Ar html
+and
+.Fl T Ns Ar xhtml
+accepts output options:
+.Bl -tag -width Ds
+.It Fl O Ns Ar style=style.css
+The file
+.Ar style.css
+is used for an external style-sheet.  This must be a valid absolute or
+relative URI.
+.It Fl O Ns Ar includes=fmt
+The string
+.Ar fmt ,
+for example,
+.Ar ../src/%I.html ,
+is used as a template for linked header files (usually via the
+.Sq \&In
+macro).  Instances of
+.Sq \&%I
+are replaced with the include filename.  The default is not to present a
+hyperlink.
+.It Fl O Ns Ar man=fmt
+The string
+.Ar fmt ,
+for example,
+.Ar ../html%S/%N.%S.html ,
+is used as a template for linked manuals (usually via the
+.Sq \&Xr
+macro).  Instances of
+.Sq \&%N
+and
+.Sq %S
+are replaced with the linked manual's name and section, respectively.
+If no section is included, section 1 is assumed.  The default is not to
+present a hyperlink.

 .El
 .El

-.\" PARAGRAPH
+.
+.
+.Sh OUTPUT
+This section documents output details of
+.Nm .
+In general, output conforms to the traditional manual style of a header,
+a body composed of sections and sub-sections, and a footer.

 .Pp
 .Pp

-As with the
-.Fl W
-flag, multiple
-.Fl f
-options may be grouped and delimited with a comma.  Using
-.Fl f Ns Ar ign-scope,no-ign-escape ,
-for example, will try to ignore scope and not ignore character-escape
-errors.
-.\" SECTION
+The text style of output characters (non-macro characters, punctuation,
+and white-space) is dictated by context.
+.Pp
+White-space is generally stripped from input.  This can be changed with
+character escapes (specified in
+.Xr mandoc_char 7 )
+or literal modes (specified in
+.Xr mdoc 7
+and
+.Xr man 7 ) .
+.Pp
+If non-macro punctuation is set apart from words, such as in the phrase
+.Dq to be \&, or not to be ,
+it's processed by
+.Nm ,
+regardless of output format, according to the following rules:  opening
+punctuation
+.Po
+.Sq \&( ,
+.Sq \&[ ,
+and
+.Sq \&{
+.Pc
+is not followed by a space; closing punctuation
+.Po
+.Sq \&. ,
+.Sq \&, ,
+.Sq \&; ,
+.Sq \&: ,
+.Sq \&? ,
+.Sq \&! ,
+.Sq \&) ,
+.Sq \&]
+and
+.Sq \&}
+.Pc
+is not preceded by white-space.
+.
+.Pp
+If the input is
+.Xr mdoc 7 ,
+however, these rules are also applied to macro arguments when appropriate.
+.
+.
+.Ss ASCII Output
+Output produced by
+.Fl T Ns Ar ascii ,
+which is the default, is rendered in standard 7-bit ASCII documented in
+.Xr ascii 7 .
+.Pp
+Font styles are applied by using back-spaced encoding such that an
+underlined character
+.Sq c
+is rendered as
+.Sq _ Ns \e[bs] Ns c ,
+where
+.Sq \e[bs]
+is the back-space character number 8.  Emboldened characters are rendered as
+.Sq c Ns \e[bs] Ns c .
+.Pp
+The special characters documented in
+.Xr mandoc_char 7
+are rendered best-effort in an ASCII equivalent.
+.Pp
+Output width is limited to 78 visible columns unless literal input lines
+exceed this limit.
+.
+.
+.Ss HTML Output
+Output produced by
+.Fl T Ns Ar html
+conforms to HTML-4.01 strict.
+.Pp
+Font styles and page structure are applied using CSS2.  By default, no
+font style is applied to any text, although CSS2 is hard-coded to format
+the basic structure of output.
+.Pp
+The
+.Pa example.style.css
+file documents the range of styles applied to output and, if used, will
+cause rendered documents to appear as they do in
+.Fl T Ns Ar ascii .
+.Pp
+Special characters are rendered in decimal-encoded UTF-8.
+.
+.
+.Ss XHTML Output
+Output produced by
+.Fl T Ns Ar xhtml
+conforms to XHTML-1.0 strict.
+.Pp
+See
+.Sx HTML Output
+for details; beyond generating XHTML tags instead of HTML tags, these
+output modes are identical.
+.
+.

 .Sh EXAMPLES
 To page manuals to the terminal:
 .Sh EXAMPLES
 To page manuals to the terminal:

-.\" PARAGRAPH
+.

 .Pp
 .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .Pp
 .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less

-.\" SECTION
+.
+.Pp
+To produce HTML manuals with
+.Ar style.css
+as the style-sheet:
+.Pp
+.D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > mdoc.7.html
+.Pp
+To check over a large set of manuals:
+.
+.Pp
+.Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
+.
+.

 .Sh COMPATIBILITY
 This section summarises
 .Nm
 compatibility with
 .Xr groff 1 .
 .Sh COMPATIBILITY
 This section summarises
 .Nm
 compatibility with
 .Xr groff 1 .

-.Pp
+Each input and output format is separately noted.
+.
+.
+.Ss ASCII Compatibility

 .Bl -bullet -compact
 .It
 .Bl -bullet -compact
 .It

+The
+.Sq \e~
+special character doesn't produce expected behaviour in
+.Fl T Ns Ar ascii .
+.
+.It
+The
+.Sq \&Bd \-literal
+and
+.Sq \&Bd \-unfilled
+macros of
+.Xr mdoc 7
+in
+.Fl T Ns Ar ascii
+are synonyms, as are \-filled and \-ragged.
+.
+.It
+In
+.Xr groff 1 ,
+the
+.Sq \&Pa
+.Xr mdoc 7
+macro does not underline when scoped under an
+.Sq \&It
+in the FILES section.  This behaves correctly in
+.Nm .
+.
+.It

 A list or display following
 A list or display following

-.Sq \&.Ss
+.Sq \&Ss
+.Xr mdoc 7
+macro in
+.Fl T Ns Ar ascii

 does not assert a prior vertical break, just as it doesn't with
 does not assert a prior vertical break, just as it doesn't with

-.Sq \&.Sh .
+.Sq \&Sh .
+.

 .It
 .It

-The \-literal and \-unfilled
-.Sq \&.Bd
-displays types are synonyms, as are \-filled and \-ragged.
+The
+.Sq \&na
+.Xr man 7
+macro in
+.Fl T Ns Ar ascii
+has no effect.
+.

 .It
 Words aren't hyphenated.
 .It
 Words aren't hyphenated.

+.

 .It
 In normal mode (not a literal block), blocks of spaces aren't preserved,
 .It
 In normal mode (not a literal block), blocks of spaces aren't preserved,

-so double spaces following sentence closure are reduced to a single space
-.Pq Dq French spacing .
+so double spaces following sentence closure are reduced to a single space;
+.Xr groff 1
+retains spaces.
+.
+.It
+Sentences are unilaterally monospaced.
+.El
+.
+.
+.Ss HTML/XHTML Compatibility
+.Bl -bullet -compact
+.It
+The
+.Sq \efP
+escape will revert the font to the previous
+.Sq \ef
+escape, not to the last rendered decoration, which is now dictated by
+CSS instead of hard-coded.  It also will not span past the current
+scope, for the same reason.  Note that in
+.Sx ASCII Output
+mode, this will work fine.
+.It
+The
+.Xr mdoc 7
+.Sq \&Bl \-hang
+and
+.Sq \&Bl \-tag
+list types render similarly (no break following overreached left-hand
+side) due to the expressive constraints of HTML.
+.
+.It
+The
+.Xr man 7
+.Sq IP
+and
+.Sq TP
+lists render similarly.

 .El
 .El

-.\" SECTION
+.
+.

 .Sh SEE ALSO
 .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,
 .Xr man 7
 .Sh SEE ALSO
 .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,
 .Xr man 7

-.\" SECTION
+.

 .Sh AUTHORS
 The
 .Nm
 utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .
 .Sh AUTHORS
 The
 .Nm
 utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .

+.
+.
+.Sh CAVEATS
+The
+.Fl T Ns Ar html
+and
+.Fl T Ns Ar xhtml
+CSS2 styling used for
+.Fl m Ns Ar doc
+input lists does not render properly in older browsers, such as Internet
+Explorer 6 and earlier.
+.
+.Pp
+In
+.Fl T Ns Ar html
+and
+.Fl T Ns Ar xhtml ,
+the maximum size of an element attribute is determined by
+.Dv BUFSIZ ,
+which is usually 1024 bytes.  Be aware of this when setting long link
+formats, e.g.,
+.Fl O Ns Ar style=really/long/link .
+.
+.Pp
+The
+.Fl T Ns Ar html
+and
+.Fl T Ns Ar xhtml
+output modes don't render the
+.Sq \es
+font size escape documented in
+.Xr mdoc 7
+and
+.Xr man 7 .
+.
+.Pp
+Nesting elements within next-line element scopes of
+.Fl m Ns Ar an ,
+such as
+.Sq br
+within an empty
+.Sq B ,
+will confuse
+.Fl T Ns Ar html
+and
+.Fl T Ns Ar xhtml
+and cause them to forget the formatting of the prior next-line scope.
+.
+.Pp
+The
+.Sq i
+macro in
+.Fl m Ns Ar an
+should italicise all subsequent text if a line argument is not provided.
+This behaviour is not implemented.
+.
+The
+.Sq \(aq
+control character is an alias for the standard macro control character
+and does not emit a line-break as stipulated in GNU troff.