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

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

version 1.37, 2009/09/21 13:06:13 version 1.61, 2010/06/07 10:55:27
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" 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 above  .\" purpose with or without fee is hereby granted, provided that the above
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MANDOC 1  .Dt MANDOC 1
 .Os  .Os
 .  
 .  
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display UNIX manuals  .Nd format and display UNIX manuals
 .  
 .  
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl f Ns Ar option...  .Op Fl V
   .Op Fl f Ns Ar option
 .Op Fl m Ns Ar format  .Op Fl m Ns Ar format
 .Op Fl o Ns Ar option...  .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 Fl W Ns Ar err...  .Op Ar file...
 .Op Ar infile...  
 .  
 .  
 .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
 .It Fl f Ns Ar option...  .It Fl f Ns Ar option
 Comma-separated compiler options.  See  Comma-separated compiler options.
   See
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .  
 .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.
 .Fl m Ns Ar andoc .  Defaults to
 .  .Fl m Ns Cm andoc .
 .It Fl o Ns Ar format  .It Fl O Ns Ar option
 Comma-separated output options.  See  Comma-separated output options.
   See
 .Sx Output Options  .Sx Output Options
 for details.  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.
 .Fl T Ns Ar ascii .  Defaults to
 .  .Fl T Ns Cm ascii .
 .It Fl V  .It Fl V
 Print version and exit.  Print version and exit.
 .  .It Fl W Ns Ar err
 .It Fl W Ns Ar err...  Comma-separated warning options.
 Comma-separated warning options.  Use  Use
 .Fl W Ns Ar all  .Fl W Ns Cm all
 to print warnings,  to print warnings,
 .Fl W Ns Ar error  .Fl W Ns Cm error
 for warnings to be considered errors and cause utility  for warnings to be considered errors and cause utility
 termination.  Multiple  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 .
 .  .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
 .  
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
Line 95  reads
Line 90  reads
 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.
 .  
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .  
 .  
 .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 or used in a literal display mode, e.g.,  
 .Sq \&Bd \-literal  
 in  
 .Xr mdoc 7 .  
 .  
 .  
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 153  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 the first  which is also the default, determines encoding on-the-fly: if the first
 non-comment macro is  non-comment macro is
 .Sq \&Dd  .Sq \&Dd
Line 177  the
Line 128  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
 .Fl m Ns Ar andoc ,  .Fl m Ns Cm andoc ,
 each has its file-type determined this way.  If multiple files are  each has its file-type determined this way.
   If multiple files are
 specified and  specified and
 .Fl m Ns Ar doc  .Fl m Ns Cm doc
 or  or
 .Fl m Ns Ar an  .Fl m Ns Cm an
 is specified, then this format is used exclusively.  is specified, then this format is used exclusively.
 .  
 .  
 .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 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.
 .  This is the default.
 .It Fl T Ns Ar html  See
   .Sx ASCII Output .
   .It Fl T Ns Cm html
 Produce strict HTML-4.01 output, with a sane default style.  Produce strict HTML-4.01 output, with a sane default style.
 .  See
 .It Fl T Ns Ar tree  .Sx HTML Output .
 Produce an indented parse tree.  .It Fl T Ns Cm lint
 .  
 .It Fl T Ns Ar 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
 .  
 .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.
 .  
 .  
 .Ss Compiler Options  .Ss Compiler Options
 Default compiler behaviour may be overridden 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 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 Cm no-ign-escape
 .It Fl f Ns Ar no-ign-escape  Do not ignore invalid escape sequences.
 Don't ignore invalid escape sequences.  .It Fl f Ns Cm 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 Cm strict
 .It Fl f Ns Ar no-ign-chars  
 Do not ignore disallowed characters.  
 .  
 .It Fl f Ns Ar strict  
 Implies  Implies
 .Fl f Ns Ar no-ign-escape ,  .Fl f Ns Cm no-ign-escape
 .Fl f Ns Ar no-ign-macro  
 and  and
 .Fl f Ns Ar no-ign-chars .  .Fl f Ns Cm no-ign-macro .
 .  
 .It Fl f Ns Ar ign-errors  
 Don't halt when encountering parse errors.  Useful with  
 .Fl T Ns Ar lint  
 over a large set of manuals passed on the command line.  
 .El  .El
 .  
 .Ss Output Options  .Ss Output Options
 For the time being, only  The
 .Fl T Ns Ar html  .Fl T Ns Ar html
 is the only mode with output options:  and
   .Fl T Ns Ar xhtml
   modes accept the following output options:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl o Ns Ar style=style.css  .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  The file
 .Ar style.css  .Ar style.css
 is used for an external style-sheet.  This must be a valid absolute or  is used for an external style-sheet.
   This must be a valid absolute or
 relative URI.  relative URI.
 .It Fl o Ns Ar base=http://base/  
 The URL  
 .Ar http://base/  
 is used as a base URL for all relative links.  This is useful when  
 linking between documents via the  
 .Sq \&Xr  
 macro.  
 .El  .El
 .  .Pp
   The
   .Fl T Ns Ar ascii
   mode accepts the following output option:
   .Bl -tag -width Ds
   .It Fl O Ns Cm width Ns = Ns Ar width
   The output width is set to
   .Ar width ,
   which will normalise to \(>=60.
   .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
   The text style of output characters (non-macro characters, punctuation,
   and white-space) is dictated by context.
   .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 ,
   however, these rules are also applied to macro arguments when appropriate.
   .Ss ASCII Output
   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
   .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 Cm ascii .
   .Pp
   Special characters are rendered in decimal-encoded UTF-8.
   .Ss XHTML Output
   Output produced by
   .Fl T Ns Cm 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:
 .  
 .Pp  .Pp
 .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less  .D1 $ mandoc \-Wall,error \-fstrict mandoc.1 2\*(Gt&1 | less
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less  .D1 $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .  
 .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:  To check over a large set of manuals:
 .  
 .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]`
 .  
 .  
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section summarises  This section summarises
 .Nm  .Nm
 compatibility with  compatibility with
 .Xr groff 1 .  .Xr groff 1 .
 Each input and output format is separately noted.  Each input and output format is separately noted.
 .  .Ss ASCII Compatibility
 .  
 .Ss ASCII output  
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 The  The
 .Sq \e~  .Sq \e~
 special character doesn't produce expected behaviour in  special character doesn't produce expected behaviour in
 .Fl T Ns Ar ascii .  .Fl T Ns Cm ascii .
 .  
 .It  .It
 The  The
 .Sq \&Bd \-literal  .Sq \&Bd \-literal
 and  and
 .Sq \&Bd \-unfilled  .Sq \&Bd \-unfilled
 macros of  macros of
 .Xr mdoc 7  .Xr mdoc 7
 in  in
 .Fl T Ns Ar ascii  .Fl T Ns Cm ascii
 are synonyms, as are \-filled and \-ragged.  are synonyms, as are \-filled and \-ragged.
 .  
 .It  .It
 In  In
 .Xr groff 1 ,  .Xr groff 1 ,
 the  the
 .Sq \&Pa  .Sq \&Pa
 .Xr mdoc 7  .Xr mdoc 7
 macro does not underline when scoped under an  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 .
 .  
 .It  .It
 A list or display following  A list or display following the
 .Sq \&Ss  .Sq \&Ss
 .Xr mdoc 7  .Xr mdoc 7
 macro in  macro in
 .Fl T Ns Ar ascii  .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
 The  The
 .Sq \&na  .Sq \&na
 .Xr man 7  .Xr man 7
 macro in  macro in
 .Fl T Ns Ar ascii  .Fl T Ns Cm ascii
 has no effect.  has no effect.
 .  
 .It  .It
 Words aren't hyphenated.  Words aren't hyphenated.
 .  
 .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  .Xr groff 1
 retains spaces.  retains spaces.
 .  
 .It  .It
 Sentences are unilaterally monospaced.  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 man 7 ,
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,  .Xr mdoc 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@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.37  
changed lines
  Added in v.1.61
CVSweb