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

Diff for /mandoc/mandoc.1 between version 1.158 and 1.222

version 1.158, 2015/03/30 16:06:14 version 1.222, 2018/03/16 15:05:44
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2012, 2014-2018 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 20 
Line 20 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display UNIX manuals  .Nd format manual pages
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl acfhkl  .Op Fl ac
 .Op Fl I Cm os Ns = Ns Ar name  .Op Fl I Cm os Ns = Ns Ar name
 .Op Fl K Ar encoding  .Op Fl K Ar encoding
 .Op Fl m Ns Ar format  .Op Fl mdoc | man
 .Op Fl O Ar option  .Op Fl O Ar options
 .Op Fl T Ar output  .Op Fl T Ar output
 .Op Fl W Ar level  .Op Fl W Ar level
 .Op Ar  .Op Ar
Line 44  reads
Line 44  reads
 .Xr mdoc 7  .Xr mdoc 7
 or  or
 .Xr man 7  .Xr man 7
 text from stdin, implying  text from stdin and produces
 .Fl m Ns Cm andoc ,  
 and produces  
 .Fl T Cm locale  .Fl T Cm locale
 output.  output.
 .Pp  .Pp
Line 67  to paginate them.
Line 65  to paginate them.
 This is the default.  This is the default.
 It can be specified to override  It can be specified to override
 .Fl a .  .Fl a .
 .It Fl f  
 A synonym for  
 .Xr whatis 1 .  
 This overrides any earlier  
 .Fl k  
 and  
 .Fl l  
 options.  
 .It Fl I Cm os Ns = Ns Ar name  .It Fl I Cm os Ns = Ns Ar name
 Override the default operating system  Override the default operating system
 .Ar name  .Ar name
 for the  for the
 .Xr mdoc 7  .Xr mdoc 7
 .Sq \&Os  .Ic \&Os
 and for the  and for the
 .Xr man 7  .Xr man 7
 .Sq \&TH  .Ic \&TH
 macro.  macro.
 .It Fl h  
 Display only the SYNOPSIS lines.  
 Implies  
 .Fl c .  
 .It Fl K Ar encoding  .It Fl K Ar encoding
 Specify the input encoding.  Specify the input encoding.
 The supported  The supported
Line 98  arguments are
Line 84  arguments are
 .Cm iso-8859-1 ,  .Cm iso-8859-1 ,
 and  and
 .Cm utf-8 .  .Cm utf-8 .
 If not specified, autodetection uses the first match:  If not specified, autodetection uses the first match in the following
 .Bl -tag -width iso-8859-1  list:
 .It Cm utf-8  .Bl -enum
 if the first three bytes of the input file  .It
 are the UTF-8 byte order mark (BOM, 0xefbbbf)  If the first three bytes of the input file are the UTF-8 byte order
 .It Ar encoding  mark (BOM, 0xefbbbf), input is interpreted as
 if the first or second line of the input file matches the  .Cm utf-8 .
   .It
   If the first or second line of the input file matches the
 .Sy emacs  .Sy emacs
 mode line format  mode line format
 .Pp  .Pp
 .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-  .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
 .It Cm utf-8  .Pp
 if the first non-ASCII byte in the file introduces a valid UTF-8 sequence  then input is interpreted according to
 .It Cm iso-8859-1  .Ar encoding .
 otherwise  .It
   If the first non-ASCII byte in the file introduces a valid UTF-8
   sequence, input is interpreted as
   .Cm utf-8 .
   .It
   Otherwise, input is interpreted as
   .Cm iso-8859-1 .
 .El  .El
 .It Fl k  .It Fl mdoc | man
 A synonym for  With
 .Xr apropos 1 .  .Fl mdoc ,
 This overrides any earlier  all input files are interpreted as
 .Fl f  .Xr mdoc 7 .
 and  With
 .Fl l  .Fl man ,
 options.  all input files are interpreted as
 .It Fl l  .Xr man 7 .
 A synonym for  By default, the input language is automatically detected for each file:
 .Fl a .  if the first macro is
 Also reverts any earlier  .Ic \&Dd
 .Fl f  or
 and  .Ic \&Dt ,
 .Fl k  the
 options.  .Xr mdoc 7
 .It Fl m Ns Ar format  parser is used; otherwise, the
 Input format.  .Xr man 7
 See  parser is used.
 .Sx Input Formats  With other arguments,
 for available formats.  .Fl m
 Defaults to  is silently ignored.
 .Fl m Ns Cm andoc .  .It Fl O Ar options
 .It Fl O Ar option  
 Comma-separated output options.  Comma-separated output options.
 .It Fl T Ar output  .It Fl T Ar output
 Output format.  Output format.
Line 153  to be reported on the standard error output and to aff
Line 146  to be reported on the standard error output and to aff
 The  The
 .Ar level  .Ar level
 can be  can be
   .Cm base ,
   .Cm style ,
 .Cm warning ,  .Cm warning ,
 .Cm error ,  .Cm error ,
 or  or
 .Cm unsupp ;  .Cm unsupp .
   The
   .Cm base
   level automatically derives the operating system from the contents of the
   .Ic \&Os
   macro, from the
   .Fl Ios
   command line option, or from the
   .Xr uname 3
   return value.
   The levels
   .Cm openbsd
   and
   .Cm netbsd
   are variants of
   .Cm base
   that bypass autodetection and request validation of base system
   conventions for a particular operating system.
   The level
 .Cm all  .Cm all
 is an alias for  is an alias for
 .Cm warning .  .Cm base .
 By default,  By default,
 .Nm  .Nm
 is silent.  is silent.
Line 190  If multiple files are specified,
Line 203  If multiple files are specified,
 will halt with the first failed parse.  will halt with the first failed parse.
 .El  .El
 .Pp  .Pp
   The options
   .Fl fhklw
   are also supported and are documented in man(1).
 In  In
 .Fl f  .Fl f
 and  and
Line 197  and
Line 213  and
 mode,  mode,
 .Nm  .Nm
 also supports the options  also supports the options
 .Fl CMmOSsw  .Fl CMmOSs
 described in the  described in the
 .Xr apropos 1  .Xr apropos 1
 manual.  manual.
 .Ss Input Formats  The options
 The  .Fl fkl
 .Nm  are mutually exclusive and override each other.
 utility accepts  
 .Xr mdoc 7  
 and  
 .Xr man 7  
 input with  
 .Fl m Ns Cm doc  
 and  
 .Fl m Ns Cm an ,  
 respectively.  
 The  
 .Xr mdoc 7  
 format is  
 .Em strongly  
 recommended;  
 .Xr man 7  
 should only be used for legacy manuals.  
 .Pp  
 A third option,  
 .Fl m Ns Cm andoc ,  
 which is also the default, determines encoding on-the-fly: if the first  
 non-comment macro is  
 .Sq \&Dd  
 or  
 .Sq \&Dt ,  
 the  
 .Xr mdoc 7  
 parser is used; otherwise, the  
 .Xr man 7  
 parser is used.  
 .Pp  
 If multiple  
 files are specified with  
 .Fl m Ns Cm andoc ,  
 each has its file-type determined this way.  
 If multiple files are  
 specified and  
 .Fl m Ns Cm doc  
 or  
 .Fl m Ns Cm an  
 is specified, then this format is used exclusively.  
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
 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 "-T locale"  .Bl -tag -width "-T markdown"
 .It Fl T Cm ascii  .It Fl T Cm ascii
 Produce 7-bit ASCII output.  Produce 7-bit ASCII output.
 See  See
Line 262  See
Line 238  See
 .It Fl T Cm lint  .It Fl T Cm lint
 Parse only: produce no output.  Parse only: produce no output.
 Implies  Implies
 .Fl W Cm warning .  .Fl W Cm all
   and redirects parser messages, which usually appear
   on standard error output, to standard output.
 .It Fl T 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.
Line 274  Produce
Line 252  Produce
 format output.  format output.
 See  See
 .Sx Man Output .  .Sx Man Output .
   .It Fl T Cm markdown
   Produce output in
   .Sy markdown
   format.
   See
   .Sx Markdown Output .
 .It Fl T Cm pdf  .It Fl T Cm pdf
 Produce PDF output.  Produce PDF output.
 See  See
Line 284  See
Line 268  See
 .Sx PostScript Output .  .Sx PostScript Output .
 .It Fl T Cm tree  .It Fl T Cm tree
 Produce an indented parse tree.  Produce an indented parse tree.
   See
   .Sx Syntax tree output .
 .It Fl T 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 Cm xhtml  
 This is a synonym for  
 .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
Line 332  and seven for
Line 315  and seven for
 .Xr man 7 .  .Xr man 7 .
 Increasing this is not recommended; it may result in degraded formatting,  Increasing this is not recommended; it may result in degraded formatting,
 for example overfull lines or ugly line breaks.  for example overfull lines or ugly line breaks.
   .It Cm mdoc
   Format
   .Xr man 7
   input files in
   .Xr mdoc 7
   output style.
   Specifically, this suppresses the two additional blank lines near the
   top and the bottom of each page, and it implies
   .Fl O Cm indent Ns =5 .
   One useful application is for checking that
   .Fl T Cm man
   output formats in the same way as the
   .Xr mdoc 7
   source it was generated from.
 .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 .
 which will normalise to \(>=58.  
 .El  .El
 .Ss HTML Output  .Ss HTML Output
 Output produced by  Output produced by
Line 347  Equations rendered from
Line 343  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 Cm style ,  .Fl O Cm style ,
Line 375  The string
Line 371  The string
 for example,  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  .Ic \&In
 macro).  macro).
 Instances of  Instances of
 .Sq \&%I  .Sq \&%I
Line 388  The string
Line 384  The string
 for example,  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  .Ic \&Xr
 macro).  macro).
 Instances of  Instances of
 .Sq \&%N  .Sq \&%N
Line 434  If the input format is
Line 430  If the input format is
 .Xr man 7 ,  .Xr man 7 ,
 the input is copied to the output, expanding any  the input is copied to the output, expanding any
 .Xr roff 7  .Xr roff 7
 .Sq so  .Ic so
 requests.  requests.
 The parser is also run, and as usual, the  The parser is also run, and as usual, the
 .Fl W  .Fl W
 level controls which  level controls which
 .Sx DIAGNOSTICS  .Sx DIAGNOSTICS
 are displayed before copying the input to the output.  are displayed before copying the input to the output.
   .Ss Markdown Output
   Translate
   .Xr mdoc 7
   input to the
   .Sy markdown
   format conforming to
   .Lk http://daringfireball.net/projects/markdown/syntax.text\
    "John Gruber's 2004 specification" .
   The output also almost conforms to the
   .Lk http://commonmark.org/ CommonMark
   specification.
   .Pp
   The character set used for the markdown output is ASCII.
   Non-ASCII characters are encoded as HTML entities.
   Since that is not possible in literal font contexts, because these
   are rendered as code spans and code blocks in the markdown output,
   non-ASCII characters are transliterated to ASCII approximations in
   these contexts.
   .Pp
   Markdown is a very weak markup language, so all semantic markup is
   lost, and even part of the presentational markup may be lost.
   Do not use this as an intermediate step in converting to HTML;
   instead, use
   .Fl T Cm html
   directly.
   .Pp
   The
   .Xr man 7 ,
   .Xr tbl 7 ,
   and
   .Xr eqn 7
   input languages are not supported by
   .Fl T Cm markdown
   output mode.
 .Ss PDF Output  .Ss PDF Output
 PDF-1.1 output may be generated by  PDF-1.1 output may be generated by
 .Fl T Cm pdf .  .Fl T Cm pdf .
Line 490  to force a UTF\-8 locale.
Line 520  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.
   .Pp
   The first paragraph shows meta data found in the
   .Xr mdoc 7
   prologue, on the
   .Xr man 7
   .Ic \&TH
   line, or the fallbacks used.
   .Pp
   In the tree dump, 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.
   .It
   BROKEN if the node is a block broken by another block.
   .It
   NOSRC if the node is not in the input file,
   but automatically generated from macros.
   .It
   NOPRT if the node is not supposed to generate output
   for any output format.
   .El
   .El
   .Pp
   The following
   .Fl O
   argument is accepted:
   .Bl -tag -width Ds
   .It Cm noval
   Skip validation and show the unvalidated syntax tree.
   This can help to find out whether a given behaviour is caused by
   the parser or by the validator.
   Meta data is not available in this case.
   .El
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPAGER  .Bl -tag -width MANPAGER
 .It Ev MANPAGER  .It Ev MANPAGER
 Any non-empty value of the environment variable  Any non-empty value of the environment variable
 .Ev MANPAGER  .Ev MANPAGER
 will be used instead of the standard pagination program,  is used instead of the standard pagination program,
 .Xr more 1 .  .Xr more 1 ;
   see
   .Xr man 1
   for details.
   Only used if
   .Fl a
   or
   .Fl l
   is specified.
 .It Ev PAGER  .It Ev PAGER
 Specifies the pagination program to use when  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
 will be used.  .Fl s
   is used.
   Only used if
   .Fl a
   or
   .Fl l
   is specified.
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
 The  The
Line 516  option:
Line 626  option:
 .Pp  .Pp
 .Bl -tag -width Ds -compact  .Bl -tag -width Ds -compact
 .It 0  .It 0
 No warnings or errors occurred, or those that did were ignored because  No base system convention violations, style suggestions, warnings,
 they were lower than the requested  or errors occurred, or those that did were ignored because they
   were lower than the requested
 .Ar level .  .Ar level .
   .It 1
   At least one base system convention violation or style suggestion
   occurred, but no warning or error, and
   .Fl W Cm base
   or
   .Fl W Cm style
   was specified.
 .It 2  .It 2
 At least one warning occurred, but no error, and  At least one warning occurred, but no error, and
 .Fl W Cm warning  .Fl W Cm warning
 was specified.  or a lower
   .Ar level
   was requested.
 .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 Cm error  .Fl W Cm error
 or  or a lower
 .Fl W Cm warning  .Ar level
 was specified.  was requested.
 .It 4  .It 4
 At least one unsupported feature was encountered, and  At least one unsupported feature was encountered, and
 .Fl W Cm unsupp ,  .Fl W Cm unsupp
 .Fl W Cm error  or a lower
 or  .Ar level
 .Fl W Cm warning  was requested.
 was specified.  
 .It 5  .It 5
 Invalid command line arguments were specified.  Invalid command line arguments were specified.
 No input files have been read.  No input files have been read.
Line 551  to exit at once, possibly in the middle of parsing or 
Line 670  to exit at once, possibly in the middle of parsing or 
 Note that selecting  Note that selecting
 .Fl T Cm lint  .Fl T Cm lint
 output mode implies  output mode implies
 .Fl W Cm warning .  .Fl W Cm all .
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .Pp  .Pp
 .Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less  .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
 .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 \-T html -O style=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
Line 585  parser:
Line 703  parser:
 Messages displayed by  Messages displayed by
 .Nm  .Nm
 follow this format:  follow this format:
   .Bd -ragged -offset indent
   .Nm :
   .Ar file : Ns Ar line : Ns Ar column : level : message : macro args
   .Pq Ar os
   .Ed
 .Pp  .Pp
 .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args  
 .Pp  
 Line and column numbers start at 1.  Line and column numbers start at 1.
 Both are omitted for messages referring to an input file as a whole.  Both are omitted for messages referring to an input file as a whole.
 Macro names and arguments are omitted where meaningless.  Macro names and arguments are omitted where meaningless.
   The
   .Ar os
   operating system specifier is omitted for messages that are relevant
   for all operating systems.
 Fatal messages about invalid command line arguments  Fatal messages about invalid command line arguments
 or operating system errors, for example when memory is exhausted,  or operating system errors, for example when memory is exhausted,
 may also omit the  may also omit the
Line 610  so using GNU troff instead of
Line 735  so using GNU troff instead of
 .Nm  .Nm
 to process the file may be preferable.  to process the file may be preferable.
 .It Cm error  .It Cm error
 An input file contains invalid syntax that cannot be safely interpreted.  Indicates a risk of information loss or severe misformatting,
 By discarding part of the input or inserting missing tokens,  in most cases caused by serious syntax errors.
 the parser is able to continue, and the error does not prevent  
 generation of formatted output, but typically, preparing that  
 output involves information loss, broken document structure  
 or unintended formatting, no matter whether  
 .Nm  
 or GNU troff is used.  
 In many cases, the output of  
 .Nm  
 and GNU troff is identical, but in some,  
 .Nm  
 is more resilient than GNU troff with respect to malformed input.  
 .Pp  
 Non-existent or unreadable input files are also reported on the  
 .Cm error  
 level.  
 In that case, the parser cannot even be started and no output  
 is produced from those input files.  
 .It Cm warning  .It Cm warning
 An input file uses obsolete, discouraged or non-portable syntax.  Indicates a risk that the information shown or its formatting
 All the same, the meaning of the input is unambiguous and a correct  may mismatch the author's intent in minor ways.
 rendering can be produced.  Additionally, syntax errors are classified at least as warnings,
 Documents causing warnings may render poorly when using other  even if they do not usually cause misformatting.
 formatting tools instead of  .It Cm style
 .Nm .  An input file uses dubious or discouraged style.
   This is not a complaint about the syntax, and probably neither
   formatting nor portability are in danger.
   While great care is taken to avoid false positives on the higher
   message levels, the
   .Cm style
   level tries to reduce the probability that issues go unnoticed,
   so it may occasionally issue bogus suggestions.
   Please use your good judgement to decide whether any particular
   .Cm style
   suggestion really justifies a change to the input file.
   .It Cm base
   A convention used in the base system of a specific operating system
   is not adhered to.
   These are not markup mistakes, and neither the quality of formatting
   nor portability are in danger.
   Messages of the
   .Cm base
   level are printed with the more intuitive
   .Cm style
   .Ar level
   tag.
 .El  .El
 .Pp  .Pp
 Messages of the  Messages of the
   .Cm base ,
   .Cm style ,
 .Cm warning ,  .Cm warning ,
 .Cm error ,  .Cm error ,
 and  and
Line 649  are hidden unless their level, or a lower level, is re
Line 780  are hidden unless their level, or a lower level, is re
 option or  option or
 .Fl T Cm lint  .Fl T Cm lint
 output mode.  output mode.
   .Pp
   As indicated below, all
   .Cm base
   and some
   .Cm style
   checks are only performed if a specific operating system name occurs
   in the arguments of the
   .Fl W
   command line option, of the
   .Ic \&Os
   macro, of the
   .Fl Ios
   command line option, or, if neither are present, in the return value
   of the
   .Xr uname 3
   function.
   .Ss Conventions for base system manuals
   .Bl -ohang
   .It Sy "Mdocdate found"
   .Pq mdoc , Nx
   The
   .Ic \&Dd
   macro uses CVS
   .Ic Mdocdate
   keyword substitution, which is not supported by the
   .Nx
   base system.
   Consider using the conventional
   .Dq "Month dd, yyyy"
   format instead.
   .It Sy "Mdocdate missing"
   .Pq mdoc , Ox
   The
   .Ic \&Dd
   macro does not use CVS
   .Ic Mdocdate
   keyword substitution, but using it is conventionally expected in the
   .Ox
   base system.
   .It Sy "unknown architecture"
   .Pq mdoc , Ox , Nx
   The third argument of the
   .Ic \&Dt
   macro does not match any of the architectures this operating system
   is running on.
   .It Sy "operating system explicitly specified"
   .Pq mdoc , Ox , Nx
   The
   .Ic \&Os
   macro has an argument.
   In the base system, it is conventionally left blank.
   .It Sy "RCS id missing"
   .Pq Ox , Nx
   The manual page lacks the comment line with the RCS identifier
   generated by CVS
   .Ic OpenBSD
   or
   .Ic NetBSD
   keyword substitution as conventionally used in these operating systems.
   .It Sy "referenced manual not found"
   .Pq mdoc
   An
   .Ic \&Xr
   macro references a manual page that is not found in the base system.
   The path to look for base system manuals is configurable at compile
   time and defaults to
   .Pa /usr/share/man : /usr/X11R6/man .
   .El
   .Ss Style suggestions
   .Bl -ohang
   .It Sy "legacy man(7) date format"
   .Pq mdoc
   The
   .Ic \&Dd
   macro uses the legacy
   .Xr man 7
   date format
   .Dq yyyy-dd-mm .
   Consider using the conventional
   .Xr mdoc 7
   date format
   .Dq "Month dd, yyyy"
   instead.
   .It Sy "lower case character in document title"
   .Pq mdoc , man
   The title is still used as given in the
   .Ic \&Dt
   or
   .Ic \&TH
   macro.
   .It Sy "duplicate RCS id"
   A single manual page contains two copies of the RCS identifier for
   the same operating system.
   Consider deleting the later instance and moving the first one up
   to the top of the page.
   .It Sy "possible typo in section name"
   .Pq mdoc
   Fuzzy string matching revealed that the argument of an
   .Ic \&Sh
   macro is similar, but not identical to a standard section name.
   .It Sy "unterminated quoted argument"
   .Pq roff
   Macro arguments can be enclosed in double quote characters
   such that space characters and macro names contained in the quoted
   argument need not be escaped.
   The closing quote of the last argument of a macro can be omitted.
   However, omitting it is not recommended because it makes the code
   harder to read.
   .It Sy "useless macro"
   .Pq mdoc
   A
   .Ic \&Bt ,
   .Ic \&Tn ,
   or
   .Ic \&Ud
   macro was found.
   Simply delete it: it serves no useful purpose.
   .It Sy "consider using OS macro"
   .Pq mdoc
   A string was found in plain text or in a
   .Ic \&Bx
   macro that could be represented using
   .Ic \&Ox ,
   .Ic \&Nx ,
   .Ic \&Fx ,
   or
   .Ic \&Dx .
   .It Sy "errnos out of order"
   .Pq mdoc, Nx
   The
   .Ic \&Er
   items in a
   .Ic \&Bl
   list are not in alphabetical order.
   .It Sy "duplicate errno"
   .Pq mdoc, Nx
   A
   .Ic \&Bl
   list contains two consecutive
   .Ic \&It
   entries describing the same
   .Ic \&Er
   number.
   .It Sy "trailing delimiter"
   .Pq mdoc
   The last argument of an
   .Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St ,
   or
   .Ic \&Sx
   macro ends with a trailing delimiter.
   This is usually bad style and often indicates typos.
   Most likely, the delimiter can be removed.
   .It Sy "no blank before trailing delimiter"
   .Pq mdoc
   The last argument of a macro that supports trailing delimiter
   arguments is longer than one byte and ends with a trailing delimiter.
   Consider inserting a blank such that the delimiter becomes a separate
   argument, thus moving it out of the scope of the macro.
   .It Sy "fill mode already enabled, skipping"
   .Pq man
   A
   .Ic \&fi
   request occurs even though the document is still in fill mode,
   or already switched back to fill mode.
   It has no effect.
   .It Sy "fill mode already disabled, skipping"
   .Pq man
   An
   .Ic \&nf
   request occurs even though the document already switched to no-fill mode
   and did not switch back to fill mode yet.
   It has no effect.
   .It Sy "verbatim \(dq--\(dq, maybe consider using \e(em"
   .Pq mdoc
   Even though the ASCII output device renders an em-dash as
   .Qq \-\- ,
   that is not a good way to write it in an input file
   because it renders poorly on all other output devices.
   .It Sy "function name without markup"
   .Pq mdoc
   A word followed by an empty pair of parentheses occurs on a text line.
   Consider using an
   .Ic \&Fn
   or
   .Ic \&Xr
   macro.
   .It Sy "whitespace at end of input line"
   .Pq mdoc , man , roff
   Whitespace at the end of input lines is almost never semantically
   significant \(em but in the odd case where it might be, it is
   extremely confusing when reviewing and maintaining documents.
   .It Sy "bad comment style"
   .Pq roff
   Comment lines start with a dot, a backslash, and a double-quote character.
   The
   .Nm
   utility treats the line as a comment line even without the backslash,
   but leaving out the backslash might not be portable.
   .El
 .Ss Warnings related to the document prologue  .Ss Warnings related to the document prologue
 .Bl -ohang  .Bl -ohang
 .It Sy "missing manual title, using UNTITLED"  .It Sy "missing manual title, using UNTITLED"
Line 663  macro before the first non-prologue macro.
Line 993  macro before the first non-prologue macro.
 There is no  There is no
 .Ic \&TH  .Ic \&TH
 macro, or it has no arguments.  macro, or it has no arguments.
 .It Sy "lower case character in document title"  
 .Pq mdoc , man  
 The title is still used as given in the  
 .Ic \&Dt  
 or  
 .Ic \&TH  
 macro.  
 .It Sy "missing manual section, using \(dq\(dq"  .It Sy "missing manual section, using \(dq\(dq"
 .Pq mdoc , man  .Pq mdoc , man
 A  A
Line 705  The date given in a
Line 1028  The date given in a
 or  or
 .Ic \&TH  .Ic \&TH
 macro does not follow the conventional format.  macro does not follow the conventional format.
   .It Sy "date in the future, using it anyway"
   .Pq mdoc , man
   The date given in a
   .Ic \&Dd
   or
   .Ic \&TH
   macro is more than a day ahead of the current system
   .Xr time 3 .
 .It Sy "missing Os macro, using \(dq\(dq"  .It Sy "missing Os macro, using \(dq\(dq"
 .Pq mdoc  .Pq mdoc
 The default or current system is not shown in this case.  The default or current system is not shown in this case.
 .It Sy "duplicate prologue macro"  
 .Pq mdoc  
 One of the prologue macros occurs more than once.  
 The last instance overrides all previous ones.  
 .It Sy "late prologue macro"  .It Sy "late prologue macro"
 .Pq mdoc  .Pq mdoc
 A  A
Line 719  A
Line 1046  A
 or  or
 .Ic \&Os  .Ic \&Os
 macro occurs after some non-prologue macro, but still takes effect.  macro occurs after some non-prologue macro, but still takes effect.
 .It Sy "skipping late title macro"  
 .Pq mdoc  
 The  
 .Ic \&Dt  
 macro appears after the first non-prologue macro.  
 Traditional formatters cannot handle this because  
 they write the page header before parsing the document body.  
 Even though this technical restriction does not apply to  
 .Nm ,  
 traditional semantics is preserved.  
 The late macro is discarded including its arguments.  
 .It Sy "prologue macros out of order"  .It Sy "prologue macros out of order"
 .Pq mdoc  .Pq mdoc
 The prologue macros are not given in the conventional order  The prologue macros are not given in the conventional order
Line 767  This may confuse
Line 1083  This may confuse
 .Xr makewhatis 8  .Xr makewhatis 8
 and  and
 .Xr apropos 1 .  .Xr apropos 1 .
 .It Sy "NAME section without name"  .It Sy "NAME section without Nm before Nd"
 .Pq mdoc  .Pq mdoc
 The NAME section does not contain any  The NAME section does not contain any
 .Ic \&Nm  .Ic \&Nm
 child macro.  child macro before the first
   .Ic \&Nd
   macro.
 .It Sy "NAME section without description"  .It Sy "NAME section without description"
 .Pq mdoc  .Pq mdoc
 The NAME section lacks the mandatory  The NAME section lacks the mandatory
Line 788  The NAME section contains plain text or macros other t
Line 1106  The NAME section contains plain text or macros other t
 .Ic \&Nm  .Ic \&Nm
 and  and
 .Ic \&Nd .  .Ic \&Nd .
   .It Sy "missing comma before name"
   .Pq mdoc
   The NAME section contains an
   .Ic \&Nm
   macro that is neither the first one nor preceded by a comma.
 .It Sy "missing description line, using \(dq\(dq"  .It Sy "missing description line, using \(dq\(dq"
 .Pq mdoc  .Pq mdoc
 The  The
 .Ic \&Nd  .Ic \&Nd
 macro lacks the required argument.  macro lacks the required argument.
 The title line of the manual will end after the dash.  The title line of the manual will end after the dash.
   .It Sy "description line outside NAME section"
   .Pq mdoc
   An
   .Ic \&Nd
   macro appears outside the NAME section.
   The arguments are printed anyway and the following text is used for
   .Xr apropos 1 ,
   but none of that behaviour is portable.
 .It Sy "sections out of conventional order"  .It Sy "sections out of conventional order"
 .Pq mdoc  .Pq mdoc
 A standard section occurs after another section it usually precedes.  A standard section occurs after another section it usually precedes.
Line 806  The same standard section title occurs more than once.
Line 1137  The same standard section title occurs more than once.
 .Pq mdoc  .Pq mdoc
 A standard section header occurs in a section of the manual  A standard section header occurs in a section of the manual
 where it normally isn't useful.  where it normally isn't useful.
   .It Sy "cross reference to self"
   .Pq mdoc
   An
   .Ic \&Xr
   macro refers to a name and section matching the section of the present
   manual page and a name mentioned in an
   .Ic \&Nm
   macro in the NAME or SYNOPSIS section, or in an
   .Ic \&Fn
   or
   .Ic \&Fo
   macro in the SYNOPSIS.
   Consider using
   .Ic \&Nm
   or
   .Ic \&Fn
   instead of
   .Ic \&Xr .
 .It Sy "unusual Xr order"  .It Sy "unusual Xr order"
 .Pq mdoc  .Pq mdoc
 In the SEE ALSO section, an  In the SEE ALSO section, an
Line 892  The paragraph macro is moved after the end of the list
Line 1241  The paragraph macro is moved after the end of the list
 .Pq mdoc  .Pq mdoc
 An input line begins with an  An input line begins with an
 .Ic \&Ns  .Ic \&Ns
 macro.  macro, or the next argument after an
   .Ic \&Ns
   macro is an isolated closing delimiter.
 The macro is ignored.  The macro is ignored.
 .It Sy "blocks badly nested"  .It Sy "blocks badly nested"
 .Pq mdoc  .Pq mdoc
Line 933  list block contains text or macros before the first
Line 1284  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"  .It Sy "first macro on line"
 .Pq mdoc  Inside a
 The  .Ic \&Bl Fl column
 .Ic \&Vt  list, a
 macro supports plain text arguments only.  .Ic \&Ta
 Formatting may be ugly and semantic searching  macro occurs as the first macro on a line, which is not portable.
 for the affected content might not work.  
 .It Sy "fill mode already enabled, skipping"  
 .Pq man  
 A  
 .Ic \&fi  
 request occurs even though the document is still in fill mode,  
 or already switched back to fill mode.  
 It has no effect.  
 .It Sy "fill mode already disabled, skipping"  
 .Pq man  
 An  
 .Ic \&nf  
 request occurs even though the document already switched to no-fill mode  
 and did not switch back to fill mode yet.  
 It has no effect.  
 .It Sy "line scope broken"  .It Sy "line scope broken"
 .Pq man  .Pq man
 While parsing the next-line scope of the previous macro,  While parsing the next-line scope of the previous macro,
Line 1007  A
Line 1343  A
 .Ic \&Bl ,  .Ic \&Bl ,
 .Ic \&D1 ,  .Ic \&D1 ,
 .Ic \&Dl ,  .Ic \&Dl ,
   .Ic \&MT ,
 .Ic \&RS ,  .Ic \&RS ,
 or  or
 .Ic \&UR  .Ic \&UR
Line 1019  or
Line 1356  or
 .Ic \&Bl  .Ic \&Bl
 .Fl offset  .Fl offset
 or  or
 .Fl width.  .Fl width .
 .It Sy "missing display type, using -ragged"  .It Sy "missing display type, using -ragged"
 .Pq mdoc  .Pq mdoc
 The  The
Line 1084  list, an
Line 1421  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 argument, using next line"
   .Pq mdoc
   An
   .Ic \&It
   macro in a
   .Ic \&Bd Fl column
   list has no arguments.
   While
   .Nm
   uses the text or macros of the following line, if any, for the cell,
   other formatters may misformat the list.
 .It Sy "missing font type, using \efR"  .It Sy "missing font type, using \efR"
 .Pq mdoc  .Pq mdoc
 A  A
Line 1112  macro is immediately followed by an
Line 1460  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
   parentheses.
 .It Sy "missing -std argument, adding it"  .It Sy "missing -std argument, adding it"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1135  An empty pair of square brackets is shown.
Line 1490  An empty pair of square brackets is shown.
 .It Sy "missing resource identifier, using \(dq\(dq"  .It Sy "missing resource identifier, using \(dq\(dq"
 .Pq man  .Pq man
 The  The
   .Ic \&MT
   or
 .Ic \&UR  .Ic \&UR
 macro is invoked without any argument.  macro is invoked without any argument.
 An empty pair of angle brackets is shown.  An empty pair of angle brackets is shown.
Line 1146  An empty box is inserted.
Line 1503  An empty box is inserted.
 .El  .El
 .Ss "Warnings related to bad macro arguments"  .Ss "Warnings related to bad macro arguments"
 .Bl -ohang  .Bl -ohang
 .It Sy "unterminated quoted argument"  
 .Pq roff  
 Macro arguments can be enclosed in double quote characters  
 such that space characters and macro names contained in the quoted  
 argument need not be escaped.  
 The closing quote of the last argument of a macro can be omitted.  
 However, omitting it is not recommended because it makes the code  
 harder to read.  
 .It Sy "duplicate argument"  .It Sy "duplicate argument"
 .Pq mdoc  .Pq mdoc
 A  A
Line 1234  or
Line 1583  or
 .Ic \&Fn  .Ic \&Fn
 macro contains an opening or closing parenthesis; that's probably wrong,  macro contains an opening or closing parenthesis; that's probably wrong,
 parentheses are added automatically.  parentheses are added automatically.
   .It Sy "unknown library name"
   .Pq mdoc, not on Ox
   An
   .Ic \&Lb
   macro has an unknown name argument and will be rendered as
   .Qq library Dq Ar name .
 .It Sy "invalid content in Rs block"  .It Sy "invalid content in Rs block"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1289  As an implementation dependent choice, tab characters 
Line 1644  As an implementation dependent choice, tab characters 
 are passed through to the formatters in any case.  are passed through to the formatters in any case.
 Given that the text before the tab character will be filled,  Given that the text before the tab character will be filled,
 it is hard to predict which tab stop position the tab will advance to.  it is hard to predict which tab stop position the tab will advance to.
 .It Sy "whitespace at end of input line"  .It Sy "new sentence, new line"
 .Pq mdoc , man , roff  .Pq mdoc
 Whitespace at the end of input lines is almost never semantically  A new sentence starts in the middle of a text line.
 significant \(em but in the odd case where it might be, it is  Start it on a new input line to help formatters produce correct spacing.
 extremely confusing when reviewing and maintaining documents.  
 .It Sy "bad comment style"  
 .Pq roff  
 Comment lines start with a dot, a backslash, and a double-quote character.  
 The  
 .Nm  
 utility treats the line as a comment line even without the backslash,  
 but leaving out the backslash might not be portable.  
 .It Sy "invalid escape sequence"  .It Sy "invalid escape sequence"
 .Pq roff  .Pq roff
 An escape sequence has an invalid opening argument delimiter, lacks the  An escape sequence has an invalid opening argument delimiter, lacks the
Line 1407  and any remaining cells stay empty.
Line 1754  and any remaining cells stay empty.
 .El  .El
 .Ss "Errors related to roff, mdoc, and man code"  .Ss "Errors related to roff, mdoc, and man code"
 .Bl -ohang  .Bl -ohang
   .It Sy "duplicate prologue macro"
   .Pq mdoc
   One of the prologue macros occurs more than once.
   The last instance overrides all previous ones.
   .It Sy "skipping late title macro"
   .Pq mdoc
   The
   .Ic \&Dt
   macro appears after the first non-prologue macro.
   Traditional formatters cannot handle this because
   they write the page header before parsing the document body.
   Even though this technical restriction does not apply to
   .Nm ,
   traditional semantics is preserved.
   The late macro is discarded including its arguments.
 .It Sy "input stack limit exceeded, infinite loop?"  .It Sy "input stack limit exceeded, infinite loop?"
 .Pq roff  .Pq roff
 Explicit recursion limits are implemented for the following features,  Explicit recursion limits are implemented for the following features,
Line 1477  An
Line 1839  An
 .Xr mdoc 7  .Xr mdoc 7
 block closing macro, a  block closing macro, a
 .Xr man 7  .Xr man 7
 .Ic \&RE  .Ic \&ME , \&RE
 or  or
 .Ic \&UE  .Ic \&UE
 macro, an  macro, an
Line 1511  At the end of the document, an explicit
Line 1873  At the end of the document, an explicit
 block, a  block, a
 .Xr man 7  .Xr man 7
 next-line scope or  next-line scope or
 .Ic \&RS  .Ic \&MT , \&RS
 or  or
 .Ic \&UR  .Ic \&UR
 block, an equation, table, or  block, an equation, table, or
Line 1565  By requesting the inclusion of a sensitive file, a mal
Line 1927  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
 .Ic \&Bl  .Ic \&Bl
 macro fails to specify the list type.  macro fails to specify the list type.
   .It Sy "argument is not numeric, using 1"
   .Pq roff
   The argument of a
   .Ic \&ce
   request is not a number.
 .It Sy "missing manual name, using \(dq\(dq"  .It Sy "missing manual name, using \(dq\(dq"
 .Pq mdoc  .Pq mdoc
 The first call to  The first call to
 .Ic \&Nm  .Ic \&Nm ,
 lacks the required argument.  or any call in the NAME section, lacks the required argument.
 .It Sy "uname(3) system call failed, using UNKNOWN"  .It Sy "uname(3) system call failed, using UNKNOWN"
 .Pq mdoc  .Pq mdoc
 The  The
Line 1671  A macro or request is invoked with too many arguments:
Line 2045  A macro or request is invoked with too many arguments:
 .Bl -dash -offset 2n -width 2n -compact  .Bl -dash -offset 2n -width 2n -compact
 .It  .It
 .Ic \&Fo ,  .Ic \&Fo ,
   .Ic \&MT ,
 .Ic \&PD ,  .Ic \&PD ,
 .Ic \&RS ,  .Ic \&RS ,
 .Ic \&UR ,  .Ic \&UR ,
Line 1762  as if they were a text line.
Line 2137  as if they were a text line.
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr roff 7 ,  .Xr roff 7 ,
 .Xr tbl 7  .Xr tbl 7
   .Sh HISTORY
   The
   .Nm
   utility first appeared in
   .Ox 4.8 .
   The option
   .Fl I
   appeared in
   .Ox 5.2 ,
   and
   .Fl aCcfhKklMSsw
   in
   .Ox 5.7 .
 .Sh AUTHORS  .Sh AUTHORS
 .An -nosplit  .An -nosplit
 The  The
Line 1770  utility was written by
Line 2158  utility was written by
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
 and is maintained by  and is maintained by
 .An Ingo Schwarze Aq Mt schwarze@openbsd.org .  .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
 .Sh BUGS  
 In  
 .Fl T Cm html ,  
 the maximum size of an element attribute is determined by  
 .Dv BUFSIZ ,  
 which is usually 1024 bytes.  
 Be aware of this when setting long link  
 formats such as  
 .Fl O Cm style Ns = Ns Ar really/long/link .  
Legend:
Removed from v.1.158  
changed lines
  Added in v.1.222
CVSweb