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

Annotation of mandoc/mandoc.1, Revision 1.228

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

CVSweb