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