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

Diff for /mandoc/mandoc.1 between version 1.159 and 1.204

version 1.159, 2015/04/03 08:46:17 version 1.204, 2017/06/24 19:06:51
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-2017 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 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 .
 .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 250  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 266  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 334  Increasing this is not recommended; it may result in d
Line 315  Increasing this is not recommended; it may result in d
 for example overfull lines or ugly line breaks.  for example overfull lines or ugly line breaks.
 .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 327  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 355  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 368  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 414  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 504  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
Line 504  is not defined.
Line 592  is not defined.
 If neither PAGER nor MANPAGER is defined,  If neither PAGER nor MANPAGER is defined,
 .Xr more 1  .Xr more 1
 .Fl s  .Fl s
 will be used.  is used.
   Only used if
   .Fl a
   or
   .Fl l
   is specified.
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
 The  The
Line 517  option:
Line 610  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 552  to exit at once, possibly in the middle of parsing or 
Line 654  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 586  parser:
Line 687  parser:
 Messages displayed by  Messages displayed by
 .Nm  .Nm
 follow this format:  follow this format:
   .Bd -ragged -offset indent
   .Nm Ns :
   .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 637  rendering can be produced.
Line 745  rendering can be produced.
 Documents causing warnings may render poorly when using other  Documents causing warnings may render poorly when using other
 formatting tools instead of  formatting tools instead of
 .Nm .  .Nm .
   .It Cm style
   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 convertion 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.
 .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 650  are hidden unless their level, or a lower level, is re
Line 777  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.
   .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 "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 "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 "description line ends with a full stop"
   .Pq mdoc
   Do not use punctuation at the end of an
   .Ic \&Nd
   block.
   .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 "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.
   .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 768  This may confuse
Line 1030  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 789  The NAME section contains plain text or macros other t
Line 1053  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 934  list block contains text or macros before the first
Line 1211  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 1020  or
Line 1290  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 1113  macro is immediately followed by an
Line 1383  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 1235  or
Line 1512  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 1295  it is hard to predict which tab stop position the tab 
Line 1578  it is hard to predict which tab stop position the tab 
 Whitespace at the end of input lines is almost never semantically  Whitespace at the end of input lines is almost never semantically
 significant \(em but in the odd case where it might be, it is  significant \(em but in the odd case where it might be, it is
 extremely confusing when reviewing and maintaining documents.  extremely confusing when reviewing and maintaining documents.
   .It Sy "new sentence, new line"
   .Pq mdoc
   A new sentence starts in the middle of a text line.
   Start it on a new input line to help formatters produce correct spacing.
 .It Sy "bad comment style"  .It Sy "bad comment style"
 .Pq roff  .Pq roff
 Comment lines start with a dot, a backslash, and a double-quote character.  Comment lines start with a dot, a backslash, and a double-quote character.
Line 1566  By requesting the inclusion of a sensitive file, a mal
Line 1853  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 1763  as if they were a text line.
Line 2062  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 1771  utility was written by
Line 2083  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.159  
changed lines
  Added in v.1.204
CVSweb