Renamed TERMP_NONOSPACE -> TERMP_DANGLE.

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 0fec9b821572659991fa9731310d3b7f7b29dbb1..a20fda73d56359745c12dea5bf30712a293b1412 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,33 +1,32 @@
-.\" $Id: mandoc.1,v 1.4 2009/03/21 13:09:29 kristaps Exp $
+.\"    $Id: mandoc.1,v 1.24 2009/07/06 09:34:29 kristaps Exp $

 .\"
 .\"

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

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any

-.\" purpose with or without fee is hereby granted, provided that the
-.\" above copyright notice and this permission notice appear in all
-.\" copies.
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.

 .\"
 .\"

-.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
-.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-.\" PERFORMANCE OF THIS SOFTWARE.
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 .\"
 .\"

-.Dd $Mdocdate: March 21 2009 $
-.Dt mandoc 1
+.Dd $Mdocdate: July 6 2009 $
+.Dt MANDOC 1

 .Os
 .\" SECTION
 .Sh NAME
 .Nm mandoc
 .Os
 .\" SECTION
 .Sh NAME
 .Nm mandoc

-.Nd format and display BSD manuals
+.Nd format and display UNIX manuals

 .\" SECTION
 .Sh SYNOPSIS
 .Nm mandoc
 .Op Fl V
 .Op Fl f Ns Ar option...
 .\" SECTION
 .Sh SYNOPSIS
 .Nm mandoc
 .Op Fl V
 .Op Fl f Ns Ar option...

+.Op Fl m Ns Ar format

 .Op Fl W Ns Ar err...
 .Op Fl T Ns Ar output
 .Op Ar infile...
 .Op Fl W Ns Ar err...
 .Op Fl T Ns Ar output
 .Op Ar infile...


@@ -35,17 +34,23 @@
 .Sh DESCRIPTION
 The
 .Nm
 .Sh DESCRIPTION
 The
 .Nm

-utility formats a BSD 
-.Dq mdoc 
-manual page for display.  The arguments are as follows:
-.Bl -tag -width XXXXXXXXXXXX
+utility formats 
+.Ux
+manual pages for display.  The arguments are as follows:
+.Bl -tag -width Ds

 .\" ITEM
 .It Fl f Ns Ar option...
 Override default compiler behaviour.  See 
 .Sx Compiler Options
 for details.
 .\" ITEM
 .\" ITEM
 .It Fl f Ns Ar option...
 Override default compiler behaviour.  See 
 .Sx Compiler Options
 for details.
 .\" ITEM

-.It Fl T
+.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 T Ns Ar output

 Output format.  See
 .Sx Output Formats
 for available formats.  Defaults to
 Output format.  See
 .Sx Output Formats
 for available formats.  Defaults to


@@ -55,15 +60,11 @@ for available formats.  Defaults to
 Print version and exit.
 .\" ITEM
 .It Fl W Ns Ar err...
 Print version and exit.
 .\" ITEM
 .It Fl W Ns Ar err...

-Print warning messages.  May be set to 
+Configure warning messages.  Use

 .Fl W Ns Ar all
 .Fl W Ns Ar all

-for all warnings, 
-.Ar compat
-for groff/troff-compatibility warnings, or
-.Ar syntax
-for syntax warnings.  If
+to print warnings,

 .Fl W Ns Ar error 
 .Fl W Ns Ar error 

-is specified, warnings are considered errors and cause utility
+for warnings to be considered errors and cause utility

 termination.  Multiple 
 .Fl W
 arguments may be comma-separated, such as
 termination.  Multiple 
 .Fl W
 arguments may be comma-separated, such as


@@ -80,29 +81,32 @@ will halt with the first failed parse.
 .Pp
 By default, 
 .Nm 
 .Pp
 By default, 
 .Nm 

-reads from stdin and prints 78-column backspace-encoded output to stdout
-as if
+reads 
+.Xr mdoc 7
+or
+.Xr man 7
+text from stdin, implying
+.Fl m Ns Ar andoc ,
+and prints 78-column backspace-encoded output to stdout as if

 .Fl T Ns Ar ascii
 were provided.
 .\" PARAGRAPH
 .Pp
 .Ex -std mandoc
 .\" SUB-SECTION
 .Fl T Ns Ar ascii
 were provided.
 .\" PARAGRAPH
 .Pp
 .Ex -std mandoc
 .\" SUB-SECTION

-.Ss Reserved Words
-The reserved words described in
-.Xr mdoc 7
-are handled according to the following rules:
-.Bl -enum -offset XXX
-.It
-Opening delimiters 
+.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 \&{
 .Po
 .Sq \&( , 
 .Sq \&[ , 
 and
 .Sq \&{

-.Pc are not followed by whitespace.
-.It
-Closing delimiters
+.Pc 
+is not followed by a space; closing punctuation

 .Po
 .Sq \&. , 
 .Sq \&, , 
 .Po
 .Sq \&. , 
 .Sq \&, , 


@@ -114,18 +118,74 @@ Closing delimiters
 .Sq \&] 
 and
 .Sq \&}
 .Sq \&] 
 and
 .Sq \&}

-.Pc are not preceeded by whitespace.
-.El
-.\" PARAGRAPH
+.Pc 
+is not preceded by whitespace.

 .Pp
 .Pp

-Note that reserved words may occur in streams of text, so the following:
-.Bd -literal -offset XXXX
-this self is not that of the waking , empirically real man
-.Ed
-.\" PARAGRAPH
+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
+utility accepts
+.Xr mdoc 7
+and
+.Xr man 7
+input with
+.Fl m Ns Ar doc
+and
+.Fl m Ns Ar an ,
+respectively.  The
+.Xr mdoc 7
+format is
+.Em strongly
+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 
+.Sq \&.Dd
+or
+.Sq \&.Dt ,
+the 
+.Xr mdoc 7
+parser is used; otherwise, the
+.Xr man 7
+parser is used.

 .Pp
 .Pp

-\&...correctly adjusts the comma spacing to
-.Qq this self is not that of the waking , empirically real man .
+If multiple
+files are specified with 
+.Fl m Ns Ar andoc , 
+each has its file-type determined this way.  If multiple files are
+specified and
+.Fl m Ns Ar doc
+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
 .\" SUB-SECTION
 .Ss Output Formats
 The


@@ -133,28 +193,40 @@ The
 utility accepts the following
 .Fl T
 arguments:
 utility accepts the following
 .Fl T
 arguments:

-.Bl -tag -width XXXXXXXXXXXX -offset XXXX
-.It Ar ascii
+.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.
 Produce 7-bit ASCII output, backspace-encoded for bold and underline
 styles.  This is the default.

-.It Ar tree
+.It Fl T Ns Ar tree

 Produce an indented parse tree.
 Produce an indented parse tree.

-.It Ar lint
+.It Fl T Ns Ar lint

 Parse only: produce no output.
 .El
 Parse only: produce no output.
 .El

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

 .\" SUB-SECTION
 .Ss Compiler Options
 Default compiler behaviour may be overriden with the
 .Fl f
 flag.
 .\" SUB-SECTION
 .Ss Compiler Options
 Default compiler behaviour may be overriden with the
 .Fl f
 flag.

-.Bl -tag -width XXXXXXXXXXXX -offset XXXX
+.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.
 .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.

-.It Fl f Ns Ar ign-escape
-Ignore invalid escape sequences.
-.It Fl f Ns Ar ign-macro
-Ignore unknown macros at the start of input lines.
+.Pq mdoc only
+.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-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 . 

 .El
 .\" PARAGRAPH
 .Pp
 .El
 .\" PARAGRAPH
 .Pp


@@ -163,44 +235,56 @@ As with the
 flag, multiple
 .Fl f
 options may be grouped and delimited with a comma.  Using
 flag, multiple
 .Fl f
 options may be grouped and delimited with a comma.  Using

-.Fl f Ns Ar ign-scope,ign-escape ,
-for example, will try to ignore scope and character-escape errors.
+.Fl f Ns Ar ign-scope,no-ign-escape ,
+for example, will try to ignore scope and not ignore character-escape
+errors.

 .\" SECTION
 .Sh EXAMPLES
 .\" SECTION
 .Sh EXAMPLES

-To page this manual page on the terminal:
+To page manuals to the terminal:

 .\" PARAGRAPH
 .Pp
 .\" PARAGRAPH
 .Pp

-.D1 % mandoc \-Wall,error mandoc.1 2>&1 | less
+.D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
+.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
+.\" SECTION
+.Sh COMPATIBILITY
+This section summarises 
+.Nm
+compatibility with 
+.Xr groff 1 .
+.Pp
+.Bl -bullet -compact
+.It 
+A list or display following
+.Sq \&.Ss
+does not assert a prior vertical break, just as it doesn't with
+.Sq \&.Sh .
+.It
+The \-literal and \-unfilled 
+.Sq \&.Bd
+displays types are synonyms, as are \-filled and \-ragged.
+.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
+.Pq Dq French spacing .
+.El

 .\" SECTION
 .Sh SEE ALSO
 .\" SECTION
 .Sh SEE ALSO

-.Xr mdoc 7
-.\" 
+.Xr mandoc_char 7 ,
+.Xr mdoc 7 ,
+.Xr man 7
+.\" SECTION

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

-.An Kristaps Dzonsons Aq kristaps@openbsd.org .
+.An Kristaps Dzonsons Aq kristaps@kth.se .

 .\" SECTION
 .Sh CAVEATS
 The 
 .Nm
 .\" SECTION
 .Sh CAVEATS
 The 
 .Nm

-utility doesn't yet know how to display the following:
-.Pp
-.Bl -bullet -compact
-.It
-The \-hang 
-.Sq \&Bl
-list is not yet supported.
-.It
-The \-literal and \-unfilled 
-.Sq \&Bd
-displays types are synonyms, as are \-filled and \-ragged.
-.It
-The
-.Sq \&Xo/Xc
-pair isn't supported.
-.El
+utility doesn't yet know how to display \-hang lists.

 .Pp
 Other macros still aren't supported by virtue of nobody complaining
 .Pp
 Other macros still aren't supported by virtue of nobody complaining

-about their absence.  Please report any omissions: this is a work in
-progress.
+about their absence.