=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.163 retrieving revision 1.170 diff -u -p -r1.163 -r1.170 --- mandoc/mandoc.1 2015/10/30 19:04:16 1.163 +++ mandoc/mandoc.1 2017/01/12 17:29:33 1.170 @@ -1,7 +1,7 @@ -.\" $Id: mandoc.1,v 1.163 2015/10/30 19:04:16 schwarze Exp $ +.\" $Id: mandoc.1,v 1.170 2017/01/12 17:29:33 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons -.\" Copyright (c) 2012, 2014, 2015 Ingo Schwarze +.\" Copyright (c) 2012, 2014-2017 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -15,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. .\" -.Dd $Mdocdate: October 30 2015 $ +.Dd $Mdocdate: January 12 2017 $ .Dt MANDOC 1 .Os .Sh NAME @@ -75,6 +75,10 @@ This overrides any earlier and .Fl l options. +.It Fl h +Display only the SYNOPSIS lines. +Implies +.Fl c . .It Fl I Cm os Ns = Ns Ar name Override the default operating system .Ar name @@ -85,10 +89,6 @@ and for the .Xr man 7 .Sq \&TH macro. -.It Fl h -Display only the SYNOPSIS lines. -Implies -.Fl c . .It Fl K Ar encoding Specify the input encoding. The supported @@ -349,7 +349,7 @@ Equations rendered from blocks use MathML. .Pp The -.Pa example.style.css +.Pa mandoc.css file documents style-sheet classes available for customising output. If a style-sheet is not specified with .Fl O Cm style , @@ -498,7 +498,15 @@ Use to show a human readable representation of the syntax tree. It is useful for debugging the source code of manual pages. The exact format is subject to change, so don't write parsers for it. -Each output line shows one syntax tree node. +.Pp +The first paragraph shows meta data found in the +.Xr mdoc 7 +prologue, on the +.Xr man 7 +.Ic \&TH +line, or the fallbacks used. +.Pp +In the tree dump, each output line shows one syntax tree node. Child nodes are indented with respect to their parent node. The columns are: .Pp @@ -529,6 +537,12 @@ The input column number (starting at one). A closing parenthesis if the node is a closing delimiter. .It A full stop if the node ends a sentence. +.It +NOSRC if the node is not in the input file, +but automatically generated from macros. +.It +NOPRT if the node is not supposed to generate output +for any output format. .El .El .Sh ENVIRONMENT @@ -601,10 +615,10 @@ To page manuals to the terminal: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less .Pp To produce HTML manuals with -.Ar style.css +.Pa mandoc.css as the style-sheet: .Pp -.Dl $ mandoc \-T html -O style=style.css mdoc.7 \*(Gt mdoc.7.html +.Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html .Pp To check over a large set of manuals: .Pp @@ -809,11 +823,13 @@ This may confuse .Xr makewhatis 8 and .Xr apropos 1 . -.It Sy "NAME section without name" +.It Sy "NAME section without Nm before Nd" .Pq mdoc The NAME section does not contain any .Ic \&Nm -child macro. +child macro before the first +.Ic \&Nd +macro. .It Sy "NAME section without description" .Pq mdoc The NAME section lacks the mandatory @@ -830,6 +846,11 @@ The NAME section contains plain text or macros other t .Ic \&Nm and .Ic \&Nd . +.It Sy "missing comma before name" +.Pq mdoc +The NAME section contains an +.Ic \&Nm +macro that is neither the first one nor preceded by a comma. .It Sy "missing description line, using \(dq\(dq" .Pq mdoc The @@ -1147,6 +1168,13 @@ macro is immediately followed by an .Ic \&Re macro on the next input line. Such an empty block does not produce any output. +.It Sy "missing section argument" +.Pq mdoc +An +.Ic \&Xr +macro lacks its second, section number argument. +The first argument, i.e. the name, is printed, but without subsequent +parentheses. .It Sy "missing -std argument, adding it" .Pq mdoc An @@ -1615,8 +1643,8 @@ macro fails to specify the list type. .It Sy "missing manual name, using \(dq\(dq" .Pq mdoc The first call to -.Ic \&Nm -lacks the required argument. +.Ic \&Nm , +or any call in the NAME section, lacks the required argument. .It Sy "uname(3) system call failed, using UNKNOWN" .Pq mdoc The