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

Annotation of mandoc/mandoc.1, Revision 1.211

1.211   ! schwarze    1: .\"    $Id: mandoc.1,v 1.210 2017/07/01 09:47:30 schwarze Exp $
1.1       kristaps    2: .\"
1.92      schwarze    3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.168     schwarze    4: .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5: .\"
                      6: .\" Permission to use, copy, modify, and distribute this software for any
1.16      kristaps    7: .\" purpose with or without fee is hereby granted, provided that the above
                      8: .\" copyright notice and this permission notice appear in all copies.
1.1       kristaps    9: .\"
1.16      kristaps   10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   17: .\"
1.211   ! schwarze   18: .Dd $Mdocdate: July 1 2017 $
1.14      kristaps   19: .Dt MANDOC 1
1.1       kristaps   20: .Os
                     21: .Sh NAME
                     22: .Nm mandoc
1.181     schwarze   23: .Nd format manual pages
1.1       kristaps   24: .Sh SYNOPSIS
                     25: .Nm mandoc
1.184     schwarze   26: .Op Fl ac
1.156     schwarze   27: .Op Fl I Cm os Ns = Ns Ar name
                     28: .Op Fl K Ar encoding
1.180     schwarze   29: .Op Fl mdoc | man
1.184     schwarze   30: .Op Fl O Ar options
1.156     schwarze   31: .Op Fl T Ar output
                     32: .Op Fl W Ar level
1.89      kristaps   33: .Op Ar
1.1       kristaps   34: .Sh DESCRIPTION
                     35: The
                     36: .Nm
1.26      kristaps   37: utility formats
1.8       kristaps   38: .Ux
1.57      kristaps   39: manual pages for display.
1.100     kristaps   40: .Pp
                     41: By default,
                     42: .Nm
                     43: reads
                     44: .Xr mdoc 7
                     45: or
                     46: .Xr man 7
1.180     schwarze   47: text from stdin and produces
1.156     schwarze   48: .Fl T Cm locale
1.100     kristaps   49: output.
                     50: .Pp
1.109     schwarze   51: The options are as follows:
1.19      kristaps   52: .Bl -tag -width Ds
1.107     schwarze   53: .It Fl a
                     54: If the standard output is a terminal device and
                     55: .Fl c
                     56: is not specified, use
                     57: .Xr more 1
                     58: to paginate the output, just like
                     59: .Xr man 1
                     60: would.
                     61: .It Fl c
                     62: Copy the formatted manual pages to the standard output without using
                     63: .Xr more 1
                     64: to paginate them.
                     65: This is the default.
                     66: It can be specified to override
                     67: .Fl a .
1.156     schwarze   68: .It Fl I Cm os Ns = Ns Ar name
1.101     schwarze   69: Override the default operating system
                     70: .Ar name
                     71: for the
                     72: .Xr mdoc 7
1.180     schwarze   73: .Ic \&Os
1.130     schwarze   74: and for the
                     75: .Xr man 7
1.180     schwarze   76: .Ic \&TH
1.101     schwarze   77: macro.
1.156     schwarze   78: .It Fl K Ar encoding
1.119     schwarze   79: Specify the input encoding.
                     80: The supported
                     81: .Ar encoding
                     82: arguments are
                     83: .Cm us-ascii ,
                     84: .Cm iso-8859-1 ,
                     85: and
                     86: .Cm utf-8 .
1.176     schwarze   87: If not specified, autodetection uses the first match in the following
                     88: list:
                     89: .Bl -enum
                     90: .It
                     91: If the first three bytes of the input file are the UTF-8 byte order
                     92: mark (BOM, 0xefbbbf), input is interpreted as
                     93: .Cm utf-8 .
                     94: .It
                     95: If the first or second line of the input file matches the
1.119     schwarze   96: .Sy emacs
                     97: mode line format
                     98: .Pp
                     99: .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
1.176     schwarze  100: .Pp
                    101: then input is interpreted according to
                    102: .Ar encoding .
                    103: .It
                    104: If the first non-ASCII byte in the file introduces a valid UTF-8
                    105: sequence, input is interpreted as
                    106: .Cm utf-8 .
                    107: .It
                    108: Otherwise, input is interpreted as
                    109: .Cm iso-8859-1 .
1.119     schwarze  110: .El
1.180     schwarze  111: .It Fl mdoc | man
                    112: With
                    113: .Fl mdoc ,
                    114: all input files are interpreted as
                    115: .Xr mdoc 7 .
                    116: With
                    117: .Fl man ,
                    118: all input files are interpreted as
                    119: .Xr man 7 .
                    120: By default, the input language is automatically detected for each file:
                    121: if the the first macro is
                    122: .Ic \&Dd
                    123: or
                    124: .Ic \&Dt ,
                    125: the
                    126: .Xr mdoc 7
                    127: parser is used; otherwise, the
                    128: .Xr man 7
                    129: parser is used.
                    130: With other arguments,
                    131: .Fl m
                    132: is silently ignored.
1.184     schwarze  133: .It Fl O Ar options
1.57      kristaps  134: Comma-separated output options.
1.156     schwarze  135: .It Fl T Ar output
1.57      kristaps  136: Output format.
                    137: See
1.1       kristaps  138: .Sx Output Formats
1.57      kristaps  139: for available formats.
                    140: Defaults to
1.156     schwarze  141: .Fl T Cm locale .
                    142: .It Fl W Ar level
1.77      schwarze  143: Specify the minimum message
                    144: .Ar level
                    145: to be reported on the standard error output and to affect the exit status.
                    146: The
                    147: .Ar level
                    148: can be
1.202     schwarze  149: .Cm base ,
1.185     schwarze  150: .Cm style ,
1.133     schwarze  151: .Cm warning ,
                    152: .Cm error ,
1.77      schwarze  153: or
1.202     schwarze  154: .Cm unsupp .
                    155: The
                    156: .Cm base
                    157: level automatically derives the operating system from the contents of the
                    158: .Ic \&Os
                    159: macro, from the
                    160: .Fl Ios
                    161: command line option, or from the
                    162: .Xr uname 3
                    163: return value.
                    164: The levels
                    165: .Cm openbsd
                    166: and
                    167: .Cm netbsd
                    168: are variants of
                    169: .Cm base
                    170: that bypass autodetection and request validation of base system
                    171: conventions for a particular operating system.
                    172: The level
1.132     schwarze  173: .Cm all
1.77      schwarze  174: is an alias for
1.202     schwarze  175: .Cm base .
1.132     schwarze  176: By default,
                    177: .Nm
                    178: is silent.
1.77      schwarze  179: See
                    180: .Sx EXIT STATUS
                    181: and
                    182: .Sx DIAGNOSTICS
                    183: for details.
                    184: .Pp
                    185: The special option
1.156     schwarze  186: .Fl W Cm stop
1.77      schwarze  187: tells
                    188: .Nm
                    189: to exit after parsing a file that causes warnings or errors of at least
                    190: the requested level.
                    191: No formatted output will be produced from that file.
                    192: If both a
                    193: .Ar level
                    194: and
                    195: .Cm stop
                    196: are requested, they can be joined with a comma, for example
1.156     schwarze  197: .Fl W Cm error , Ns Cm stop .
1.58      kristaps  198: .It Ar file
                    199: Read input from zero or more files.
1.57      kristaps  200: If unspecified, reads from stdin.
                    201: If multiple files are specified,
1.2       kristaps  202: .Nm
                    203: will halt with the first failed parse.
1.1       kristaps  204: .El
1.109     schwarze  205: .Pp
1.183     schwarze  206: The options
                    207: .Fl fhklw
                    208: are also supported and are documented in man(1).
1.109     schwarze  209: In
                    210: .Fl f
                    211: and
                    212: .Fl k
                    213: mode,
                    214: .Nm
                    215: also supports the options
1.183     schwarze  216: .Fl CMmOSs
1.109     schwarze  217: described in the
                    218: .Xr apropos 1
                    219: manual.
1.182     schwarze  220: The options
                    221: .Fl fkl
                    222: are mutually exclusive and override each other.
1.1       kristaps  223: .Ss Output Formats
                    224: The
                    225: .Nm
                    226: utility accepts the following
                    227: .Fl T
1.66      kristaps  228: arguments, which correspond to output modes:
1.175     schwarze  229: .Bl -tag -width "-T markdown"
1.156     schwarze  230: .It Fl T Cm ascii
1.81      kristaps  231: Produce 7-bit ASCII output.
1.57      kristaps  232: See
1.48      kristaps  233: .Sx ASCII Output .
1.156     schwarze  234: .It Fl T Cm html
1.116     kristaps  235: Produce HTML5, CSS1, and MathML output.
1.57      kristaps  236: See
1.48      kristaps  237: .Sx HTML Output .
1.156     schwarze  238: .It Fl T Cm lint
1.58      kristaps  239: Parse only: produce no output.
                    240: Implies
1.202     schwarze  241: .Fl W Cm all .
1.156     schwarze  242: .It Fl T Cm locale
1.93      schwarze  243: Encode output using the current locale.
1.128     schwarze  244: This is the default.
1.93      schwarze  245: See
                    246: .Sx Locale Output .
1.156     schwarze  247: .It Fl T Cm man
1.95      kristaps  248: Produce
1.91      schwarze  249: .Xr man 7
1.95      kristaps  250: format output.
                    251: See
                    252: .Sx Man Output .
1.175     schwarze  253: .It Fl T Cm markdown
                    254: Produce output in
                    255: .Sy markdown
                    256: format.
                    257: See
                    258: .Sx Markdown Output .
1.156     schwarze  259: .It Fl T Cm pdf
1.73      kristaps  260: Produce PDF output.
                    261: See
                    262: .Sx PDF Output .
1.156     schwarze  263: .It Fl T Cm ps
1.62      kristaps  264: Produce PostScript output.
                    265: See
                    266: .Sx PostScript Output .
1.156     schwarze  267: .It Fl T Cm tree
1.58      kristaps  268: Produce an indented parse tree.
1.161     schwarze  269: See
                    270: .Sx Syntax tree output .
1.156     schwarze  271: .It Fl T Cm utf8
1.93      schwarze  272: Encode output in the UTF\-8 multi-byte format.
                    273: See
                    274: .Sx UTF\-8 Output .
1.1       kristaps  275: .El
1.13      kristaps  276: .Pp
                    277: If multiple input files are specified, these will be processed by the
                    278: corresponding filter in-order.
1.66      kristaps  279: .Ss ASCII Output
                    280: Output produced by
1.156     schwarze  281: .Fl T Cm ascii
1.128     schwarze  282: is rendered in standard 7-bit ASCII documented in
1.66      kristaps  283: .Xr ascii 7 .
                    284: .Pp
                    285: Font styles are applied by using back-spaced encoding such that an
                    286: underlined character
                    287: .Sq c
                    288: is rendered as
                    289: .Sq _ Ns \e[bs] Ns c ,
                    290: where
                    291: .Sq \e[bs]
                    292: is the back-space character number 8.
                    293: Emboldened characters are rendered as
                    294: .Sq c Ns \e[bs] Ns c .
                    295: .Pp
                    296: The special characters documented in
                    297: .Xr mandoc_char 7
                    298: are rendered best-effort in an ASCII equivalent.
                    299: .Pp
                    300: Output width is limited to 78 visible columns unless literal input lines
                    301: exceed this limit.
                    302: .Pp
                    303: The following
                    304: .Fl O
                    305: arguments are accepted:
1.19      kristaps  306: .Bl -tag -width Ds
1.98      schwarze  307: .It Cm indent Ns = Ns Ar indent
                    308: The left margin for normal text is set to
                    309: .Ar indent
                    310: blank characters instead of the default of five for
                    311: .Xr mdoc 7
                    312: and seven for
                    313: .Xr man 7 .
                    314: Increasing this is not recommended; it may result in degraded formatting,
1.99      schwarze  315: for example overfull lines or ugly line breaks.
1.66      kristaps  316: .It Cm width Ns = Ns Ar width
                    317: The output width is set to
1.199     schwarze  318: .Ar width .
1.1       kristaps  319: .El
1.66      kristaps  320: .Ss HTML Output
                    321: Output produced by
1.156     schwarze  322: .Fl T Cm html
1.114     kristaps  323: conforms to HTML5 using optional self-closing tags.
1.116     kristaps  324: Default styles use only CSS1.
                    325: Equations rendered from
                    326: .Xr eqn 7
                    327: blocks use MathML.
1.66      kristaps  328: .Pp
1.61      kristaps  329: The
1.164     schwarze  330: .Pa mandoc.css
1.83      kristaps  331: file documents style-sheet classes available for customising output.
                    332: If a style-sheet is not specified with
1.156     schwarze  333: .Fl O Cm style ,
                    334: .Fl T Cm html
1.114     kristaps  335: defaults to simple output (via an embedded style-sheet)
                    336: readable in any graphical or text-based web
1.83      kristaps  337: browser.
1.66      kristaps  338: .Pp
1.89      kristaps  339: Special characters are rendered in decimal-encoded UTF\-8.
1.66      kristaps  340: .Pp
                    341: The following
1.64      kristaps  342: .Fl O
1.66      kristaps  343: arguments are accepted:
1.37      kristaps  344: .Bl -tag -width Ds
1.94      kristaps  345: .It Cm fragment
1.123     schwarze  346: Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
                    347: elements and only emit the subtree below the <body> element.
1.94      kristaps  348: The
                    349: .Cm style
1.97      schwarze  350: argument will be ignored.
1.94      kristaps  351: This is useful when embedding manual content within existing documents.
1.64      kristaps  352: .It Cm includes Ns = Ns Ar fmt
1.40      kristaps  353: The string
                    354: .Ar fmt ,
1.49      kristaps  355: for example,
1.40      kristaps  356: .Ar ../src/%I.html ,
                    357: is used as a template for linked header files (usually via the
1.180     schwarze  358: .Ic \&In
1.57      kristaps  359: macro).
                    360: Instances of
1.43      kristaps  361: .Sq \&%I
1.57      kristaps  362: are replaced with the include filename.
                    363: The default is not to present a
1.40      kristaps  364: hyperlink.
1.64      kristaps  365: .It Cm man Ns = Ns Ar fmt
1.39      kristaps  366: The string
                    367: .Ar fmt ,
1.49      kristaps  368: for example,
1.39      kristaps  369: .Ar ../html%S/%N.%S.html ,
                    370: is used as a template for linked manuals (usually via the
1.180     schwarze  371: .Ic \&Xr
1.57      kristaps  372: macro).
                    373: Instances of
1.43      kristaps  374: .Sq \&%N
1.40      kristaps  375: and
                    376: .Sq %S
                    377: are replaced with the linked manual's name and section, respectively.
1.57      kristaps  378: If no section is included, section 1 is assumed.
                    379: The default is not to
1.40      kristaps  380: present a hyperlink.
1.64      kristaps  381: .It Cm style Ns = Ns Ar style.css
1.58      kristaps  382: The file
                    383: .Ar style.css
                    384: is used for an external style-sheet.
                    385: This must be a valid absolute or
                    386: relative URI.
1.61      kristaps  387: .El
1.93      schwarze  388: .Ss Locale Output
                    389: Locale-depending output encoding is triggered with
1.156     schwarze  390: .Fl T Cm locale .
1.128     schwarze  391: This is the default.
                    392: .Pp
1.93      schwarze  393: This option is not available on all systems: systems without locale
                    394: support, or those whose internal representation is not natively UCS-4,
                    395: will fall back to
1.156     schwarze  396: .Fl T Cm ascii .
1.93      schwarze  397: See
                    398: .Sx ASCII Output
                    399: for font style specification and available command-line arguments.
1.95      kristaps  400: .Ss Man Output
                    401: Translate input format into
                    402: .Xr man 7
                    403: output format.
1.102     schwarze  404: This is useful for distributing manual sources to legacy systems
1.96      kristaps  405: lacking
1.95      kristaps  406: .Xr mdoc 7
                    407: formatters.
                    408: .Pp
                    409: If
                    410: .Xr mdoc 7
                    411: is passed as input, it is translated into
1.97      schwarze  412: .Xr man 7 .
                    413: If the input format is
1.95      kristaps  414: .Xr man 7 ,
1.97      schwarze  415: the input is copied to the output, expanding any
1.95      kristaps  416: .Xr roff 7
1.180     schwarze  417: .Ic so
1.97      schwarze  418: requests.
                    419: The parser is also run, and as usual, the
                    420: .Fl W
                    421: level controls which
                    422: .Sx DIAGNOSTICS
                    423: are displayed before copying the input to the output.
1.175     schwarze  424: .Ss Markdown Output
                    425: Translate
                    426: .Xr mdoc 7
                    427: input to the
                    428: .Sy markdown
                    429: format conforming to
                    430: .Lk http://daringfireball.net/projects/markdown/syntax.text\
                    431:  "John Gruber's 2004 specification" .
1.178     schwarze  432: The output also almost conforms to the
                    433: .Lk http://commonmark.org/ CommonMark
                    434: specification.
                    435: .Pp
                    436: The character set used for the markdown output is ASCII.
                    437: Non-ASCII characters are encoded as HTML entities.
                    438: Since that is not possible in literal font contexts, because these
                    439: are rendered as code spans and code blocks in the markdown output,
                    440: non-ASCII characters are transliterated to ASCII approximations in
                    441: these contexts.
1.175     schwarze  442: .Pp
                    443: Markdown is a very weak markup language, so all semantic markup is
                    444: lost, and even part of the presentational markup may be lost.
                    445: Do not use this as an intermediate step in converting to HTML;
                    446: instead, use
                    447: .Fl T Cm html
                    448: directly.
                    449: .Pp
                    450: The
                    451: .Xr man 7 ,
                    452: .Xr tbl 7 ,
                    453: and
                    454: .Xr eqn 7
                    455: input languages are not supported by
                    456: .Fl T Cm markdown
                    457: output mode.
1.93      schwarze  458: .Ss PDF Output
                    459: PDF-1.1 output may be generated by
1.156     schwarze  460: .Fl T Cm pdf .
1.93      schwarze  461: See
                    462: .Sx PostScript Output
                    463: for
                    464: .Fl O
                    465: arguments and defaults.
1.62      kristaps  466: .Ss PostScript Output
1.65      kristaps  467: PostScript
                    468: .Qq Adobe-3.0
                    469: Level-2 pages may be generated by
1.156     schwarze  470: .Fl T Cm ps .
1.67      kristaps  471: Output pages default to letter sized and are rendered in the Times font
1.70      kristaps  472: family, 11-point.
                    473: Margins are calculated as 1/9 the page length and width.
1.71      kristaps  474: Line-height is 1.4m.
1.66      kristaps  475: .Pp
                    476: Special characters are rendered as in
                    477: .Sx ASCII Output .
                    478: .Pp
                    479: The following
                    480: .Fl O
                    481: arguments are accepted:
                    482: .Bl -tag -width Ds
                    483: .It Cm paper Ns = Ns Ar name
                    484: The paper size
                    485: .Ar name
                    486: may be one of
1.68      kristaps  487: .Ar a3 ,
                    488: .Ar a4 ,
                    489: .Ar a5 ,
                    490: .Ar legal ,
1.66      kristaps  491: or
                    492: .Ar letter .
1.68      kristaps  493: You may also manually specify dimensions as
                    494: .Ar NNxNN ,
                    495: width by height in millimetres.
                    496: If an unknown value is encountered,
                    497: .Ar letter
                    498: is used.
1.66      kristaps  499: .El
1.93      schwarze  500: .Ss UTF\-8 Output
                    501: Use
1.156     schwarze  502: .Fl T Cm utf8
1.93      schwarze  503: to force a UTF\-8 locale.
1.73      kristaps  504: See
1.93      schwarze  505: .Sx Locale Output
                    506: for details and options.
1.161     schwarze  507: .Ss Syntax tree output
                    508: Use
                    509: .Fl T Cm tree
                    510: to show a human readable representation of the syntax tree.
                    511: It is useful for debugging the source code of manual pages.
1.162     schwarze  512: The exact format is subject to change, so don't write parsers for it.
1.170     schwarze  513: .Pp
                    514: The first paragraph shows meta data found in the
                    515: .Xr mdoc 7
                    516: prologue, on the
                    517: .Xr man 7
                    518: .Ic \&TH
                    519: line, or the fallbacks used.
                    520: .Pp
                    521: In the tree dump, each output line shows one syntax tree node.
1.161     schwarze  522: Child nodes are indented with respect to their parent node.
                    523: The columns are:
                    524: .Pp
                    525: .Bl -enum -compact
                    526: .It
                    527: For macro nodes, the macro name; for text and
                    528: .Xr tbl 7
1.162     schwarze  529: nodes, the content.
                    530: There is a special format for
1.161     schwarze  531: .Xr eqn 7
                    532: nodes.
                    533: .It
                    534: Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
                    535: .It
                    536: Flags:
                    537: .Bl -dash -compact
                    538: .It
                    539: An opening parenthesis if the node is an opening delimiter.
                    540: .It
                    541: An asterisk if the node starts a new input line.
                    542: .It
                    543: The input line number (starting at one).
                    544: .It
                    545: A colon.
                    546: .It
                    547: The input column number (starting at one).
                    548: .It
                    549: A closing parenthesis if the node is a closing delimiter.
                    550: .It
                    551: A full stop if the node ends a sentence.
1.169     schwarze  552: .It
1.174     schwarze  553: BROKEN if the node is a block broken by another block.
                    554: .It
1.169     schwarze  555: NOSRC if the node is not in the input file,
                    556: but automatically generated from macros.
                    557: .It
                    558: NOPRT if the node is not supposed to generate output
                    559: for any output format.
1.161     schwarze  560: .El
1.174     schwarze  561: .El
                    562: .Pp
                    563: The following
                    564: .Fl O
                    565: argument is accepted:
                    566: .Bl -tag -width Ds
                    567: .It Cm noval
                    568: Skip validation and show the unvalidated syntax tree.
                    569: This can help to find out whether a given behaviour is caused by
                    570: the parser or by the validator.
                    571: Meta data is not available in this case.
1.161     schwarze  572: .El
1.108     schwarze  573: .Sh ENVIRONMENT
                    574: .Bl -tag -width MANPAGER
                    575: .It Ev MANPAGER
                    576: Any non-empty value of the environment variable
                    577: .Ev MANPAGER
1.179     schwarze  578: is used instead of the standard pagination program,
                    579: .Xr more 1 ;
                    580: see
                    581: .Xr man 1
                    582: for details.
                    583: Only used if
                    584: .Fl a
                    585: or
                    586: .Fl l
                    587: is specified.
1.108     schwarze  588: .It Ev PAGER
                    589: Specifies the pagination program to use when
                    590: .Ev MANPAGER
                    591: is not defined.
                    592: If neither PAGER nor MANPAGER is defined,
1.159     schwarze  593: .Xr more 1
                    594: .Fl s
1.179     schwarze  595: is used.
                    596: Only used if
                    597: .Fl a
                    598: or
                    599: .Fl l
                    600: is specified.
1.108     schwarze  601: .El
1.77      schwarze  602: .Sh EXIT STATUS
                    603: The
                    604: .Nm
                    605: utility exits with one of the following values, controlled by the message
                    606: .Ar level
                    607: associated with the
                    608: .Fl W
                    609: option:
                    610: .Pp
                    611: .Bl -tag -width Ds -compact
                    612: .It 0
1.202     schwarze  613: No base system convention violations, style suggestions, warnings,
                    614: or errors occurred, or those that did were ignored because they
                    615: were lower than the requested
1.77      schwarze  616: .Ar level .
1.185     schwarze  617: .It 1
1.202     schwarze  618: At least one base system convention violation or style suggestion
                    619: occurred, but no warning or error, and
                    620: .Fl W Cm base
                    621: or
1.185     schwarze  622: .Fl W Cm style
                    623: was specified.
1.77      schwarze  624: .It 2
                    625: At least one warning occurred, but no error, and
1.156     schwarze  626: .Fl W Cm warning
1.202     schwarze  627: or a lower
                    628: .Ar level
                    629: was requested.
1.77      schwarze  630: .It 3
1.133     schwarze  631: At least one parsing error occurred,
                    632: but no unsupported feature was encountered, and
1.156     schwarze  633: .Fl W Cm error
1.185     schwarze  634: or a lower
                    635: .Ar level
                    636: was requested.
1.133     schwarze  637: .It 4
1.134     schwarze  638: At least one unsupported feature was encountered, and
1.185     schwarze  639: .Fl W Cm unsupp
                    640: or a lower
                    641: .Ar level
                    642: was requested.
1.77      schwarze  643: .It 5
                    644: Invalid command line arguments were specified.
                    645: No input files have been read.
                    646: .It 6
1.131     schwarze  647: An operating system error occurred, for example exhaustion
                    648: of memory, file descriptors, or process table entries.
1.77      schwarze  649: Such errors cause
                    650: .Nm
                    651: to exit at once, possibly in the middle of parsing or formatting a file.
                    652: .El
                    653: .Pp
                    654: Note that selecting
1.156     schwarze  655: .Fl T Cm lint
1.77      schwarze  656: output mode implies
1.202     schwarze  657: .Fl W Cm all .
1.1       kristaps  658: .Sh EXAMPLES
1.13      kristaps  659: To page manuals to the terminal:
1.1       kristaps  660: .Pp
1.187     schwarze  661: .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
1.28      kristaps  662: .Pp
1.41      kristaps  663: To produce HTML manuals with
1.164     schwarze  664: .Pa mandoc.css
1.41      kristaps  665: as the style-sheet:
1.38      kristaps  666: .Pp
1.164     schwarze  667: .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
1.38      kristaps  668: .Pp
1.28      kristaps  669: To check over a large set of manuals:
                    670: .Pp
1.158     schwarze  671: .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
1.66      kristaps  672: .Pp
                    673: To produce a series of PostScript manuals for A4 paper:
                    674: .Pp
1.156     schwarze  675: .Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.91      schwarze  676: .Pp
                    677: Convert a modern
                    678: .Xr mdoc 7
                    679: manual to the older
                    680: .Xr man 7
                    681: format, for use on systems lacking an
                    682: .Xr mdoc 7
                    683: parser:
                    684: .Pp
1.156     schwarze  685: .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
1.77      schwarze  686: .Sh DIAGNOSTICS
1.106     schwarze  687: Messages displayed by
                    688: .Nm
                    689: follow this format:
1.202     schwarze  690: .Bd -ragged -offset indent
1.205     schwarze  691: .Nm :
1.202     schwarze  692: .Ar file : Ns Ar line : Ns Ar column : level : message : macro args
                    693: .Pq Ar os
                    694: .Ed
1.77      schwarze  695: .Pp
1.106     schwarze  696: Line and column numbers start at 1.
                    697: Both are omitted for messages referring to an input file as a whole.
                    698: Macro names and arguments are omitted where meaningless.
1.202     schwarze  699: The
                    700: .Ar os
                    701: operating system specifier is omitted for messages that are relevant
                    702: for all operating systems.
1.106     schwarze  703: Fatal messages about invalid command line arguments
                    704: or operating system errors, for example when memory is exhausted,
                    705: may also omit the
                    706: .Ar file
1.104     schwarze  707: and
1.106     schwarze  708: .Ar level
                    709: fields.
1.104     schwarze  710: .Pp
1.77      schwarze  711: Message levels have the following meanings:
                    712: .Bl -tag -width "warning"
1.133     schwarze  713: .It Cm unsupp
                    714: An input file uses unsupported low-level
                    715: .Xr roff 7
                    716: features.
                    717: The output may be incomplete and/or misformatted,
                    718: so using GNU troff instead of
                    719: .Nm
                    720: to process the file may be preferable.
1.77      schwarze  721: .It Cm error
1.133     schwarze  722: An input file contains invalid syntax that cannot be safely interpreted.
1.77      schwarze  723: By discarding part of the input or inserting missing tokens,
                    724: the parser is able to continue, and the error does not prevent
                    725: generation of formatted output, but typically, preparing that
                    726: output involves information loss, broken document structure
1.133     schwarze  727: or unintended formatting, no matter whether
                    728: .Nm
                    729: or GNU troff is used.
                    730: In many cases, the output of
                    731: .Nm
                    732: and GNU troff is identical, but in some,
                    733: .Nm
                    734: is more resilient than GNU troff with respect to malformed input.
1.131     schwarze  735: .Pp
                    736: Non-existent or unreadable input files are also reported on the
                    737: .Cm error
                    738: level.
                    739: In that case, the parser cannot even be started and no output
                    740: is produced from those input files.
1.77      schwarze  741: .It Cm warning
                    742: An input file uses obsolete, discouraged or non-portable syntax.
                    743: All the same, the meaning of the input is unambiguous and a correct
                    744: rendering can be produced.
                    745: Documents causing warnings may render poorly when using other
                    746: formatting tools instead of
                    747: .Nm .
1.185     schwarze  748: .It Cm style
                    749: An input file uses dubious or discouraged style.
                    750: This is not a complaint about the syntax, and probably neither
                    751: formatting nor portability are in danger.
                    752: While great care is taken to avoid false positives on the higher
                    753: message levels, the
                    754: .Cm style
                    755: level tries to reduce the probability that issues go unnoticed,
                    756: so it may occasionally issue bogus suggestions.
                    757: Please use your good judgement to decide whether any particular
                    758: .Cm style
                    759: suggestion really justifies a change to the input file.
1.202     schwarze  760: .It Cm base
                    761: A convertion used in the base system of a specific operating system
                    762: is not adhered to.
                    763: These are not markup mistakes, and neither the quality of formatting
                    764: nor portability are in danger.
1.77      schwarze  765: .El
                    766: .Pp
                    767: Messages of the
1.202     schwarze  768: .Cm base ,
1.185     schwarze  769: .Cm style ,
1.133     schwarze  770: .Cm warning ,
                    771: .Cm error ,
1.77      schwarze  772: and
1.133     schwarze  773: .Cm unsupp
1.131     schwarze  774: levels except those about non-existent or unreadable input files
                    775: are hidden unless their level, or a lower level, is requested using a
1.77      schwarze  776: .Fl W
                    777: option or
1.156     schwarze  778: .Fl T Cm lint
1.77      schwarze  779: output mode.
1.202     schwarze  780: .Pp
                    781: As indicated below, all
                    782: .Cm base
                    783: and some
                    784: .Cm style
                    785: checks are only performed if a specific operating system name occurs
                    786: in the arguments of the
                    787: .Fl W
                    788: command line option, of the
1.195     schwarze  789: .Ic \&Os
                    790: macro, of the
                    791: .Fl Ios
                    792: command line option, or, if neither are present, in the return value
                    793: of the
                    794: .Xr uname 3
                    795: function.
1.202     schwarze  796: .Ss Conventions for base system manuals
1.189     schwarze  797: .Bl -ohang
1.200     schwarze  798: .It Sy "Mdocdate found"
                    799: .Pq mdoc , Nx
                    800: The
                    801: .Ic \&Dd
                    802: macro uses CVS
                    803: .Ic Mdocdate
                    804: keyword substitution, which is not supported by the
                    805: .Nx
                    806: base system.
                    807: Consider using the conventional
                    808: .Dq "Month dd, yyyy"
                    809: format instead.
                    810: .It Sy "Mdocdate missing"
                    811: .Pq mdoc , Ox
                    812: The
                    813: .Ic \&Dd
                    814: macro does not use CVS
                    815: .Ic Mdocdate
                    816: keyword substitution, but using it is conventionally expected in the
                    817: .Ox
                    818: base system.
1.204     schwarze  819: .It Sy "unknown architecture"
                    820: .Pq mdoc , Ox , Nx
                    821: The third argument of the
                    822: .Ic \&Dt
                    823: macro does not match any of the architectures this operating system
                    824: is running on.
1.203     schwarze  825: .It Sy "operating system explicitly specified"
                    826: .Pq mdoc , Ox , Nx
                    827: The
                    828: .Ic \&Os
                    829: macro has an argument.
                    830: In the base system, it is conventionally left blank.
1.202     schwarze  831: .It Sy "RCS id missing"
                    832: .Pq Ox , Nx
                    833: The manual page lacks the comment line with the RCS identifier
                    834: generated by CVS
                    835: .Ic OpenBSD
                    836: or
                    837: .Ic NetBSD
                    838: keyword substitution as conventionally used in these operating systems.
1.210     schwarze  839: .It Sy "referenced manual not found"
                    840: .Pq mdoc
                    841: An
                    842: .Ic \&Xr
                    843: macro references a manual page that is not found in the base system.
                    844: The path to look for base system manuals is configurable at compile
                    845: time and defaults to
                    846: .Pa /usr/share/man : /usr/X11R6/man .
1.202     schwarze  847: .El
                    848: .Ss Style suggestions
                    849: .Bl -ohang
1.200     schwarze  850: .It Sy "legacy man(7) date format"
                    851: .Pq mdoc
                    852: The
                    853: .Ic \&Dd
                    854: macro uses the legacy
                    855: .Xr man 7
                    856: date format
                    857: .Dq yyyy-dd-mm .
                    858: Consider using the conventional
                    859: .Xr mdoc 7
                    860: date format
                    861: .Dq "Month dd, yyyy"
                    862: instead.
1.201     schwarze  863: .It Sy "duplicate RCS id"
                    864: A single manual page contains two copies of the RCS identifier for
                    865: the same operating system.
                    866: Consider deleting the later instance and moving the first one up
                    867: to the top of the page.
1.207     schwarze  868: .It Sy "typo in section name"
                    869: .Pq mdoc
                    870: Fuzzy string matching revealed that the argument of an
                    871: .Ic \&Sh
                    872: macro is similar, but not identical to a standard section name.
1.189     schwarze  873: .It Sy "useless macro"
                    874: .Pq mdoc
                    875: A
                    876: .Ic \&Bt ,
                    877: .Ic \&Tn ,
                    878: or
1.190     schwarze  879: .Ic \&Ud
1.189     schwarze  880: macro was found.
1.190     schwarze  881: Simply delete it: it serves no useful purpose.
1.191     schwarze  882: .It Sy "consider using OS macro"
                    883: .Pq mdoc
                    884: A string was found in plain text or in a
                    885: .Ic \&Bx
                    886: macro that could be represented using
                    887: .Ic \&Ox ,
                    888: .Ic \&Nx ,
                    889: .Ic \&Fx ,
                    890: or
                    891: .Ic \&Dx .
1.195     schwarze  892: .It Sy "errnos out of order"
                    893: .Pq mdoc, Nx
                    894: The
                    895: .Ic \&Er
                    896: items in a
                    897: .Ic \&Bl
                    898: list are not in alphabetical order.
                    899: .It Sy "duplicate errno"
                    900: .Pq mdoc, Nx
                    901: A
                    902: .Ic \&Bl
                    903: list contains two consecutive
                    904: .Ic \&It
                    905: entries describing the same
                    906: .Ic \&Er
                    907: number.
1.192     schwarze  908: .It Sy "description line ends with a full stop"
                    909: .Pq mdoc
                    910: Do not use punctuation at the end of an
                    911: .Ic \&Nd
                    912: block.
1.197     schwarze  913: .It Sy "no blank before trailing delimiter"
1.198     schwarze  914: .Pq mdoc
1.197     schwarze  915: The last argument of a macro that supports trailing delimiter
                    916: arguments is longer than one byte and ends with a trailing delimiter.
                    917: Consider inserting a blank such that the delimiter becomes a separate
                    918: argument, thus moving it out of the scope of the macro.
1.198     schwarze  919: .It Sy "function name without markup"
                    920: .Pq mdoc
                    921: A word followed by an empty pair of parentheses occurs on a text line.
                    922: Consider using an
                    923: .Ic \&Fn
                    924: or
                    925: .Ic \&Xr
                    926: macro.
1.189     schwarze  927: .El
1.106     schwarze  928: .Ss Warnings related to the document prologue
                    929: .Bl -ohang
                    930: .It Sy "missing manual title, using UNTITLED"
                    931: .Pq mdoc
                    932: A
                    933: .Ic \&Dt
                    934: macro has no arguments, or there is no
                    935: .Ic \&Dt
                    936: macro before the first non-prologue macro.
                    937: .It Sy "missing manual title, using \(dq\(dq"
                    938: .Pq man
                    939: There is no
                    940: .Ic \&TH
                    941: macro, or it has no arguments.
                    942: .It Sy "lower case character in document title"
                    943: .Pq mdoc , man
                    944: The title is still used as given in the
                    945: .Ic \&Dt
                    946: or
                    947: .Ic \&TH
                    948: macro.
                    949: .It Sy "missing manual section, using \(dq\(dq"
                    950: .Pq mdoc , man
                    951: A
                    952: .Ic \&Dt
                    953: or
                    954: .Ic \&TH
                    955: macro lacks the mandatory section argument.
                    956: .It Sy "unknown manual section"
                    957: .Pq mdoc
                    958: The section number in a
                    959: .Ic \&Dt
                    960: line is invalid, but still used.
                    961: .It Sy "missing date, using today's date"
                    962: .Pq mdoc, man
                    963: The document was parsed as
                    964: .Xr mdoc 7
                    965: and it has no
                    966: .Ic \&Dd
                    967: macro, or the
                    968: .Ic \&Dd
                    969: macro has no arguments or only empty arguments;
                    970: or the document was parsed as
                    971: .Xr man 7
                    972: and it has no
                    973: .Ic \&TH
                    974: macro, or the
                    975: .Ic \&TH
                    976: macro has less than three arguments or its third argument is empty.
                    977: .It Sy "cannot parse date, using it verbatim"
                    978: .Pq mdoc , man
                    979: The date given in a
                    980: .Ic \&Dd
                    981: or
                    982: .Ic \&TH
                    983: macro does not follow the conventional format.
                    984: .It Sy "missing Os macro, using \(dq\(dq"
                    985: .Pq mdoc
                    986: The default or current system is not shown in this case.
                    987: .It Sy "duplicate prologue macro"
                    988: .Pq mdoc
                    989: One of the prologue macros occurs more than once.
                    990: The last instance overrides all previous ones.
                    991: .It Sy "late prologue macro"
                    992: .Pq mdoc
                    993: A
                    994: .Ic \&Dd
                    995: or
                    996: .Ic \&Os
                    997: macro occurs after some non-prologue macro, but still takes effect.
                    998: .It Sy "skipping late title macro"
                    999: .Pq mdoc
                   1000: The
                   1001: .Ic \&Dt
1.152     schwarze 1002: macro appears after the first non-prologue macro.
                   1003: Traditional formatters cannot handle this because
                   1004: they write the page header before parsing the document body.
1.106     schwarze 1005: Even though this technical restriction does not apply to
                   1006: .Nm ,
                   1007: traditional semantics is preserved.
                   1008: The late macro is discarded including its arguments.
                   1009: .It Sy "prologue macros out of order"
                   1010: .Pq mdoc
                   1011: The prologue macros are not given in the conventional order
                   1012: .Ic \&Dd ,
                   1013: .Ic \&Dt ,
                   1014: .Ic \&Os .
                   1015: All three macros are used even when given in another order.
                   1016: .El
                   1017: .Ss Warnings regarding document structure
                   1018: .Bl -ohang
                   1019: .It Sy ".so is fragile, better use ln(1)"
                   1020: .Pq roff
                   1021: Including files only works when the parser program runs with the correct
                   1022: current working directory.
                   1023: .It Sy "no document body"
                   1024: .Pq mdoc , man
                   1025: The document body contains neither text nor macros.
                   1026: An empty document is shown, consisting only of a header and a footer line.
                   1027: .It Sy "content before first section header"
                   1028: .Pq mdoc , man
                   1029: Some macros or text precede the first
                   1030: .Ic \&Sh
                   1031: or
                   1032: .Ic \&SH
                   1033: section header.
                   1034: The offending macros and text are parsed and added to the top level
                   1035: of the syntax tree, outside any section block.
                   1036: .It Sy "first section is not NAME"
                   1037: .Pq mdoc
                   1038: The argument of the first
                   1039: .Ic \&Sh
                   1040: macro is not
                   1041: .Sq NAME .
                   1042: This may confuse
                   1043: .Xr makewhatis 8
                   1044: and
                   1045: .Xr apropos 1 .
1.168     schwarze 1046: .It Sy "NAME section without Nm before Nd"
1.106     schwarze 1047: .Pq mdoc
1.155     schwarze 1048: The NAME section does not contain any
                   1049: .Ic \&Nm
1.168     schwarze 1050: child macro before the first
                   1051: .Ic \&Nd
                   1052: macro.
1.155     schwarze 1053: .It Sy "NAME section without description"
                   1054: .Pq mdoc
                   1055: The NAME section lacks the mandatory
                   1056: .Ic \&Nd
                   1057: child macro.
                   1058: .It Sy "description not at the end of NAME"
                   1059: .Pq mdoc
                   1060: The NAME section does contain an
1.106     schwarze 1061: .Ic \&Nd
1.155     schwarze 1062: child macro, but other content follows it.
                   1063: .It Sy "bad NAME section content"
                   1064: .Pq mdoc
                   1065: The NAME section contains plain text or macros other than
                   1066: .Ic \&Nm
1.106     schwarze 1067: and
1.155     schwarze 1068: .Ic \&Nd .
1.168     schwarze 1069: .It Sy "missing comma before name"
                   1070: .Pq mdoc
                   1071: The NAME section contains an
                   1072: .Ic \&Nm
                   1073: macro that is neither the first one nor preceded by a comma.
1.142     schwarze 1074: .It Sy "missing description line, using \(dq\(dq"
                   1075: .Pq mdoc
                   1076: The
                   1077: .Ic \&Nd
                   1078: macro lacks the required argument.
                   1079: The title line of the manual will end after the dash.
1.177     schwarze 1080: .It Sy "description line outside NAME section"
                   1081: .Pq mdoc
                   1082: An
                   1083: .Ic \&Nd
                   1084: macro appears outside the NAME section.
                   1085: The arguments are printed anyway and the following text is used for
                   1086: .Xr apropos 1 ,
                   1087: but none of that behaviour is portable.
1.106     schwarze 1088: .It Sy "sections out of conventional order"
                   1089: .Pq mdoc
                   1090: A standard section occurs after another section it usually precedes.
                   1091: All section titles are used as given,
                   1092: and the order of sections is not changed.
                   1093: .It Sy "duplicate section title"
                   1094: .Pq mdoc
                   1095: The same standard section title occurs more than once.
                   1096: .It Sy "unexpected section"
                   1097: .Pq mdoc
                   1098: A standard section header occurs in a section of the manual
                   1099: where it normally isn't useful.
1.211   ! schwarze 1100: .It Sy "cross reference to self"
        !          1101: .Pq mdoc
        !          1102: An
        !          1103: .Ic \&Xr
        !          1104: macro refers to a name and section matching the section of the present
        !          1105: manual page and a name mentioned in an
        !          1106: .Ic \&Nm
        !          1107: macro in the NAME or SYNOPSIS section, or in an
        !          1108: .Ic \&Fn
        !          1109: or
        !          1110: .Ic \&Fo
        !          1111: macro in the SYNOPSIS.
        !          1112: Consider using
        !          1113: .Ic \&Nm
        !          1114: or
        !          1115: .Ic \&Fn
        !          1116: instead of
        !          1117: .Ic \&Xr .
1.112     schwarze 1118: .It Sy "unusual Xr order"
                   1119: .Pq mdoc
                   1120: In the SEE ALSO section, an
                   1121: .Ic \&Xr
                   1122: macro with a lower section number follows one with a higher number,
                   1123: or two
                   1124: .Ic \&Xr
1.157     schwarze 1125: macros referring to the same section are out of alphabetical order.
1.112     schwarze 1126: .It Sy "unusual Xr punctuation"
                   1127: .Pq mdoc
                   1128: In the SEE ALSO section, punctuation between two
                   1129: .Ic \&Xr
                   1130: macros differs from a single comma, or there is trailing punctuation
                   1131: after the last
                   1132: .Ic \&Xr
                   1133: macro.
1.111     schwarze 1134: .It Sy "AUTHORS section without An macro"
                   1135: .Pq mdoc
                   1136: An AUTHORS sections contains no
                   1137: .Ic \&An
                   1138: macros, or only empty ones.
                   1139: Probably, there are author names lacking markup.
1.106     schwarze 1140: .El
                   1141: .Ss "Warnings related to macros and nesting"
                   1142: .Bl -ohang
                   1143: .It Sy "obsolete macro"
                   1144: .Pq mdoc
                   1145: See the
                   1146: .Xr mdoc 7
                   1147: manual for replacements.
1.126     schwarze 1148: .It Sy "macro neither callable nor escaped"
                   1149: .Pq mdoc
                   1150: The name of a macro that is not callable appears on a macro line.
                   1151: It is printed verbatim.
1.152     schwarze 1152: If the intention is to call it, move it to its own input line;
1.126     schwarze 1153: otherwise, escape it by prepending
                   1154: .Sq \e& .
1.106     schwarze 1155: .It Sy "skipping paragraph macro"
                   1156: In
                   1157: .Xr mdoc 7
                   1158: documents, this happens
                   1159: .Bl -dash -compact
                   1160: .It
                   1161: at the beginning and end of sections and subsections
                   1162: .It
                   1163: right before non-compact lists and displays
                   1164: .It
                   1165: at the end of items in non-column, non-compact lists
                   1166: .It
                   1167: and for multiple consecutive paragraph macros.
                   1168: .El
                   1169: In
                   1170: .Xr man 7
                   1171: documents, it happens
                   1172: .Bl -dash -compact
                   1173: .It
                   1174: for empty
                   1175: .Ic \&P ,
                   1176: .Ic \&PP ,
                   1177: and
                   1178: .Ic \&LP
                   1179: macros
                   1180: .It
                   1181: for
                   1182: .Ic \&IP
                   1183: macros having neither head nor body arguments
                   1184: .It
                   1185: for
                   1186: .Ic \&br
                   1187: or
                   1188: .Ic \&sp
                   1189: right after
                   1190: .Ic \&SH
                   1191: or
                   1192: .Ic \&SS
                   1193: .El
                   1194: .It Sy "moving paragraph macro out of list"
                   1195: .Pq mdoc
                   1196: A list item in a
                   1197: .Ic \&Bl
                   1198: list contains a trailing paragraph macro.
                   1199: The paragraph macro is moved after the end of the list.
                   1200: .It Sy "skipping no-space macro"
                   1201: .Pq mdoc
                   1202: An input line begins with an
                   1203: .Ic \&Ns
1.208     schwarze 1204: macro, or the next argument after an
                   1205: .Ic \&Ns
                   1206: macro is an isolated closing delimiter.
1.106     schwarze 1207: The macro is ignored.
                   1208: .It Sy "blocks badly nested"
                   1209: .Pq mdoc
                   1210: If two blocks intersect, one should completely contain the other.
                   1211: Otherwise, rendered output is likely to look strange in any output
                   1212: format, and rendering in SGML-based output formats is likely to be
                   1213: outright wrong because such languages do not support badly nested
                   1214: blocks at all.
                   1215: Typical examples of badly nested blocks are
                   1216: .Qq Ic \&Ao \&Bo \&Ac \&Bc
                   1217: and
                   1218: .Qq Ic \&Ao \&Bq \&Ac .
                   1219: In these examples,
                   1220: .Ic \&Ac
                   1221: breaks
                   1222: .Ic \&Bo
                   1223: and
                   1224: .Ic \&Bq ,
                   1225: respectively.
                   1226: .It Sy "nested displays are not portable"
                   1227: .Pq mdoc
                   1228: A
                   1229: .Ic \&Bd ,
                   1230: .Ic \&D1 ,
                   1231: or
                   1232: .Ic \&Dl
                   1233: display occurs nested inside another
                   1234: .Ic \&Bd
                   1235: display.
                   1236: This works with
                   1237: .Nm ,
                   1238: but fails with most other implementations.
                   1239: .It Sy "moving content out of list"
                   1240: .Pq mdoc
                   1241: A
                   1242: .Ic \&Bl
                   1243: list block contains text or macros before the first
                   1244: .Ic \&It
                   1245: macro.
                   1246: The offending children are moved before the beginning of the list.
1.209     schwarze 1247: .It Sy "first macro on line"
                   1248: Inside a
                   1249: .Ic \&Bl Fl column
                   1250: list, a
                   1251: .Ic \&Ta
                   1252: macro occurs as the first macro on a line, which is not portable.
1.106     schwarze 1253: .It Sy "fill mode already enabled, skipping"
                   1254: .Pq man
                   1255: A
                   1256: .Ic \&fi
                   1257: request occurs even though the document is still in fill mode,
                   1258: or already switched back to fill mode.
                   1259: It has no effect.
                   1260: .It Sy "fill mode already disabled, skipping"
                   1261: .Pq man
                   1262: An
                   1263: .Ic \&nf
                   1264: request occurs even though the document already switched to no-fill mode
                   1265: and did not switch back to fill mode yet.
                   1266: It has no effect.
                   1267: .It Sy "line scope broken"
                   1268: .Pq man
                   1269: While parsing the next-line scope of the previous macro,
                   1270: another macro is found that prematurely terminates the previous one.
                   1271: The previous, interrupted macro is deleted from the parse tree.
                   1272: .El
                   1273: .Ss "Warnings related to missing arguments"
                   1274: .Bl -ohang
                   1275: .It Sy "skipping empty request"
1.118     schwarze 1276: .Pq roff , eqn
                   1277: The macro name is missing from a macro definition request,
                   1278: or an
                   1279: .Xr eqn 7
                   1280: control statement or operation keyword lacks its required argument.
1.106     schwarze 1281: .It Sy "conditional request controls empty scope"
                   1282: .Pq roff
                   1283: A conditional request is only useful if any of the following
                   1284: follows it on the same logical input line:
                   1285: .Bl -dash -compact
                   1286: .It
                   1287: The
                   1288: .Sq \e{
                   1289: keyword to open a multi-line scope.
                   1290: .It
                   1291: A request or macro or some text, resulting in a single-line scope.
                   1292: .It
                   1293: The immediate end of the logical line without any intervening whitespace,
                   1294: resulting in next-line scope.
                   1295: .El
                   1296: Here, a conditional request is followed by trailing whitespace only,
                   1297: and there is no other content on its logical input line.
                   1298: Note that it doesn't matter whether the logical input line is split
                   1299: across multiple physical input lines using
                   1300: .Sq \e
                   1301: line continuation characters.
                   1302: This is one of the rare cases
                   1303: where trailing whitespace is syntactically significant.
                   1304: The conditional request controls a scope containing whitespace only,
                   1305: so it is unlikely to have a significant effect,
                   1306: except that it may control a following
                   1307: .Ic \&el
                   1308: clause.
                   1309: .It Sy "skipping empty macro"
                   1310: .Pq mdoc
1.147     schwarze 1311: The indicated macro has no arguments and hence no effect.
                   1312: .It Sy "empty block"
                   1313: .Pq mdoc , man
                   1314: A
                   1315: .Ic \&Bd ,
                   1316: .Ic \&Bk ,
                   1317: .Ic \&Bl ,
                   1318: .Ic \&D1 ,
                   1319: .Ic \&Dl ,
1.206     schwarze 1320: .Ic \&MT ,
1.147     schwarze 1321: .Ic \&RS ,
                   1322: or
                   1323: .Ic \&UR
                   1324: block contains nothing in its body and will produce no output.
1.106     schwarze 1325: .It Sy "empty argument, using 0n"
                   1326: .Pq mdoc
                   1327: The required width is missing after
                   1328: .Ic \&Bd
                   1329: or
                   1330: .Ic \&Bl
                   1331: .Fl offset
                   1332: or
1.186     schwarze 1333: .Fl width .
1.106     schwarze 1334: .It Sy "missing display type, using -ragged"
                   1335: .Pq mdoc
                   1336: The
                   1337: .Ic \&Bd
                   1338: macro is invoked without the required display type.
                   1339: .It Sy "list type is not the first argument"
                   1340: .Pq mdoc
                   1341: In a
                   1342: .Ic \&Bl
                   1343: macro, at least one other argument precedes the type argument.
                   1344: The
                   1345: .Nm
                   1346: utility copes with any argument order, but some other
                   1347: .Xr mdoc 7
                   1348: implementations do not.
                   1349: .It Sy "missing -width in -tag list, using 8n"
                   1350: .Pq mdoc
                   1351: Every
                   1352: .Ic \&Bl
                   1353: macro having the
                   1354: .Fl tag
                   1355: argument requires
                   1356: .Fl width ,
                   1357: too.
                   1358: .It Sy "missing utility name, using \(dq\(dq"
                   1359: .Pq mdoc
                   1360: The
                   1361: .Ic \&Ex Fl std
                   1362: macro is called without an argument before
                   1363: .Ic \&Nm
                   1364: has first been called with an argument.
1.146     schwarze 1365: .It Sy "missing function name, using \(dq\(dq"
                   1366: .Pq mdoc
                   1367: The
                   1368: .Ic \&Fo
                   1369: macro is called without an argument.
                   1370: No function name is printed.
1.106     schwarze 1371: .It Sy "empty head in list item"
                   1372: .Pq mdoc
                   1373: In a
                   1374: .Ic \&Bl
                   1375: .Fl diag ,
                   1376: .Fl hang ,
                   1377: .Fl inset ,
                   1378: .Fl ohang ,
                   1379: or
                   1380: .Fl tag
                   1381: list, an
                   1382: .Ic \&It
                   1383: macro lacks the required argument.
                   1384: The item head is left empty.
                   1385: .It Sy "empty list item"
                   1386: .Pq mdoc
                   1387: In a
                   1388: .Ic \&Bl
                   1389: .Fl bullet ,
                   1390: .Fl dash ,
                   1391: .Fl enum ,
                   1392: or
                   1393: .Fl hyphen
                   1394: list, an
                   1395: .Ic \&It
                   1396: block is empty.
                   1397: An empty list item is shown.
1.209     schwarze 1398: .It Sy "missing argument, using next line"
                   1399: .Pq mdoc
                   1400: An
                   1401: .Ic \&It
                   1402: macro in a
                   1403: .Ic \&Bd Fl column
                   1404: list has no arguments.
                   1405: While
                   1406: .Nm
                   1407: uses the text or macros of the following line, if any, for the cell,
                   1408: other formatters may misformat the list.
1.152     schwarze 1409: .It Sy "missing font type, using \efR"
1.106     schwarze 1410: .Pq mdoc
                   1411: A
                   1412: .Ic \&Bf
                   1413: macro has no argument.
1.152     schwarze 1414: It switches to the default font.
                   1415: .It Sy "unknown font type, using \efR"
1.106     schwarze 1416: .Pq mdoc
                   1417: The
                   1418: .Ic \&Bf
                   1419: argument is invalid.
1.152     schwarze 1420: The default font is used instead.
1.127     schwarze 1421: .It Sy "nothing follows prefix"
                   1422: .Pq mdoc
                   1423: A
                   1424: .Ic \&Pf
                   1425: macro has no argument, or only one argument and no macro follows
                   1426: on the same input line.
                   1427: This defeats its purpose; in particular, spacing is not suppressed
                   1428: before the text or macros following on the next input line.
1.143     schwarze 1429: .It Sy "empty reference block"
                   1430: .Pq mdoc
                   1431: An
                   1432: .Ic \&Rs
                   1433: macro is immediately followed by an
                   1434: .Ic \&Re
                   1435: macro on the next input line.
                   1436: Such an empty block does not produce any output.
1.165     schwarze 1437: .It Sy "missing section argument"
                   1438: .Pq mdoc
                   1439: An
                   1440: .Ic \&Xr
                   1441: macro lacks its second, section number argument.
                   1442: The first argument, i.e. the name, is printed, but without subsequent
1.166     schwarze 1443: parentheses.
1.106     schwarze 1444: .It Sy "missing -std argument, adding it"
                   1445: .Pq mdoc
                   1446: An
                   1447: .Ic \&Ex
                   1448: or
                   1449: .Ic \&Rv
                   1450: macro lacks the required
                   1451: .Fl std
                   1452: argument.
                   1453: The
                   1454: .Nm
                   1455: utility assumes
                   1456: .Fl std
                   1457: even when it is not specified, but other implementations may not.
1.150     schwarze 1458: .It Sy "missing option string, using \(dq\(dq"
                   1459: .Pq man
                   1460: The
                   1461: .Ic \&OP
                   1462: macro is invoked without any argument.
                   1463: An empty pair of square brackets is shown.
                   1464: .It Sy "missing resource identifier, using \(dq\(dq"
                   1465: .Pq man
                   1466: The
1.206     schwarze 1467: .Ic \&MT
                   1468: or
1.150     schwarze 1469: .Ic \&UR
                   1470: macro is invoked without any argument.
                   1471: An empty pair of angle brackets is shown.
1.118     schwarze 1472: .It Sy "missing eqn box, using \(dq\(dq"
                   1473: .Pq eqn
                   1474: A diacritic mark or a binary operator is found,
                   1475: but there is nothing to the left of it.
                   1476: An empty box is inserted.
1.106     schwarze 1477: .El
                   1478: .Ss "Warnings related to bad macro arguments"
                   1479: .Bl -ohang
                   1480: .It Sy "unterminated quoted argument"
                   1481: .Pq roff
                   1482: Macro arguments can be enclosed in double quote characters
                   1483: such that space characters and macro names contained in the quoted
                   1484: argument need not be escaped.
                   1485: The closing quote of the last argument of a macro can be omitted.
                   1486: However, omitting it is not recommended because it makes the code
                   1487: harder to read.
                   1488: .It Sy "duplicate argument"
                   1489: .Pq mdoc
                   1490: A
                   1491: .Ic \&Bd
                   1492: or
                   1493: .Ic \&Bl
                   1494: macro has more than one
                   1495: .Fl compact ,
                   1496: more than one
                   1497: .Fl offset ,
                   1498: or more than one
                   1499: .Fl width
                   1500: argument.
                   1501: All but the last instances of these arguments are ignored.
                   1502: .It Sy "skipping duplicate argument"
                   1503: .Pq mdoc
                   1504: An
                   1505: .Ic \&An
                   1506: macro has more than one
                   1507: .Fl split
                   1508: or
                   1509: .Fl nosplit
                   1510: argument.
                   1511: All but the first of these arguments are ignored.
                   1512: .It Sy "skipping duplicate display type"
                   1513: .Pq mdoc
                   1514: A
                   1515: .Ic \&Bd
                   1516: macro has more than one type argument; the first one is used.
                   1517: .It Sy "skipping duplicate list type"
                   1518: .Pq mdoc
                   1519: A
                   1520: .Ic \&Bl
                   1521: macro has more than one type argument; the first one is used.
                   1522: .It Sy "skipping -width argument"
                   1523: .Pq mdoc
                   1524: A
                   1525: .Ic \&Bl
                   1526: .Fl column ,
                   1527: .Fl diag ,
                   1528: .Fl ohang ,
                   1529: .Fl inset ,
                   1530: or
                   1531: .Fl item
                   1532: list has a
                   1533: .Fl width
                   1534: argument.
                   1535: That has no effect.
1.151     schwarze 1536: .It Sy "wrong number of cells"
                   1537: In a line of a
                   1538: .Ic \&Bl Fl column
                   1539: list, the number of tabs or
                   1540: .Ic \&Ta
                   1541: macros is less than the number expected from the list header line
                   1542: or exceeds the expected number by more than one.
                   1543: Missing cells remain empty, and all cells exceeding the number of
                   1544: columns are joined into one single cell.
1.106     schwarze 1545: .It Sy "unknown AT&T UNIX version"
                   1546: .Pq mdoc
                   1547: An
                   1548: .Ic \&At
                   1549: macro has an invalid argument.
                   1550: It is used verbatim, with
                   1551: .Qq "AT&T UNIX "
                   1552: prefixed to it.
1.113     schwarze 1553: .It Sy "comma in function argument"
                   1554: .Pq mdoc
                   1555: An argument of an
                   1556: .Ic \&Fa
                   1557: or
                   1558: .Ic \&Fn
                   1559: macro contains a comma; it should probably be split into two arguments.
1.117     schwarze 1560: .It Sy "parenthesis in function name"
                   1561: .Pq mdoc
                   1562: The first argument of an
                   1563: .Ic \&Fc
                   1564: or
                   1565: .Ic \&Fn
                   1566: macro contains an opening or closing parenthesis; that's probably wrong,
                   1567: parentheses are added automatically.
1.196     schwarze 1568: .It Sy "unknown library name"
                   1569: .Pq mdoc, not on Ox
                   1570: An
                   1571: .Ic \&Lb
                   1572: macro has an unknown name argument and will be rendered as
                   1573: .Qq library Dq Ar name .
1.106     schwarze 1574: .It Sy "invalid content in Rs block"
                   1575: .Pq mdoc
                   1576: An
                   1577: .Ic \&Rs
                   1578: block contains plain text or non-% macros.
                   1579: The bogus content is left in the syntax tree.
                   1580: Formatting may be poor.
                   1581: .It Sy "invalid Boolean argument"
                   1582: .Pq mdoc
                   1583: An
                   1584: .Ic \&Sm
                   1585: macro has an argument other than
                   1586: .Cm on
                   1587: or
                   1588: .Cm off .
                   1589: The invalid argument is moved out of the macro, which leaves the macro
                   1590: empty, causing it to toggle the spacing mode.
                   1591: .It Sy "unknown font, skipping request"
1.115     schwarze 1592: .Pq man , tbl
1.106     schwarze 1593: A
                   1594: .Xr roff 7
                   1595: .Ic \&ft
1.115     schwarze 1596: request or a
                   1597: .Xr tbl 7
                   1598: .Ic \&f
                   1599: layout modifier has an unknown
                   1600: .Ar font
                   1601: argument.
1.151     schwarze 1602: .It Sy "odd number of characters in request"
                   1603: .Pq roff
                   1604: A
                   1605: .Ic \&tr
                   1606: request contains an odd number of characters.
                   1607: The last character is mapped to the blank character.
1.106     schwarze 1608: .El
                   1609: .Ss "Warnings related to plain text"
                   1610: .Bl -ohang
                   1611: .It Sy "blank line in fill mode, using .sp"
                   1612: .Pq mdoc
                   1613: The meaning of blank input lines is only well-defined in non-fill mode:
                   1614: In fill mode, line breaks of text input lines are not supposed to be
                   1615: significant.
                   1616: However, for compatibility with groff, blank lines in fill mode
                   1617: are replaced with
                   1618: .Ic \&sp
                   1619: requests.
                   1620: .It Sy "tab in filled text"
                   1621: .Pq mdoc , man
                   1622: The meaning of tab characters is only well-defined in non-fill mode:
                   1623: In fill mode, whitespace is not supposed to be significant
                   1624: on text input lines.
                   1625: As an implementation dependent choice, tab characters on text lines
                   1626: are passed through to the formatters in any case.
                   1627: Given that the text before the tab character will be filled,
                   1628: it is hard to predict which tab stop position the tab will advance to.
                   1629: .It Sy "whitespace at end of input line"
                   1630: .Pq mdoc , man , roff
                   1631: Whitespace at the end of input lines is almost never semantically
                   1632: significant \(em but in the odd case where it might be, it is
                   1633: extremely confusing when reviewing and maintaining documents.
1.172     schwarze 1634: .It Sy "new sentence, new line"
                   1635: .Pq mdoc
                   1636: A new sentence starts in the middle of a text line.
                   1637: Start it on a new input line to help formatters produce correct spacing.
1.106     schwarze 1638: .It Sy "bad comment style"
                   1639: .Pq roff
                   1640: Comment lines start with a dot, a backslash, and a double-quote character.
                   1641: The
                   1642: .Nm
                   1643: utility treats the line as a comment line even without the backslash,
                   1644: but leaving out the backslash might not be portable.
                   1645: .It Sy "invalid escape sequence"
                   1646: .Pq roff
                   1647: An escape sequence has an invalid opening argument delimiter, lacks the
                   1648: closing argument delimiter, or the argument has too few characters.
                   1649: If the argument is incomplete,
                   1650: .Ic \e*
                   1651: and
                   1652: .Ic \en
                   1653: expand to an empty string,
                   1654: .Ic \eB
                   1655: to the digit
                   1656: .Sq 0 ,
                   1657: and
                   1658: .Ic \ew
                   1659: to the length of the incomplete argument.
                   1660: All other invalid escape sequences are ignored.
                   1661: .It Sy "undefined string, using \(dq\(dq"
                   1662: .Pq roff
                   1663: If a string is used without being defined before,
                   1664: its value is implicitly set to the empty string.
                   1665: However, defining strings explicitly before use
                   1666: keeps the code more readable.
                   1667: .El
1.138     schwarze 1668: .Ss "Warnings related to tables"
                   1669: .Bl -ohang
                   1670: .It Sy "tbl line starts with span"
                   1671: .Pq tbl
                   1672: The first cell in a table layout line is a horizontal span
                   1673: .Pq Sq Cm s .
                   1674: Data provided for this cell is ignored, and nothing is printed in the cell.
                   1675: .It Sy "tbl column starts with span"
                   1676: .Pq tbl
                   1677: The first line of a table layout specification
                   1678: requests a vertical span
                   1679: .Pq Sq Cm ^ .
                   1680: Data provided for this cell is ignored, and nothing is printed in the cell.
                   1681: .It Sy "skipping vertical bar in tbl layout"
                   1682: .Pq tbl
                   1683: A table layout specification contains more than two consecutive vertical bars.
                   1684: A double bar is printed, all additional bars are discarded.
1.106     schwarze 1685: .El
                   1686: .Ss "Errors related to tables"
1.136     schwarze 1687: .Bl -ohang
                   1688: .It Sy "non-alphabetic character in tbl options"
                   1689: .Pq tbl
                   1690: The table options line contains a character other than a letter,
                   1691: blank, or comma where the beginning of an option name is expected.
                   1692: The character is ignored.
                   1693: .It Sy "skipping unknown tbl option"
                   1694: .Pq tbl
                   1695: The table options line contains a string of letters that does not
                   1696: match any known option name.
                   1697: The word is ignored.
                   1698: .It Sy "missing tbl option argument"
                   1699: .Pq tbl
                   1700: A table option that requires an argument is not followed by an
                   1701: opening parenthesis, or the opening parenthesis is immediately
                   1702: followed by a closing parenthesis.
                   1703: The option is ignored.
                   1704: .It Sy "wrong tbl option argument size"
                   1705: .Pq tbl
                   1706: A table option argument contains an invalid number of characters.
                   1707: Both the option and the argument are ignored.
1.138     schwarze 1708: .It Sy "empty tbl layout"
                   1709: .Pq tbl
                   1710: A table layout specification is completely empty,
                   1711: specifying zero lines and zero columns.
                   1712: As a fallback, a single left-justified column is used.
                   1713: .It Sy "invalid character in tbl layout"
                   1714: .Pq tbl
                   1715: A table layout specification contains a character that can neither
                   1716: be interpreted as a layout key character nor as a layout modifier,
                   1717: or a modifier precedes the first key.
                   1718: The invalid character is discarded.
                   1719: .It Sy "unmatched parenthesis in tbl layout"
                   1720: .Pq tbl
                   1721: A table layout specification contains an opening parenthesis,
                   1722: but no matching closing parenthesis.
                   1723: The rest of the input line, starting from the parenthesis, has no effect.
1.139     schwarze 1724: .It Sy "tbl without any data cells"
                   1725: .Pq tbl
                   1726: A table does not contain any data cells.
                   1727: It will probably produce no output.
                   1728: .It Sy "ignoring data in spanned tbl cell"
                   1729: .Pq tbl
                   1730: A table cell is marked as a horizontal span
                   1731: .Pq Sq Cm s
                   1732: or vertical span
                   1733: .Pq Sq Cm ^
                   1734: in the table layout, but it contains data.
                   1735: The data is ignored.
                   1736: .It Sy "ignoring extra tbl data cells"
                   1737: .Pq tbl
                   1738: A data line contains more cells than the corresponding layout line.
                   1739: The data in the extra cells is ignored.
                   1740: .It Sy "data block open at end of tbl"
                   1741: .Pq tbl
                   1742: A data block is opened with
                   1743: .Cm T{ ,
                   1744: but never closed with a matching
                   1745: .Cm T} .
                   1746: The remaining data lines of the table are all put into one cell,
                   1747: and any remaining cells stay empty.
1.106     schwarze 1748: .El
                   1749: .Ss "Errors related to roff, mdoc, and man code"
                   1750: .Bl -ohang
                   1751: .It Sy "input stack limit exceeded, infinite loop?"
                   1752: .Pq roff
                   1753: Explicit recursion limits are implemented for the following features,
                   1754: in order to prevent infinite loops:
                   1755: .Bl -dash -compact
                   1756: .It
                   1757: expansion of nested escape sequences
                   1758: including expansion of strings and number registers,
                   1759: .It
                   1760: expansion of nested user-defined macros,
                   1761: .It
                   1762: and
                   1763: .Ic \&so
                   1764: file inclusion.
                   1765: .El
                   1766: When a limit is hit, the output is incorrect, typically losing
                   1767: some content, but the parser can continue.
                   1768: .It Sy "skipping bad character"
                   1769: .Pq mdoc , man , roff
                   1770: The input file contains a byte that is not a printable
                   1771: .Xr ascii 7
                   1772: character.
                   1773: The message mentions the character number.
                   1774: The offending byte is replaced with a question mark
                   1775: .Pq Sq \&? .
                   1776: Consider editing the input file to replace the byte with an ASCII
                   1777: transliteration of the intended character.
                   1778: .It Sy "skipping unknown macro"
                   1779: .Pq mdoc , man , roff
                   1780: The first identifier on a request or macro line is neither recognized as a
                   1781: .Xr roff 7
                   1782: request, nor as a user-defined macro, nor, respectively, as an
                   1783: .Xr mdoc 7
                   1784: or
                   1785: .Xr man 7
                   1786: macro.
                   1787: It may be mistyped or unsupported.
                   1788: The request or macro is discarded including its arguments.
1.133     schwarze 1789: .It Sy "skipping insecure request"
                   1790: .Pq roff
                   1791: An input file attempted to run a shell command
                   1792: or to read or write an external file.
                   1793: Such attempts are denied for security reasons.
1.106     schwarze 1794: .It Sy "skipping item outside list"
1.118     schwarze 1795: .Pq mdoc , eqn
1.106     schwarze 1796: An
                   1797: .Ic \&It
                   1798: macro occurs outside any
                   1799: .Ic \&Bl
1.118     schwarze 1800: list, or an
                   1801: .Xr eqn 7
                   1802: .Ic above
                   1803: delimiter occurs outside any pile.
1.106     schwarze 1804: It is discarded including its arguments.
                   1805: .It Sy "skipping column outside column list"
                   1806: .Pq mdoc
                   1807: A
                   1808: .Ic \&Ta
                   1809: macro occurs outside any
                   1810: .Ic \&Bl Fl column
                   1811: block.
                   1812: It is discarded including its arguments.
                   1813: .It Sy "skipping end of block that is not open"
                   1814: .Pq mdoc , man , eqn , tbl , roff
                   1815: Various syntax elements can only be used to explicitly close blocks
                   1816: that have previously been opened.
                   1817: An
                   1818: .Xr mdoc 7
                   1819: block closing macro, a
                   1820: .Xr man 7
1.206     schwarze 1821: .Ic \&ME , \&RE
1.106     schwarze 1822: or
                   1823: .Ic \&UE
1.118     schwarze 1824: macro, an
                   1825: .Xr eqn 7
                   1826: right delimiter or closing brace, or the end of an equation, table, or
1.106     schwarze 1827: .Xr roff 7
                   1828: conditional request is encountered but no matching block is open.
                   1829: The offending request or macro is discarded.
1.135     schwarze 1830: .It Sy "fewer RS blocks open, skipping"
                   1831: .Pq man
                   1832: The
                   1833: .Ic \&RE
                   1834: macro is invoked with an argument, but less than the specified number of
                   1835: .Ic \&RS
                   1836: blocks is open.
                   1837: The
                   1838: .Ic \&RE
                   1839: macro is discarded.
1.106     schwarze 1840: .It Sy "inserting missing end of block"
                   1841: .Pq mdoc , tbl
                   1842: Various
                   1843: .Xr mdoc 7
                   1844: macros as well as tables require explicit closing by dedicated macros.
                   1845: A block that doesn't support bad nesting
                   1846: ends before all of its children are properly closed.
                   1847: The open child nodes are closed implicitly.
1.152     schwarze 1848: .It Sy "appending missing end of block"
1.106     schwarze 1849: .Pq mdoc , man , eqn , tbl , roff
                   1850: At the end of the document, an explicit
                   1851: .Xr mdoc 7
                   1852: block, a
                   1853: .Xr man 7
                   1854: next-line scope or
1.206     schwarze 1855: .Ic \&MT , \&RS
1.106     schwarze 1856: or
                   1857: .Ic \&UR
                   1858: block, an equation, table, or
                   1859: .Xr roff 7
                   1860: conditional or ignore block is still open.
                   1861: The open block is closed implicitly.
                   1862: .It Sy "escaped character not allowed in a name"
                   1863: .Pq roff
                   1864: Macro, string and register identifiers consist of printable,
                   1865: non-whitespace ASCII characters.
                   1866: Escape sequences and characters and strings expressed in terms of them
                   1867: cannot form part of a name.
                   1868: The first argument of an
                   1869: .Ic \&am ,
                   1870: .Ic \&as ,
                   1871: .Ic \&de ,
                   1872: .Ic \&ds ,
                   1873: .Ic \&nr ,
                   1874: or
                   1875: .Ic \&rr
                   1876: request, or any argument of an
                   1877: .Ic \&rm
                   1878: request, or the name of a request or user defined macro being called,
                   1879: is terminated by an escape sequence.
                   1880: In the cases of
                   1881: .Ic \&as ,
                   1882: .Ic \&ds ,
                   1883: and
                   1884: .Ic \&nr ,
                   1885: the request has no effect at all.
                   1886: In the cases of
                   1887: .Ic \&am ,
                   1888: .Ic \&de ,
                   1889: .Ic \&rr ,
                   1890: and
                   1891: .Ic \&rm ,
                   1892: what was parsed up to this point is used as the arguments to the request,
                   1893: and the rest of the input line is discarded including the escape sequence.
                   1894: When parsing for a request or a user-defined macro name to be called,
                   1895: only the escape sequence is discarded.
                   1896: The characters preceding it are used as the request or macro name,
                   1897: the characters following it are used as the arguments to the request or macro.
1.124     schwarze 1898: .It Sy "NOT IMPLEMENTED: Bd -file"
                   1899: .Pq mdoc
                   1900: For security reasons, the
                   1901: .Ic \&Bd
                   1902: macro does not support the
                   1903: .Fl file
                   1904: argument.
                   1905: By requesting the inclusion of a sensitive file, a malicious document
                   1906: might otherwise trick a privileged user into inadvertently displaying
                   1907: the file on the screen, revealing the file content to bystanders.
                   1908: The argument is ignored including the file name following it.
1.163     schwarze 1909: .It Sy "skipping display without arguments"
                   1910: .Pq mdoc
                   1911: A
                   1912: .Ic \&Bd
                   1913: block macro does not have any arguments.
                   1914: The block is discarded, and the block content is displayed in
                   1915: whatever mode was active before the block.
1.106     schwarze 1916: .It Sy "missing list type, using -item"
                   1917: .Pq mdoc
                   1918: A
                   1919: .Ic \&Bl
                   1920: macro fails to specify the list type.
1.194     schwarze 1921: .It Sy "argument is not numeric, using 1"
                   1922: .Pq roff
                   1923: The argument of a
                   1924: .Ic \&ce
                   1925: request is not a number.
1.106     schwarze 1926: .It Sy "missing manual name, using \(dq\(dq"
                   1927: .Pq mdoc
                   1928: The first call to
1.168     schwarze 1929: .Ic \&Nm ,
                   1930: or any call in the NAME section, lacks the required argument.
1.106     schwarze 1931: .It Sy "uname(3) system call failed, using UNKNOWN"
                   1932: .Pq mdoc
                   1933: The
                   1934: .Ic \&Os
                   1935: macro is called without arguments, and the
                   1936: .Xr uname 3
                   1937: system call failed.
                   1938: As a workaround,
                   1939: .Nm
                   1940: can be compiled with
                   1941: .Sm off
                   1942: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
                   1943: .Sm on
                   1944: .It Sy "unknown standard specifier"
                   1945: .Pq mdoc
                   1946: An
                   1947: .Ic \&St
                   1948: macro has an unknown argument and is discarded.
                   1949: .It Sy "skipping request without numeric argument"
1.118     schwarze 1950: .Pq roff , eqn
1.106     schwarze 1951: An
                   1952: .Ic \&it
1.118     schwarze 1953: request or an
                   1954: .Xr eqn 7
                   1955: .Ic \&size
                   1956: or
                   1957: .Ic \&gsize
                   1958: statement has a non-numeric or negative argument or no argument at all.
                   1959: The invalid request or statement is ignored.
1.132     schwarze 1960: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
                   1961: .Pq roff
                   1962: For security reasons,
                   1963: .Nm
                   1964: allows
                   1965: .Ic \&so
                   1966: file inclusion requests only with relative paths
                   1967: and only without ascending to any parent directory.
                   1968: By requesting the inclusion of a sensitive file, a malicious document
                   1969: might otherwise trick a privileged user into inadvertently displaying
                   1970: the file on the screen, revealing the file content to bystanders.
                   1971: .Nm
                   1972: only shows the path as it appears behind
                   1973: .Ic \&so .
                   1974: .It Sy ".so request failed"
                   1975: .Pq roff
                   1976: Servicing a
                   1977: .Ic \&so
                   1978: request requires reading an external file, but the file could not be
                   1979: opened.
                   1980: .Nm
                   1981: only shows the path as it appears behind
                   1982: .Ic \&so .
1.106     schwarze 1983: .It Sy "skipping all arguments"
                   1984: .Pq mdoc , man , eqn , roff
                   1985: An
                   1986: .Xr mdoc 7
                   1987: .Ic \&Bt ,
                   1988: .Ic \&Ed ,
                   1989: .Ic \&Ef ,
                   1990: .Ic \&Ek ,
                   1991: .Ic \&El ,
1.144     schwarze 1992: .Ic \&Lp ,
                   1993: .Ic \&Pp ,
1.106     schwarze 1994: .Ic \&Re ,
1.143     schwarze 1995: .Ic \&Rs ,
1.106     schwarze 1996: or
                   1997: .Ic \&Ud
                   1998: macro, an
                   1999: .Ic \&It
                   2000: macro in a list that don't support item heads, a
                   2001: .Xr man 7
                   2002: .Ic \&LP ,
                   2003: .Ic \&P ,
                   2004: or
                   2005: .Ic \&PP
                   2006: macro, an
                   2007: .Xr eqn 7
1.120     schwarze 2008: .Ic \&EQ
                   2009: or
1.106     schwarze 2010: .Ic \&EN
                   2011: macro, or a
                   2012: .Xr roff 7
1.148     schwarze 2013: .Ic \&br ,
                   2014: .Ic \&fi ,
                   2015: or
                   2016: .Ic \&nf
1.144     schwarze 2017: request or
1.106     schwarze 2018: .Sq \&..
                   2019: block closing request is invoked with at least one argument.
                   2020: All arguments are ignored.
                   2021: .It Sy "skipping excess arguments"
1.135     schwarze 2022: .Pq mdoc , man , roff
1.150     schwarze 2023: A macro or request is invoked with too many arguments:
                   2024: .Bl -dash -offset 2n -width 2n -compact
                   2025: .It
                   2026: .Ic \&Fo ,
1.206     schwarze 2027: .Ic \&MT ,
1.150     schwarze 2028: .Ic \&PD ,
                   2029: .Ic \&RS ,
                   2030: .Ic \&UR ,
                   2031: .Ic \&ft ,
                   2032: or
                   2033: .Ic \&sp
                   2034: with more than one argument
                   2035: .It
1.144     schwarze 2036: .Ic \&An
1.150     schwarze 2037: with another argument after
1.144     schwarze 2038: .Fl split
                   2039: or
1.150     schwarze 2040: .Fl nosplit
                   2041: .It
                   2042: .Ic \&RE
                   2043: with more than one argument or with a non-integer argument
                   2044: .It
                   2045: .Ic \&OP
                   2046: or a request of the
                   2047: .Ic \&de
                   2048: family with more than two arguments
1.154     schwarze 2049: .It
                   2050: .Ic \&Dt
                   2051: with more than three arguments
1.150     schwarze 2052: .It
                   2053: .Ic \&TH
                   2054: with more than five arguments
                   2055: .It
1.145     schwarze 2056: .Ic \&Bd ,
                   2057: .Ic \&Bk ,
                   2058: or
                   2059: .Ic \&Bl
1.150     schwarze 2060: with invalid arguments
                   2061: .El
1.106     schwarze 2062: The excess arguments are ignored.
1.133     schwarze 2063: .El
                   2064: .Ss Unsupported features
                   2065: .Bl -ohang
                   2066: .It Sy "input too large"
                   2067: .Pq mdoc , man
                   2068: Currently,
                   2069: .Nm
                   2070: cannot handle input files larger than its arbitrary size limit
                   2071: of 2^31 bytes (2 Gigabytes).
                   2072: Since useful manuals are always small, this is not a problem in practice.
                   2073: Parsing is aborted as soon as the condition is detected.
1.136     schwarze 2074: .It Sy "unsupported control character"
                   2075: .Pq roff
                   2076: An ASCII control character supported by other
                   2077: .Xr roff 7
                   2078: implementations but not by
                   2079: .Nm
                   2080: was found in an input file.
                   2081: It is replaced by a question mark.
1.133     schwarze 2082: .It Sy "unsupported roff request"
                   2083: .Pq roff
                   2084: An input file contains a
                   2085: .Xr roff 7
                   2086: request supported by GNU troff or Heirloom troff but not by
                   2087: .Nm ,
                   2088: and it is likely that this will cause information loss
                   2089: or considerable misformatting.
1.139     schwarze 2090: .It Sy "eqn delim option in tbl"
                   2091: .Pq eqn , tbl
                   2092: The options line of a table defines equation delimiters.
                   2093: Any equation source code contained in the table will be printed unformatted.
                   2094: .It Sy "unsupported table layout modifier"
1.138     schwarze 2095: .Pq tbl
                   2096: A table layout specification contains an
                   2097: .Sq Cm m
                   2098: modifier.
                   2099: The modifier is discarded.
1.133     schwarze 2100: .It Sy "ignoring macro in table"
1.139     schwarze 2101: .Pq tbl , mdoc , man
                   2102: A table contains an invocation of an
                   2103: .Xr mdoc 7
                   2104: or
                   2105: .Xr man 7
                   2106: macro or of an undefined macro.
                   2107: The macro is ignored, and its arguments are handled
                   2108: as if they were a text line.
1.106     schwarze 2109: .El
1.1       kristaps 2110: .Sh SEE ALSO
1.141     schwarze 2111: .Xr apropos 1 ,
                   2112: .Xr man 1 ,
1.85      kristaps 2113: .Xr eqn 7 ,
1.57      kristaps 2114: .Xr man 7 ,
1.13      kristaps 2115: .Xr mandoc_char 7 ,
1.84      kristaps 2116: .Xr mdoc 7 ,
                   2117: .Xr roff 7 ,
                   2118: .Xr tbl 7
1.173     schwarze 2119: .Sh HISTORY
                   2120: The
                   2121: .Nm
                   2122: utility first appeared in
                   2123: .Ox 4.8 .
                   2124: The option
                   2125: .Fl I
                   2126: appeared in
                   2127: .Ox 5.2 ,
                   2128: and
                   2129: .Fl aCcfhKklMSsw
                   2130: in
                   2131: .Ox 5.7 .
1.1       kristaps 2132: .Sh AUTHORS
1.156     schwarze 2133: .An -nosplit
1.1       kristaps 2134: The
                   2135: .Nm
1.26      kristaps 2136: utility was written by
1.141     schwarze 2137: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
                   2138: and is maintained by
                   2139: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .

CVSweb