[BACK]Return to mandoc.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.31 and 1.50

version 1.31, 2009/08/20 11:51:07 version 1.50, 2010/01/29 14:39:38
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MANDOC 1  .Dt MANDOC 1
 .Os  .Os
 .\" SECTION  .
   .
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display UNIX manuals  .Nd format and display UNIX manuals
 .\" SECTION  .
   .
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl V  
 .Op Fl f Ns Ar option...  .Op Fl f Ns Ar option...
 .Op Fl m Ns Ar format  .Op Fl m Ns Ar format
 .Op Fl W Ns Ar err...  .Op Fl O Ns Ar option...
 .Op Fl T Ns Ar output  .Op Fl T Ns Ar output
   .Op Fl V
   .Op Fl W Ns Ar err...
 .Op Ar infile...  .Op Ar infile...
 .\" SECTION  .
   .
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility formats  utility formats
 .Ux  .Ux
 manual pages for display.  The arguments are as follows:  manual pages for display.  The arguments are as follows:
   .
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .\" ITEM  
 .It Fl f Ns Ar option...  .It Fl f Ns Ar option...
 Override default compiler behaviour.  See  Comma-separated compiler options.  See
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .\" ITEM  .
 .It Fl m Ns Ar format  .It Fl m Ns Ar format
 Input format.  See  Input format.  See
 .Sx Input Formats  .Sx Input Formats
 for available formats.  Defaults to  for available formats.  Defaults to
 .Fl m Ns Ar andoc .  .Fl m Ns Ar andoc .
 .\" ITEM  .
   .It Fl O Ns Ar option...
   Comma-separated output options.  See
   .Sx Output Options
   for details.
   .
 .It Fl T Ns Ar output  .It Fl T Ns Ar output
 Output format.  See  Output format.  See
 .Sx Output Formats  .Sx Output Formats
 for available formats.  Defaults to  for available formats.  Defaults to
 .Fl T Ns Ar ascii .  .Fl T Ns Ar ascii .
 .\" ITEM  .
 .It Fl V  .It Fl V
 Print version and exit.  Print version and exit.
 .\" ITEM  .
 .It Fl W Ns Ar err...  .It Fl W Ns Ar err...
 Configure warning messages.  Use  Comma-separated warning options.  Use
 .Fl W Ns Ar all  .Fl W Ns Ar all
 to print warnings,  to print warnings,
 .Fl W Ns Ar error  .Fl W Ns Ar error
Line 69  termination.  Multiple
Line 78  termination.  Multiple
 .Fl W  .Fl W
 arguments may be comma-separated, such as  arguments may be comma-separated, such as
 .Fl W Ns Ar error,all .  .Fl W Ns Ar error,all .
 .\" ITEM  .
 .It Ar infile...  .It Ar infile...
 Read input from zero or more  Read input from zero or more
 .Ar infile .  .Ar infile .
Line 77  If unspecified, reads from stdin.  If multiple files a
Line 86  If unspecified, reads from stdin.  If multiple files a
 .Nm  .Nm
 will halt with the first failed parse.  will halt with the first failed parse.
 .El  .El
 .\" PARAGRAPH  .
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
Line 87  or
Line 96  or
 .Xr man 7  .Xr man 7
 text from stdin, implying  text from stdin, implying
 .Fl m Ns Ar andoc ,  .Fl m Ns Ar andoc ,
 and prints 78-column backspace-encoded output to stdout as if  and produces
 .Fl T Ns Ar ascii  .Fl T Ns Ar ascii
 were provided.  output.
 .\" PARAGRAPH  .
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .\" SUB-SECTION  .
 .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 \&{  
 .Pc  
 is not followed by a space; closing punctuation  
 .Po  
 .Sq \&. ,  
 .Sq \&, ,  
 .Sq \&; ,  
 .Sq \&: ,  
 .Sq \&? ,  
 .Sq \&! ,  
 .Sq \&) ,  
 .Sq \&]  
 and  
 .Sq \&}  
 .Pc  
 is not preceded by whitespace.  
 .Pp  
 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  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 152  format is
Line 122  format is
 recommended;  recommended;
 .Xr man 7  .Xr man 7
 should only be used for legacy manuals.  should only be used for legacy manuals.
   .
 .Pp  .Pp
 A third option,  A third option,
 .Fl m Ns Ar andoc ,  .Fl m Ns Ar andoc ,
Line 165  the
Line 136  the
 parser is used; otherwise, the  parser is used; otherwise, the
 .Xr man 7  .Xr man 7
 parser is used.  parser is used.
   .
 .Pp  .Pp
 If multiple  If multiple
 files are specified with  files are specified with
Line 175  specified and
Line 147  specified and
 or  or
 .Fl m Ns Ar an  .Fl m Ns Ar an
 is specified, then this format is used exclusively.  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  .Ss Output Formats
 The  The
 .Nm  .Nm
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments:  arguments (see
   .Sx OUTPUT ) :
   .
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl T Ns Ar ascii  .It Fl T Ns Ar ascii
 Produce 7-bit ASCII output, backspace-encoded for bold and underline  Produce 7-bit ASCII output, backspace-encoded for bold and underline
 styles.  This is the default.  styles.  This is the default.  See
   .Sx ASCII Output .
   .
   .It Fl T Ns Ar html
   Produce strict HTML-4.01 output, with a sane default style.  See
   .Sx HTML Output .
   .
   .It Fl T Ns Ar xhtml
   Produce strict XHTML-1.0 output, with a sane default style.  See
   .Sx XHTML Output .
   .
 .It Fl T Ns Ar tree  .It Fl T Ns Ar tree
 Produce an indented parse tree.  Produce an indented parse tree.
   .
 .It Fl T Ns Ar lint  .It Fl T Ns Ar lint
 Parse only: produce no output.  Parse only: produce no output.
 .El  .El
   .
 .Pp  .Pp
 If multiple input files are specified, these will be processed by the  If multiple input files are specified, these will be processed by the
 corresponding filter in-order.  corresponding filter in-order.
 .\" SUB-SECTION  .
   .
 .Ss Compiler Options  .Ss Compiler Options
 Default compiler behaviour may be overriden with the  Default compiler behaviour may be overridden with the
 .Fl f  .Fl f
 flag.  flag.
   .
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl f Ns Ar ign-scope  .It Fl f Ns Ar ign-scope
 When rewinding the scope of a block macro, forces the compiler to ignore  When rewinding the scope of a block macro, forces the compiler to ignore
 scope violations.  This can seriously mangle the resulting tree.  scope violations.  This can seriously mangle the resulting tree.
 .Pq mdoc only  .Pq mdoc only
   .
   .It Fl f Ns Ar ign-escape
   Ignore invalid escape sequences.
   This is the default, but the option can be used to override an earlier
   .Fl f Ns Ar strict .
   .
 .It Fl f Ns Ar no-ign-escape  .It Fl f Ns Ar no-ign-escape
 Don't ignore invalid escape sequences.  Don't ignore invalid escape sequences.
   .
 .It Fl f Ns Ar no-ign-macro  .It Fl f Ns Ar no-ign-macro
 Do not ignore unknown macros at the start of input lines.  Do not ignore unknown macros at the start of input lines.
   .
 .It Fl f Ns Ar no-ign-chars  .It Fl f Ns Ar no-ign-chars
 Do not ignore disallowed characters.  Do not ignore disallowed characters.
   .
 .It Fl f Ns Ar strict  .It Fl f Ns Ar strict
 Implies  Implies
 .Fl f Ns Ar no-ign-escape ,  .Fl f Ns Ar no-ign-escape ,
 .Fl f Ns Ar no-ign-macro  .Fl f Ns Ar no-ign-macro
 and  and
 .Fl f Ns Ar no-ign-chars .  .Fl f Ns Ar no-ign-chars .
   .
 .It Fl f Ns Ar ign-errors  .It Fl f Ns Ar ign-errors
 Don't halt when encountering parse errors.  Useful with  Don't halt when encountering parse errors.  Useful with
 .Fl T Ns Ar lint  .Fl T Ns Ar lint
 over a large set of manuals passed on the command line.  over a large set of manuals passed on the command line.
 .El  .El
 .\" PARAGRAPH  .
   .
   .Ss Output Options
   For the time being, only
   .Fl T Ns Ar html
   accepts output options:
   .Bl -tag -width Ds
   .It Fl O Ns Ar style=style.css
   The file
   .Ar style.css
   is used for an external style-sheet.  This must be a valid absolute or
   relative URI.
   .It Fl O Ns Ar includes=fmt
   The string
   .Ar fmt ,
   for example,
   .Ar ../src/%I.html ,
   is used as a template for linked header files (usually via the
   .Sq \&In
   macro).  Instances of
   .Sq \&%I
   are replaced with the include filename.  The default is not to present a
   hyperlink.
   .It Fl O Ns Ar man=fmt
   The string
   .Ar fmt ,
   for example,
   .Ar ../html%S/%N.%S.html ,
   is used as a template for linked manuals (usually via the
   .Sq \&Xr
   macro).  Instances of
   .Sq \&%N
   and
   .Sq %S
   are replaced with the linked manual's name and section, respectively.
   If no section is included, section 1 is assumed.  The default is not to
   present a hyperlink.
   .El
   .
   .
   .Sh OUTPUT
   This section documents output details of
   .Nm .
   In general, output conforms to the traditional manual style of a header,
   a body composed of sections and sub-sections, and a footer.
 .Pp  .Pp
 As with the  The text style of output characters (non-macro characters, punctuation,
 .Fl W  and white-space) is dictated by context.
 flag, multiple  .Pp
 .Fl f  White-space is generally stripped from input.  This can be changed with
 options may be grouped and delimited with a comma.  Using  character escapes (specified in
 .Fl f Ns Ar ign-scope,no-ign-escape ,  .Xr mandoc_char 7 )
 for example, will try to ignore scope and not ignore character-escape  or literal modes (specified in
 errors.  .Xr mdoc 7
 .\" SECTION  and
   .Xr man 7 ) .
   .Pp
   If non-macro punctuation is set apart from words, such as in the phrase
   .Dq to be \&, or not to be ,
   it's processed by
   .Nm ,
   regardless of output format, according to the following rules:  opening
   punctuation
   .Po
   .Sq \&( ,
   .Sq \&[ ,
   and
   .Sq \&{
   .Pc
   is not followed by a space; closing punctuation
   .Po
   .Sq \&. ,
   .Sq \&, ,
   .Sq \&; ,
   .Sq \&: ,
   .Sq \&? ,
   .Sq \&! ,
   .Sq \&) ,
   .Sq \&]
   and
   .Sq \&}
   .Pc
   is not preceded by white-space.
   .
   .Pp
   If the input is
   .Xr mdoc 7 ,
   however, these rules are also applied to macro arguments when appropriate.
   .
   .
   .Ss ASCII Output
   Output produced by
   .Fl T Ns Ar ascii ,
   which is the default, is rendered in standard 7-bit ASCII documented in
   .Xr ascii 7 .
   .Pp
   Font styles are applied by using back-spaced encoding such that an
   underlined character
   .Sq c
   is rendered as
   .Sq _ Ns \e[bs] Ns c ,
   where
   .Sq \e[bs]
   is the back-space character number 8.  Emboldened characters are rendered as
   .Sq c Ns \e[bs] Ns c .
   .Pp
   The special characters documented in
   .Xr mandoc_char 7
   are rendered best-effort in an ASCII equivalent.
   .Pp
   Output width is limited to 78 visible columns unless literal input lines
   exceed this limit.
   .
   .
   .Ss HTML Output
   Output produced by
   .Fl T Ns Ar 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
   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 Ar ascii .
   .Pp
   Special characters are rendered in decimal-encoded UTF-8.
   .
   .
   .Ss XHTML Output
   Output produced by
   .Fl T Ns Ar xhtml
   conforms to XHTML-1.0 strict.
   .Pp
   See
   .Sx HTML Output
   for details; beyond generating XHTML tags instead of HTML tags, these
   output modes are identical.
   .
   .
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .\" PARAGRAPH  .
 .Pp  .Pp
 .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less  .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less  .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .\" PARAGRAPH  .
 .Pp  .Pp
   To produce HTML manuals with
   .Ar style.css
   as the style-sheet:
   .Pp
   .D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > mdoc.7.html
   .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .\" PARAGRAPH  .
 .Pp  .Pp
 .Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`  .Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
 .\" SECTION  .
   .
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 .\" FIXME: libman `na' and `DT' have no effect.  
 This section summarises  This section summarises
 .Nm  .Nm
 compatibility with  compatibility with
 .Xr groff 1 .  .Xr groff 1 .
 .Pp  Each input and output format is separately noted.
   .
   .
   .Ss ASCII Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .\" LIST-ITEM  
 .It  .It
 The  The
 .Sq \e~  .Sq \e~
 special character doesn't produce expected behaviour.  special character doesn't produce expected behaviour in
 .\" LIST-ITEM  .Fl T Ns Ar ascii .
   .
 .It  .It
 In  The
   .Sq \&Bd \-literal
   and
   .Sq \&Bd \-unfilled
   macros of
   .Xr mdoc 7
   in
   .Fl T Ns Ar ascii
   are synonyms, as are \-filled and \-ragged.
   .
   .It
   In
 .Xr groff 1 ,  .Xr groff 1 ,
 the  the
 .Sq \&Pa  .Sq \&Pa
 macro does not underline when under a  .Xr mdoc 7
   macro does not underline when scoped under an
 .Sq \&It  .Sq \&It
 in the FILES section.  This behaves correctly in  in the FILES section.  This behaves correctly in
 .Nm .  .Nm .
 .\" LIST-ITEM  .
 .It  .It
 A list or display following  A list or display following
 .Sq \&Ss  .Sq \&Ss
   .Xr mdoc 7
   macro in
   .Fl T Ns Ar ascii
 does not assert a prior vertical break, just as it doesn't with  does not assert a prior vertical break, just as it doesn't with
 .Sq \&Sh .  .Sq \&Sh .
   .
 .It  .It
 The \-literal and \-unfilled  The
 .Sq \&Bd  .Sq \&na
 displays types are synonyms, as are \-filled and \-ragged.  .Xr man 7
 .\" LIST-ITEM  macro in
   .Fl T Ns Ar ascii
   has no effect.
   .
 .It  .It
 Words aren't hyphenated.  Words aren't hyphenated.
 .\" LIST-ITEM  .
 .It  .It
 In normal mode (not a literal block), blocks of spaces aren't preserved,  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.  so double spaces following sentence closure are reduced to a single space;
   .Xr groff 1
   retains spaces.
   .
   .It
   Sentences are unilaterally monospaced.
 .El  .El
 .\" SECTION  .
   .
   .Ss HTML/XHTML Compatibility
   .Bl -bullet -compact
   .It
   The
   .Sq \efP
   escape will revert the font to the previous
   .Sq \ef
   escape, not to the last rendered decoration, which is now dictated by
   CSS instead of hard-coded.  It also will not span past the current
   scope, for the same reason.  Note that in
   .Sx ASCII Output
   mode, this will work fine.
   .It
   The
   .Xr mdoc 7
   .Sq \&Bl \-hang
   and
   .Sq \&Bl \-tag
   list types render similarly (no break following overreached left-hand
   side) due to the expressive constraints of HTML.
   .
   .It
   The
   .Xr man 7
   .Sq IP
   and
   .Sq TP
   lists render similarly.
   .El
   .
   .
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr man 7  .Xr man 7
 .\" SECTION  .
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
   .
   .
   .Sh CAVEATS
   The
   .Fl T Ns Ar html
   and
   .Fl T Ns Ar xhtml
   CSS2 styling used for
   .Fl m Ns Ar doc
   input lists does not render properly in brain-dead browsers, such as
   Internet Explorer 6 and earlier.
   .Pp
   In
   .Fl T Ns Ar html
   and
   .Fl T Ns Ar xhtml ,
   the maximum size of an element attribute is determined by
   .Dv BUFSIZ ,
   which is usually 1024 bytes.  Be aware of this when setting long link
   formats, e.g.,
   .Fl O Ns Ar style=really/long/link .
   .Pp
   The
   .Fl T Ns Ar html
   and
   .Fl T Ns Ar xhtml
   output modes don't render the
   .Sq \es
   font size escape documented in
   .Xr mdoc 7
   and
   .Xr man 7 .
Legend:
Removed from v.1.31  
changed lines
  Added in v.1.50
CVSweb