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

Annotation of mandoc/mandoc.1, Revision 1.233

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

CVSweb