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

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

version 1.33, 2009/08/20 12:26:15 version 1.42, 2009/10/10 11:05:23
Line 26 
Line 26 
 .  .
 .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...
 .  .
 .  .
Line 43  manual pages for display.  The arguments are as follow
Line 44  manual pages for display.  The arguments are as follow
 .  .
 .Bl -tag -width Ds  .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.
 .  .
Line 53  Input format.  See
Line 54  Input format.  See
 for available formats.  Defaults to  for available formats.  Defaults to
 .Fl m Ns Ar andoc .  .Fl m Ns Ar andoc .
 .  .
   .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
Line 63  for available formats.  Defaults to
Line 69  for available formats.  Defaults to
 Print version and exit.  Print version and exit.
 .  .
 .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 196  arguments:
Line 202  arguments:
 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
   Produce strict HTML-4.01 output, with a sane default style.
   .
 .It Fl T Ns Ar tree  .It Fl T Ns Ar tree
 Produce an indented parse tree.  Produce an indented parse tree.
 .  .
Line 209  corresponding filter in-order.
Line 218  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.
 .  .
Line 241  Don't halt when encountering parse errors.  Useful wit
Line 250  Don't halt when encountering parse errors.  Useful wit
 over a large set of manuals passed on the command line.  over a large set of manuals passed on the command line.
 .El  .El
 .  .
 .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,no-ign-escape ,  The file
 for example, will try to ignore scope and not ignore character-escape  .Ar style.css
 errors.  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 manuals to the terminal:  To page manuals to the terminal:
 .  .
Line 260  To page manuals to the terminal:
Line 295  To page manuals to the terminal:
 .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 > mdoc.7.html
   .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .  .
 .Pp  .Pp
Line 316  does not assert a prior vertical break, just as it doe
Line 357  does not assert a prior vertical break, just as it doe
 .It  .It
 The  The
 .Sq \&na  .Sq \&na
 and  
 .Sq \&Dt  
 .Xr man 7  .Xr man 7
 macros in  macro in
 .Fl T Ns Ar ascii  .Fl T Ns Ar ascii
 have no effect.  has no effect.
 .  .
 .It  .It
 Words aren't hyphenated.  Words aren't hyphenated.
Line 335  retains spaces.
Line 374  retains spaces.
 .It  .It
 Sentences are unilaterally monospaced.  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  .\" SECTION
 .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
   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.33  
changed lines
  Added in v.1.42
CVSweb