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

Diff for /mandoc/mandoc.1 between version 1.155 and 1.156

version 1.155, 2015/02/23 13:31:03 version 1.156, 2015/03/27 16:36:31
Line 24 
Line 24 
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl acfhkl  .Op Fl acfhkl
 .Sm off  .Op Fl I Cm os Ns = Ns Ar name
 .Op Fl I Cm os Li = Ar name  .Op Fl K Ar encoding
 .Sm on  
 .Op Fl K Ns Ar encoding  
 .Op Fl m Ns Ar format  .Op Fl m Ns Ar format
 .Op Fl O Ns Ar option  .Op Fl O Ar option
 .Op Fl T Ns Ar output  .Op Fl T Ar output
 .Op Fl W Ns Ar level  .Op Fl W Ar level
 .Op Ar  .Op Ar
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
Line 49  or
Line 47  or
 text from stdin, implying  text from stdin, implying
 .Fl m Ns Cm andoc ,  .Fl m Ns Cm andoc ,
 and produces  and produces
 .Fl T Ns Cm locale  .Fl T Cm locale
 output.  output.
 .Pp  .Pp
 The options are as follows:  The options are as follows:
Line 77  This overrides any earlier
Line 75  This overrides any earlier
 and  and
 .Fl l  .Fl l
 options.  options.
 .Sm off  .It Fl I Cm os Ns = Ns Ar name
 .It Fl I Cm os Li = Ar name  
 .Sm on  
 Override the default operating system  Override the default operating system
 .Ar name  .Ar name
 for the  for the
Line 93  macro.
Line 89  macro.
 Display only the SYNOPSIS lines.  Display only the SYNOPSIS lines.
 Implies  Implies
 .Fl c .  .Fl c .
 .It Fl K Ns Ar encoding  .It Fl K Ar encoding
 Specify the input encoding.  Specify the input encoding.
 The supported  The supported
 .Ar encoding  .Ar encoding
Line 141  See
Line 137  See
 for available formats.  for available formats.
 Defaults to  Defaults to
 .Fl m Ns Cm andoc .  .Fl m Ns Cm andoc .
 .It Fl O Ns Ar option  .It Fl O Ar option
 Comma-separated output options.  Comma-separated output options.
 .It Fl T Ns Ar output  .It Fl T Ar output
 Output format.  Output format.
 See  See
 .Sx Output Formats  .Sx Output Formats
 for available formats.  for available formats.
 Defaults to  Defaults to
 .Fl T Ns Cm locale .  .Fl T Cm locale .
 .It Fl W Ns Ar level  .It Fl W Ar level
 Specify the minimum message  Specify the minimum message
 .Ar level  .Ar level
 to be reported on the standard error output and to affect the exit status.  to be reported on the standard error output and to affect the exit status.
Line 174  and
Line 170  and
 for details.  for details.
 .Pp  .Pp
 The special option  The special option
 .Fl W Ns Cm stop  .Fl W Cm stop
 tells  tells
 .Nm  .Nm
 to exit after parsing a file that causes warnings or errors of at least  to exit after parsing a file that causes warnings or errors of at least
Line 185  If both a
Line 181  If both a
 and  and
 .Cm stop  .Cm stop
 are requested, they can be joined with a comma, for example  are requested, they can be joined with a comma, for example
 .Fl W Ns Cm error , Ns Cm stop .  .Fl W Cm error , Ns Cm stop .
 .It Ar file  .It Ar file
 Read input from zero or more files.  Read input from zero or more files.
 If unspecified, reads from stdin.  If unspecified, reads from stdin.
Line 254  The
Line 250  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 "-Tlocale"  .Bl -tag -width "-T locale"
 .It Fl T Ns Cm ascii  .It Fl T Cm ascii
 Produce 7-bit ASCII output.  Produce 7-bit ASCII output.
 See  See
 .Sx ASCII Output .  .Sx ASCII Output .
 .It Fl T Ns Cm html  .It Fl T Cm html
 Produce HTML5, CSS1, and MathML output.  Produce HTML5, CSS1, and MathML output.
 See  See
 .Sx HTML Output .  .Sx HTML Output .
 .It Fl T Ns Cm lint  .It Fl T Cm lint
 Parse only: produce no output.  Parse only: produce no output.
 Implies  Implies
 .Fl W Ns Cm warning .  .Fl W Cm warning .
 .It Fl T Ns Cm locale  .It Fl T Cm locale
 Encode output using the current locale.  Encode output using the current locale.
 This is the default.  This is the default.
 See  See
 .Sx Locale Output .  .Sx Locale Output .
 .It Fl T Ns Cm man  .It Fl T Cm man
 Produce  Produce
 .Xr man 7  .Xr man 7
 format output.  format output.
 See  See
 .Sx Man Output .  .Sx Man Output .
 .It Fl T Ns Cm pdf  .It Fl T Cm pdf
 Produce PDF output.  Produce PDF output.
 See  See
 .Sx PDF Output .  .Sx PDF Output .
 .It Fl T Ns Cm ps  .It Fl T Cm ps
 Produce PostScript output.  Produce PostScript output.
 See  See
 .Sx PostScript Output .  .Sx PostScript Output .
 .It Fl T Ns Cm tree  .It Fl T Cm tree
 Produce an indented parse tree.  Produce an indented parse tree.
 .It Fl T Ns Cm utf8  .It Fl T Cm utf8
 Encode output in the UTF\-8 multi-byte format.  Encode output in the UTF\-8 multi-byte format.
 See  See
 .Sx UTF\-8 Output .  .Sx UTF\-8 Output .
 .It Fl T Ns Cm xhtml  .It Fl T Cm xhtml
 This is a synonym for  This is a synonym for
 .Fl T Ns Cm html .  .Fl T Cm html .
 .El  .El
 .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 ASCII Output  .Ss ASCII Output
 Output produced by  Output produced by
 .Fl T Ns Cm ascii  .Fl T Cm ascii
 is rendered in standard 7-bit ASCII documented in  is rendered in standard 7-bit ASCII documented in
 .Xr ascii 7 .  .Xr ascii 7 .
 .Pp  .Pp
Line 343  which will normalise to \(>=58.
Line 339  which will normalise to \(>=58.
 .El  .El
 .Ss HTML Output  .Ss HTML Output
 Output produced by  Output produced by
 .Fl T Ns Cm html  .Fl T Cm html
 conforms to HTML5 using optional self-closing tags.  conforms to HTML5 using optional self-closing tags.
 Default styles use only CSS1.  Default styles use only CSS1.
 Equations rendered from  Equations rendered from
Line 354  The
Line 350  The
 .Pa example.style.css  .Pa example.style.css
 file documents style-sheet classes available for customising output.  file documents style-sheet classes available for customising output.
 If a style-sheet is not specified with  If a style-sheet is not specified with
 .Fl O Ns Ar style ,  .Fl O Cm style ,
 .Fl T Ns Cm html  .Fl T Cm html
 defaults to simple output (via an embedded style-sheet)  defaults to simple output (via an embedded style-sheet)
 readable in any graphical or text-based web  readable in any graphical or text-based web
 browser.  browser.
Line 411  relative URI.
Line 407  relative URI.
 .El  .El
 .Ss Locale Output  .Ss Locale Output
 Locale-depending output encoding is triggered with  Locale-depending output encoding is triggered with
 .Fl T Ns Cm locale .  .Fl T Cm locale .
 This is the default.  This is the default.
 .Pp  .Pp
 This option is not available on all systems: systems without locale  This option is not available on all systems: systems without locale
 support, or those whose internal representation is not natively UCS-4,  support, or those whose internal representation is not natively UCS-4,
 will fall back to  will fall back to
 .Fl T Ns Cm ascii .  .Fl T Cm ascii .
 See  See
 .Sx ASCII Output  .Sx ASCII Output
 for font style specification and available command-line arguments.  for font style specification and available command-line arguments.
Line 447  level controls which
Line 443  level controls which
 are displayed before copying the input to the output.  are displayed before copying the input to the output.
 .Ss PDF Output  .Ss PDF Output
 PDF-1.1 output may be generated by  PDF-1.1 output may be generated by
 .Fl T Ns Cm pdf .  .Fl T Cm pdf .
 See  See
 .Sx PostScript Output  .Sx PostScript Output
 for  for
Line 457  arguments and defaults.
Line 453  arguments and defaults.
 PostScript  PostScript
 .Qq Adobe-3.0  .Qq Adobe-3.0
 Level-2 pages may be generated by  Level-2 pages may be generated by
 .Fl T Ns Cm ps .  .Fl T Cm ps .
 Output pages default to letter sized and are rendered in the Times font  Output pages default to letter sized and are rendered in the Times font
 family, 11-point.  family, 11-point.
 Margins are calculated as 1/9 the page length and width.  Margins are calculated as 1/9 the page length and width.
Line 489  is used.
Line 485  is used.
 .El  .El
 .Ss UTF\-8 Output  .Ss UTF\-8 Output
 Use  Use
 .Fl T Ns Cm utf8  .Fl T Cm utf8
 to force a UTF\-8 locale.  to force a UTF\-8 locale.
 See  See
 .Sx Locale Output  .Sx Locale Output
Line 525  they were lower than the requested
Line 521  they were lower than the requested
 .Ar level .  .Ar level .
 .It 2  .It 2
 At least one warning occurred, but no error, and  At least one warning occurred, but no error, and
 .Fl W Ns Cm warning  .Fl W Cm warning
 was specified.  was specified.
 .It 3  .It 3
 At least one parsing error occurred,  At least one parsing error occurred,
 but no unsupported feature was encountered, and  but no unsupported feature was encountered, and
 .Fl W Ns Cm error  .Fl W Cm error
 or  or
 .Fl W Ns Cm warning  .Fl W Cm warning
 was specified.  was specified.
 .It 4  .It 4
 At least one unsupported feature was encountered, and  At least one unsupported feature was encountered, and
 .Fl W Ns Cm unsupp ,  .Fl W Cm unsupp ,
 .Fl W Ns Cm error  .Fl W Cm error
 or  or
 .Fl W Ns Cm warning  .Fl W Cm warning
 was specified.  was specified.
 .It 5  .It 5
 Invalid command line arguments were specified.  Invalid command line arguments were specified.
Line 553  to exit at once, possibly in the middle of parsing or 
Line 549  to exit at once, possibly in the middle of parsing or 
 .El  .El
 .Pp  .Pp
 Note that selecting  Note that selecting
 .Fl T Ns Cm lint  .Fl T Cm lint
 output mode implies  output mode implies
 .Fl W Ns Cm warning .  .Fl W Cm warning .
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .Pp  .Pp
 .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less  .Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less
 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less  .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .Pp  .Pp
 To produce HTML manuals with  To produce HTML manuals with
 .Ar style.css  .Ar style.css
 as the style-sheet:  as the style-sheet:
 .Pp  .Pp
 .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html  .Dl $ mandoc \-T html -O style=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:
 .Pp  .Pp
 .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`  .Dl $ mandoc \-T lint `find /usr/src -name \e*\e.[1-9]`
 .Pp  .Pp
 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 \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
 .Pp  .Pp
 Convert a modern  Convert a modern
 .Xr mdoc 7  .Xr mdoc 7
Line 584  format, for use on systems lacking an
Line 580  format, for use on systems lacking an
 .Xr mdoc 7  .Xr mdoc 7
 parser:  parser:
 .Pp  .Pp
 .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man  .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
 .Sh DIAGNOSTICS  .Sh DIAGNOSTICS
 Messages displayed by  Messages displayed by
 .Nm  .Nm
Line 651  levels except those about non-existent or unreadable i
Line 647  levels except those about non-existent or unreadable i
 are hidden unless their level, or a lower level, is requested using a  are hidden unless their level, or a lower level, is requested using a
 .Fl W  .Fl W
 option or  option or
 .Fl T Ns Cm lint  .Fl T Cm lint
 output mode.  output mode.
 .Ss Warnings related to the document prologue  .Ss Warnings related to the document prologue
 .Bl -ohang  .Bl -ohang
Line 1767  as if they were a text line.
Line 1763  as if they were a text line.
 .Xr roff 7 ,  .Xr roff 7 ,
 .Xr tbl 7  .Xr tbl 7
 .Sh AUTHORS  .Sh AUTHORS
   .An -nosplit
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
Line 1775  and is maintained by
Line 1772  and is maintained by
 .An Ingo Schwarze Aq Mt schwarze@openbsd.org .  .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
 .Sh BUGS  .Sh BUGS
 In  In
 .Fl T Ns Cm html ,  .Fl T Cm html ,
 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.  which is usually 1024 bytes.
 Be aware of this when setting long link  Be aware of this when setting long link
 formats such as  formats such as
 .Fl O Ns Cm style Ns = Ns Ar really/long/link .  .Fl O Cm style Ns = Ns Ar really/long/link .
Legend:
Removed from v.1.155  
changed lines
  Added in v.1.156
CVSweb