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

Diff for /mandoc/mandoc.1 between version 1.118 and 1.130

version 1.118, 2014/10/12 19:31:41 version 1.130, 2014/12/28 14:42:27
Line 27 
Line 27 
 .Sm off  .Sm off
 .Op Fl I Cm os Li = Ar name  .Op Fl I Cm os Li = Ar name
 .Sm on  .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 Ns Ar option
 .Op Fl T Ns Ar output  .Op Fl T Ns Ar output
Line 48  or
Line 49  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 ascii  .Fl T Ns Cm locale
 output.  output.
 .Pp  .Pp
 The options are as follows:  The options are as follows:
Line 84  Override the default operating system
Line 85  Override the default operating system
 for the  for the
 .Xr mdoc 7  .Xr mdoc 7
 .Sq \&Os  .Sq \&Os
   and for the
   .Xr man 7
   .Sq \&TH
 macro.  macro.
 .It Fl h  .It Fl h
 Display only the SYNOPSIS lines.  Display only the SYNOPSIS lines.
 Implies  Implies
 .Fl a .  .Fl c .
   .It Fl K Ns Ar encoding
   Specify the input encoding.
   The supported
   .Ar encoding
   arguments are
   .Cm us-ascii ,
   .Cm iso-8859-1 ,
   and
   .Cm utf-8 .
   If not specified, autodetection uses the first match:
   .Bl -tag -width iso-8859-1
   .It Cm utf-8
   if the first three bytes of the input file
   are the UTF-8 byte order mark (BOM, 0xefbbbf)
   .It Ar encoding
   if the first or second line of the input file matches the
   .Sy emacs
   mode line format
   .Pp
   .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
   .It Cm utf-8
   if the first non-ASCII byte in the file introduces a valid UTF-8 sequence
   .It Cm iso-8859-1
   otherwise
   .El
 .It Fl k  .It Fl k
 A synonym for  A synonym for
 .Xr apropos 1 .  .Xr apropos 1 .
Line 120  See
Line 149  See
 .Sx Output Formats  .Sx Output Formats
 for available formats.  for available formats.
 Defaults to  Defaults to
 .Fl T Ns Cm ascii .  .Fl T Ns Cm locale .
 .It Fl V  .It Fl V
 Print version and exit.  Print version and exit.
 .It Fl W Ns Ar level  .It Fl W Ns Ar level
Line 229  arguments, which correspond to output modes:
Line 258  arguments, which correspond to output modes:
 .Bl -tag -width "-Tlocale"  .Bl -tag -width "-Tlocale"
 .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.  
 See  See
 .Sx ASCII Output .  .Sx ASCII Output .
 .It Fl T Ns Cm html  .It Fl T Ns Cm html
Line 242  Implies
Line 270  Implies
 .Fl W Ns Cm warning .  .Fl W Ns Cm warning .
 .It Fl T Ns Cm locale  .It Fl T Ns Cm locale
 Encode output using the current locale.  Encode output using the current locale.
   This is the default.
 See  See
 .Sx Locale Output .  .Sx Locale Output .
 .It Fl T Ns Cm man  .It Fl T Ns Cm man
Line 273  If multiple input files are specified, these will be p
Line 302  If multiple input files are specified, these will be p
 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 Ns Cm ascii
 which is the default, 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
 Font styles are applied by using back-spaced encoding such that an  Font styles are applied by using back-spaced encoding such that an
Line 342  The following
Line 371  The following
 arguments are accepted:  arguments are accepted:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Cm fragment  .It Cm fragment
 Omit the  Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
 .Aq !DOCTYPE  elements and only emit the subtree below the <body> element.
 declaration and the  
 .Aq html ,  
 .Aq head ,  
 and  
 .Aq body  
 elements and only emit the subtree below the  
 .Aq body  
 element.  
 The  The
 .Cm style  .Cm style
 argument will be ignored.  argument will be ignored.
Line 395  relative URI.
Line 416  relative URI.
 .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 Ns Cm locale .
   This is the default.
   .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
Line 647  macro lacks the mandatory section argument.
Line 670  macro lacks the mandatory section argument.
 The section number in a  The section number in a
 .Ic \&Dt  .Ic \&Dt
 line is invalid, but still used.  line is invalid, but still used.
 .It Sy "unknown manual volume or arch"  
 .Pq mdoc  
 The volume name in a  
 .Ic \&Dt  
 line is invalid, but still used.  
 The manual is assumed to be architecture-independent.  
 .It Sy "missing date, using today's date"  .It Sy "missing date, using today's date"
 .Pq mdoc, man  .Pq mdoc, man
 The document was parsed as  The document was parsed as
Line 791  Probably, there are author names lacking markup.
Line 808  Probably, there are author names lacking markup.
 See the  See the
 .Xr mdoc 7  .Xr mdoc 7
 manual for replacements.  manual for replacements.
   .It Sy "macro neither callable nor escaped"
   .Pq mdoc
   The name of a macro that is not callable appears on a macro line.
   It is printed verbatim.
   If the intention is to call it, move it to its own line;
   otherwise, escape it by prepending
   .Sq \e& .
 .It Sy "skipping paragraph macro"  .It Sy "skipping paragraph macro"
 In  In
 .Xr mdoc 7  .Xr mdoc 7
Line 1035  argument is invalid.
Line 1059  argument is invalid.
 The default font  The default font
 .Cm \efR  .Cm \efR
 is used instead.  is used instead.
   .It Sy "nothing follows prefix"
   .Pq mdoc
   A
   .Ic \&Pf
   macro has no argument, or only one argument and no macro follows
   on the same input line.
   This defeats its purpose; in particular, spacing is not suppressed
   before the text or macros following on the next input line.
 .It Sy "missing -std argument, adding it"  .It Sy "missing -std argument, adding it"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1237  keeps the code more readable.
Line 1269  keeps the code more readable.
 .It "ignore data in cell"  .It "ignore data in cell"
 .It "data block still open"  .It "data block still open"
 .It "ignoring extra data cells"  .It "ignoring extra data cells"
   .It "ignoring macro in table"
 .El  .El
 .Ss "Errors related to roff, mdoc, and man code"  .Ss "Errors related to roff, mdoc, and man code"
 .Bl -ohang  .Bl -ohang
Line 1378  The indicated request or macro has too few or too many
Line 1411  The indicated request or macro has too few or too many
 The syntax tree will contain the wrong number of arguments as given.  The syntax tree will contain the wrong number of arguments as given.
 Formatting behaviour depends on the specific request or macro in question.  Formatting behaviour depends on the specific request or macro in question.
 Note that the same message may also occur as a WARNING, see above.  Note that the same message may also occur as a WARNING, see above.
   .It Sy "NOT IMPLEMENTED: Bd -file"
   .Pq mdoc
   For security reasons, the
   .Ic \&Bd
   macro does not support the
   .Fl file
   argument.
   By requesting the inclusion of a sensitive file, a malicious document
   might otherwise trick a privileged user into inadvertently displaying
   the file on the screen, revealing the file content to bystanders.
   The argument is ignored including the file name following it.
 .It Sy "missing list type, using -item"  .It Sy "missing list type, using -item"
 .Pq mdoc  .Pq mdoc
 A  A
Line 1439  or
Line 1483  or
 .Ic \&PP  .Ic \&PP
 macro, an  macro, an
 .Xr eqn 7  .Xr eqn 7
   .Ic \&EQ
   or
 .Ic \&EN  .Ic \&EN
 macro, or a  macro, or a
 .Xr roff 7  .Xr roff 7
Line 1464  cannot handle input files larger than its arbitrary si
Line 1510  cannot handle input files larger than its arbitrary si
 of 2^31 bytes (2 Gigabytes).  of 2^31 bytes (2 Gigabytes).
 Since useful manuals are always small, this is not a problem in practice.  Since useful manuals are always small, this is not a problem in practice.
 Parsing is aborted as soon as the condition is detected.  Parsing is aborted as soon as the condition is detected.
 .It Sy "NOT IMPLEMENTED: Bd -file"  
 .Pq mdoc  
 For security reasons, the  
 .Ic \&Bd  
 macro does not support the  
 .Fl file  
 argument.  
 By requesting the inclusion of a sensitive file, a malicious document  
 might otherwise trick a privileged user into inadvertently displaying  
 the file on the screen, revealing the file content to bystanders.  
 The parser exits immediately.  
 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"  .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
 .Pq roff  .Pq roff
 For security reasons,  For security reasons,
Legend:
Removed from v.1.118  
changed lines
  Added in v.1.130
CVSweb