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 527ba0ce72ef786b3add8e0e9560a0c35176c1e0..ffbc18c273b16633bfef02e8a3e49ddc5b5fda95 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc.1,v 1.48 2009/11/16 09:52:47 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,7 +14,7 @@
 .\" 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: November 16 2009 $
+.Dd $Mdocdate: March 29 2010 $

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


@@ -167,11 +167,19 @@ styles.  This is the default.  See
 Produce strict HTML-4.01 output, with a sane default style.  See
 .Sx HTML Output .
 .
 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 lint
 Parse only: produce no output.
 .It Fl T Ns Ar tree
 Produce an indented parse tree.
 .
 .It Fl T Ns Ar lint
 Parse only: produce no output.

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

 .El
 .
 .Pp
 .El
 .
 .Pp


@@ -212,7 +220,8 @@ and
 .Fl f Ns Ar no-ign-chars .
 .
 .It Fl f Ns Ar ign-errors
 .Fl f Ns Ar no-ign-chars .
 .
 .It Fl f Ns Ar ign-errors

-Don't halt when encountering parse errors.  Useful with
+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
 .Fl T Ns Ar lint
 over a large set of manuals passed on the command line.
 .El


@@ -221,6 +230,8 @@ over a large set of manuals passed on the command line.
 .Ss Output Options
 For the time being, only
 .Fl T Ns Ar html
 .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
 accepts output options:
 .Bl -tag -width Ds
 .It Fl O Ns Ar style=style.css


@@ -231,7 +242,7 @@ relative URI.
 .It Fl O Ns Ar includes=fmt
 The string
 .Ar fmt ,
 .It Fl O Ns Ar includes=fmt
 The string
 .Ar fmt ,

-for example, 
+for example,

 .Ar ../src/%I.html ,
 is used as a template for linked header files (usually via the
 .Sq \&In
 .Ar ../src/%I.html ,
 is used as a template for linked header files (usually via the
 .Sq \&In


@@ -242,7 +253,7 @@ hyperlink.
 .It Fl O Ns Ar man=fmt
 The string
 .Ar fmt ,
 .It Fl O Ns Ar man=fmt
 The string
 .Ar fmt ,

-for example, 
+for example,

 .Ar ../html%S/%N.%S.html ,
 is used as a template for linked manuals (usually via the
 .Sq \&Xr
 .Ar ../html%S/%N.%S.html ,
 is used as a template for linked manuals (usually via the
 .Sq \&Xr


@@ -260,7 +271,7 @@ present a hyperlink.
 This section documents output details of
 .Nm .
 In general, output conforms to the traditional manual style of a header,
 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.  
+a body composed of sections and sub-sections, and a footer.

 .Pp
 The text style of output characters (non-macro characters, punctuation,
 and white-space) is dictated by context.
 .Pp
 The text style of output characters (non-macro characters, punctuation,
 and white-space) is dictated by context.


@@ -307,7 +318,7 @@ however, these rules are also applied to macro arguments when appropriate.
 .
 .
 .Ss ASCII Output
 .
 .
 .Ss ASCII Output

-Output produced by 
+Output produced by

 .Fl T Ns Ar ascii ,
 which is the default, is rendered in standard 7-bit ASCII documented in
 .Xr ascii 7 .
 .Fl T Ns Ar ascii ,
 which is the default, is rendered in standard 7-bit ASCII documented in
 .Xr ascii 7 .


@@ -333,7 +344,7 @@ exceed this limit.
 .Ss HTML Output
 Output produced by
 .Fl T Ns Ar html
 .Ss HTML Output
 Output produced by
 .Fl T Ns Ar html

-comforms to HTML-4.01 strict.
+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
 .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


@@ -348,6 +359,17 @@ cause rendered documents to appear as they do in
 Special characters are rendered in decimal-encoded UTF-8.
 .
 .
 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:
 .


@@ -379,15 +401,15 @@ Each input and output format is separately noted.
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It

-The 
+The

 .Sq \e~
 .Sq \e~

-special character doesn't produce expected behaviour in 
+special character doesn't produce expected behaviour in

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

-The 
+The

 .Sq \&Bd \-literal
 .Sq \&Bd \-literal

-and 
+and

 .Sq \&Bd \-unfilled
 macros of
 .Xr mdoc 7
 .Sq \&Bd \-unfilled
 macros of
 .Xr mdoc 7


@@ -396,7 +418,7 @@ in
 are synonyms, as are \-filled and \-ragged.
 .
 .It
 are synonyms, as are \-filled and \-ragged.
 .
 .It

-In 
+In

 .Xr groff 1 ,
 the
 .Sq \&Pa
 .Xr groff 1 ,
 the
 .Sq \&Pa


@@ -437,7 +459,7 @@ Sentences are unilaterally monospaced.
 .El
 .
 .
 .El
 .
 .

-.Ss HTML Compatibility
+.Ss HTML/XHTML Compatibility

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


@@ -446,7 +468,7 @@ 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
 .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 
+scope, for the same reason.  Note that in

 .Sx ASCII Output
 mode, this will work fine.
 .It
 .Sx ASCII Output
 mode, this will work fine.
 .It


@@ -483,24 +505,58 @@ utility was written by
 .Sh CAVEATS
 The
 .Fl T Ns Ar html
 .Sh CAVEATS
 The
 .Fl T Ns Ar html

+and
+.Fl T Ns Ar xhtml

 CSS2 styling used for
 .Fl m Ns Ar doc
 CSS2 styling used for
 .Fl m Ns Ar doc

-input lists does not render properly in brain-dead browsers, such as
-Internet Explorer 6 and earlier.
+input lists does not render properly in older browsers, such as Internet
+Explorer 6 and earlier.
+.

 .Pp
 In
 .Pp
 In

-.Fl T Ns Ar html ,
+.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 .
 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
 .Pp
 The
 .Fl T Ns Ar html

-output mode doesn't render the
+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 .
 .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.