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

Annotation of mandoc/mandoc.1, Revision 1.158

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

CVSweb