Simplify: replace one global flag by one local variable.

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 815463c63ca3bcc6ead8de277e0d23f27dc09bbb..745dd504ed61e08fac1d746076dd3faecdb3a79c 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,6 +1,7 @@
-.\"    $Id: mandoc.1,v 1.66 2010/06/29 14:55:41 kristaps Exp $
+.\"    $Id: mandoc.1,v 1.105 2014/06/23 22:03:30 schwarze Exp $

 .\"
 .\"

-.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -14,7 +15,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: June 29 2010 $
+.Dd $Mdocdate: June 23 2014 $

 .Dt MANDOC 1
 .Os
 .Sh NAME
 .Dt MANDOC 1
 .Os
 .Sh NAME


@@ -23,25 +24,44 @@
 .Sh SYNOPSIS
 .Nm mandoc
 .Op Fl V
 .Sh SYNOPSIS
 .Nm mandoc
 .Op Fl V

-.Op Fl f Ns Ar option
+.Sm off
+.Op Fl I Cm os Li = Ar name
+.Sm on

 .Op Fl m Ns Ar format
 .Op Fl O Ns Ar option
 .Op Fl T Ns Ar output
 .Op Fl m Ns Ar format
 .Op Fl O Ns Ar option
 .Op Fl T Ns Ar output

-.Op Fl W Ns Ar err
-.Op Ar file...
+.Op Fl W Ns Ar level
+.Op Ar

 .Sh DESCRIPTION
 The
 .Nm
 utility formats
 .Ux
 manual pages for display.
 .Sh DESCRIPTION
 The
 .Nm
 utility formats
 .Ux
 manual pages for display.

+.Pp
+By default,
+.Nm
+reads
+.Xr mdoc 7
+or
+.Xr man 7
+text from stdin, implying
+.Fl m Ns Cm andoc ,
+and produces
+.Fl T Ns Cm ascii
+output.
+.Pp

 The arguments are as follows:
 .Bl -tag -width Ds
 The arguments are as follows:
 .Bl -tag -width Ds

-.It Fl f Ns Ar option
-Comma-separated compiler options.
-See
-.Sx Compiler Options
-for details.
+.Sm off
+.It Fl I Cm os Li = Ar name
+.Sm on
+Override the default operating system
+.Ar name
+for the
+.Xr mdoc 7
+.Sq \&Os
+macro.

 .It Fl m Ns Ar format
 Input format.
 See
 .It Fl m Ns Ar format
 Input format.
 See


@@ -60,18 +80,41 @@ Defaults to
 .Fl T Ns Cm ascii .
 .It Fl V
 Print version and exit.
 .Fl T Ns Cm ascii .
 .It Fl V
 Print version and exit.

-.It Fl W Ns Ar err
-Comma-separated warning options.
-Use
+.It Fl W Ns Ar level
+Specify the minimum message
+.Ar level
+to be reported on the standard error output and to affect the exit status.
+The
+.Ar level
+can be
+.Cm warning ,
+.Cm error ,
+or
+.Cm fatal .
+The default is
+.Fl W Ns Cm fatal ;

 .Fl W Ns Cm all
 .Fl W Ns Cm all

-to print warnings,
-.Fl W Ns Cm error
-for warnings to be considered errors and cause utility
-termination.
-Multiple
-.Fl W
-arguments may be comma-separated, such as
-.Fl W Ns Cm error , Ns Cm all .
+is an alias for
+.Fl W Ns Cm warning .
+See
+.Sx EXIT STATUS
+and
+.Sx DIAGNOSTICS
+for details.
+.Pp
+The special option
+.Fl W Ns Cm stop
+tells
+.Nm
+to exit after parsing a file that causes warnings or errors of at least
+the requested level.
+No formatted output will be produced from that file.
+If both a
+.Ar level
+and
+.Cm stop
+are requested, they can be joined with a comma, for example
+.Fl W Ns Cm error , Ns Cm stop .

 .It Ar file
 Read input from zero or more files.
 If unspecified, reads from stdin.
 .It Ar file
 Read input from zero or more files.
 If unspecified, reads from stdin.


@@ -79,20 +122,6 @@ If multiple files are specified,
 .Nm
 will halt with the first failed parse.
 .El
 .Nm
 will halt with the first failed parse.
 .El

-.Pp
-By default,
-.Nm
-reads
-.Xr mdoc 7
-or
-.Xr man 7
-text from stdin, implying
-.Fl m Ns Cm andoc ,
-and produces
-.Fl T Ns Cm ascii
-output.
-.Pp
-.Ex -std mandoc

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


@@ -136,70 +165,52 @@ specified and
 or
 .Fl m Ns Cm an
 is specified, then this format is used exclusively.
 or
 .Fl m Ns Cm an
 is specified, then this format is used exclusively.

-.Ss Compiler Options
-Default
-.Xr mdoc 7
-and
-.Xr man 7
-compilation behaviour may be overridden with the
-.Fl f
-flag.
-.Bl -tag -width Ds
-.It Fl f Ns Cm ign-errors
-When parsing multiple files, don't halt when one errors out.
-Useful with
-.Fl T Ns Cm lint
-over a large set of manuals passed on the command line.
-.It Fl f Ns Cm ign-escape
-Ignore invalid escape sequences.
-This is the default, but the option can be used to override an earlier
-.Fl f Ns Cm strict .
-.It Fl f Ns Cm 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 Cm no-ign-escape
-Do not ignore invalid escape sequences.
-.It Fl f Ns Cm no-ign-macro
-Do not ignore unknown macros at the start of input lines.
-.It Fl f Ns Cm strict
-Implies
-.Fl f Ns Cm no-ign-escape
-and
-.Fl f Ns Cm no-ign-macro .
-.El

 .Ss Output Formats
 The
 .Nm
 utility accepts the following
 .Fl T
 arguments, which correspond to output modes:
 .Ss Output Formats
 The
 .Nm
 utility accepts the following
 .Fl T
 arguments, which correspond to output modes:

-.Bl -tag -width Ds
+.Bl -tag -width "-Tlocale"

 .It Fl T Ns Cm ascii
 .It Fl T Ns Cm ascii

-Produce 7-bit ASCII output, backspace-encoded for bold and underline
-styles.
+Produce 7-bit ASCII output.

 This is the default.
 See
 .Sx ASCII Output .
 .It Fl T Ns Cm html
 This is the default.
 See
 .Sx ASCII Output .
 .It Fl T Ns Cm html

-Produce strict HTML-4.01 output, with a sane default style.
+Produce strict CSS1/HTML-4.01 output.

 See
 .Sx HTML Output .
 .It Fl T Ns Cm lint
 Parse only: produce no output.
 Implies
 See
 .Sx HTML Output .
 .It Fl T Ns Cm lint
 Parse only: produce no output.
 Implies

-.Fl W Ns Cm all
-and
-.Fl f Ns Cm strict .
+.Fl W Ns Cm warning .
+.It Fl T Ns Cm locale
+Encode output using the current locale.
+See
+.Sx Locale Output .
+.It Fl T Ns Cm man
+Produce
+.Xr man 7
+format output.
+See
+.Sx Man Output .
+.It Fl T Ns Cm pdf
+Produce PDF output.
+See
+.Sx PDF Output .

 .It Fl T Ns Cm ps
 Produce PostScript output.
 See
 .Sx PostScript Output .
 .It Fl T Ns Cm tree
 Produce an indented parse tree.
 .It Fl T Ns Cm ps
 Produce PostScript output.
 See
 .Sx PostScript Output .
 .It Fl T Ns Cm tree
 Produce an indented parse tree.

+.It Fl T Ns Cm utf8
+Encode output in the UTF\-8 multi-byte format.
+See
+.Sx UTF\-8 Output .

 .It Fl T Ns Cm xhtml
 .It Fl T Ns Cm xhtml

-Produce strict XHTML-1.0 output, with a sane default style.
+Produce strict CSS1/XHTML-1.0 output.

 See
 .Sx XHTML Output .
 .El
 See
 .Sx XHTML Output .
 .El


@@ -226,6 +237,9 @@ Emboldened characters are rendered as
 The special characters documented in
 .Xr mandoc_char 7
 are rendered best-effort in an ASCII equivalent.
 The special characters documented in
 .Xr mandoc_char 7
 are rendered best-effort in an ASCII equivalent.

+If no equivalent is found,
+.Sq \&?
+is used instead.

 .Pp
 Output width is limited to 78 visible columns unless literal input lines
 exceed this limit.
 .Pp
 Output width is limited to 78 visible columns unless literal input lines
 exceed this limit.


@@ -234,6 +248,15 @@ The following
 .Fl O
 arguments are accepted:
 .Bl -tag -width Ds
 .Fl O
 arguments are accepted:
 .Bl -tag -width Ds

+.It Cm indent Ns = Ns Ar indent
+The left margin for normal text is set to
+.Ar indent
+blank characters instead of the default of five for
+.Xr mdoc 7
+and seven for
+.Xr man 7 .
+Increasing this is not recommended; it may result in degraded formatting,
+for example overfull lines or ugly line breaks.

 .It Cm width Ns = Ns Ar width
 The output width is set to
 .Ar width ,
 .It Cm width Ns = Ns Ar width
 The output width is set to
 .Ar width ,


@@ -244,23 +267,36 @@ Output produced by
 .Fl T Ns Cm html
 conforms to HTML-4.01 strict.
 .Pp
 .Fl T Ns Cm 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
 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 Cm ascii .
+file documents style-sheet classes available for customising output.
+If a style-sheet is not specified with
+.Fl O Ns Ar style ,
+.Fl T Ns Cm html
+defaults to simple output readable in any graphical or text-based web
+browser.

 .Pp
 .Pp

-Special characters are rendered in decimal-encoded UTF-8.
+Special characters are rendered in decimal-encoded UTF\-8.

 .Pp
 The following
 .Fl O
 arguments are accepted:
 .Bl -tag -width Ds
 .Pp
 The following
 .Fl O
 arguments are accepted:
 .Bl -tag -width Ds

+.It Cm fragment
+Omit the
+.Aq !DOCTYPE
+declaration and the
+.Aq html ,
+.Aq head ,
+and
+.Aq body
+elements and only emit the subtree below the
+.Aq body
+element.
+The
+.Cm style
+argument will be ignored.
+This is useful when embedding manual content within existing documents.

 .It Cm includes Ns = Ns Ar fmt
 The string
 .Ar fmt ,
 .It Cm includes Ns = Ns Ar fmt
 The string
 .Ar fmt ,


@@ -297,13 +333,57 @@ is used for an external style-sheet.
 This must be a valid absolute or
 relative URI.
 .El
 This must be a valid absolute or
 relative URI.
 .El

+.Ss Locale Output
+Locale-depending output encoding is triggered with
+.Fl T Ns Cm locale .
+This option is not available on all systems: systems without locale
+support, or those whose internal representation is not natively UCS-4,
+will fall back to
+.Fl T Ns Cm ascii .
+See
+.Sx ASCII Output
+for font style specification and available command-line arguments.
+.Ss Man Output
+Translate input format into
+.Xr man 7
+output format.
+This is useful for distributing manual sources to legacy systems
+lacking
+.Xr mdoc 7
+formatters.
+.Pp
+If
+.Xr mdoc 7
+is passed as input, it is translated into
+.Xr man 7 .
+If the input format is
+.Xr man 7 ,
+the input is copied to the output, expanding any
+.Xr roff 7
+.Sq so
+requests.
+The parser is also run, and as usual, the
+.Fl W
+level controls which
+.Sx DIAGNOSTICS
+are displayed before copying the input to the output.
+.Ss PDF Output
+PDF-1.1 output may be generated by
+.Fl T Ns Cm pdf .
+See
+.Sx PostScript Output
+for
+.Fl O
+arguments and defaults.

 .Ss PostScript Output
 PostScript
 .Qq Adobe-3.0
 Level-2 pages may be generated by
 .Fl T Ns Cm ps .
 .Ss PostScript Output
 PostScript
 .Qq Adobe-3.0
 Level-2 pages may be generated by
 .Fl T Ns Cm ps .

-Output pages are US-letter sized and rendered in fixed, 10-point Courier
-font.
+Output pages default to letter sized and are rendered in the Times font
+family, 11-point.
+Margins are calculated as 1/9 the page length and width.
+Line-height is 1.4m.

 .Pp
 Special characters are rendered as in
 .Sx ASCII Output .
 .Pp
 Special characters are rendered as in
 .Sx ASCII Output .


@@ -316,10 +396,26 @@ arguments are accepted:
 The paper size
 .Ar name
 may be one of
 The paper size
 .Ar name
 may be one of

-.Ar a4
+.Ar a3 ,
+.Ar a4 ,
+.Ar a5 ,
+.Ar legal ,

 or
 .Ar letter .
 or
 .Ar letter .

+You may also manually specify dimensions as
+.Ar NNxNN ,
+width by height in millimetres.
+If an unknown value is encountered,
+.Ar letter
+is used.

 .El
 .El

+.Ss UTF\-8 Output
+Use
+.Fl T Ns Cm utf8
+to force a UTF\-8 locale.
+See
+.Sx Locale Output
+for details and options.

 .Ss XHTML Output
 Output produced by
 .Fl T Ns Cm xhtml
 .Ss XHTML Output
 Output produced by
 .Fl T Ns Cm xhtml


@@ -329,38 +425,159 @@ See
 .Sx HTML Output
 for details; beyond generating XHTML tags instead of HTML tags, these
 output modes are identical.
 .Sx HTML Output
 for details; beyond generating XHTML tags instead of HTML tags, these
 output modes are identical.

+.Sh EXIT STATUS
+The
+.Nm
+utility exits with one of the following values, controlled by the message
+.Ar level
+associated with the
+.Fl W
+option:
+.Pp
+.Bl -tag -width Ds -compact
+.It 0
+No warnings or errors occurred, or those that did were ignored because
+they were lower than the requested
+.Ar level .
+.It 2
+At least one warning occurred, but no error, and
+.Fl W Ns Cm warning
+was specified.
+.It 3
+At least one parsing error occurred, but no fatal error, and
+.Fl W Ns Cm error
+or
+.Fl W Ns Cm warning
+was specified.
+.It 4
+A fatal parsing error occurred.
+.It 5
+Invalid command line arguments were specified.
+No input files have been read.
+.It 6
+An operating system error occurred, for example memory exhaustion or an
+error accessing input files.
+Such errors cause
+.Nm
+to exit at once, possibly in the middle of parsing or formatting a file.
+.El
+.Pp
+Note that selecting
+.Fl T Ns Cm lint
+output mode implies
+.Fl W Ns Cm warning .

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

-.D1 $ mandoc \-Wall,error \-fstrict mandoc.1 2\*(Gt&1 | less
-.D1 $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
+.Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
+.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less

 .Pp
 To produce HTML manuals with
 .Ar style.css
 as the style-sheet:
 .Pp
 .Pp
 To produce HTML manuals with
 .Ar style.css
 as the style-sheet:
 .Pp

-.D1 $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
+.Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html

 .Pp
 To check over a large set of manuals:
 .Pp
 .Pp
 To check over a large set of manuals:
 .Pp

-.Dl $ mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
+.Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`

 .Pp
 To produce a series of PostScript manuals for A4 paper:
 .Pp
 .Pp
 To produce a series of PostScript manuals for A4 paper:
 .Pp

-.D1 $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
+.Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
+.Pp
+Convert a modern
+.Xr mdoc 7
+manual to the older
+.Xr man 7
+format, for use on systems lacking an
+.Xr mdoc 7
+parser:
+.Pp
+.Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
+.Sh DIAGNOSTICS
+Standard error messages reporting parsing errors are prefixed by
+.Pp
+.D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level :
+.Pp
+where the fields have the following meanings:
+.Bl -tag -width "column"
+.It Ar file
+The name of the input file causing the message.
+.It Ar line
+The line number in that input file.
+Line numbering starts at 1.
+.It Ar column
+The column number in that input file.
+Column numbering starts at 1.
+If the issue is caused by a word, the column number usually
+points to the first character of the word.
+.It Ar level
+The message level, printed in capital letters.
+.El
+.Pp
+The
+.Ar line
+and
+.Ar column
+fields are omitted when meaningless.
+.Pp
+Message levels have the following meanings:
+.Bl -tag -width "warning"
+.It Cm syserr
+Opening or reading an input file failed, so the parser cannot
+even be started and no output is produced from that input file.
+.It Cm fatal
+The parser is unable to parse a given input file at all.
+No formatted output is produced from that input file.
+.It Cm error
+An input file contains syntax that cannot be safely interpreted,
+either because it is invalid or because
+.Nm
+does not implement it yet.
+By discarding part of the input or inserting missing tokens,
+the parser is able to continue, and the error does not prevent
+generation of formatted output, but typically, preparing that
+output involves information loss, broken document structure
+or unintended formatting.
+.It Cm warning
+An input file uses obsolete, discouraged or non-portable syntax.
+All the same, the meaning of the input is unambiguous and a correct
+rendering can be produced.
+Documents causing warnings may render poorly when using other
+formatting tools instead of
+.Nm .
+.El
+.Pp
+Messages of the
+.Cm warning
+and
+.Cm error
+levels are hidden unless their level, or a lower level, is requested using a
+.Fl W
+option or
+.Fl T Ns Cm lint
+output mode.
+.Pp
+The
+.Nm
+utility may also print messages related to invalid command line arguments
+or operating system errors, for example when memory is exhausted.
+Such messages may not carry the prefix described above.

 .Sh COMPATIBILITY
 This section summarises
 .Nm
 .Sh COMPATIBILITY
 This section summarises
 .Nm

-compatibility with
-.Xr groff 1 .
+compatibility with GNU troff.

 Each input and output format is separately noted.
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It
 Each input and output format is separately noted.
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It

-The
-.Sq \e~
-special character doesn't produce expected behaviour in
-.Fl T Ns Cm ascii .
+Unrenderable unicode codepoints specified with
+.Sq \e[uNNNN]
+escapes are printed as
+.Sq \&?
+in mandoc.
+In GNU troff, these raise an error.

 .It
 The
 .Sq \&Bd \-literal
 .It
 The
 .Sq \&Bd \-literal


@@ -372,9 +589,7 @@ in
 .Fl T Ns Cm ascii
 are synonyms, as are \-filled and \-ragged.
 .It
 .Fl T Ns Cm ascii
 are synonyms, as are \-filled and \-ragged.
 .It

-In
-.Xr groff 1 ,
-the
+In historic GNU troff, the

 .Sq \&Pa
 .Xr mdoc 7
 macro does not underline when scoped under an
 .Sq \&Pa
 .Xr mdoc 7
 macro does not underline when scoped under an


@@ -399,13 +614,6 @@ macro in
 has no effect.
 .It
 Words aren't hyphenated.
 has no effect.
 .It
 Words aren't hyphenated.

-.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;
-.Xr groff 1
-retains spaces.
-.It
-Sentences are unilaterally monospaced.

 .El
 .Ss HTML/XHTML Compatibility
 .Bl -bullet -compact
 .El
 .Ss HTML/XHTML Compatibility
 .Bl -bullet -compact


@@ -438,24 +646,18 @@ and
 lists render similarly.
 .El
 .Sh SEE ALSO
 lists render similarly.
 .El
 .Sh SEE ALSO

+.Xr eqn 7 ,

 .Xr man 7 ,
 .Xr mandoc_char 7 ,
 .Xr man 7 ,
 .Xr mandoc_char 7 ,

-.Xr mdoc 7
+.Xr mdoc 7 ,
+.Xr roff 7 ,
+.Xr tbl 7

 .Sh AUTHORS
 The
 .Nm
 utility was written by
 .Sh AUTHORS
 The
 .Nm
 utility was written by

-.An Kristaps Dzonsons Aq kristaps@bsd.lv .
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

 .Sh CAVEATS
 .Sh CAVEATS

-The
-.Fl T Ns Cm html
-and
-.Fl T Ns Cm xhtml
-CSS2 styling used for
-.Fl m Ns Cm doc
-input lists does not render properly in older browsers, such as Internet
-Explorer 6 and earlier.
-.Pp

 In
 .Fl T Ns Cm html
 and
 In
 .Fl T Ns Cm html
 and


@@ -467,17 +669,6 @@ Be aware of this when setting long link
 formats such as
 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
 .Pp
 formats such as
 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
 .Pp

-The
-.Fl T Ns Cm html
-and
-.Fl T Ns Cm 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 Cm an ,
 such as
 Nesting elements within next-line element scopes of
 .Fl m Ns Cm an ,
 such as


@@ -491,12 +682,6 @@ and
 and cause them to forget the formatting of the prior next-line scope.
 .Pp
 The
 and cause them to forget the formatting of the prior next-line scope.
 .Pp
 The

-.Sq i
-macro in
-.Fl m Ns Cm 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.
 .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.