Do not handle vertical lines as additional tbl(7) columns,

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 2f7482832fb7e71d01fdbf156bf3ff68e5917345..9a0271503996778b597167d083d6b2dc5588a5a1 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,6 +1,7 @@
-.\"    $Id: mandoc.1,v 1.93 2011/09/26 20:47:23 schwarze Exp $
+.\"    $Id: mandoc.1,v 1.101 2012/05/27 17:48:57 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 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: September 26 2011 $
+.Dd $Mdocdate: May 27 2012 $

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


@@ -23,6 +24,9 @@
 .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 m Ns Ar format
 .Op Fl O Ns Ar option
 .Op Fl T Ns Ar output


@@ -34,8 +38,30 @@ The
 utility formats
 .Ux
 manual pages for display.
 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


@@ -176,11 +190,11 @@ Encode output using the current locale.
 See
 .Sx Locale Output .
 .It Fl T Ns Cm man
 See
 .Sx Locale Output .
 .It Fl T Ns Cm man

-Produce output in
+Produce

 .Xr man 7
 .Xr man 7

-format; only useful when applied to
-.Fl m Ns Cm doc
-input.
+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


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


@@ -259,6 +282,21 @@ The following
 .Fl O
 arguments are accepted:
 .Bl -tag -width Ds
 .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 ,


@@ -305,6 +343,30 @@ will fall back to
 See
 .Sx ASCII Output
 for font style specification and available command-line arguments.
 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 .
 .Ss PDF Output
 PDF-1.1 output may be generated by
 .Fl T Ns Cm pdf .