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

Annotation of mandoc/mandoc.1, Revision 1.206

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

CVSweb