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

Annotation of mandoc/mandoc.1, Revision 1.115

1.115   ! schwarze    1: .\"    $Id: mandoc.1,v 1.114 2014/09/27 11:17:19 kristaps Exp $
1.1       kristaps    2: .\"
1.92      schwarze    3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.105     schwarze    4: .\" Copyright (c) 2012, 2014 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.115   ! schwarze   18: .Dd $Mdocdate: September 27 2014 $
1.14      kristaps   19: .Dt MANDOC 1
1.1       kristaps   20: .Os
                     21: .Sh NAME
                     22: .Nm mandoc
1.8       kristaps   23: .Nd format and display UNIX manuals
1.1       kristaps   24: .Sh SYNOPSIS
                     25: .Nm mandoc
1.110     schwarze   26: .Op Fl acfhklV
1.101     schwarze   27: .Sm off
                     28: .Op Fl I Cm os Li = Ar name
                     29: .Sm on
1.8       kristaps   30: .Op Fl m Ns Ar format
1.58      kristaps   31: .Op Fl O Ns Ar option
1.37      kristaps   32: .Op Fl T Ns Ar output
1.77      schwarze   33: .Op Fl W Ns Ar level
1.89      kristaps   34: .Op Ar
1.1       kristaps   35: .Sh DESCRIPTION
                     36: The
                     37: .Nm
1.26      kristaps   38: utility formats
1.8       kristaps   39: .Ux
1.57      kristaps   40: manual pages for display.
1.100     kristaps   41: .Pp
                     42: By default,
                     43: .Nm
                     44: reads
                     45: .Xr mdoc 7
                     46: or
                     47: .Xr man 7
                     48: text from stdin, implying
                     49: .Fl m Ns Cm andoc ,
                     50: and produces
                     51: .Fl T Ns Cm ascii
                     52: output.
                     53: .Pp
1.109     schwarze   54: The options are as follows:
1.19      kristaps   55: .Bl -tag -width Ds
1.107     schwarze   56: .It Fl a
                     57: If the standard output is a terminal device and
                     58: .Fl c
                     59: is not specified, use
                     60: .Xr more 1
                     61: to paginate the output, just like
                     62: .Xr man 1
                     63: would.
                     64: .It Fl c
                     65: Copy the formatted manual pages to the standard output without using
                     66: .Xr more 1
                     67: to paginate them.
                     68: This is the default.
                     69: It can be specified to override
                     70: .Fl a .
1.109     schwarze   71: .It Fl f
                     72: A synonym for
                     73: .Xr whatis 1 .
                     74: This overrides any earlier
                     75: .Fl k
                     76: and
                     77: .Fl l
                     78: options.
1.101     schwarze   79: .Sm off
                     80: .It Fl I Cm os Li = Ar name
                     81: .Sm on
                     82: Override the default operating system
                     83: .Ar name
                     84: for the
                     85: .Xr mdoc 7
                     86: .Sq \&Os
                     87: macro.
1.110     schwarze   88: .It Fl h
                     89: Display only the SYNOPSIS lines.
                     90: Implies
                     91: .Fl a .
1.109     schwarze   92: .It Fl k
                     93: A synonym for
                     94: .Xr apropos 1 .
                     95: This overrides any earlier
                     96: .Fl f
                     97: and
                     98: .Fl l
                     99: options.
                    100: .It Fl l
                    101: A synonym for
                    102: .Fl a .
                    103: Also reverts any earlier
                    104: .Fl f
                    105: and
                    106: .Fl k
                    107: options.
1.19      kristaps  108: .It Fl m Ns Ar format
1.57      kristaps  109: Input format.
                    110: See
1.8       kristaps  111: .Sx Input Formats
1.57      kristaps  112: for available formats.
                    113: Defaults to
1.58      kristaps  114: .Fl m Ns Cm andoc .
                    115: .It Fl O Ns Ar option
1.57      kristaps  116: Comma-separated output options.
1.19      kristaps  117: .It Fl T Ns Ar output
1.57      kristaps  118: Output format.
                    119: See
1.1       kristaps  120: .Sx Output Formats
1.57      kristaps  121: for available formats.
                    122: Defaults to
1.58      kristaps  123: .Fl T Ns Cm ascii .
1.1       kristaps  124: .It Fl V
                    125: Print version and exit.
1.77      schwarze  126: .It Fl W Ns Ar level
                    127: Specify the minimum message
                    128: .Ar level
                    129: to be reported on the standard error output and to affect the exit status.
                    130: The
                    131: .Ar level
                    132: can be
                    133: .Cm warning ,
                    134: .Cm error ,
                    135: or
                    136: .Cm fatal .
                    137: The default is
                    138: .Fl W Ns Cm fatal ;
1.58      kristaps  139: .Fl W Ns Cm all
1.77      schwarze  140: is an alias for
                    141: .Fl W Ns Cm warning .
                    142: See
                    143: .Sx EXIT STATUS
                    144: and
                    145: .Sx DIAGNOSTICS
                    146: for details.
                    147: .Pp
                    148: The special option
                    149: .Fl W Ns Cm stop
                    150: tells
                    151: .Nm
                    152: to exit after parsing a file that causes warnings or errors of at least
                    153: the requested level.
                    154: No formatted output will be produced from that file.
                    155: If both a
                    156: .Ar level
                    157: and
                    158: .Cm stop
                    159: are requested, they can be joined with a comma, for example
                    160: .Fl W Ns Cm error , Ns Cm stop .
1.58      kristaps  161: .It Ar file
                    162: Read input from zero or more files.
1.57      kristaps  163: If unspecified, reads from stdin.
                    164: If multiple files are specified,
1.2       kristaps  165: .Nm
                    166: will halt with the first failed parse.
1.1       kristaps  167: .El
1.109     schwarze  168: .Pp
                    169: In
                    170: .Fl f
                    171: and
                    172: .Fl k
                    173: mode,
                    174: .Nm
                    175: also supports the options
                    176: .Fl CMmOSsw
                    177: described in the
                    178: .Xr apropos 1
                    179: manual.
1.8       kristaps  180: .Ss Input Formats
                    181: The
                    182: .Nm
                    183: utility accepts
                    184: .Xr mdoc 7
                    185: and
                    186: .Xr man 7
                    187: input with
1.58      kristaps  188: .Fl m Ns Cm doc
1.8       kristaps  189: and
1.58      kristaps  190: .Fl m Ns Cm an ,
1.57      kristaps  191: respectively.
                    192: The
1.8       kristaps  193: .Xr mdoc 7
                    194: format is
                    195: .Em strongly
1.26      kristaps  196: recommended;
1.8       kristaps  197: .Xr man 7
                    198: should only be used for legacy manuals.
1.11      kristaps  199: .Pp
1.12      kristaps  200: A third option,
1.58      kristaps  201: .Fl m Ns Cm andoc ,
1.13      kristaps  202: which is also the default, determines encoding on-the-fly: if the first
1.26      kristaps  203: non-comment macro is
1.27      kristaps  204: .Sq \&Dd
1.13      kristaps  205: or
1.27      kristaps  206: .Sq \&Dt ,
1.26      kristaps  207: the
1.13      kristaps  208: .Xr mdoc 7
                    209: parser is used; otherwise, the
                    210: .Xr man 7
                    211: parser is used.
                    212: .Pp
                    213: If multiple
1.26      kristaps  214: files are specified with
1.58      kristaps  215: .Fl m Ns Cm andoc ,
1.57      kristaps  216: each has its file-type determined this way.
                    217: If multiple files are
1.13      kristaps  218: specified and
1.58      kristaps  219: .Fl m Ns Cm doc
1.12      kristaps  220: or
1.58      kristaps  221: .Fl m Ns Cm an
1.12      kristaps  222: is specified, then this format is used exclusively.
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.93      schwarze  229: .Bl -tag -width "-Tlocale"
1.58      kristaps  230: .It Fl T Ns Cm ascii
1.81      kristaps  231: Produce 7-bit ASCII output.
1.57      kristaps  232: This is the default.
                    233: See
1.48      kristaps  234: .Sx ASCII Output .
1.58      kristaps  235: .It Fl T Ns Cm html
1.114     kristaps  236: Produce CSS1/HTML5 output.
1.57      kristaps  237: See
1.48      kristaps  238: .Sx HTML Output .
1.58      kristaps  239: .It Fl T Ns Cm lint
                    240: Parse only: produce no output.
                    241: Implies
1.77      schwarze  242: .Fl W Ns Cm warning .
1.93      schwarze  243: .It Fl T Ns Cm locale
                    244: Encode output using the current locale.
                    245: See
                    246: .Sx Locale Output .
1.91      schwarze  247: .It Fl T Ns 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.73      kristaps  253: .It Fl T Ns Cm pdf
                    254: Produce PDF output.
                    255: See
                    256: .Sx PDF Output .
1.62      kristaps  257: .It Fl T Ns Cm ps
                    258: Produce PostScript output.
                    259: See
                    260: .Sx PostScript Output .
1.58      kristaps  261: .It Fl T Ns Cm tree
                    262: Produce an indented parse tree.
1.93      schwarze  263: .It Fl T Ns Cm utf8
                    264: Encode output in the UTF\-8 multi-byte format.
                    265: See
                    266: .Sx UTF\-8 Output .
1.58      kristaps  267: .It Fl T Ns Cm xhtml
1.114     kristaps  268: This is a synonym for
                    269: .Fl T Ns Cm html .
1.1       kristaps  270: .El
1.13      kristaps  271: .Pp
                    272: If multiple input files are specified, these will be processed by the
                    273: corresponding filter in-order.
1.66      kristaps  274: .Ss ASCII Output
                    275: Output produced by
                    276: .Fl T Ns Cm ascii ,
                    277: which is the default, is rendered in standard 7-bit ASCII documented in
                    278: .Xr ascii 7 .
                    279: .Pp
                    280: Font styles are applied by using back-spaced encoding such that an
                    281: underlined character
                    282: .Sq c
                    283: is rendered as
                    284: .Sq _ Ns \e[bs] Ns c ,
                    285: where
                    286: .Sq \e[bs]
                    287: is the back-space character number 8.
                    288: Emboldened characters are rendered as
                    289: .Sq c Ns \e[bs] Ns c .
                    290: .Pp
                    291: The special characters documented in
                    292: .Xr mandoc_char 7
                    293: are rendered best-effort in an ASCII equivalent.
1.87      kristaps  294: If no equivalent is found,
                    295: .Sq \&?
                    296: is used instead.
1.66      kristaps  297: .Pp
                    298: Output width is limited to 78 visible columns unless literal input lines
                    299: exceed this limit.
                    300: .Pp
                    301: The following
                    302: .Fl O
                    303: arguments are accepted:
1.19      kristaps  304: .Bl -tag -width Ds
1.98      schwarze  305: .It Cm indent Ns = Ns Ar indent
                    306: The left margin for normal text is set to
                    307: .Ar indent
                    308: blank characters instead of the default of five for
                    309: .Xr mdoc 7
                    310: and seven for
                    311: .Xr man 7 .
                    312: Increasing this is not recommended; it may result in degraded formatting,
1.99      schwarze  313: for example overfull lines or ugly line breaks.
1.66      kristaps  314: .It Cm width Ns = Ns Ar width
                    315: The output width is set to
                    316: .Ar width ,
                    317: which will normalise to \(>=60.
1.1       kristaps  318: .El
1.66      kristaps  319: .Ss HTML Output
                    320: Output produced by
                    321: .Fl T Ns Cm html
1.114     kristaps  322: conforms to HTML5 using optional self-closing tags.
1.66      kristaps  323: .Pp
1.61      kristaps  324: The
1.66      kristaps  325: .Pa example.style.css
1.83      kristaps  326: file documents style-sheet classes available for customising output.
                    327: If a style-sheet is not specified with
                    328: .Fl O Ns Ar style ,
                    329: .Fl T Ns Cm html
1.114     kristaps  330: defaults to simple output (via an embedded style-sheet)
                    331: readable in any graphical or text-based web
1.83      kristaps  332: browser.
1.66      kristaps  333: .Pp
1.89      kristaps  334: Special characters are rendered in decimal-encoded UTF\-8.
1.66      kristaps  335: .Pp
                    336: The following
1.64      kristaps  337: .Fl O
1.66      kristaps  338: arguments are accepted:
1.37      kristaps  339: .Bl -tag -width Ds
1.94      kristaps  340: .It Cm fragment
1.97      schwarze  341: Omit the
                    342: .Aq !DOCTYPE
                    343: declaration and the
                    344: .Aq html ,
                    345: .Aq head ,
                    346: and
                    347: .Aq body
                    348: elements and only emit the subtree below the
                    349: .Aq body
                    350: element.
1.94      kristaps  351: The
                    352: .Cm style
1.97      schwarze  353: argument will be ignored.
1.94      kristaps  354: This is useful when embedding manual content within existing documents.
1.64      kristaps  355: .It Cm includes Ns = Ns Ar fmt
1.40      kristaps  356: The string
                    357: .Ar fmt ,
1.49      kristaps  358: for example,
1.40      kristaps  359: .Ar ../src/%I.html ,
                    360: is used as a template for linked header files (usually via the
                    361: .Sq \&In
1.57      kristaps  362: macro).
                    363: Instances of
1.43      kristaps  364: .Sq \&%I
1.57      kristaps  365: are replaced with the include filename.
                    366: The default is not to present a
1.40      kristaps  367: hyperlink.
1.64      kristaps  368: .It Cm man Ns = Ns Ar fmt
1.39      kristaps  369: The string
                    370: .Ar fmt ,
1.49      kristaps  371: for example,
1.39      kristaps  372: .Ar ../html%S/%N.%S.html ,
                    373: is used as a template for linked manuals (usually via the
1.37      kristaps  374: .Sq \&Xr
1.57      kristaps  375: macro).
                    376: Instances of
1.43      kristaps  377: .Sq \&%N
1.40      kristaps  378: and
                    379: .Sq %S
                    380: are replaced with the linked manual's name and section, respectively.
1.57      kristaps  381: If no section is included, section 1 is assumed.
                    382: The default is not to
1.40      kristaps  383: present a hyperlink.
1.64      kristaps  384: .It Cm style Ns = Ns Ar style.css
1.58      kristaps  385: The file
                    386: .Ar style.css
                    387: is used for an external style-sheet.
                    388: This must be a valid absolute or
                    389: relative URI.
1.61      kristaps  390: .El
1.93      schwarze  391: .Ss Locale Output
                    392: Locale-depending output encoding is triggered with
                    393: .Fl T Ns Cm locale .
                    394: This option is not available on all systems: systems without locale
                    395: support, or those whose internal representation is not natively UCS-4,
                    396: will fall back to
                    397: .Fl T Ns Cm ascii .
                    398: See
                    399: .Sx ASCII Output
                    400: for font style specification and available command-line arguments.
1.95      kristaps  401: .Ss Man Output
                    402: Translate input format into
                    403: .Xr man 7
                    404: output format.
1.102     schwarze  405: This is useful for distributing manual sources to legacy systems
1.96      kristaps  406: lacking
1.95      kristaps  407: .Xr mdoc 7
                    408: formatters.
                    409: .Pp
                    410: If
                    411: .Xr mdoc 7
                    412: is passed as input, it is translated into
1.97      schwarze  413: .Xr man 7 .
                    414: If the input format is
1.95      kristaps  415: .Xr man 7 ,
1.97      schwarze  416: the input is copied to the output, expanding any
1.95      kristaps  417: .Xr roff 7
                    418: .Sq so
1.97      schwarze  419: requests.
                    420: The parser is also run, and as usual, the
                    421: .Fl W
                    422: level controls which
                    423: .Sx DIAGNOSTICS
                    424: are displayed before copying the input to the output.
1.93      schwarze  425: .Ss PDF Output
                    426: PDF-1.1 output may be generated by
                    427: .Fl T Ns Cm pdf .
                    428: See
                    429: .Sx PostScript Output
                    430: for
                    431: .Fl O
                    432: arguments and defaults.
1.62      kristaps  433: .Ss PostScript Output
1.65      kristaps  434: PostScript
                    435: .Qq Adobe-3.0
                    436: Level-2 pages may be generated by
1.62      kristaps  437: .Fl T Ns Cm ps .
1.67      kristaps  438: Output pages default to letter sized and are rendered in the Times font
1.70      kristaps  439: family, 11-point.
                    440: Margins are calculated as 1/9 the page length and width.
1.71      kristaps  441: Line-height is 1.4m.
1.66      kristaps  442: .Pp
                    443: Special characters are rendered as in
                    444: .Sx ASCII Output .
                    445: .Pp
                    446: The following
                    447: .Fl O
                    448: arguments are accepted:
                    449: .Bl -tag -width Ds
                    450: .It Cm paper Ns = Ns Ar name
                    451: The paper size
                    452: .Ar name
                    453: may be one of
1.68      kristaps  454: .Ar a3 ,
                    455: .Ar a4 ,
                    456: .Ar a5 ,
                    457: .Ar legal ,
1.66      kristaps  458: or
                    459: .Ar letter .
1.68      kristaps  460: You may also manually specify dimensions as
                    461: .Ar NNxNN ,
                    462: width by height in millimetres.
                    463: If an unknown value is encountered,
                    464: .Ar letter
                    465: is used.
1.66      kristaps  466: .El
1.93      schwarze  467: .Ss UTF\-8 Output
                    468: Use
                    469: .Fl T Ns Cm utf8
                    470: to force a UTF\-8 locale.
1.73      kristaps  471: See
1.93      schwarze  472: .Sx Locale Output
                    473: for details and options.
1.108     schwarze  474: .Sh ENVIRONMENT
                    475: .Bl -tag -width MANPAGER
                    476: .It Ev MANPAGER
                    477: Any non-empty value of the environment variable
                    478: .Ev MANPAGER
                    479: will be used instead of the standard pagination program,
                    480: .Xr more 1 .
                    481: .It Ev PAGER
                    482: Specifies the pagination program to use when
                    483: .Ev MANPAGER
                    484: is not defined.
                    485: If neither PAGER nor MANPAGER is defined,
                    486: .Pa /usr/bin/more Fl s
                    487: will be used.
                    488: .El
1.77      schwarze  489: .Sh EXIT STATUS
                    490: The
                    491: .Nm
                    492: utility exits with one of the following values, controlled by the message
                    493: .Ar level
                    494: associated with the
                    495: .Fl W
                    496: option:
                    497: .Pp
                    498: .Bl -tag -width Ds -compact
                    499: .It 0
                    500: No warnings or errors occurred, or those that did were ignored because
                    501: they were lower than the requested
                    502: .Ar level .
                    503: .It 2
                    504: At least one warning occurred, but no error, and
                    505: .Fl W Ns Cm warning
                    506: was specified.
                    507: .It 3
                    508: At least one parsing error occurred, but no fatal error, and
                    509: .Fl W Ns Cm error
                    510: or
                    511: .Fl W Ns Cm warning
                    512: was specified.
                    513: .It 4
                    514: A fatal parsing error occurred.
                    515: .It 5
                    516: Invalid command line arguments were specified.
                    517: No input files have been read.
                    518: .It 6
                    519: An operating system error occurred, for example memory exhaustion or an
                    520: error accessing input files.
                    521: Such errors cause
                    522: .Nm
                    523: to exit at once, possibly in the middle of parsing or formatting a file.
                    524: .El
                    525: .Pp
                    526: Note that selecting
                    527: .Fl T Ns Cm lint
                    528: output mode implies
                    529: .Fl W Ns Cm warning .
1.1       kristaps  530: .Sh EXAMPLES
1.13      kristaps  531: To page manuals to the terminal:
1.1       kristaps  532: .Pp
1.82      kristaps  533: .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
                    534: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.28      kristaps  535: .Pp
1.41      kristaps  536: To produce HTML manuals with
                    537: .Ar style.css
                    538: as the style-sheet:
1.38      kristaps  539: .Pp
1.82      kristaps  540: .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
1.38      kristaps  541: .Pp
1.28      kristaps  542: To check over a large set of manuals:
                    543: .Pp
1.77      schwarze  544: .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
1.66      kristaps  545: .Pp
                    546: To produce a series of PostScript manuals for A4 paper:
                    547: .Pp
1.82      kristaps  548: .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.91      schwarze  549: .Pp
                    550: Convert a modern
                    551: .Xr mdoc 7
                    552: manual to the older
                    553: .Xr man 7
                    554: format, for use on systems lacking an
                    555: .Xr mdoc 7
                    556: parser:
                    557: .Pp
                    558: .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
1.77      schwarze  559: .Sh DIAGNOSTICS
1.106     schwarze  560: Messages displayed by
                    561: .Nm
                    562: follow this format:
1.77      schwarze  563: .Pp
1.106     schwarze  564: .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
1.77      schwarze  565: .Pp
1.106     schwarze  566: Line and column numbers start at 1.
                    567: Both are omitted for messages referring to an input file as a whole.
                    568: Macro names and arguments are omitted where meaningless.
                    569: Fatal messages about invalid command line arguments
                    570: or operating system errors, for example when memory is exhausted,
                    571: may also omit the
                    572: .Ar file
1.104     schwarze  573: and
1.106     schwarze  574: .Ar level
                    575: fields.
1.104     schwarze  576: .Pp
1.77      schwarze  577: Message levels have the following meanings:
                    578: .Bl -tag -width "warning"
1.105     schwarze  579: .It Cm syserr
                    580: Opening or reading an input file failed, so the parser cannot
                    581: even be started and no output is produced from that input file.
1.77      schwarze  582: .It Cm fatal
                    583: The parser is unable to parse a given input file at all.
                    584: No formatted output is produced from that input file.
                    585: .It Cm error
                    586: An input file contains syntax that cannot be safely interpreted,
                    587: either because it is invalid or because
                    588: .Nm
                    589: does not implement it yet.
                    590: By discarding part of the input or inserting missing tokens,
                    591: the parser is able to continue, and the error does not prevent
                    592: generation of formatted output, but typically, preparing that
                    593: output involves information loss, broken document structure
                    594: or unintended formatting.
                    595: .It Cm warning
                    596: An input file uses obsolete, discouraged or non-portable syntax.
                    597: All the same, the meaning of the input is unambiguous and a correct
                    598: rendering can be produced.
                    599: Documents causing warnings may render poorly when using other
                    600: formatting tools instead of
                    601: .Nm .
                    602: .El
                    603: .Pp
                    604: Messages of the
                    605: .Cm warning
                    606: and
                    607: .Cm error
                    608: levels are hidden unless their level, or a lower level, is requested using a
                    609: .Fl W
                    610: option or
                    611: .Fl T Ns Cm lint
                    612: output mode.
1.106     schwarze  613: .Ss Warnings related to the document prologue
                    614: .Bl -ohang
                    615: .It Sy "missing manual title, using UNTITLED"
                    616: .Pq mdoc
                    617: A
                    618: .Ic \&Dt
                    619: macro has no arguments, or there is no
                    620: .Ic \&Dt
                    621: macro before the first non-prologue macro.
                    622: .It Sy "missing manual title, using \(dq\(dq"
                    623: .Pq man
                    624: There is no
                    625: .Ic \&TH
                    626: macro, or it has no arguments.
                    627: .It Sy "lower case character in document title"
                    628: .Pq mdoc , man
                    629: The title is still used as given in the
                    630: .Ic \&Dt
                    631: or
                    632: .Ic \&TH
                    633: macro.
                    634: .It Sy "missing manual section, using \(dq\(dq"
                    635: .Pq mdoc , man
                    636: A
                    637: .Ic \&Dt
                    638: or
                    639: .Ic \&TH
                    640: macro lacks the mandatory section argument.
                    641: .It Sy "unknown manual section"
                    642: .Pq mdoc
                    643: The section number in a
                    644: .Ic \&Dt
                    645: line is invalid, but still used.
                    646: .It Sy "unknown manual volume or arch"
                    647: .Pq mdoc
                    648: The volume name in a
                    649: .Ic \&Dt
                    650: line is invalid, but still used.
                    651: The manual is assumed to be architecture-independent.
                    652: .It Sy "missing date, using today's date"
                    653: .Pq mdoc, man
                    654: The document was parsed as
                    655: .Xr mdoc 7
                    656: and it has no
                    657: .Ic \&Dd
                    658: macro, or the
                    659: .Ic \&Dd
                    660: macro has no arguments or only empty arguments;
                    661: or the document was parsed as
                    662: .Xr man 7
                    663: and it has no
                    664: .Ic \&TH
                    665: macro, or the
                    666: .Ic \&TH
                    667: macro has less than three arguments or its third argument is empty.
                    668: .It Sy "cannot parse date, using it verbatim"
                    669: .Pq mdoc , man
                    670: The date given in a
                    671: .Ic \&Dd
                    672: or
                    673: .Ic \&TH
                    674: macro does not follow the conventional format.
                    675: .It Sy "missing Os macro, using \(dq\(dq"
                    676: .Pq mdoc
                    677: The default or current system is not shown in this case.
                    678: .It Sy "duplicate prologue macro"
                    679: .Pq mdoc
                    680: One of the prologue macros occurs more than once.
                    681: The last instance overrides all previous ones.
                    682: .It Sy "late prologue macro"
                    683: .Pq mdoc
                    684: A
                    685: .Ic \&Dd
                    686: or
                    687: .Ic \&Os
                    688: macro occurs after some non-prologue macro, but still takes effect.
                    689: .It Sy "skipping late title macro"
                    690: .Pq mdoc
                    691: The
                    692: .Ic \&Dt
                    693: macro can only occur before the first non-prologue macro
                    694: because traditional formatters write the page header
                    695: before parsing the document body.
                    696: Even though this technical restriction does not apply to
                    697: .Nm ,
                    698: traditional semantics is preserved.
                    699: The late macro is discarded including its arguments.
                    700: .It Sy "prologue macros out of order"
                    701: .Pq mdoc
                    702: The prologue macros are not given in the conventional order
                    703: .Ic \&Dd ,
                    704: .Ic \&Dt ,
                    705: .Ic \&Os .
                    706: All three macros are used even when given in another order.
                    707: .El
                    708: .Ss Warnings regarding document structure
                    709: .Bl -ohang
                    710: .It Sy ".so is fragile, better use ln(1)"
                    711: .Pq roff
                    712: Including files only works when the parser program runs with the correct
                    713: current working directory.
                    714: .It Sy "no document body"
                    715: .Pq mdoc , man
                    716: The document body contains neither text nor macros.
                    717: An empty document is shown, consisting only of a header and a footer line.
                    718: .It Sy "content before first section header"
                    719: .Pq mdoc , man
                    720: Some macros or text precede the first
                    721: .Ic \&Sh
                    722: or
                    723: .Ic \&SH
                    724: section header.
                    725: The offending macros and text are parsed and added to the top level
                    726: of the syntax tree, outside any section block.
                    727: .It Sy "first section is not NAME"
                    728: .Pq mdoc
                    729: The argument of the first
                    730: .Ic \&Sh
                    731: macro is not
                    732: .Sq NAME .
                    733: This may confuse
                    734: .Xr makewhatis 8
                    735: and
                    736: .Xr apropos 1 .
                    737: .It Sy "bad NAME section contents"
                    738: .Pq mdoc
                    739: The last node in the NAME section is not an
                    740: .Ic \&Nd
                    741: macro, or any preceding macro is not
                    742: .Ic \&Nm ,
                    743: or the NAME section is completely empty.
                    744: This may confuse
                    745: .Xr makewhatis 8
                    746: and
                    747: .Xr apropos 1 .
                    748: .It Sy "sections out of conventional order"
                    749: .Pq mdoc
                    750: A standard section occurs after another section it usually precedes.
                    751: All section titles are used as given,
                    752: and the order of sections is not changed.
                    753: .It Sy "duplicate section title"
                    754: .Pq mdoc
                    755: The same standard section title occurs more than once.
                    756: .It Sy "unexpected section"
                    757: .Pq mdoc
                    758: A standard section header occurs in a section of the manual
                    759: where it normally isn't useful.
1.112     schwarze  760: .It Sy "unusual Xr order"
                    761: .Pq mdoc
                    762: In the SEE ALSO section, an
                    763: .Ic \&Xr
                    764: macro with a lower section number follows one with a higher number,
                    765: or two
                    766: .Ic \&Xr
                    767: macros refering to the same section are out of alphabetical order.
                    768: .It Sy "unusual Xr punctuation"
                    769: .Pq mdoc
                    770: In the SEE ALSO section, punctuation between two
                    771: .Ic \&Xr
                    772: macros differs from a single comma, or there is trailing punctuation
                    773: after the last
                    774: .Ic \&Xr
                    775: macro.
1.111     schwarze  776: .It Sy "AUTHORS section without An macro"
                    777: .Pq mdoc
                    778: An AUTHORS sections contains no
                    779: .Ic \&An
                    780: macros, or only empty ones.
                    781: Probably, there are author names lacking markup.
1.106     schwarze  782: .El
                    783: .Ss "Warnings related to macros and nesting"
                    784: .Bl -ohang
                    785: .It Sy "obsolete macro"
                    786: .Pq mdoc
                    787: See the
                    788: .Xr mdoc 7
                    789: manual for replacements.
                    790: .It Sy "skipping paragraph macro"
                    791: In
                    792: .Xr mdoc 7
                    793: documents, this happens
                    794: .Bl -dash -compact
                    795: .It
                    796: at the beginning and end of sections and subsections
                    797: .It
                    798: right before non-compact lists and displays
                    799: .It
                    800: at the end of items in non-column, non-compact lists
                    801: .It
                    802: and for multiple consecutive paragraph macros.
                    803: .El
                    804: In
                    805: .Xr man 7
                    806: documents, it happens
                    807: .Bl -dash -compact
                    808: .It
                    809: for empty
                    810: .Ic \&P ,
                    811: .Ic \&PP ,
                    812: and
                    813: .Ic \&LP
                    814: macros
                    815: .It
                    816: for
                    817: .Ic \&IP
                    818: macros having neither head nor body arguments
                    819: .It
                    820: for
                    821: .Ic \&br
                    822: or
                    823: .Ic \&sp
                    824: right after
                    825: .Ic \&SH
                    826: or
                    827: .Ic \&SS
                    828: .El
                    829: .It Sy "moving paragraph macro out of list"
                    830: .Pq mdoc
                    831: A list item in a
                    832: .Ic \&Bl
                    833: list contains a trailing paragraph macro.
                    834: The paragraph macro is moved after the end of the list.
                    835: .It Sy "skipping no-space macro"
                    836: .Pq mdoc
                    837: An input line begins with an
                    838: .Ic \&Ns
                    839: macro.
                    840: The macro is ignored.
                    841: .It Sy "blocks badly nested"
                    842: .Pq mdoc
                    843: If two blocks intersect, one should completely contain the other.
                    844: Otherwise, rendered output is likely to look strange in any output
                    845: format, and rendering in SGML-based output formats is likely to be
                    846: outright wrong because such languages do not support badly nested
                    847: blocks at all.
                    848: Typical examples of badly nested blocks are
                    849: .Qq Ic \&Ao \&Bo \&Ac \&Bc
                    850: and
                    851: .Qq Ic \&Ao \&Bq \&Ac .
                    852: In these examples,
                    853: .Ic \&Ac
                    854: breaks
                    855: .Ic \&Bo
                    856: and
                    857: .Ic \&Bq ,
                    858: respectively.
                    859: .It Sy "nested displays are not portable"
                    860: .Pq mdoc
                    861: A
                    862: .Ic \&Bd ,
                    863: .Ic \&D1 ,
                    864: or
                    865: .Ic \&Dl
                    866: display occurs nested inside another
                    867: .Ic \&Bd
                    868: display.
                    869: This works with
                    870: .Nm ,
                    871: but fails with most other implementations.
                    872: .It Sy "moving content out of list"
                    873: .Pq mdoc
                    874: A
                    875: .Ic \&Bl
                    876: list block contains text or macros before the first
                    877: .Ic \&It
                    878: macro.
                    879: The offending children are moved before the beginning of the list.
                    880: .It Sy ".Vt block has child macro"
                    881: .Pq mdoc
                    882: The
                    883: .Ic \&Vt
                    884: macro supports plain text arguments only.
                    885: Formatting may be ugly and semantic searching
                    886: for the affected content might not work.
                    887: .It Sy "fill mode already enabled, skipping"
                    888: .Pq man
                    889: A
                    890: .Ic \&fi
                    891: request occurs even though the document is still in fill mode,
                    892: or already switched back to fill mode.
                    893: It has no effect.
                    894: .It Sy "fill mode already disabled, skipping"
                    895: .Pq man
                    896: An
                    897: .Ic \&nf
                    898: request occurs even though the document already switched to no-fill mode
                    899: and did not switch back to fill mode yet.
                    900: It has no effect.
                    901: .It Sy "line scope broken"
                    902: .Pq man
                    903: While parsing the next-line scope of the previous macro,
                    904: another macro is found that prematurely terminates the previous one.
                    905: The previous, interrupted macro is deleted from the parse tree.
                    906: .El
                    907: .Ss "Warnings related to missing arguments"
                    908: .Bl -ohang
                    909: .It Sy "skipping empty request"
                    910: .Pq roff
                    911: The macro name is missing from a macro definition request.
                    912: .It Sy "conditional request controls empty scope"
                    913: .Pq roff
                    914: A conditional request is only useful if any of the following
                    915: follows it on the same logical input line:
                    916: .Bl -dash -compact
                    917: .It
                    918: The
                    919: .Sq \e{
                    920: keyword to open a multi-line scope.
                    921: .It
                    922: A request or macro or some text, resulting in a single-line scope.
                    923: .It
                    924: The immediate end of the logical line without any intervening whitespace,
                    925: resulting in next-line scope.
                    926: .El
                    927: Here, a conditional request is followed by trailing whitespace only,
                    928: and there is no other content on its logical input line.
                    929: Note that it doesn't matter whether the logical input line is split
                    930: across multiple physical input lines using
                    931: .Sq \e
                    932: line continuation characters.
                    933: This is one of the rare cases
                    934: where trailing whitespace is syntactically significant.
                    935: The conditional request controls a scope containing whitespace only,
                    936: so it is unlikely to have a significant effect,
                    937: except that it may control a following
                    938: .Ic \&el
                    939: clause.
                    940: .It Sy "skipping empty macro"
                    941: .Pq mdoc
                    942: The indicated macro has no arguments and hence no effect.
                    943: .It Sy "empty argument, using 0n"
                    944: .Pq mdoc
                    945: The required width is missing after
                    946: .Ic \&Bd
                    947: or
                    948: .Ic \&Bl
                    949: .Fl offset
                    950: or
                    951: .Fl width.
                    952: .It Sy "argument count wrong"
                    953: .Pq mdoc , man
                    954: The indicated macro has too few or too many arguments.
                    955: The syntax tree will contain the wrong number of arguments as given.
                    956: Formatting behaviour depends on the specific macro in question.
                    957: Note that the same message may also occur as an ERROR, see below.
                    958: .It Sy "missing display type, using -ragged"
                    959: .Pq mdoc
                    960: The
                    961: .Ic \&Bd
                    962: macro is invoked without the required display type.
                    963: .It Sy "list type is not the first argument"
                    964: .Pq mdoc
                    965: In a
                    966: .Ic \&Bl
                    967: macro, at least one other argument precedes the type argument.
                    968: The
                    969: .Nm
                    970: utility copes with any argument order, but some other
                    971: .Xr mdoc 7
                    972: implementations do not.
                    973: .It Sy "missing -width in -tag list, using 8n"
                    974: .Pq mdoc
                    975: Every
                    976: .Ic \&Bl
                    977: macro having the
                    978: .Fl tag
                    979: argument requires
                    980: .Fl width ,
                    981: too.
                    982: .It Sy "missing utility name, using \(dq\(dq"
                    983: .Pq mdoc
                    984: The
                    985: .Ic \&Ex Fl std
                    986: macro is called without an argument before
                    987: .Ic \&Nm
                    988: has first been called with an argument.
                    989: .It Sy "empty head in list item"
                    990: .Pq mdoc
                    991: In a
                    992: .Ic \&Bl
                    993: .Fl diag ,
                    994: .Fl hang ,
                    995: .Fl inset ,
                    996: .Fl ohang ,
                    997: or
                    998: .Fl tag
                    999: list, an
                   1000: .Ic \&It
                   1001: macro lacks the required argument.
                   1002: The item head is left empty.
                   1003: .It Sy "empty list item"
                   1004: .Pq mdoc
                   1005: In a
                   1006: .Ic \&Bl
                   1007: .Fl bullet ,
                   1008: .Fl dash ,
                   1009: .Fl enum ,
                   1010: or
                   1011: .Fl hyphen
                   1012: list, an
                   1013: .Ic \&It
                   1014: block is empty.
                   1015: An empty list item is shown.
                   1016: .It Sy "missing font type"
                   1017: .Pq mdoc
                   1018: A
                   1019: .Ic \&Bf
                   1020: macro has no argument.
                   1021: It switches to the default font,
                   1022: .Cm \efR .
                   1023: .It Sy "unknown font type"
                   1024: .Pq mdoc
                   1025: The
                   1026: .Ic \&Bf
                   1027: argument is invalid.
                   1028: The default font
                   1029: .Cm \efR
                   1030: is used instead.
                   1031: .It Sy "missing -std argument, adding it"
                   1032: .Pq mdoc
                   1033: An
                   1034: .Ic \&Ex
                   1035: or
                   1036: .Ic \&Rv
                   1037: macro lacks the required
                   1038: .Fl std
                   1039: argument.
                   1040: The
                   1041: .Nm
                   1042: utility assumes
                   1043: .Fl std
                   1044: even when it is not specified, but other implementations may not.
                   1045: .El
                   1046: .Ss "Warnings related to bad macro arguments"
                   1047: .Bl -ohang
                   1048: .It Sy "unterminated quoted argument"
                   1049: .Pq roff
                   1050: Macro arguments can be enclosed in double quote characters
                   1051: such that space characters and macro names contained in the quoted
                   1052: argument need not be escaped.
                   1053: The closing quote of the last argument of a macro can be omitted.
                   1054: However, omitting it is not recommended because it makes the code
                   1055: harder to read.
                   1056: .It Sy "duplicate argument"
                   1057: .Pq mdoc
                   1058: A
                   1059: .Ic \&Bd
                   1060: or
                   1061: .Ic \&Bl
                   1062: macro has more than one
                   1063: .Fl compact ,
                   1064: more than one
                   1065: .Fl offset ,
                   1066: or more than one
                   1067: .Fl width
                   1068: argument.
                   1069: All but the last instances of these arguments are ignored.
                   1070: .It Sy "skipping duplicate argument"
                   1071: .Pq mdoc
                   1072: An
                   1073: .Ic \&An
                   1074: macro has more than one
                   1075: .Fl split
                   1076: or
                   1077: .Fl nosplit
                   1078: argument.
                   1079: All but the first of these arguments are ignored.
                   1080: .It Sy "skipping duplicate display type"
                   1081: .Pq mdoc
                   1082: A
                   1083: .Ic \&Bd
                   1084: macro has more than one type argument; the first one is used.
                   1085: .It Sy "skipping duplicate list type"
                   1086: .Pq mdoc
                   1087: A
                   1088: .Ic \&Bl
                   1089: macro has more than one type argument; the first one is used.
                   1090: .It Sy "skipping -width argument"
                   1091: .Pq mdoc
                   1092: A
                   1093: .Ic \&Bl
                   1094: .Fl column ,
                   1095: .Fl diag ,
                   1096: .Fl ohang ,
                   1097: .Fl inset ,
                   1098: or
                   1099: .Fl item
                   1100: list has a
                   1101: .Fl width
                   1102: argument.
                   1103: That has no effect.
                   1104: .It Sy "unknown AT&T UNIX version"
                   1105: .Pq mdoc
                   1106: An
                   1107: .Ic \&At
                   1108: macro has an invalid argument.
                   1109: It is used verbatim, with
                   1110: .Qq "AT&T UNIX "
                   1111: prefixed to it.
1.113     schwarze 1112: .It Sy "comma in function argument"
                   1113: .Pq mdoc
                   1114: An argument of an
                   1115: .Ic \&Fa
                   1116: or
                   1117: .Ic \&Fn
                   1118: macro contains a comma; it should probably be split into two arguments.
1.106     schwarze 1119: .It Sy "invalid content in Rs block"
                   1120: .Pq mdoc
                   1121: An
                   1122: .Ic \&Rs
                   1123: block contains plain text or non-% macros.
                   1124: The bogus content is left in the syntax tree.
                   1125: Formatting may be poor.
                   1126: .It Sy "invalid Boolean argument"
                   1127: .Pq mdoc
                   1128: An
                   1129: .Ic \&Sm
                   1130: macro has an argument other than
                   1131: .Cm on
                   1132: or
                   1133: .Cm off .
                   1134: The invalid argument is moved out of the macro, which leaves the macro
                   1135: empty, causing it to toggle the spacing mode.
                   1136: .It Sy "unknown font, skipping request"
1.115   ! schwarze 1137: .Pq man , tbl
1.106     schwarze 1138: A
                   1139: .Xr roff 7
                   1140: .Ic \&ft
1.115   ! schwarze 1141: request or a
        !          1142: .Xr tbl 7
        !          1143: .Ic \&f
        !          1144: layout modifier has an unknown
        !          1145: .Ar font
        !          1146: argument.
1.106     schwarze 1147: .El
                   1148: .Ss "Warnings related to plain text"
                   1149: .Bl -ohang
                   1150: .It Sy "blank line in fill mode, using .sp"
                   1151: .Pq mdoc
                   1152: The meaning of blank input lines is only well-defined in non-fill mode:
                   1153: In fill mode, line breaks of text input lines are not supposed to be
                   1154: significant.
                   1155: However, for compatibility with groff, blank lines in fill mode
                   1156: are replaced with
                   1157: .Ic \&sp
                   1158: requests.
                   1159: .It Sy "tab in filled text"
                   1160: .Pq mdoc , man
                   1161: The meaning of tab characters is only well-defined in non-fill mode:
                   1162: In fill mode, whitespace is not supposed to be significant
                   1163: on text input lines.
                   1164: As an implementation dependent choice, tab characters on text lines
                   1165: are passed through to the formatters in any case.
                   1166: Given that the text before the tab character will be filled,
                   1167: it is hard to predict which tab stop position the tab will advance to.
                   1168: .It Sy "whitespace at end of input line"
                   1169: .Pq mdoc , man , roff
                   1170: Whitespace at the end of input lines is almost never semantically
                   1171: significant \(em but in the odd case where it might be, it is
                   1172: extremely confusing when reviewing and maintaining documents.
                   1173: .It Sy "bad comment style"
                   1174: .Pq roff
                   1175: Comment lines start with a dot, a backslash, and a double-quote character.
                   1176: The
                   1177: .Nm
                   1178: utility treats the line as a comment line even without the backslash,
                   1179: but leaving out the backslash might not be portable.
                   1180: .It Sy "invalid escape sequence"
                   1181: .Pq roff
                   1182: An escape sequence has an invalid opening argument delimiter, lacks the
                   1183: closing argument delimiter, or the argument has too few characters.
                   1184: If the argument is incomplete,
                   1185: .Ic \e*
                   1186: and
                   1187: .Ic \en
                   1188: expand to an empty string,
                   1189: .Ic \eB
                   1190: to the digit
                   1191: .Sq 0 ,
                   1192: and
                   1193: .Ic \ew
                   1194: to the length of the incomplete argument.
                   1195: All other invalid escape sequences are ignored.
                   1196: .It Sy "undefined string, using \(dq\(dq"
                   1197: .Pq roff
                   1198: If a string is used without being defined before,
                   1199: its value is implicitly set to the empty string.
                   1200: However, defining strings explicitly before use
                   1201: keeps the code more readable.
                   1202: .El
                   1203: .Ss "Errors related to equations"
                   1204: .Bl -inset -compact
                   1205: .It "unexpected equation scope closure"
                   1206: .It "equation scope open on exit"
                   1207: .It "overlapping equation scopes"
                   1208: .It "unexpected end of equation"
                   1209: .It "equation syntax error"
                   1210: .El
                   1211: .Ss "Errors related to tables"
                   1212: .Bl -inset -compact
                   1213: .It "bad table syntax"
                   1214: .It "bad table option"
                   1215: .It "bad table layout"
                   1216: .It "no table layout cells specified"
                   1217: .It "no table data cells specified"
                   1218: .It "ignore data in cell"
                   1219: .It "data block still open"
                   1220: .It "ignoring extra data cells"
                   1221: .El
                   1222: .Ss "Errors related to roff, mdoc, and man code"
                   1223: .Bl -ohang
                   1224: .It Sy "input stack limit exceeded, infinite loop?"
                   1225: .Pq roff
                   1226: Explicit recursion limits are implemented for the following features,
                   1227: in order to prevent infinite loops:
                   1228: .Bl -dash -compact
                   1229: .It
                   1230: expansion of nested escape sequences
                   1231: including expansion of strings and number registers,
                   1232: .It
                   1233: expansion of nested user-defined macros,
                   1234: .It
                   1235: and
                   1236: .Ic \&so
                   1237: file inclusion.
                   1238: .El
                   1239: When a limit is hit, the output is incorrect, typically losing
                   1240: some content, but the parser can continue.
                   1241: .It Sy "skipping bad character"
                   1242: .Pq mdoc , man , roff
                   1243: The input file contains a byte that is not a printable
                   1244: .Xr ascii 7
                   1245: character.
                   1246: The message mentions the character number.
                   1247: The offending byte is replaced with a question mark
                   1248: .Pq Sq \&? .
                   1249: Consider editing the input file to replace the byte with an ASCII
                   1250: transliteration of the intended character.
                   1251: .It Sy "skipping unknown macro"
                   1252: .Pq mdoc , man , roff
                   1253: The first identifier on a request or macro line is neither recognized as a
                   1254: .Xr roff 7
                   1255: request, nor as a user-defined macro, nor, respectively, as an
                   1256: .Xr mdoc 7
                   1257: or
                   1258: .Xr man 7
                   1259: macro.
                   1260: It may be mistyped or unsupported.
                   1261: The request or macro is discarded including its arguments.
                   1262: .It Sy "skipping item outside list"
                   1263: .Pq mdoc
                   1264: An
                   1265: .Ic \&It
                   1266: macro occurs outside any
                   1267: .Ic \&Bl
                   1268: list.
                   1269: It is discarded including its arguments.
                   1270: .It Sy "skipping column outside column list"
                   1271: .Pq mdoc
                   1272: A
                   1273: .Ic \&Ta
                   1274: macro occurs outside any
                   1275: .Ic \&Bl Fl column
                   1276: block.
                   1277: It is discarded including its arguments.
                   1278: .It Sy "skipping end of block that is not open"
                   1279: .Pq mdoc , man , eqn , tbl , roff
                   1280: Various syntax elements can only be used to explicitly close blocks
                   1281: that have previously been opened.
                   1282: An
                   1283: .Xr mdoc 7
                   1284: block closing macro, a
                   1285: .Xr man 7
                   1286: .Ic \&RE
                   1287: or
                   1288: .Ic \&UE
                   1289: macro, or the end of an equation, table, or
                   1290: .Xr roff 7
                   1291: conditional request is encountered but no matching block is open.
                   1292: The offending request or macro is discarded.
                   1293: .It Sy "inserting missing end of block"
                   1294: .Pq mdoc , tbl
                   1295: Various
                   1296: .Xr mdoc 7
                   1297: macros as well as tables require explicit closing by dedicated macros.
                   1298: A block that doesn't support bad nesting
                   1299: ends before all of its children are properly closed.
                   1300: The open child nodes are closed implicitly.
                   1301: .It Sy "scope open on exit"
                   1302: .Pq mdoc , man , eqn , tbl , roff
                   1303: At the end of the document, an explicit
                   1304: .Xr mdoc 7
                   1305: block, a
                   1306: .Xr man 7
                   1307: next-line scope or
                   1308: .Ic \&RS
                   1309: or
                   1310: .Ic \&UR
                   1311: block, an equation, table, or
                   1312: .Xr roff 7
                   1313: conditional or ignore block is still open.
                   1314: The open block is closed implicitly.
                   1315: .It Sy "escaped character not allowed in a name"
                   1316: .Pq roff
                   1317: Macro, string and register identifiers consist of printable,
                   1318: non-whitespace ASCII characters.
                   1319: Escape sequences and characters and strings expressed in terms of them
                   1320: cannot form part of a name.
                   1321: The first argument of an
                   1322: .Ic \&am ,
                   1323: .Ic \&as ,
                   1324: .Ic \&de ,
                   1325: .Ic \&ds ,
                   1326: .Ic \&nr ,
                   1327: or
                   1328: .Ic \&rr
                   1329: request, or any argument of an
                   1330: .Ic \&rm
                   1331: request, or the name of a request or user defined macro being called,
                   1332: is terminated by an escape sequence.
                   1333: In the cases of
                   1334: .Ic \&as ,
                   1335: .Ic \&ds ,
                   1336: and
                   1337: .Ic \&nr ,
                   1338: the request has no effect at all.
                   1339: In the cases of
                   1340: .Ic \&am ,
                   1341: .Ic \&de ,
                   1342: .Ic \&rr ,
                   1343: and
                   1344: .Ic \&rm ,
                   1345: what was parsed up to this point is used as the arguments to the request,
                   1346: and the rest of the input line is discarded including the escape sequence.
                   1347: When parsing for a request or a user-defined macro name to be called,
                   1348: only the escape sequence is discarded.
                   1349: The characters preceding it are used as the request or macro name,
                   1350: the characters following it are used as the arguments to the request or macro.
                   1351: .It Sy "argument count wrong"
                   1352: .Pq mdoc , man , roff
                   1353: The indicated request or macro has too few or too many arguments.
                   1354: The syntax tree will contain the wrong number of arguments as given.
                   1355: Formatting behaviour depends on the specific request or macro in question.
                   1356: Note that the same message may also occur as a WARNING, see above.
                   1357: .It Sy "missing list type, using -item"
                   1358: .Pq mdoc
                   1359: A
                   1360: .Ic \&Bl
                   1361: macro fails to specify the list type.
                   1362: .It Sy "missing manual name, using \(dq\(dq"
                   1363: .Pq mdoc
                   1364: The first call to
                   1365: .Ic \&Nm
                   1366: lacks the required argument.
                   1367: .It Sy "uname(3) system call failed, using UNKNOWN"
                   1368: .Pq mdoc
                   1369: The
                   1370: .Ic \&Os
                   1371: macro is called without arguments, and the
                   1372: .Xr uname 3
                   1373: system call failed.
                   1374: As a workaround,
                   1375: .Nm
                   1376: can be compiled with
                   1377: .Sm off
                   1378: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
                   1379: .Sm on
                   1380: .It Sy "unknown standard specifier"
                   1381: .Pq mdoc
                   1382: An
                   1383: .Ic \&St
                   1384: macro has an unknown argument and is discarded.
                   1385: .It Sy "skipping request without numeric argument"
                   1386: .Pq roff
                   1387: An
                   1388: .Ic \&it
                   1389: request has a non-numeric or negative argument or no argument at all.
                   1390: The invalid request is ignored.
                   1391: .It Sy "skipping all arguments"
                   1392: .Pq mdoc , man , eqn , roff
                   1393: An
                   1394: .Xr mdoc 7
                   1395: .Ic \&Bt ,
                   1396: .Ic \&Ed ,
                   1397: .Ic \&Ef ,
                   1398: .Ic \&Ek ,
                   1399: .Ic \&El ,
                   1400: .Ic \&Re ,
                   1401: or
                   1402: .Ic \&Ud
                   1403: macro, an
                   1404: .Ic \&It
                   1405: macro in a list that don't support item heads, a
                   1406: .Xr man 7
                   1407: .Ic \&LP ,
                   1408: .Ic \&P ,
                   1409: or
                   1410: .Ic \&PP
                   1411: macro, an
                   1412: .Xr eqn 7
                   1413: .Ic \&EN
                   1414: macro, or a
                   1415: .Xr roff 7
                   1416: .Sq \&..
                   1417: block closing request is invoked with at least one argument.
                   1418: All arguments are ignored.
                   1419: .It Sy "skipping excess arguments"
                   1420: .Pq mdoc , roff
1.77      schwarze 1421: The
1.106     schwarze 1422: .Ic \&Bf
                   1423: macro is invoked with more than one argument, or a request of the
                   1424: .Ic \&de
                   1425: family is invoked with more than two arguments.
                   1426: The excess arguments are ignored.
                   1427: .El
                   1428: .Ss FATAL errors
                   1429: .Bl -ohang
                   1430: .It Sy "input too large"
                   1431: .Pq mdoc , man
                   1432: Currently,
                   1433: .Nm
                   1434: cannot handle input files larger than its arbitrary size limit
                   1435: of 2^31 bytes (2 Gigabytes).
                   1436: Since useful manuals are always small, this is not a problem in practice.
                   1437: Parsing is aborted as soon as the condition is detected.
                   1438: .It Sy "NOT IMPLEMENTED: Bd -file"
                   1439: .Pq mdoc
                   1440: For security reasons, the
                   1441: .Ic \&Bd
                   1442: macro does not support the
                   1443: .Fl file
                   1444: argument.
                   1445: By requesting the inclusion of a sensitive file, a malicious document
                   1446: might otherwise trick a privileged user into inadvertently displaying
                   1447: the file on the screen, revealing the file content to bystanders.
                   1448: The parser exits immediately.
                   1449: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
                   1450: .Pq roff
                   1451: For security reasons,
1.77      schwarze 1452: .Nm
1.106     schwarze 1453: allows
                   1454: .Ic \&so
                   1455: file inclusion requests only with relative paths
                   1456: and only without ascending to any parent directory.
                   1457: By requesting the inclusion of a sensitive file, a malicious document
                   1458: might otherwise trick a privileged user into inadvertently displaying
                   1459: the file on the screen, revealing the file content to bystanders.
                   1460: The parser exits immediately.
                   1461: .It Sy ".so request failed"
                   1462: .Pq roff
                   1463: Servicing a
                   1464: .Ic \&so
                   1465: request requires reading an external file.
                   1466: While trying to do so, an
                   1467: .Xr open 2 ,
                   1468: .Xr stat 2 ,
                   1469: or
                   1470: .Xr read 2
                   1471: system call failed.
                   1472: The parser exits immediately.
                   1473: Before showing this message,
                   1474: .Nm
                   1475: always shows another message explaining why the system call failed.
                   1476: .El
1.20      kristaps 1477: .Sh COMPATIBILITY
1.26      kristaps 1478: This section summarises
1.20      kristaps 1479: .Nm
1.76      kristaps 1480: compatibility with GNU troff.
1.32      kristaps 1481: Each input and output format is separately noted.
1.48      kristaps 1482: .Ss ASCII Compatibility
1.37      kristaps 1483: .Bl -bullet -compact
1.29      kristaps 1484: .It
1.87      kristaps 1485: Unrenderable unicode codepoints specified with
1.86      kristaps 1486: .Sq \e[uNNNN]
                   1487: escapes are printed as
                   1488: .Sq \&?
                   1489: in mandoc.
                   1490: In GNU troff, these raise an error.
                   1491: .It
1.49      kristaps 1492: The
1.33      kristaps 1493: .Sq \&Bd \-literal
1.49      kristaps 1494: and
1.32      kristaps 1495: .Sq \&Bd \-unfilled
                   1496: macros of
                   1497: .Xr mdoc 7
                   1498: in
1.58      kristaps 1499: .Fl T Ns Cm ascii
1.32      kristaps 1500: are synonyms, as are \-filled and \-ragged.
1.26      kristaps 1501: .It
1.86      kristaps 1502: In historic GNU troff, the
1.27      kristaps 1503: .Sq \&Pa
1.32      kristaps 1504: .Xr mdoc 7
                   1505: macro does not underline when scoped under an
1.30      kristaps 1506: .Sq \&It
1.57      kristaps 1507: in the FILES section.
                   1508: This behaves correctly in
1.27      kristaps 1509: .Nm .
                   1510: .It
1.58      kristaps 1511: A list or display following the
1.27      kristaps 1512: .Sq \&Ss
1.32      kristaps 1513: .Xr mdoc 7
                   1514: macro in
1.58      kristaps 1515: .Fl T Ns Cm ascii
1.20      kristaps 1516: does not assert a prior vertical break, just as it doesn't with
1.27      kristaps 1517: .Sq \&Sh .
1.20      kristaps 1518: .It
1.32      kristaps 1519: The
                   1520: .Sq \&na
                   1521: .Xr man 7
1.34      kristaps 1522: macro in
1.58      kristaps 1523: .Fl T Ns Cm ascii
1.34      kristaps 1524: has no effect.
1.20      kristaps 1525: .It
                   1526: Words aren't hyphenated.
                   1527: .El
1.114     kristaps 1528: .Ss HTML Compatibility
1.42      kristaps 1529: .Bl -bullet -compact
                   1530: .It
                   1531: The
1.47      kristaps 1532: .Sq \efP
                   1533: escape will revert the font to the previous
                   1534: .Sq \ef
                   1535: escape, not to the last rendered decoration, which is now dictated by
1.57      kristaps 1536: CSS instead of hard-coded.
                   1537: It also will not span past the current scope,
                   1538: for the same reason.
                   1539: Note that in
1.47      kristaps 1540: .Sx ASCII Output
                   1541: mode, this will work fine.
                   1542: .It
                   1543: The
1.42      kristaps 1544: .Xr mdoc 7
                   1545: .Sq \&Bl \-hang
                   1546: and
                   1547: .Sq \&Bl \-tag
                   1548: list types render similarly (no break following overreached left-hand
                   1549: side) due to the expressive constraints of HTML.
                   1550: .It
                   1551: The
                   1552: .Xr man 7
                   1553: .Sq IP
                   1554: and
                   1555: .Sq TP
                   1556: lists render similarly.
                   1557: .El
1.1       kristaps 1558: .Sh SEE ALSO
1.85      kristaps 1559: .Xr eqn 7 ,
1.57      kristaps 1560: .Xr man 7 ,
1.13      kristaps 1561: .Xr mandoc_char 7 ,
1.84      kristaps 1562: .Xr mdoc 7 ,
                   1563: .Xr roff 7 ,
                   1564: .Xr tbl 7
1.1       kristaps 1565: .Sh AUTHORS
                   1566: The
                   1567: .Nm
1.26      kristaps 1568: utility was written by
1.103     schwarze 1569: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.39      kristaps 1570: .Sh CAVEATS
                   1571: In
1.58      kristaps 1572: .Fl T Ns Cm html
1.50      kristaps 1573: and
1.58      kristaps 1574: .Fl T Ns Cm xhtml ,
1.39      kristaps 1575: the maximum size of an element attribute is determined by
                   1576: .Dv BUFSIZ ,
1.57      kristaps 1577: which is usually 1024 bytes.
                   1578: Be aware of this when setting long link
1.58      kristaps 1579: formats such as
                   1580: .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1.51      kristaps 1581: .Pp
                   1582: Nesting elements within next-line element scopes of
1.58      kristaps 1583: .Fl m Ns Cm an ,
1.51      kristaps 1584: such as
                   1585: .Sq br
                   1586: within an empty
                   1587: .Sq B ,
                   1588: will confuse
1.58      kristaps 1589: .Fl T Ns Cm html
1.51      kristaps 1590: and
1.58      kristaps 1591: .Fl T Ns Cm xhtml
1.52      kristaps 1592: and cause them to forget the formatting of the prior next-line scope.
1.53      kristaps 1593: .Pp
1.54      kristaps 1594: The
                   1595: .Sq \(aq
1.55      kristaps 1596: control character is an alias for the standard macro control character
                   1597: and does not emit a line-break as stipulated in GNU troff.

CVSweb