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

Annotation of mandoc/mandoc.1, Revision 1.198

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

CVSweb