Make the generated man(7) code more portable by using .PD

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 795aaa4970f1357714d41a61210beb35d5fc158b..9a0271503996778b597167d083d6b2dc5588a5a1 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,6 +1,7 @@
-.\"    $Id: mandoc.1,v 1.81 2010/12/16 23:07:01 kristaps Exp $
+.\"    $Id: mandoc.1,v 1.101 2012/05/27 17:48:57 schwarze Exp $

 .\"
 .\"

-.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2012 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: December 16 2010 $
+.Dd $Mdocdate: May 27 2012 $

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


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

+.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 W Ns Ar level
 .Op Fl m Ns Ar format
 .Op Fl O Ns Ar option
 .Op Fl T Ns Ar output
 .Op Fl W Ns Ar level

-.Op Ar file...
+.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

+.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


@@ -96,18 +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.

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


@@ -157,7 +171,7 @@ The
 utility accepts the following
 .Fl T
 arguments, which correspond to output modes:
 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
 Produce 7-bit ASCII output.
 This is the default.
 .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output.
 This is the default.


@@ -171,6 +185,16 @@ See
 Parse only: produce no output.
 Implies
 .Fl W Ns Cm warning .
 Parse only: produce no output.
 Implies
 .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
 .It Fl T Ns Cm pdf
 Produce PDF output.
 See


@@ -181,6 +205,10 @@ See
 .Sx PostScript Output .
 .It Fl T Ns Cm tree
 Produce an indented parse tree.
 .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
 Produce strict CSS1/XHTML-1.0 output.
 See
 .It Fl T Ns Cm xhtml
 Produce strict CSS1/XHTML-1.0 output.
 See


@@ -209,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.


@@ -217,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 ,


@@ -227,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 CSS1.
-By default, no font style is applied to any text,
-although CSS1 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 ,


@@ -280,6 +333,48 @@ 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 legancy 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
 .Ss PostScript Output
 PostScript
 .Qq Adobe-3.0


@@ -314,14 +409,13 @@ If an unknown value is encountered,
 .Ar letter
 is used.
 .El
 .Ar letter
 is used.
 .El

-.Ss PDF Output
-PDF-1.1 output may be generated by
-.Fl T Ns Cm pdf .
+.Ss UTF\-8 Output
+Use
+.Fl T Ns Cm utf8
+to force a UTF\-8 locale.

 See
 See

-.Sx PostScript Output
-for
-.Fl O
-arguments and defaults.
+.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


@@ -375,14 +469,14 @@ output mode implies
 .Sh EXAMPLES
 To page manuals to the terminal:
 .Pp
 .Sh EXAMPLES
 To page manuals to the terminal:
 .Pp

-.D1 $ mandoc \-Wall,stop 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


@@ -390,7 +484,17 @@ To check over a large set of manuals:
 .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
 .Sh DIAGNOSTICS
 Standard error messages reporting parsing errors are prefixed by
 .Pp


@@ -462,6 +566,13 @@ Each input and output format is separately noted.
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It

+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
 and
 The
 .Sq \&Bd \-literal
 and


@@ -472,7 +583,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 GNU troff, 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


@@ -497,8 +608,6 @@ macro in
 has no effect.
 .It
 Words aren't hyphenated.
 has no effect.
 .It
 Words aren't hyphenated.

-.It
-Sentences are unilaterally monospaced.

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


@@ -531,14 +640,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 ,
+.Mt kristaps@bsd.lv .

 .Sh CAVEATS
 In
 .Fl T Ns Cm html
 .Sh CAVEATS
 In
 .Fl T Ns Cm html