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

Diff for /mandoc/mandoc.1 between version 1.56 and 1.57

version 1.56, 2010/03/29 10:10:35 version 1.57, 2010/04/08 07:40:03
Line 40  The
Line 40  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.
   Defaults to
 .Fl m Ns Ar andoc .  .Fl m Ns Ar andoc .
 .  .
 .It Fl O Ns Ar option...  .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.
   Defaults to
 .Fl T Ns Ar ascii .  .Fl T Ns Ar 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.  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
 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 Ar error,all .
Line 82  arguments may be comma-separated, such as
Line 91  arguments may be comma-separated, such as
 .It Ar infile...  .It Ar infile...
 Read input from zero or more  Read input from zero or more
 .Ar infile .  .Ar infile .
 If unspecified, reads from stdin.  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
Line 115  input with
Line 125  input with
 .Fl m Ns Ar doc  .Fl m Ns Ar doc
 and  and
 .Fl m Ns Ar an ,  .Fl m Ns Ar an ,
 respectively.  The  respectively.
   The
 .Xr mdoc 7  .Xr mdoc 7
 format is  format is
 .Em strongly  .Em strongly
Line 141  parser is used.
Line 152  parser is used.
 If multiple  If multiple
 files are specified with  files are specified with
 .Fl m Ns Ar andoc ,  .Fl m Ns Ar 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 Ar doc
 or  or
Line 160  arguments (see
Line 172  arguments (see
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl T Ns Ar ascii  .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.  See  styles.
   This is the default.
   See
 .Sx ASCII Output .  .Sx ASCII Output .
 .  .
 .It Fl T Ns Ar html  .It Fl T Ns Ar html
 Produce strict HTML-4.01 output, with a sane default style.  See  Produce strict HTML-4.01 output, with a sane default style.
   See
 .Sx HTML Output .  .Sx HTML Output .
 .  .
 .It Fl T Ns Ar xhtml  .It Fl T Ns Ar xhtml
 Produce strict XHTML-1.0 output, with a sane default style.  See  Produce strict XHTML-1.0 output, with a sane default style.
   See
 .Sx XHTML Output .  .Sx XHTML Output .
 .  .
 .It Fl T Ns Ar tree  .It Fl T Ns Ar tree
Line 195  flag.
Line 211  flag.
 .Bl -tag -width Ds  .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  .It Fl f Ns Ar ign-escape
Line 220  and
Line 237  and
 .Fl f Ns Ar no-ign-chars .  .Fl f Ns Ar no-ign-chars .
 .  .
 .It Fl f Ns Ar ign-errors  .It Fl f Ns Ar ign-errors
 When parsing multiple files, don't halt when one errors out.  Useful  When parsing multiple files, don't halt when one errors out.
 with  Useful with
 .Fl T Ns Ar lint  .Fl T Ns Ar lint
 over a large set of manuals passed on the command line.  over a large set of manuals passed on the command line.
 .El  .El
Line 237  accepts output options:
Line 254  accepts output options:
 .It Fl O Ns Ar style=style.css  .It Fl O Ns Ar style=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 includes=fmt  .It Fl O Ns Ar includes=fmt
 The string  The string
Line 246  for example,
Line 264  for example,
 .Ar ../src/%I.html ,  .Ar ../src/%I.html ,
 is used as a template for linked header files (usually via the  is used as a template for linked header files (usually via the
 .Sq \&In  .Sq \&In
 macro).  Instances of  macro).
   Instances of
 .Sq \&%I  .Sq \&%I
 are replaced with the include filename.  The default is not to present a  are replaced with the include filename.
   The default is not to present a
 hyperlink.  hyperlink.
 .It Fl O Ns Ar man=fmt  .It Fl O Ns Ar man=fmt
 The string  The string
Line 257  for example,
Line 277  for example,
 .Ar ../html%S/%N.%S.html ,  .Ar ../html%S/%N.%S.html ,
 is used as a template for linked manuals (usually via the  is used as a template for linked manuals (usually via the
 .Sq \&Xr  .Sq \&Xr
 macro).  Instances of  macro).
   Instances of
 .Sq \&%N  .Sq \&%N
 and  and
 .Sq %S  .Sq %S
 are replaced with the linked manual's name and section, respectively.  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  If no section is included, section 1 is assumed.
   The default is not to
 present a hyperlink.  present a hyperlink.
 .El  .El
 .  .
Line 276  a body composed of sections and sub-sections, and a fo
Line 298  a body composed of sections and sub-sections, and a fo
 The text style of output characters (non-macro characters, punctuation,  The text style of output characters (non-macro characters, punctuation,
 and white-space) is dictated by context.  and white-space) is dictated by context.
 .Pp  .Pp
 White-space is generally stripped from input.  This can be changed with  White-space is generally stripped from input.
   This can be changed with
 character escapes (specified in  character escapes (specified in
 .Xr mandoc_char 7 )  .Xr mandoc_char 7 )
 or literal modes (specified in  or literal modes (specified in
Line 330  is rendered as
Line 353  is rendered as
 .Sq _ Ns \e[bs] Ns c ,  .Sq _ Ns \e[bs] Ns c ,
 where  where
 .Sq \e[bs]  .Sq \e[bs]
 is the back-space character number 8.  Emboldened characters are rendered as  is the back-space character number 8.
   Emboldened characters are rendered as
 .Sq c Ns \e[bs] Ns c .  .Sq c Ns \e[bs] Ns c .
 .Pp  .Pp
 The special characters documented in  The special characters documented in
Line 346  Output produced by
Line 370  Output produced by
 .Fl T Ns Ar html  .Fl T Ns Ar html
 conforms to HTML-4.01 strict.  conforms to HTML-4.01 strict.
 .Pp  .Pp
 Font styles and page structure are applied using CSS2.  By default, no  Font styles and page structure are applied using CSS2.
 font style is applied to any text, although CSS2 is hard-coded to format  By default, no font style is applied to any text,
   although CSS2 is hard-coded to format
 the basic structure of output.  the basic structure of output.
 .Pp  .Pp
 The  The
Line 374  output modes are identical.
Line 399  output modes are identical.
 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
Line 382  To produce HTML manuals with
Line 407  To produce HTML manuals with
 .Ar style.css  .Ar style.css
 as the style-sheet:  as the style-sheet:
 .Pp  .Pp
 .D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > mdoc.7.html  .D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
 .Pp  .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .  .
Line 425  the
Line 450  the
 .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
Line 467  The
Line 493  The
 escape will revert the font to the previous  escape will revert the font to the previous
 .Sq \ef  .Sq \ef
 escape, not to the last rendered decoration, which is now dictated by  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  CSS instead of hard-coded.
 scope, for the same reason.  Note that in  It also will not span past the current scope,
   for the same reason.
   Note that in
 .Sx ASCII Output  .Sx ASCII Output
 mode, this will work fine.  mode, this will work fine.
 .It  .It
Line 491  lists render similarly.
Line 519  lists render similarly.
 .  .
 .  .
 .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  
 .  .
 .Sh AUTHORS  .Sh AUTHORS
 The  The
Line 519  and
Line 547  and
 .Fl T Ns Ar xhtml ,  .Fl T Ns Ar xhtml ,
 the maximum size of an element attribute is determined by  the maximum size of an element attribute is determined by
 .Dv BUFSIZ ,  .Dv BUFSIZ ,
 which is usually 1024 bytes.  Be aware of this when setting long link  which is usually 1024 bytes.
   Be aware of this when setting long link
 formats, e.g.,  formats, e.g.,
 .Fl O Ns Ar style=really/long/link .  .Fl O Ns Ar style=really/long/link .
 .  .

Legend:
Removed from v.1.56  
changed lines
  Added in v.1.57

CVSweb