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

Diff for /mandoc/mandoc.1 between version 1.8 and 1.42

version 1.8, 2009/03/23 15:41:09 version 1.42, 2009/10/10 11:05:23
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" 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  .\" 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 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 XXXXXXXXXXXX  .
 .\" 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  .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 mdoc .  .Fl m Ns Ar andoc .
 .\" ITEM  .
 .It Fl T  .It Fl o Ns Ar option...
   Comma-separated output options.  See
   .Sx Output Options
   for details.
   .
   .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...
 Print warning messages.  May be set to  Comma-separated warning options.  Use
 .Fl W Ns Ar all  .Fl W Ns Ar all
 for all warnings,  to print warnings,
 .Ar compat  .Fl W Ns Ar error
 for groff/troff-compatibility warnings, or  for warnings to be considered errors and cause utility
 .Ar syntax  termination.  Multiple
 for syntax warnings.  If  
 .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 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 83  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
 reads  reads
 .Xr mdoc 7  .Xr mdoc 7
   or
   .Xr man 7
 text from stdin, implying  text from stdin, implying
 .Fl m Ns Ar mdoc ,  .Fl m Ns Ar andoc ,
 and prints 78-column backspace-encoded output to stdout as if  and prints 78-column backspace-encoded output to stdout as if
 .Fl T Ns Ar ascii  .Fl T Ns Ar ascii
 were provided.  were provided.
 .\" PARAGRAPH  .
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .\" SUB-SECTION  .
 .Ss Reserved Words (mdoc only)  .
 The reserved words described in  .Ss Punctuation and Spacing
 .Xr mdoc 7  If punctuation is set apart from words, such as in the phrase
 are handled according to the following rules:  .Dq to be \&, or not to be ,
 .Bl -enum -offset XXX  it's processed by
 .It  .Nm
 Opening delimiters  according to the following rules:  opening punctuation
 .Po  .Po
 .Sq \&( ,  .Sq \&( ,
 .Sq \&[ ,  .Sq \&[ ,
 and  and
 .Sq \&{  .Sq \&{
 .Pc are not followed by whitespace.  .Pc
 .It  is not followed by a space; closing punctuation
 Closing delimiters  
 .Po  .Po
 .Sq \&. ,  .Sq \&. ,
 .Sq \&, ,  .Sq \&, ,
 .Sq \&; ,  .Sq \&; ,
 .Sq \&: ,  .Sq \&: ,
 .Sq \&? ,  .Sq \&? ,
 .Sq \&! ,  .Sq \&! ,
 .Sq \&) ,  .Sq \&) ,
 .Sq \&]  .Sq \&]
 and  and
 .Sq \&}  .Sq \&}
 .Pc are not preceeded by whitespace.  .Pc
 .El  is not preceded by whitespace.
 .\" PARAGRAPH  .
 .Pp  .Pp
 Note that reserved words only register as such as if they appear as  If the input is
 standalone tokens, either in parsed lines or streams of text.  Thus, the  .Xr mdoc 7 ,
 following fragment:  these rules are also applied to macro arguments when appropriate.
 .Bd -literal -offset XXXX  .
 this self is not that of the waking , empirically real man  
 .Ed  
 .\" PARAGRAPH  
 .Pp  .Pp
 \&...correctly adjusts the comma spacing to  White-space, in non-literal (normal) mode, is stripped from input and
 .Dq this self is not that of the waking , empirically real man .  replaced on output by a single space.  Thus, if you wish to preserve multiple
 However, if the comma were part of  spaces, they must be space-escaped or used in a literal display mode, e.g.,
 .Dq ,empirically ,  .Sq \&Bd \-literal
 it would not.  in
 .\" SUB-SECTION  .Xr mdoc 7 .
   .
   .
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 150  utility accepts
Line 153  utility accepts
 and  and
 .Xr man 7  .Xr man 7
 input with  input with
 .Fl m Ns Ar mdoc  .Fl m Ns Ar doc
 and  and
 .Fl m Ns Ar man ,  .Fl m Ns Ar 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
 Note that the  A third option,
 .Fl m Ns Ar man  .Fl m Ns Ar andoc ,
 option is experimental and only works with  which is also the default, determines encoding on-the-fly: if the first
 .Fl T Ns Ar tree .  non-comment macro is
 .\" SUB-SECTION  .Sq \&Dd
   or
   .Sq \&Dt ,
   the
   .Xr mdoc 7
   parser is used; otherwise, the
   .Xr man 7
   parser is used.
   .
   .Pp
   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.
   .
   .
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments:  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  Produce 7-bit ASCII output, backspace-encoded for bold and underline
 styles.  This is the default.  styles.  This is the default.
 .It Ar tree  .
   .It Fl T Ns Ar html
   Produce strict HTML-4.01 output, with a sane default style.
   .
   .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.  Parse only: produce no 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 XXXXXXXXXXXX -offset XXXX  .
   .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.  .It Fl f Ns Ar no-ign-escape
 .It Fl f Ns Ar ign-macro  Don't ignore invalid escape sequences.
 Ignore unknown macros at the start of input lines.  .
   .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 .
   .
   .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
 .\" PARAGRAPH  .
 .Pp  .Ss Output Options
 As with the  For the time being, only
 .Fl W  .Fl T Ns Ar html
 flag, multiple  is the only mode with output options:
 .Fl f  .Bl -tag -width Ds
 options may be grouped and delimited with a comma.  Using  .It Fl o Ns Ar style=style.css
 .Fl f Ns Ar ign-scope,ign-escape ,  The file
 for example, will try to ignore scope and character-escape errors.  .Ar style.css
 .\" SECTION  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 EXAMPLES  .Sh EXAMPLES
 To page this manual page on the terminal:  To page manuals to the terminal:
 .\" PARAGRAPH  .
 .Pp  .Pp
 .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less  .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
 .\" SECTION  .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .Sh SEE ALSO  .
 .Xr mdoc 7  
 .\"  
 .Sh AUTHORS  
 The  
 .Nm  
 utility was written by  
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  
 .\" SECTION  
 .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  To produce HTML manuals with
 .It  .Ar style.css
 The \-hang  as the style-sheet:
 .Sq \&Bl  
 list is not yet supported.  
 .El  
 .Pp  .Pp
 Other macros still aren't supported by virtue of nobody complaining  .D1 % mandoc \-Thtml -ostyle=style.css mdoc.7 > mdoc.7.html
 about their absence.  Please report any omissions: this is a work in  
 progress.  
 .Pp  .Pp
 The following list documents differences between traditional  To check over a large set of manuals:
 .Xr nroff 1  .
 output and  
 .Nm :  
 .Pp  .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 output
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 A list of display following  The
   .Sq \e~
   special character doesn't produce expected behaviour in
   .Fl T Ns Ar ascii .
   .
   .It
   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 ,
   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
 .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
 Special characters don't follow the current font style.  The
 .\" LIST-ITEM  .Sq \&na
   .Xr man 7
   macro in
   .Fl T Ns Ar ascii
   has no effect.
   .
 .It  .It
 The \-literal and \-unfilled  Words aren't hyphenated.
 .Sq \&Bd  .
 displays types are synonyms, as are \-filled and \-ragged.  .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;
   .Xr groff 1
   retains spaces.
   .
   .It
   Sentences are unilaterally monospaced.
 .El  .El
   .
   .Ss HTML output
   .Bl -bullet -compact
   .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
   .\" SECTION
   .Sh SEE ALSO
   .Xr mandoc_char 7 ,
   .Xr mdoc 7 ,
   .Xr man 7
   .
   .Sh AUTHORS
   The
   .Nm
   utility was written by
   .An Kristaps Dzonsons Aq kristaps@kth.se .
   .
   .Sh CAVEATS
   In
   .Fl T Ns Ar html ,
   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 with
   .Fl o Ns Ar man=fmt .
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.42
CVSweb