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

Diff for /mandoc/mandoc.1 between version 1.90 and 1.102

version 1.90, 2011/08/18 08:58:43 version 1.102, 2013/03/06 08:08:24
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2012 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" 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 23 
Line 24 
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl V  .Op Fl V
   .Sm off
   .Op Fl I Cm os Li = Ar name
   .Sm on
 .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
Line 34  The
Line 38  The
 utility formats  utility formats
 .Ux  .Ux
 manual pages for display.  manual pages for display.
   .Pp
   By default,
   .Nm
   reads
   .Xr mdoc 7
   or
   .Xr man 7
   text from stdin, implying
   .Fl m Ns Cm andoc ,
   and produces
   .Fl T Ns Cm ascii
   output.
   .Pp
 The arguments are as follows:  The arguments are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .Sm off
   .It Fl I Cm os Li = Ar name
   .Sm on
   Override the default operating system
   .Ar name
   for the
   .Xr mdoc 7
   .Sq \&Os
   macro.
 .It Fl m Ns Ar format  .It Fl m Ns Ar format
 Input format.  Input format.
 See  See
Line 96  If multiple files are specified,
Line 122  If multiple files are specified,
 .Nm  .Nm
 will halt with the first failed parse.  will halt with the first failed parse.
 .El  .El
 .Pp  
 By default,  
 .Nm  
 reads  
 .Xr mdoc 7  
 or  
 .Xr man 7  
 text from stdin, implying  
 .Fl m Ns Cm andoc ,  
 and produces  
 .Fl T Ns Cm ascii  
 output.  
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 157  The
Line 171  The
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments, which correspond to output modes:  arguments, which correspond to output modes:
 .Bl -tag -width Ds  .Bl -tag -width "-Tlocale"
 .It Fl T Ns Cm utf8  
 Encode output in the UTF\-8 multi-byte format.  
 See  
 .Sx UTF\-8 Output .  
 .It Fl T Ns Cm locale  
 Encode output using the current locale.  
 See  
 .Sx Locale Output .  
 .It Fl T Ns Cm ascii  .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output.  Produce 7-bit ASCII output.
 This is the default.  This is the default.
Line 179  See
Line 185  See
 Parse only: produce no output.  Parse only: produce no output.
 Implies  Implies
 .Fl W Ns Cm warning .  .Fl W Ns Cm warning .
   .It Fl T Ns Cm locale
   Encode output using the current locale.
   See
   .Sx Locale Output .
   .It Fl T Ns Cm man
   Produce
   .Xr man 7
   format output.
   See
   .Sx Man Output .
 .It Fl T Ns Cm pdf  .It Fl T Ns Cm pdf
 Produce PDF output.  Produce PDF output.
 See  See
Line 189  See
Line 205  See
 .Sx PostScript Output .  .Sx PostScript Output .
 .It Fl T Ns Cm tree  .It Fl T Ns Cm tree
 Produce an indented parse tree.  Produce an indented parse tree.
   .It Fl T Ns Cm utf8
   Encode output in the UTF\-8 multi-byte format.
   See
   .Sx UTF\-8 Output .
 .It Fl T Ns Cm xhtml  .It Fl T Ns Cm xhtml
 Produce strict CSS1/XHTML-1.0 output.  Produce strict CSS1/XHTML-1.0 output.
 See  See
Line 197  See
Line 217  See
 .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 UTF\-8 Output  
 Use  
 .Fl T Ns Cm utf8  
 to force a UTF\-8 locale.  
 See  
 .Sx Locale Output  
 for details and options.  
 .Ss Locale Output  
 Locale-depending output encoding is triggered with  
 .Fl T Ns Cm locale .  
 This option is not available on all systems: systems without locale  
 support, or those whose internal representation is not natively UCS-4,  
 will fall back to  
 .Fl T Ns Cm ascii .  
 See  
 .Sx ASCII Output  
 for font style specification and available command-line arguments.  
 .Ss ASCII Output  .Ss ASCII Output
 Output produced by  Output produced by
 .Fl T Ns Cm ascii ,  .Fl T Ns Cm ascii ,
Line 245  The following
Line 248  The following
 .Fl O  .Fl O
 arguments are accepted:  arguments are accepted:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .It Cm indent Ns = Ns Ar indent
   The left margin for normal text is set to
   .Ar indent
   blank characters instead of the default of five for
   .Xr mdoc 7
   and seven for
   .Xr man 7 .
   Increasing this is not recommended; it may result in degraded formatting,
   for example overfull lines or ugly line breaks.
 .It Cm width Ns = Ns Ar width  .It Cm width Ns = Ns Ar width
 The output width is set to  The output width is set to
 .Ar width ,  .Ar width ,
Line 270  The following
Line 282  The following
 .Fl O  .Fl O
 arguments are accepted:  arguments are accepted:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .It Cm fragment
   Omit the
   .Aq !DOCTYPE
   declaration and the
   .Aq html ,
   .Aq head ,
   and
   .Aq body
   elements and only emit the subtree below the
   .Aq body
   element.
   The
   .Cm style
   argument will be ignored.
   This is useful when embedding manual content within existing documents.
 .It Cm includes Ns = Ns Ar fmt  .It Cm includes Ns = Ns Ar fmt
 The string  The string
 .Ar fmt ,  .Ar fmt ,
Line 306  is used for an external style-sheet.
Line 333  is used for an external style-sheet.
 This must be a valid absolute or  This must be a valid absolute or
 relative URI.  relative URI.
 .El  .El
   .Ss Locale Output
   Locale-depending output encoding is triggered with
   .Fl T Ns Cm locale .
   This option is not available on all systems: systems without locale
   support, or those whose internal representation is not natively UCS-4,
   will fall back to
   .Fl T Ns Cm ascii .
   See
   .Sx ASCII Output
   for font style specification and available command-line arguments.
   .Ss Man Output
   Translate input format into
   .Xr man 7
   output format.
   This is useful for distributing manual sources to legacy systems
   lacking
   .Xr mdoc 7
   formatters.
   .Pp
   If
   .Xr mdoc 7
   is passed as input, it is translated into
   .Xr man 7 .
   If the input format is
   .Xr man 7 ,
   the input is copied to the output, expanding any
   .Xr roff 7
   .Sq so
   requests.
   The parser is also run, and as usual, the
   .Fl W
   level controls which
   .Sx DIAGNOSTICS
   are displayed before copying the input to the output.
   .Ss PDF Output
   PDF-1.1 output may be generated by
   .Fl T Ns Cm pdf .
   See
   .Sx PostScript Output
   for
   .Fl O
   arguments and defaults.
 .Ss PostScript Output  .Ss PostScript Output
 PostScript  PostScript
 .Qq Adobe-3.0  .Qq Adobe-3.0
Line 340  If an unknown value is encountered,
Line 409  If an unknown value is encountered,
 .Ar letter  .Ar letter
 is used.  is used.
 .El  .El
 .Ss PDF Output  .Ss UTF\-8 Output
 PDF-1.1 output may be generated by  Use
 .Fl T Ns Cm pdf .  .Fl T Ns Cm utf8
   to force a UTF\-8 locale.
 See  See
 .Sx PostScript Output  .Sx Locale Output
 for  for details and options.
 .Fl O  
 arguments and defaults.  
 .Ss XHTML Output  .Ss XHTML Output
 Output produced by  Output produced by
 .Fl T Ns Cm xhtml  .Fl T Ns Cm xhtml
Line 417  To check over a large set of manuals:
Line 485  To check over a large set of manuals:
 To produce a series of PostScript manuals for A4 paper:  To produce a series of PostScript manuals for A4 paper:
 .Pp  .Pp
 .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps  .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
   .Pp
   Convert a modern
   .Xr mdoc 7
   manual to the older
   .Xr man 7
   format, for use on systems lacking an
   .Xr mdoc 7
   parser:
   .Pp
   .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
 .Sh DIAGNOSTICS  .Sh DIAGNOSTICS
 Standard error messages reporting parsing errors are prefixed by  Standard error messages reporting parsing errors are prefixed by
 .Pp  .Pp
Legend:
Removed from v.1.90  
changed lines
  Added in v.1.102
CVSweb