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

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

version 1.7, 2009/03/23 09:42:43 version 1.12, 2009/04/02 16:42:35
Line 22 
Line 22 
 .\" SECTION  .\" SECTION
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display BSD manuals  .Nd format and display UNIX manuals
 .\" SECTION  .\" 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 W Ns Ar err...  .Op Fl W Ns Ar err...
 .Op Fl T Ns Ar output  .Op Fl T Ns Ar output
 .Op Ar infile...  .Op Ar infile...
Line 35 
Line 36 
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility formats a BSD  utility formats
 .Dq mdoc  .Ux
 manual page for display.  The arguments are as follows:  manual pages for display.  The arguments are as follows:
 .Bl -tag -width XXXXXXXXXXXX  .Bl -tag -width XXXXXXXXXXXX
 .\" ITEM  .\" ITEM
 .It Fl f Ns Ar option...  .It Fl f Ns Ar option...
Line 45  Override default compiler behaviour.  See 
Line 46  Override default compiler behaviour.  See 
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .\" ITEM  .\" ITEM
   .It Fl m
   Input format.  See
   .Sx Input Formats
   for available formats.  Defaults to
   .Fl m Ns Ar andoc .
   .\" ITEM
 .It Fl T  .It Fl T
 Output format.  See  Output format.  See
 .Sx Output Formats  .Sx Output Formats
Line 80  will halt with the first failed parse.
Line 87  will halt with the first failed parse.
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 reads from stdin and prints 78-column backspace-encoded output to stdout  reads
 as if  .Xr mdoc 7
   or
   .Xr man 7
   text from stdin, implying
   .Fl m Ns Ar andoc ,
   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  .\" PARAGRAPH
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Reserved Words  .Ss Reserved Words (mdoc only)
 The reserved words described in  The reserved words described in
 .Xr mdoc 7  .Xr mdoc 7
 are handled according to the following rules:  are handled according to the following rules:
Line 132  However, if the comma were part of 
Line 144  However, if the comma were part of 
 .Dq ,empirically ,  .Dq ,empirically ,
 it would not.  it would not.
 .\" SUB-SECTION  .\" SUB-SECTION
   .Ss Input Formats
   The
   .Nm
   utility accepts
   .Xr mdoc 7
   and
   .Xr man 7
   input with
   .Fl m Ns Ar doc
   and
   .Fl m Ns Ar an ,
   respectively.  The
   .Xr mdoc 7
   format is
   .Em strongly
   recommended;
   .Xr man 7
   should only be used for legacy manuals.
   .Pp
   A third option,
   .Fl m Ns Ar andoc ,
   which is also the default, determines encoding on-the-fly.  If multiple
   files are passed in, each has its file-type determined this way.  If
   multiple files are passed and
   .Fl m Ns Ar doc
   or
   .Fl m Ns Ar an
   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
Line 152  Parse only: produce no output.
Line 204  Parse only: produce no output.
 Default compiler behaviour may be overriden with the  Default compiler behaviour may be overriden with the
 .Fl f  .Fl f
 flag.  flag.
 .Bl -tag -width XXXXXXXXXXXX -offset XXXX  .Bl -tag -width XXXXXXXXXXXXXX -offset XXXX
 .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
 .It Fl f Ns Ar ign-escape  .It Fl f Ns Ar ign-escape
 Ignore invalid escape sequences.  Ignore invalid escape sequences.
 .It Fl f Ns Ar ign-macro  .It Fl f Ns Ar ign-macro
 Ignore unknown macros at the start of input lines.  Ignore unknown macros at the start of input lines (default for
   .Xr man 7
   parsing).
   .It Fl f Ns Ar no-ign-macro
   Do not ignore unknown macros at the start of input lines (default for
   .Xr mdoc 7
   parsing).
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
Line 178  To page this manual page on the terminal:
Line 237  To page this manual page on the terminal:
 .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less  .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less
 .\" SECTION  .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mdoc 7  .Xr mdoc 7 ,
   .Xr man 7
 .\"  .\"
 .Sh AUTHORS  .Sh AUTHORS
 The  The
Line 196  mode doesn't yet know how to display the following:
Line 256  mode doesn't yet know how to display the following:
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 The \-hang  The \-hang
 .Sq \&Bl  .Sq \&.Bl
 list is not yet supported.  list is not yet supported.
 .El  .El
 .Pp  .Pp
Line 212  output and
Line 272  output and
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 A list of display following  A list of display following
 .Sq \&Ss  .Sq \&.Ss
 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.  Special characters don't follow the current font style.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 The \-literal and \-unfilled  The \-literal and \-unfilled
 .Sq \&Bd  .Sq \&.Bd
 displays types are synonyms, as are \-filled and \-ragged.  displays types are synonyms, as are \-filled and \-ragged.
 .El  .El
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.12
CVSweb