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

Diff for /mandoc/mandoc.1 between version 1.144 and 1.165

version 1.144, 2015/02/04 19:20:12 version 1.165, 2016/12/28 17:34:18
Line 23 
Line 23 
 .Nd format and display UNIX manuals  .Nd format and display UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl acfhklV  .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 V  .It Fl W Ar level
 Print version and exit.  
 .It Fl W Ns 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 176  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 187  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 256  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  See
   .Sx Syntax tree output .
   .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 345  which will normalise to \(>=58.
Line 341  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 353  Equations rendered from
Line 349  Equations rendered from
 blocks use MathML.  blocks use MathML.
 .Pp  .Pp
 The  The
 .Pa example.style.css  .Pa mandoc.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 413  relative URI.
Line 409  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 449  level controls which
Line 445  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 459  arguments and defaults.
Line 455  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 491  is used.
Line 487  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
 for details and options.  for details and options.
   .Ss Syntax tree output
   Use
   .Fl T Cm tree
   to show a human readable representation of the syntax tree.
   It is useful for debugging the source code of manual pages.
   The exact format is subject to change, so don't write parsers for it.
   Each output line shows one syntax tree node.
   Child nodes are indented with respect to their parent node.
   The columns are:
   .Pp
   .Bl -enum -compact
   .It
   For macro nodes, the macro name; for text and
   .Xr tbl 7
   nodes, the content.
   There is a special format for
   .Xr eqn 7
   nodes.
   .It
   Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
   .It
   Flags:
   .Bl -dash -compact
   .It
   An opening parenthesis if the node is an opening delimiter.
   .It
   An asterisk if the node starts a new input line.
   .It
   The input line number (starting at one).
   .It
   A colon.
   .It
   The input column number (starting at one).
   .It
   A closing parenthesis if the node is a closing delimiter.
   .It
   A full stop if the node ends a sentence.
   .El
   .El
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPAGER  .Bl -tag -width MANPAGER
 .It Ev MANPAGER  .It Ev MANPAGER
Line 508  Specifies the pagination program to use when
Line 543  Specifies the pagination program to use when
 .Ev MANPAGER  .Ev MANPAGER
 is not defined.  is not defined.
 If neither PAGER nor MANPAGER is defined,  If neither PAGER nor MANPAGER is defined,
 .Pa /usr/bin/more Fl s  .Xr more 1
   .Fl s
 will be used.  will be used.
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
Line 527  they were lower than the requested
Line 563  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 555  to exit at once, possibly in the middle of parsing or 
Line 591  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  .Pa mandoc.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=mandoc.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 \(gafind /usr/src -name \e*\e.[1-9]\(ga
 .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 586  format, for use on systems lacking an
Line 622  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 653  levels except those about non-existent or unreadable i
Line 689  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 729  macro occurs after some non-prologue macro, but still 
Line 765  macro occurs after some non-prologue macro, but still 
 .Pq mdoc  .Pq mdoc
 The  The
 .Ic \&Dt  .Ic \&Dt
 macro can only occur before the first non-prologue macro  macro appears after the first non-prologue macro.
 because traditional formatters write the page header  Traditional formatters cannot handle this because
 before parsing the document body.  they write the page header before parsing the document body.
 Even though this technical restriction does not apply to  Even though this technical restriction does not apply to
 .Nm ,  .Nm ,
 traditional semantics is preserved.  traditional semantics is preserved.
Line 773  This may confuse
Line 809  This may confuse
 .Xr makewhatis 8  .Xr makewhatis 8
 and  and
 .Xr apropos 1 .  .Xr apropos 1 .
 .It Sy "bad NAME section contents"  .It Sy "NAME section without name"
 .Pq mdoc  .Pq mdoc
 The last node in the NAME section is not an  The NAME section does not contain any
   .Ic \&Nm
   child macro.
   .It Sy "NAME section without description"
   .Pq mdoc
   The NAME section lacks the mandatory
 .Ic \&Nd  .Ic \&Nd
 macro, or any preceding macro is not  child macro.
 .Ic \&Nm ,  .It Sy "description not at the end of NAME"
 or the NAME section is completely empty.  .Pq mdoc
 This may confuse  The NAME section does contain an
 .Xr makewhatis 8  .Ic \&Nd
   child macro, but other content follows it.
   .It Sy "bad NAME section content"
   .Pq mdoc
   The NAME section contains plain text or macros other than
   .Ic \&Nm
 and  and
 .Xr apropos 1 .  .Ic \&Nd .
 .It Sy "missing description line, using \(dq\(dq"  .It Sy "missing description line, using \(dq\(dq"
 .Pq mdoc  .Pq mdoc
 The  The
Line 809  In the SEE ALSO section, an
Line 855  In the SEE ALSO section, an
 macro with a lower section number follows one with a higher number,  macro with a lower section number follows one with a higher number,
 or two  or two
 .Ic \&Xr  .Ic \&Xr
 macros refering to the same section are out of alphabetical order.  macros referring to the same section are out of alphabetical order.
 .It Sy "unusual Xr punctuation"  .It Sy "unusual Xr punctuation"
 .Pq mdoc  .Pq mdoc
 In the SEE ALSO section, punctuation between two  In the SEE ALSO section, punctuation between two
Line 836  manual for replacements.
Line 882  manual for replacements.
 .Pq mdoc  .Pq mdoc
 The name of a macro that is not callable appears on a macro line.  The name of a macro that is not callable appears on a macro line.
 It is printed verbatim.  It is printed verbatim.
 If the intention is to call it, move it to its own line;  If the intention is to call it, move it to its own input line;
 otherwise, escape it by prepending  otherwise, escape it by prepending
 .Sq \e& .  .Sq \e& .
 .It Sy "skipping paragraph macro"  .It Sy "skipping paragraph macro"
Line 929  list block contains text or macros before the first
Line 975  list block contains text or macros before the first
 .Ic \&It  .Ic \&It
 macro.  macro.
 The offending children are moved before the beginning of the list.  The offending children are moved before the beginning of the list.
 .It Sy ".Vt block has child macro"  
 .Pq mdoc  
 The  
 .Ic \&Vt  
 macro supports plain text arguments only.  
 Formatting may be ugly and semantic searching  
 for the affected content might not work.  
 .It Sy "fill mode already enabled, skipping"  .It Sy "fill mode already enabled, skipping"
 .Pq man  .Pq man
 A  A
Line 995  clause.
Line 1034  clause.
 .It Sy "skipping empty macro"  .It Sy "skipping empty macro"
 .Pq mdoc  .Pq mdoc
 The indicated macro has no arguments and hence no effect.  The indicated macro has no arguments and hence no effect.
   .It Sy "empty block"
   .Pq mdoc , man
   A
   .Ic \&Bd ,
   .Ic \&Bk ,
   .Ic \&Bl ,
   .Ic \&D1 ,
   .Ic \&Dl ,
   .Ic \&RS ,
   or
   .Ic \&UR
   block contains nothing in its body and will produce no output.
 .It Sy "empty argument, using 0n"  .It Sy "empty argument, using 0n"
 .Pq mdoc  .Pq mdoc
 The required width is missing after  The required width is missing after
Line 1004  or
Line 1055  or
 .Fl offset  .Fl offset
 or  or
 .Fl width.  .Fl width.
 .It Sy "argument count wrong"  
 .Pq mdoc , man  
 The indicated macro has too few or too many arguments.  
 The syntax tree will contain the wrong number of arguments as given.  
 Formatting behaviour depends on the specific macro in question.  
 Note that the same message may also occur as an ERROR, see below.  
 .It Sy "missing display type, using -ragged"  .It Sy "missing display type, using -ragged"
 .Pq mdoc  .Pq mdoc
 The  The
Line 1041  The
Line 1086  The
 macro is called without an argument before  macro is called without an argument before
 .Ic \&Nm  .Ic \&Nm
 has first been called with an argument.  has first been called with an argument.
   .It Sy "missing function name, using \(dq\(dq"
   .Pq mdoc
   The
   .Ic \&Fo
   macro is called without an argument.
   No function name is printed.
 .It Sy "empty head in list item"  .It Sy "empty head in list item"
 .Pq mdoc  .Pq mdoc
 In a  In a
Line 1068  list, an
Line 1119  list, an
 .Ic \&It  .Ic \&It
 block is empty.  block is empty.
 An empty list item is shown.  An empty list item is shown.
 .It Sy "missing font type"  .It Sy "missing font type, using \efR"
 .Pq mdoc  .Pq mdoc
 A  A
 .Ic \&Bf  .Ic \&Bf
 macro has no argument.  macro has no argument.
 It switches to the default font,  It switches to the default font.
 .Cm \efR .  .It Sy "unknown font type, using \efR"
 .It Sy "unknown font type"  
 .Pq mdoc  .Pq mdoc
 The  The
 .Ic \&Bf  .Ic \&Bf
 argument is invalid.  argument is invalid.
 The default font  The default font is used instead.
 .Cm \efR  
 is used instead.  
 .It Sy "nothing follows prefix"  .It Sy "nothing follows prefix"
 .Pq mdoc  .Pq mdoc
 A  A
Line 1099  macro is immediately followed by an
Line 1147  macro is immediately followed by an
 .Ic \&Re  .Ic \&Re
 macro on the next input line.  macro on the next input line.
 Such an empty block does not produce any output.  Such an empty block does not produce any output.
   .It Sy "missing section argument"
   .Pq mdoc
   An
   .Ic \&Xr
   macro lacks its second, section number argument.
   The first argument, i.e. the name, is printed, but without subsequent
   parantheses.
 .It Sy "missing -std argument, adding it"  .It Sy "missing -std argument, adding it"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1113  The
Line 1168  The
 utility assumes  utility assumes
 .Fl std  .Fl std
 even when it is not specified, but other implementations may not.  even when it is not specified, but other implementations may not.
   .It Sy "missing option string, using \(dq\(dq"
   .Pq man
   The
   .Ic \&OP
   macro is invoked without any argument.
   An empty pair of square brackets is shown.
   .It Sy "missing resource identifier, using \(dq\(dq"
   .Pq man
   The
   .Ic \&UR
   macro is invoked without any argument.
   An empty pair of angle brackets is shown.
 .It Sy "missing eqn box, using \(dq\(dq"  .It Sy "missing eqn box, using \(dq\(dq"
 .Pq eqn  .Pq eqn
 A diacritic mark or a binary operator is found,  A diacritic mark or a binary operator is found,
Line 1177  list has a
Line 1244  list has a
 .Fl width  .Fl width
 argument.  argument.
 That has no effect.  That has no effect.
   .It Sy "wrong number of cells"
   In a line of a
   .Ic \&Bl Fl column
   list, the number of tabs or
   .Ic \&Ta
   macros is less than the number expected from the list header line
   or exceeds the expected number by more than one.
   Missing cells remain empty, and all cells exceeding the number of
   columns are joined into one single cell.
 .It Sy "unknown AT&T UNIX version"  .It Sy "unknown AT&T UNIX version"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1228  request or a
Line 1304  request or a
 layout modifier has an unknown  layout modifier has an unknown
 .Ar font  .Ar font
 argument.  argument.
   .It Sy "odd number of characters in request"
   .Pq roff
   A
   .Ic \&tr
   request contains an odd number of characters.
   The last character is mapped to the blank character.
 .El  .El
 .Ss "Warnings related to plain text"  .Ss "Warnings related to plain text"
 .Bl -ohang  .Bl -ohang
Line 1464  macros as well as tables require explicit closing by d
Line 1546  macros as well as tables require explicit closing by d
 A block that doesn't support bad nesting  A block that doesn't support bad nesting
 ends before all of its children are properly closed.  ends before all of its children are properly closed.
 The open child nodes are closed implicitly.  The open child nodes are closed implicitly.
 .It Sy "scope open on exit"  .It Sy "appending missing end of block"
 .Pq mdoc , man , eqn , tbl , roff  .Pq mdoc , man , eqn , tbl , roff
 At the end of the document, an explicit  At the end of the document, an explicit
 .Xr mdoc 7  .Xr mdoc 7
Line 1514  When parsing for a request or a user-defined macro nam
Line 1596  When parsing for a request or a user-defined macro nam
 only the escape sequence is discarded.  only the escape sequence is discarded.
 The characters preceding it are used as the request or macro name,  The characters preceding it are used as the request or macro name,
 the characters following it are used as the arguments to the request or macro.  the characters following it are used as the arguments to the request or macro.
 .It Sy "argument count wrong"  
 .Pq mdoc , man , roff  
 The indicated request or macro has too few or too many arguments.  
 The syntax tree will contain the wrong number of arguments as given.  
 Formatting behaviour depends on the specific request or macro in question.  
 Note that the same message may also occur as a WARNING, see above.  
 .It Sy "NOT IMPLEMENTED: Bd -file"  .It Sy "NOT IMPLEMENTED: Bd -file"
 .Pq mdoc  .Pq mdoc
 For security reasons, the  For security reasons, the
Line 1531  By requesting the inclusion of a sensitive file, a mal
Line 1607  By requesting the inclusion of a sensitive file, a mal
 might otherwise trick a privileged user into inadvertently displaying  might otherwise trick a privileged user into inadvertently displaying
 the file on the screen, revealing the file content to bystanders.  the file on the screen, revealing the file content to bystanders.
 The argument is ignored including the file name following it.  The argument is ignored including the file name following it.
   .It Sy "skipping display without arguments"
   .Pq mdoc
   A
   .Ic \&Bd
   block macro does not have any arguments.
   The block is discarded, and the block content is displayed in
   whatever mode was active before the block.
 .It Sy "missing list type, using -item"  .It Sy "missing list type, using -item"
 .Pq mdoc  .Pq mdoc
 A  A
Line 1623  or
Line 1706  or
 .Ic \&EN  .Ic \&EN
 macro, or a  macro, or a
 .Xr roff 7  .Xr roff 7
 .Ic \&br  .Ic \&br ,
   .Ic \&fi ,
   or
   .Ic \&nf
 request or  request or
 .Sq \&..  .Sq \&..
 block closing request is invoked with at least one argument.  block closing request is invoked with at least one argument.
 All arguments are ignored.  All arguments are ignored.
 .It Sy "skipping excess arguments"  .It Sy "skipping excess arguments"
 .Pq mdoc , man , roff  .Pq mdoc , man , roff
 The  A macro or request is invoked with too many arguments:
   .Bl -dash -offset 2n -width 2n -compact
   .It
   .Ic \&Fo ,
   .Ic \&PD ,
   .Ic \&RS ,
   .Ic \&UR ,
   .Ic \&ft ,
   or
   .Ic \&sp
   with more than one argument
   .It
 .Ic \&An  .Ic \&An
 macro is invoked with another argument after  with another argument after
 .Fl split  .Fl split
 or  or
 .Fl nosplit ,  .Fl nosplit
 the  .It
 .Ic \&Bf  
 macro or the  
 .Ic \&sp  
 request is invoked with more than one argument, the  
 .Ic \&RE  .Ic \&RE
 macro is invoked with more than one argument  with more than one argument or with a non-integer argument
 or with a non-integer argument, or a request of the  .It
   .Ic \&OP
   or a request of the
 .Ic \&de  .Ic \&de
 family is invoked with more than two arguments.  family with more than two arguments
   .It
   .Ic \&Dt
   with more than three arguments
   .It
   .Ic \&TH
   with more than five arguments
   .It
   .Ic \&Bd ,
   .Ic \&Bk ,
   or
   .Ic \&Bl
   with invalid arguments
   .El
 The excess arguments are ignored.  The excess arguments are ignored.
 .El  .El
 .Ss Unsupported features  .Ss Unsupported features
Line 1704  as if they were a text line.
Line 1812  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 1712  and is maintained by
Line 1821  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.144  
changed lines
  Added in v.1.165

CVSweb