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

Annotation of mandoc/mandoc.1, Revision 1.200

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

CVSweb