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

Annotation of mandoc/mandoc.1, Revision 1.262

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

CVSweb