[BACK]Return to mandoc.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/mandoc.1, Revision 1.75

1.75    ! schwarze    1: .\"    $OpenBSD: mandoc.1,v 1.74 2015/01/20 22:02:15 jmc Exp $
1.1       kristaps    2: .\"
1.44      schwarze    3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.71      schwarze    4: .\" Copyright (c) 2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5: .\"
                      6: .\" Permission to use, copy, modify, and distribute this software for any
1.3       schwarze    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.3       schwarze   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.74      jmc        18: .Dd $Mdocdate: January 20 2015 $
1.2       deraadt    19: .Dt MANDOC 1
1.1       kristaps   20: .Os
                     21: .Sh NAME
                     22: .Nm mandoc
                     23: .Nd format and display UNIX manuals
                     24: .Sh SYNOPSIS
                     25: .Nm mandoc
1.62      schwarze   26: .Op Fl acfhklV
1.54      schwarze   27: .Sm off
                     28: .Op Fl I Cm os Li = Ar name
                     29: .Sm on
1.65      jmc        30: .Op Fl K Ns Ar encoding
1.1       kristaps   31: .Op Fl m Ns Ar format
1.26      jmc        32: .Op Fl O Ns Ar option
1.17      schwarze   33: .Op Fl T Ns Ar output
1.38      schwarze   34: .Op Fl W Ns Ar level
1.45      schwarze   35: .Op Ar
1.1       kristaps   36: .Sh DESCRIPTION
                     37: The
                     38: .Nm
1.10      schwarze   39: utility formats
1.1       kristaps   40: .Ux
1.25      jmc        41: manual pages for display.
1.53      schwarze   42: .Pp
                     43: By default,
                     44: .Nm
                     45: reads
                     46: .Xr mdoc 7
                     47: or
                     48: .Xr man 7
                     49: text from stdin, implying
                     50: .Fl m Ns Cm andoc ,
                     51: and produces
1.68      schwarze   52: .Fl T Ns Cm locale
1.53      schwarze   53: output.
                     54: .Pp
1.61      schwarze   55: The options are as follows:
1.5       schwarze   56: .Bl -tag -width Ds
1.60      schwarze   57: .It Fl a
                     58: If the standard output is a terminal device and
                     59: .Fl c
                     60: is not specified, use
                     61: .Xr more 1
                     62: to paginate the output, just like
                     63: .Xr man 1
                     64: would.
                     65: .It Fl c
                     66: Copy the formatted manual pages to the standard output without using
                     67: .Xr more 1
                     68: to paginate them.
                     69: This is the default.
                     70: It can be specified to override
                     71: .Fl a .
1.61      schwarze   72: .It Fl f
                     73: A synonym for
                     74: .Xr whatis 1 .
                     75: This overrides any earlier
                     76: .Fl k
                     77: and
                     78: .Fl l
                     79: options.
1.54      schwarze   80: .Sm off
                     81: .It Fl I Cm os Li = Ar name
                     82: .Sm on
                     83: Override the default operating system
                     84: .Ar name
                     85: for the
                     86: .Xr mdoc 7
                     87: .Sq \&Os
1.70      schwarze   88: and for the
                     89: .Xr man 7
                     90: .Sq \&TH
1.54      schwarze   91: macro.
1.62      schwarze   92: .It Fl h
                     93: Display only the SYNOPSIS lines.
                     94: Implies
1.66      schwarze   95: .Fl c .
1.64      schwarze   96: .It Fl K Ns Ar encoding
                     97: Specify the input encoding.
                     98: The supported
                     99: .Ar encoding
                    100: arguments are
                    101: .Cm us-ascii ,
                    102: .Cm iso-8859-1 ,
                    103: and
                    104: .Cm utf-8 .
                    105: If not specified, autodetection uses the first match:
                    106: .Bl -tag -width iso-8859-1
                    107: .It Cm utf-8
                    108: if the first three bytes of the input file
                    109: are the UTF-8 byte order mark (BOM, 0xefbbbf)
                    110: .It Ar encoding
                    111: if the first or second line of the input file matches the
                    112: .Sy emacs
                    113: mode line format
                    114: .Pp
                    115: .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
                    116: .It Cm utf-8
                    117: if the first non-ASCII byte in the file introduces a valid UTF-8 sequence
                    118: .It Cm iso-8859-1
                    119: otherwise
                    120: .El
1.61      schwarze  121: .It Fl k
                    122: A synonym for
                    123: .Xr apropos 1 .
                    124: This overrides any earlier
                    125: .Fl f
                    126: and
                    127: .Fl l
                    128: options.
                    129: .It Fl l
                    130: A synonym for
                    131: .Fl a .
                    132: Also reverts any earlier
                    133: .Fl f
                    134: and
                    135: .Fl k
                    136: options.
1.1       kristaps  137: .It Fl m Ns Ar format
1.25      jmc       138: Input format.
                    139: See
1.1       kristaps  140: .Sx Input Formats
1.25      jmc       141: for available formats.
                    142: Defaults to
1.26      jmc       143: .Fl m Ns Cm andoc .
                    144: .It Fl O Ns Ar option
1.25      jmc       145: Comma-separated output options.
1.1       kristaps  146: .It Fl T Ns Ar output
1.25      jmc       147: Output format.
                    148: See
1.1       kristaps  149: .Sx Output Formats
1.25      jmc       150: for available formats.
                    151: Defaults to
1.68      schwarze  152: .Fl T Ns Cm locale .
1.4       schwarze  153: .It Fl V
                    154: Print version and exit.
1.38      schwarze  155: .It Fl W Ns Ar level
                    156: Specify the minimum message
                    157: .Ar level
                    158: to be reported on the standard error output and to affect the exit status.
                    159: The
                    160: .Ar level
                    161: can be
1.73      schwarze  162: .Cm warning ,
                    163: .Cm error ,
1.38      schwarze  164: or
1.73      schwarze  165: .Cm unsupp ;
1.72      schwarze  166: .Cm all
1.38      schwarze  167: is an alias for
1.72      schwarze  168: .Cm warning .
                    169: By default,
                    170: .Nm
                    171: is silent.
1.38      schwarze  172: See
                    173: .Sx EXIT STATUS
                    174: and
                    175: .Sx DIAGNOSTICS
                    176: for details.
                    177: .Pp
                    178: The special option
                    179: .Fl W Ns Cm stop
                    180: tells
                    181: .Nm
                    182: to exit after parsing a file that causes warnings or errors of at least
                    183: the requested level.
                    184: No formatted output will be produced from that file.
                    185: If both a
                    186: .Ar level
                    187: and
                    188: .Cm stop
                    189: are requested, they can be joined with a comma, for example
                    190: .Fl W Ns Cm error , Ns Cm stop .
1.26      jmc       191: .It Ar file
                    192: Read input from zero or more files.
1.25      jmc       193: If unspecified, reads from stdin.
                    194: If multiple files are specified,
1.1       kristaps  195: .Nm
                    196: will halt with the first failed parse.
                    197: .El
1.61      schwarze  198: .Pp
                    199: In
                    200: .Fl f
                    201: and
                    202: .Fl k
                    203: mode,
                    204: .Nm
                    205: also supports the options
                    206: .Fl CMmOSsw
                    207: described in the
                    208: .Xr apropos 1
                    209: manual.
1.1       kristaps  210: .Ss Input Formats
                    211: The
                    212: .Nm
                    213: utility accepts
                    214: .Xr mdoc 7
                    215: and
                    216: .Xr man 7
                    217: input with
1.26      jmc       218: .Fl m Ns Cm doc
1.1       kristaps  219: and
1.26      jmc       220: .Fl m Ns Cm an ,
1.25      jmc       221: respectively.
                    222: The
1.1       kristaps  223: .Xr mdoc 7
                    224: format is
                    225: .Em strongly
1.10      schwarze  226: recommended;
1.1       kristaps  227: .Xr man 7
                    228: should only be used for legacy manuals.
                    229: .Pp
                    230: A third option,
1.26      jmc       231: .Fl m Ns Cm andoc ,
1.1       kristaps  232: which is also the default, determines encoding on-the-fly: if the first
1.10      schwarze  233: non-comment macro is
1.11      schwarze  234: .Sq \&Dd
1.1       kristaps  235: or
1.11      schwarze  236: .Sq \&Dt ,
1.10      schwarze  237: the
1.1       kristaps  238: .Xr mdoc 7
                    239: parser is used; otherwise, the
                    240: .Xr man 7
                    241: parser is used.
                    242: .Pp
                    243: If multiple
1.10      schwarze  244: files are specified with
1.26      jmc       245: .Fl m Ns Cm andoc ,
1.25      jmc       246: each has its file-type determined this way.
                    247: If multiple files are
1.1       kristaps  248: specified and
1.26      jmc       249: .Fl m Ns Cm doc
1.1       kristaps  250: or
1.26      jmc       251: .Fl m Ns Cm an
1.1       kristaps  252: is specified, then this format is used exclusively.
                    253: .Ss Output Formats
                    254: The
                    255: .Nm
                    256: utility accepts the following
                    257: .Fl T
1.34      schwarze  258: arguments, which correspond to output modes:
1.48      jmc       259: .Bl -tag -width "-Tlocale"
1.26      jmc       260: .It Fl T Ns Cm ascii
1.42      schwarze  261: Produce 7-bit ASCII output.
1.25      jmc       262: See
1.20      schwarze  263: .Sx ASCII Output .
1.26      jmc       264: .It Fl T Ns Cm html
1.69      schwarze  265: Produce HTML5, CSS1, and MathML output.
1.25      jmc       266: See
1.20      schwarze  267: .Sx HTML Output .
1.26      jmc       268: .It Fl T Ns Cm lint
                    269: Parse only: produce no output.
                    270: Implies
1.38      schwarze  271: .Fl W Ns Cm warning .
1.48      jmc       272: .It Fl T Ns Cm locale
                    273: Encode output using the current locale.
1.68      schwarze  274: This is the default.
1.48      jmc       275: See
                    276: .Sx Locale Output .
1.46      schwarze  277: .It Fl T Ns Cm man
1.49      schwarze  278: Produce
1.46      schwarze  279: .Xr man 7
1.49      schwarze  280: format output.
                    281: See
                    282: .Sx Man Output .
1.36      schwarze  283: .It Fl T Ns Cm pdf
                    284: Produce PDF output.
                    285: See
                    286: .Sx PDF Output .
1.31      schwarze  287: .It Fl T Ns Cm ps
                    288: Produce PostScript output.
                    289: See
                    290: .Sx PostScript Output .
1.26      jmc       291: .It Fl T Ns Cm tree
                    292: Produce an indented parse tree.
1.48      jmc       293: .It Fl T Ns Cm utf8
                    294: Encode output in the UTF\-8 multi-byte format.
                    295: See
                    296: .Sx UTF\-8 Output .
1.26      jmc       297: .It Fl T Ns Cm xhtml
1.63      schwarze  298: This is a synonym for
                    299: .Fl T Ns Cm html .
1.1       kristaps  300: .El
                    301: .Pp
                    302: If multiple input files are specified, these will be processed by the
                    303: corresponding filter in-order.
1.34      schwarze  304: .Ss ASCII Output
                    305: Output produced by
1.68      schwarze  306: .Fl T Ns Cm ascii
                    307: is rendered in standard 7-bit ASCII documented in
1.34      schwarze  308: .Xr ascii 7 .
                    309: .Pp
                    310: Font styles are applied by using back-spaced encoding such that an
                    311: underlined character
                    312: .Sq c
                    313: is rendered as
                    314: .Sq _ Ns \e[bs] Ns c ,
                    315: where
                    316: .Sq \e[bs]
                    317: is the back-space character number 8.
                    318: Emboldened characters are rendered as
                    319: .Sq c Ns \e[bs] Ns c .
                    320: .Pp
                    321: The special characters documented in
                    322: .Xr mandoc_char 7
                    323: are rendered best-effort in an ASCII equivalent.
                    324: .Pp
                    325: Output width is limited to 78 visible columns unless literal input lines
                    326: exceed this limit.
                    327: .Pp
                    328: The following
                    329: .Fl O
                    330: arguments are accepted:
1.5       schwarze  331: .Bl -tag -width Ds
1.51      schwarze  332: .It Cm indent Ns = Ns Ar indent
                    333: The left margin for normal text is set to
                    334: .Ar indent
                    335: blank characters instead of the default of five for
                    336: .Xr mdoc 7
                    337: and seven for
                    338: .Xr man 7 .
                    339: Increasing this is not recommended; it may result in degraded formatting,
1.52      jmc       340: for example overfull lines or ugly line breaks.
1.34      schwarze  341: .It Cm width Ns = Ns Ar width
                    342: The output width is set to
                    343: .Ar width ,
1.75    ! schwarze  344: which will normalise to \(>=58.
1.1       kristaps  345: .El
1.34      schwarze  346: .Ss HTML Output
                    347: Output produced by
                    348: .Fl T Ns Cm html
1.63      schwarze  349: conforms to HTML5 using optional self-closing tags.
1.69      schwarze  350: Default styles use only CSS1.
                    351: Equations rendered from
                    352: .Xr eqn 7
                    353: blocks use MathML.
1.34      schwarze  354: .Pp
1.30      schwarze  355: The
1.34      schwarze  356: .Pa example.style.css
1.42      schwarze  357: file documents style-sheet classes available for customising output.
                    358: If a style-sheet is not specified with
                    359: .Fl O Ns Ar style ,
                    360: .Fl T Ns Cm html
1.63      schwarze  361: defaults to simple output (via an embedded style-sheet)
                    362: readable in any graphical or text-based web
1.42      schwarze  363: browser.
1.34      schwarze  364: .Pp
1.45      schwarze  365: Special characters are rendered in decimal-encoded UTF\-8.
1.34      schwarze  366: .Pp
                    367: The following
1.33      schwarze  368: .Fl O
1.34      schwarze  369: arguments are accepted:
1.17      schwarze  370: .Bl -tag -width Ds
1.49      schwarze  371: .It Cm fragment
1.67      bentley   372: Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
                    373: elements and only emit the subtree below the <body> element.
1.49      schwarze  374: The
                    375: .Cm style
1.50      schwarze  376: argument will be ignored.
1.49      schwarze  377: This is useful when embedding manual content within existing documents.
1.33      schwarze  378: .It Cm includes Ns = Ns Ar fmt
1.17      schwarze  379: The string
                    380: .Ar fmt ,
1.21      schwarze  381: for example,
1.17      schwarze  382: .Ar ../src/%I.html ,
                    383: is used as a template for linked header files (usually via the
                    384: .Sq \&In
1.25      jmc       385: macro).
                    386: Instances of
1.17      schwarze  387: .Sq \&%I
1.25      jmc       388: are replaced with the include filename.
                    389: The default is not to present a
1.17      schwarze  390: hyperlink.
1.33      schwarze  391: .It Cm man Ns = Ns Ar fmt
1.17      schwarze  392: The string
                    393: .Ar fmt ,
1.21      schwarze  394: for example,
1.17      schwarze  395: .Ar ../html%S/%N.%S.html ,
                    396: is used as a template for linked manuals (usually via the
                    397: .Sq \&Xr
1.25      jmc       398: macro).
                    399: Instances of
1.17      schwarze  400: .Sq \&%N
                    401: and
                    402: .Sq %S
                    403: are replaced with the linked manual's name and section, respectively.
1.25      jmc       404: If no section is included, section 1 is assumed.
                    405: The default is not to
1.17      schwarze  406: present a hyperlink.
1.33      schwarze  407: .It Cm style Ns = Ns Ar style.css
1.26      jmc       408: The file
                    409: .Ar style.css
                    410: is used for an external style-sheet.
                    411: This must be a valid absolute or
                    412: relative URI.
1.30      schwarze  413: .El
1.48      jmc       414: .Ss Locale Output
                    415: Locale-depending output encoding is triggered with
                    416: .Fl T Ns Cm locale .
1.68      schwarze  417: This is the default.
                    418: .Pp
1.48      jmc       419: This option is not available on all systems: systems without locale
                    420: support, or those whose internal representation is not natively UCS-4,
                    421: will fall back to
                    422: .Fl T Ns Cm ascii .
                    423: See
                    424: .Sx ASCII Output
                    425: for font style specification and available command-line arguments.
1.49      schwarze  426: .Ss Man Output
                    427: Translate input format into
                    428: .Xr man 7
                    429: output format.
1.55      jmc       430: This is useful for distributing manual sources to legacy systems
1.49      schwarze  431: lacking
                    432: .Xr mdoc 7
                    433: formatters.
                    434: .Pp
                    435: If
                    436: .Xr mdoc 7
                    437: is passed as input, it is translated into
1.50      schwarze  438: .Xr man 7 .
                    439: If the input format is
1.49      schwarze  440: .Xr man 7 ,
1.50      schwarze  441: the input is copied to the output, expanding any
1.49      schwarze  442: .Xr roff 7
                    443: .Sq so
1.50      schwarze  444: requests.
                    445: The parser is also run, and as usual, the
                    446: .Fl W
                    447: level controls which
                    448: .Sx DIAGNOSTICS
                    449: are displayed before copying the input to the output.
1.48      jmc       450: .Ss PDF Output
                    451: PDF-1.1 output may be generated by
                    452: .Fl T Ns Cm pdf .
                    453: See
                    454: .Sx PostScript Output
                    455: for
                    456: .Fl O
                    457: arguments and defaults.
1.31      schwarze  458: .Ss PostScript Output
1.33      schwarze  459: PostScript
                    460: .Qq Adobe-3.0
                    461: Level-2 pages may be generated by
1.31      schwarze  462: .Fl T Ns Cm ps .
1.35      schwarze  463: Output pages default to letter sized and are rendered in the Times font
                    464: family, 11-point.
                    465: Margins are calculated as 1/9 the page length and width.
                    466: Line-height is 1.4m.
1.34      schwarze  467: .Pp
                    468: Special characters are rendered as in
                    469: .Sx ASCII Output .
                    470: .Pp
                    471: The following
                    472: .Fl O
                    473: arguments are accepted:
                    474: .Bl -tag -width Ds
                    475: .It Cm paper Ns = Ns Ar name
                    476: The paper size
                    477: .Ar name
                    478: may be one of
1.35      schwarze  479: .Ar a3 ,
                    480: .Ar a4 ,
                    481: .Ar a5 ,
                    482: .Ar legal ,
1.34      schwarze  483: or
                    484: .Ar letter .
1.35      schwarze  485: You may also manually specify dimensions as
                    486: .Ar NNxNN ,
                    487: width by height in millimetres.
                    488: If an unknown value is encountered,
                    489: .Ar letter
                    490: is used.
1.34      schwarze  491: .El
1.48      jmc       492: .Ss UTF\-8 Output
                    493: Use
                    494: .Fl T Ns Cm utf8
                    495: to force a UTF\-8 locale.
1.36      schwarze  496: See
1.48      jmc       497: .Sx Locale Output
                    498: for details and options.
1.60      schwarze  499: .Sh ENVIRONMENT
                    500: .Bl -tag -width MANPAGER
                    501: .It Ev MANPAGER
                    502: Any non-empty value of the environment variable
                    503: .Ev MANPAGER
                    504: will be used instead of the standard pagination program,
                    505: .Xr more 1 .
                    506: .It Ev PAGER
                    507: Specifies the pagination program to use when
                    508: .Ev MANPAGER
                    509: is not defined.
                    510: If neither PAGER nor MANPAGER is defined,
                    511: .Pa /usr/bin/more Fl s
                    512: will be used.
                    513: .El
1.38      schwarze  514: .Sh EXIT STATUS
                    515: The
                    516: .Nm
                    517: utility exits with one of the following values, controlled by the message
                    518: .Ar level
                    519: associated with the
                    520: .Fl W
                    521: option:
                    522: .Pp
                    523: .Bl -tag -width Ds -compact
                    524: .It 0
                    525: No warnings or errors occurred, or those that did were ignored because
                    526: they were lower than the requested
                    527: .Ar level .
                    528: .It 2
                    529: At least one warning occurred, but no error, and
                    530: .Fl W Ns Cm warning
                    531: was specified.
                    532: .It 3
1.73      schwarze  533: At least one parsing error occurred,
                    534: but no unsupported feature was encountered, and
                    535: .Fl W Ns Cm error
                    536: or
                    537: .Fl W Ns Cm warning
                    538: was specified.
                    539: .It 4
1.74      jmc       540: At least one unsupported feature was encountered, and
1.73      schwarze  541: .Fl W Ns Cm unsupp ,
1.38      schwarze  542: .Fl W Ns Cm error
                    543: or
                    544: .Fl W Ns Cm warning
                    545: was specified.
                    546: .It 5
                    547: Invalid command line arguments were specified.
                    548: No input files have been read.
                    549: .It 6
1.71      schwarze  550: An operating system error occurred, for example exhaustion
                    551: of memory, file descriptors, or process table entries.
1.38      schwarze  552: Such errors cause
                    553: .Nm
                    554: to exit at once, possibly in the middle of parsing or formatting a file.
                    555: .El
                    556: .Pp
                    557: Note that selecting
                    558: .Fl T Ns Cm lint
                    559: output mode implies
                    560: .Fl W Ns Cm warning .
1.1       kristaps  561: .Sh EXAMPLES
                    562: To page manuals to the terminal:
                    563: .Pp
1.42      schwarze  564: .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
                    565: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.12      schwarze  566: .Pp
1.17      schwarze  567: To produce HTML manuals with
                    568: .Ar style.css
                    569: as the style-sheet:
                    570: .Pp
1.42      schwarze  571: .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
1.17      schwarze  572: .Pp
1.12      schwarze  573: To check over a large set of manuals:
                    574: .Pp
1.38      schwarze  575: .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
1.34      schwarze  576: .Pp
                    577: To produce a series of PostScript manuals for A4 paper:
                    578: .Pp
1.42      schwarze  579: .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.46      schwarze  580: .Pp
                    581: Convert a modern
                    582: .Xr mdoc 7
                    583: manual to the older
                    584: .Xr man 7
                    585: format, for use on systems lacking an
                    586: .Xr mdoc 7
                    587: parser:
                    588: .Pp
                    589: .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
1.38      schwarze  590: .Sh DIAGNOSTICS
1.59      schwarze  591: Messages displayed by
                    592: .Nm
                    593: follow this format:
1.38      schwarze  594: .Pp
1.59      schwarze  595: .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
1.38      schwarze  596: .Pp
1.59      schwarze  597: Line and column numbers start at 1.
                    598: Both are omitted for messages referring to an input file as a whole.
                    599: Macro names and arguments are omitted where meaningless.
                    600: Fatal messages about invalid command line arguments
                    601: or operating system errors, for example when memory is exhausted,
                    602: may also omit the
                    603: .Ar file
1.57      schwarze  604: and
1.59      schwarze  605: .Ar level
                    606: fields.
1.57      schwarze  607: .Pp
1.38      schwarze  608: Message levels have the following meanings:
                    609: .Bl -tag -width "warning"
1.73      schwarze  610: .It Cm unsupp
                    611: An input file uses unsupported low-level
                    612: .Xr roff 7
                    613: features.
                    614: The output may be incomplete and/or misformatted,
                    615: so using GNU troff instead of
                    616: .Nm
                    617: to process the file may be preferable.
1.38      schwarze  618: .It Cm error
1.73      schwarze  619: An input file contains invalid syntax that cannot be safely interpreted.
1.38      schwarze  620: By discarding part of the input or inserting missing tokens,
                    621: the parser is able to continue, and the error does not prevent
                    622: generation of formatted output, but typically, preparing that
                    623: output involves information loss, broken document structure
1.73      schwarze  624: or unintended formatting, no matter whether
                    625: .Nm
                    626: or GNU troff is used.
                    627: In many cases, the output of
                    628: .Nm
                    629: and GNU troff is identical, but in some,
                    630: .Nm
                    631: is more resilient than GNU troff with respect to malformed input.
1.71      schwarze  632: .Pp
                    633: Non-existent or unreadable input files are also reported on the
                    634: .Cm error
                    635: level.
                    636: In that case, the parser cannot even be started and no output
                    637: is produced from those input files.
1.38      schwarze  638: .It Cm warning
                    639: An input file uses obsolete, discouraged or non-portable syntax.
                    640: All the same, the meaning of the input is unambiguous and a correct
                    641: rendering can be produced.
                    642: Documents causing warnings may render poorly when using other
                    643: formatting tools instead of
                    644: .Nm .
                    645: .El
                    646: .Pp
                    647: Messages of the
1.73      schwarze  648: .Cm warning ,
                    649: .Cm error ,
1.38      schwarze  650: and
1.73      schwarze  651: .Cm unsupp
1.71      schwarze  652: levels except those about non-existent or unreadable input files
                    653: are hidden unless their level, or a lower level, is requested using a
1.38      schwarze  654: .Fl W
                    655: option or
                    656: .Fl T Ns Cm lint
                    657: output mode.
1.1       kristaps  658: .Sh SEE ALSO
1.75    ! schwarze  659: .Xr apropos 1 ,
        !           660: .Xr man 1 ,
1.47      schwarze  661: .Xr eqn 7 ,
1.25      jmc       662: .Xr man 7 ,
1.1       kristaps  663: .Xr mandoc_char 7 ,
1.43      schwarze  664: .Xr mdoc 7 ,
                    665: .Xr roff 7 ,
                    666: .Xr tbl 7
1.1       kristaps  667: .Sh AUTHORS
                    668: The
                    669: .Nm
1.10      schwarze  670: utility was written by
1.75    ! schwarze  671: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
        !           672: and is maintained by
        !           673: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
        !           674: .Sh BUGS
1.17      schwarze  675: In
1.75    ! schwarze  676: .Fl T Ns Cm html ,
1.17      schwarze  677: the maximum size of an element attribute is determined by
                    678: .Dv BUFSIZ ,
1.25      jmc       679: which is usually 1024 bytes.
                    680: Be aware of this when setting long link
1.26      jmc       681: formats such as
                    682: .Fl O Ns Cm style Ns = Ns Ar really/long/link .