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

Diff for /mandoc/mandoc.1 between version 1.12 and 1.61

version 1.12, 2009/04/02 16:42:35 version 1.61, 2010/06/07 10:55:27
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" 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  .\" purpose with or without fee is hereby granted, provided that the above
 .\" above copyright notice and this permission notice appear in all  .\" copyright notice and this permission notice appear in all copies.
 .\" copies.  
 .\"  .\"
 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL  .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED  .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE  .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL  .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" PERFORMANCE OF THIS SOFTWARE.  
 .\"  .\"
 .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 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 Ar infile...  .Op Fl W Ns Ar err
 .\" SECTION  .Op Ar file...
 .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.
 .Bl -tag -width XXXXXXXXXXXX  The arguments are as follows:
 .\" ITEM  .Bl -tag -width Ds
 .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  Input format.
 Input format.  See  See
 .Sx Input Formats  .Sx Input Formats
 for available formats.  Defaults to  for available formats.
 .Fl m Ns Ar andoc .  Defaults to
 .\" ITEM  .Fl m Ns Cm andoc .
 .It Fl T  .It Fl O Ns Ar option
 Output format.  See  Comma-separated output options.
   See
   .Sx Output Options
   for details.
   .It Fl T Ns Ar output
   Output format.
   See
 .Sx Output Formats  .Sx Output Formats
 for available formats.  Defaults to  for available formats.
 .Fl T Ns Ar ascii .  Defaults to
 .\" ITEM  .Fl T Ns Cm ascii .
 .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...  Comma-separated warning options.
 Print warning messages.  May be set to  Use
 .Fl W Ns Ar all  .Fl W Ns Cm all
 for all warnings,  to print warnings,
 .Ar compat  .Fl W Ns Cm error
 for groff/troff-compatibility warnings, or  for warnings to be considered errors and cause utility
 .Ar syntax  termination.
 for syntax warnings.  If  Multiple
 .Fl W Ns Ar error  
 is specified, warnings are considered errors and cause utility  
 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 Cm error , Ns Cm all .
 .\" ITEM  .It Ar file
 .It Ar infile...  Read input from zero or more files.
 Read input from zero or more  If unspecified, reads from stdin.
 .Ar infile .  If multiple files are specified,
 If unspecified, reads from stdin.  If multiple files are specified,  
 .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
 reads  reads
 .Xr mdoc 7  .Xr mdoc 7
 or  or
 .Xr man 7  .Xr man 7
 text from stdin, implying  text from stdin, implying
 .Fl m Ns Ar andoc ,  .Fl m Ns Cm andoc ,
 and prints 78-column backspace-encoded output to stdout as if  and produces
 .Fl T Ns Ar ascii  .Fl T Ns Cm ascii
 were provided.  output.
 .\" PARAGRAPH  
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .\" SUB-SECTION  
 .Ss Reserved Words (mdoc only)  
 The reserved words described in  
 .Xr mdoc 7  
 are handled according to the following rules:  
 .Bl -enum -offset XXX  
 .It  
 Opening delimiters  
 .Po  
 .Sq \&( ,  
 .Sq \&[ ,  
 and  
 .Sq \&{  
 .Pc are not followed by whitespace.  
 .It  
 Closing delimiters  
 .Po  
 .Sq \&. ,  
 .Sq \&, ,  
 .Sq \&; ,  
 .Sq \&: ,  
 .Sq \&? ,  
 .Sq \&! ,  
 .Sq \&) ,  
 .Sq \&]  
 and  
 .Sq \&}  
 .Pc are not preceeded by whitespace.  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Note that reserved words only register as such as if they appear as  
 standalone tokens, either in parsed lines or streams of text.  Thus, the  
 following fragment:  
 .Bd -literal -offset XXXX  
 this self is not that of the waking , empirically real man  
 .Ed  
 .\" PARAGRAPH  
 .Pp  
 \&...correctly adjusts the comma spacing to  
 .Dq this self is not that of the waking , empirically real man .  
 However, if the comma were part of  
 .Dq ,empirically ,  
 it would not.  
 .\" SUB-SECTION  
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 152  utility accepts
Line 104  utility accepts
 and  and
 .Xr man 7  .Xr man 7
 input with  input with
 .Fl m Ns Ar doc  .Fl m Ns Cm doc
 and  and
 .Fl m Ns Ar an ,  .Fl m Ns Cm an ,
 respectively.  The  respectively.
   The
 .Xr mdoc 7  .Xr mdoc 7
 format is  format is
 .Em strongly  .Em strongly
 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 Cm andoc ,
 which is also the default, determines encoding on-the-fly.  If multiple  which is also the default, determines encoding on-the-fly: if the first
 files are passed in, each has its file-type determined this way.  If  non-comment macro is
 multiple files are passed and  .Sq \&Dd
 .Fl m Ns Ar doc  
 or  or
 .Fl m Ns Ar an  .Sq \&Dt ,
 is specified, then this format is used exclusively.  the
   .Xr mdoc 7
   parser is used; otherwise, the
   .Xr man 7
   parser is used.
 .Pp  .Pp
 The following escape sequences are recognised, although the per-format  If multiple
 compiler may not allow certain sequences.  files are specified with
 .Bl -tag -width Ds -offset XXXX  .Fl m Ns Cm andoc ,
 .It \efX  each has its file-type determined this way.
 sets the font mode to X (B, I, R or P, where P resets the font)  If multiple files are
 .It \eX, \e(XX, \e[XN]  specified and
 queries the special-character table for a corresponding symbol  .Fl m Ns Cm doc
 .It \e*X, \e*(XX, \e*[XN]  or
 deprecated special-character format  .Fl m Ns Cm an
 .El  is specified, then this format is used exclusively.
 .\" 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
 .Bl -tag -width XXXXXXXXXXXX -offset XXXX  .Sx OUTPUT ) :
 .It Ar ascii  .Bl -tag -width Ds
   .It Fl T Ns Cm 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.
 .It Ar tree  This is the default.
 Produce an indented parse tree.  See
 .It Ar lint  .Sx ASCII Output .
   .It Fl T Ns Cm html
   Produce strict HTML-4.01 output, with a sane default style.
   See
   .Sx HTML Output .
   .It Fl T Ns Cm lint
 Parse only: produce no output.  Parse only: produce no output.
   Implies
   .Fl W Ns Cm all
   and
   .Fl f Ns Cm strict .
   .It Fl T Ns Cm tree
   Produce an indented parse tree.
   .It Fl T Ns Cm xhtml
   Produce strict XHTML-1.0 output, with a sane default style.
   See
   .Sx XHTML Output .
 .El  .El
 .\" SUB-SECTION  .Pp
   If multiple input files are specified, these will be processed by the
   corresponding filter in-order.
 .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 XXXXXXXXXXXXXX -offset XXXX  .Bl -tag -width Ds
 .It Fl f Ns Ar ign-scope  .It Fl f Ns Cm ign-errors
   When parsing multiple files, don't halt when one errors out.
   Useful with
   .Fl T Ns Cm lint
   over a large set of manuals passed on the command line.
   .It Fl f Ns Cm ign-escape
   Ignore invalid escape sequences.
   This is the default, but the option can be used to override an earlier
   .Fl f Ns Cm strict .
   .It Fl f Ns Cm 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  .It Fl f Ns Cm no-ign-escape
 Ignore invalid escape sequences.  Do not ignore invalid escape sequences.
 .It Fl f Ns Ar ign-macro  .It Fl f Ns Cm no-ign-macro
 Ignore unknown macros at the start of input lines (default for  Do not ignore unknown macros at the start of input lines.
 .Xr man 7  .It Fl f Ns Cm strict
 parsing).  Implies
 .It Fl f Ns Ar no-ign-macro  .Fl f Ns Cm no-ign-escape
 Do not ignore unknown macros at the start of input lines (default for  and
 .Xr mdoc 7  .Fl f Ns Cm no-ign-macro .
 parsing).  
 .El  .El
 .\" PARAGRAPH  .Ss Output Options
   The
   .Fl T Ns Ar html
   and
   .Fl T Ns Ar xhtml
   modes accept the following output options:
   .Bl -tag -width Ds
   .It Fl O Ns Cm includes Ns = Ns Ar 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 Cm man Ns = Ns Ar 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.
   .It Fl O Ns Cm style Ns = Ns Ar style.css
   The file
   .Ar style.css
   is used for an external style-sheet.
   This must be a valid absolute or
   relative URI.
   .El
 .Pp  .Pp
 As with the  The
 .Fl W  .Fl T Ns Ar ascii
 flag, multiple  mode accepts the following output option:
 .Fl f  .Bl -tag -width Ds
 options may be grouped and delimited with a comma.  Using  .It Fl O Ns Cm width Ns = Ns Ar width
 .Fl f Ns Ar ign-scope,ign-escape ,  The output width is set to
 for example, will try to ignore scope and character-escape errors.  .Ar width ,
 .\" SECTION  which will normalise to \(>=60.
 .Sh EXAMPLES  .El
 To page this manual page on the terminal:  .Sh OUTPUT
 .\" PARAGRAPH  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
 .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less  The text style of output characters (non-macro characters, punctuation,
 .\" SECTION  and white-space) is dictated by context.
 .Sh SEE ALSO  .Pp
   White-space is generally stripped from input.
   This can be changed with
   character escapes (specified in
   .Xr mandoc_char 7 )
   or literal modes (specified in
   .Xr mdoc 7
   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 ,  .Xr mdoc 7 ,
 .Xr man 7  however, these rules are also applied to macro arguments when appropriate.
 .\"  .Ss ASCII Output
 .Sh AUTHORS  Output produced by
   .Fl T Ns Cm 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 Cm 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  The
 .Nm  .Pa example.style.css
 utility was written by  file documents the range of styles applied to output and, if used, will
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  cause rendered documents to appear as they do in
 .\" SECTION  .Fl T Ns Cm ascii .
 .Sh CAVEATS  
 The  
 .Nm  
 utility in  
 .Fl T Ns Ar ascii  
 mode doesn't yet know how to display the following:  
 .Pp  .Pp
 .Bl -bullet -compact  Special characters are rendered in decimal-encoded UTF-8.
 .It  .Ss XHTML Output
 The \-hang  Output produced by
 .Sq \&.Bl  .Fl T Ns Cm xhtml
 list is not yet supported.  conforms to XHTML-1.0 strict.
 .El  
 .Pp  .Pp
 Other macros still aren't supported by virtue of nobody complaining  See
 about their absence.  Please report any omissions: this is a work in  .Sx HTML Output
 progress.  for details; beyond generating XHTML tags instead of HTML tags, these
   output modes are identical.
   .Sh EXAMPLES
   To page manuals to the terminal:
 .Pp  .Pp
 The following list documents differences between traditional  .D1 $ mandoc \-Wall,error \-fstrict mandoc.1 2\*(Gt&1 | less
 .Xr nroff 1  .D1 $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
 output and  
 .Nm :  
 .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
   .Pp
   To check over a large set of manuals:
   .Pp
   .Dl $ mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
   .Sh COMPATIBILITY
   This section summarises
   .Nm
   compatibility with
   .Xr groff 1 .
   Each input and output format is separately noted.
   .Ss ASCII Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 A list of display following  The
 .Sq \&.Ss  .Sq \e~
   special character doesn't produce expected behaviour in
   .Fl T Ns Cm ascii .
   .It
   The
   .Sq \&Bd \-literal
   and
   .Sq \&Bd \-unfilled
   macros of
   .Xr mdoc 7
   in
   .Fl T Ns Cm ascii
   are synonyms, as are \-filled and \-ragged.
   .It
   In
   .Xr groff 1 ,
   the
   .Sq \&Pa
   .Xr mdoc 7
   macro does not underline when scoped under an
   .Sq \&It
   in the FILES section.
   This behaves correctly in
   .Nm .
   .It
   A list or display following the
   .Sq \&Ss
   .Xr mdoc 7
   macro in
   .Fl T Ns Cm 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
 Special characters don't follow the current font style.  The
 .\" LIST-ITEM  .Sq \&na
   .Xr man 7
   macro in
   .Fl T Ns Cm ascii
   has no effect.
 .It  .It
 The \-literal and \-unfilled  Words aren't hyphenated.
 .Sq \&.Bd  .It
 displays types are synonyms, as are \-filled and \-ragged.  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;
   .Xr groff 1
   retains spaces.
   .It
   Sentences are unilaterally monospaced.
 .El  .El
   .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
   .Xr man 7 ,
   .Xr mandoc_char 7 ,
   .Xr mdoc 7
   .Sh AUTHORS
   The
   .Nm
   utility was written by
   .An Kristaps Dzonsons Aq kristaps@bsd.lv .
   .Sh CAVEATS
   The
   .Fl T Ns Cm html
   and
   .Fl T Ns Cm xhtml
   CSS2 styling used for
   .Fl m Ns Cm doc
   input lists does not render properly in older browsers, such as Internet
   Explorer 6 and earlier.
   .Pp
   In
   .Fl T Ns Cm html
   and
   .Fl T Ns Cm 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 such as
   .Fl O Ns Cm style Ns = Ns Ar really/long/link .
   .Pp
   The
   .Fl T Ns Cm html
   and
   .Fl T Ns Cm xhtml
   output modes don't render the
   .Sq \es
   font size escape documented in
   .Xr mdoc 7
   and
   .Xr man 7 .
   .Pp
   Nesting elements within next-line element scopes of
   .Fl m Ns Cm an ,
   such as
   .Sq br
   within an empty
   .Sq B ,
   will confuse
   .Fl T Ns Cm html
   and
   .Fl T Ns Cm xhtml
   and cause them to forget the formatting of the prior next-line scope.
   .Pp
   The
   .Sq i
   macro in
   .Fl m Ns Cm an
   should italicise all subsequent text if a line argument is not provided.
   This behaviour is not implemented.
   The
   .Sq \(aq
   control character is an alias for the standard macro control character
   and does not emit a line-break as stipulated in GNU troff.
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.61
CVSweb