Annotation of mandoc/mandoc.1, Revision 1.166
1.166 ! schwarze 1: .\" $Id: mandoc.1,v 1.165 2016/12/28 17:34:18 schwarze Exp $
1.1 kristaps 2: .\"
1.92 schwarze 3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.131 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.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.166 ! schwarze 18: .Dd $Mdocdate: December 28 2016 $
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.156 schwarze 78: .It Fl I Cm os Ns = Ns Ar name
1.101 schwarze 79: Override the default operating system
80: .Ar name
81: for the
82: .Xr mdoc 7
83: .Sq \&Os
1.130 schwarze 84: and for the
85: .Xr man 7
86: .Sq \&TH
1.101 schwarze 87: macro.
1.110 schwarze 88: .It Fl h
89: Display only the SYNOPSIS lines.
90: Implies
1.122 schwarze 91: .Fl c .
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.155 schwarze 812: .It Sy "NAME section without name"
1.106 schwarze 813: .Pq mdoc
1.155 schwarze 814: The NAME section does not contain any
815: .Ic \&Nm
816: child macro.
817: .It Sy "NAME section without description"
818: .Pq mdoc
819: The NAME section lacks the mandatory
820: .Ic \&Nd
821: child macro.
822: .It Sy "description not at the end of NAME"
823: .Pq mdoc
824: The NAME section does contain an
1.106 schwarze 825: .Ic \&Nd
1.155 schwarze 826: child macro, but other content follows it.
827: .It Sy "bad NAME section content"
828: .Pq mdoc
829: The NAME section contains plain text or macros other than
830: .Ic \&Nm
1.106 schwarze 831: and
1.155 schwarze 832: .Ic \&Nd .
1.142 schwarze 833: .It Sy "missing description line, using \(dq\(dq"
834: .Pq mdoc
835: The
836: .Ic \&Nd
837: macro lacks the required argument.
838: The title line of the manual will end after the dash.
1.106 schwarze 839: .It Sy "sections out of conventional order"
840: .Pq mdoc
841: A standard section occurs after another section it usually precedes.
842: All section titles are used as given,
843: and the order of sections is not changed.
844: .It Sy "duplicate section title"
845: .Pq mdoc
846: The same standard section title occurs more than once.
847: .It Sy "unexpected section"
848: .Pq mdoc
849: A standard section header occurs in a section of the manual
850: where it normally isn't useful.
1.112 schwarze 851: .It Sy "unusual Xr order"
852: .Pq mdoc
853: In the SEE ALSO section, an
854: .Ic \&Xr
855: macro with a lower section number follows one with a higher number,
856: or two
857: .Ic \&Xr
1.157 schwarze 858: macros referring to the same section are out of alphabetical order.
1.112 schwarze 859: .It Sy "unusual Xr punctuation"
860: .Pq mdoc
861: In the SEE ALSO section, punctuation between two
862: .Ic \&Xr
863: macros differs from a single comma, or there is trailing punctuation
864: after the last
865: .Ic \&Xr
866: macro.
1.111 schwarze 867: .It Sy "AUTHORS section without An macro"
868: .Pq mdoc
869: An AUTHORS sections contains no
870: .Ic \&An
871: macros, or only empty ones.
872: Probably, there are author names lacking markup.
1.106 schwarze 873: .El
874: .Ss "Warnings related to macros and nesting"
875: .Bl -ohang
876: .It Sy "obsolete macro"
877: .Pq mdoc
878: See the
879: .Xr mdoc 7
880: manual for replacements.
1.126 schwarze 881: .It Sy "macro neither callable nor escaped"
882: .Pq mdoc
883: The name of a macro that is not callable appears on a macro line.
884: It is printed verbatim.
1.152 schwarze 885: If the intention is to call it, move it to its own input line;
1.126 schwarze 886: otherwise, escape it by prepending
887: .Sq \e& .
1.106 schwarze 888: .It Sy "skipping paragraph macro"
889: In
890: .Xr mdoc 7
891: documents, this happens
892: .Bl -dash -compact
893: .It
894: at the beginning and end of sections and subsections
895: .It
896: right before non-compact lists and displays
897: .It
898: at the end of items in non-column, non-compact lists
899: .It
900: and for multiple consecutive paragraph macros.
901: .El
902: In
903: .Xr man 7
904: documents, it happens
905: .Bl -dash -compact
906: .It
907: for empty
908: .Ic \&P ,
909: .Ic \&PP ,
910: and
911: .Ic \&LP
912: macros
913: .It
914: for
915: .Ic \&IP
916: macros having neither head nor body arguments
917: .It
918: for
919: .Ic \&br
920: or
921: .Ic \&sp
922: right after
923: .Ic \&SH
924: or
925: .Ic \&SS
926: .El
927: .It Sy "moving paragraph macro out of list"
928: .Pq mdoc
929: A list item in a
930: .Ic \&Bl
931: list contains a trailing paragraph macro.
932: The paragraph macro is moved after the end of the list.
933: .It Sy "skipping no-space macro"
934: .Pq mdoc
935: An input line begins with an
936: .Ic \&Ns
937: macro.
938: The macro is ignored.
939: .It Sy "blocks badly nested"
940: .Pq mdoc
941: If two blocks intersect, one should completely contain the other.
942: Otherwise, rendered output is likely to look strange in any output
943: format, and rendering in SGML-based output formats is likely to be
944: outright wrong because such languages do not support badly nested
945: blocks at all.
946: Typical examples of badly nested blocks are
947: .Qq Ic \&Ao \&Bo \&Ac \&Bc
948: and
949: .Qq Ic \&Ao \&Bq \&Ac .
950: In these examples,
951: .Ic \&Ac
952: breaks
953: .Ic \&Bo
954: and
955: .Ic \&Bq ,
956: respectively.
957: .It Sy "nested displays are not portable"
958: .Pq mdoc
959: A
960: .Ic \&Bd ,
961: .Ic \&D1 ,
962: or
963: .Ic \&Dl
964: display occurs nested inside another
965: .Ic \&Bd
966: display.
967: This works with
968: .Nm ,
969: but fails with most other implementations.
970: .It Sy "moving content out of list"
971: .Pq mdoc
972: A
973: .Ic \&Bl
974: list block contains text or macros before the first
975: .Ic \&It
976: macro.
977: The offending children are moved before the beginning of the list.
978: .It Sy "fill mode already enabled, skipping"
979: .Pq man
980: A
981: .Ic \&fi
982: request occurs even though the document is still in fill mode,
983: or already switched back to fill mode.
984: It has no effect.
985: .It Sy "fill mode already disabled, skipping"
986: .Pq man
987: An
988: .Ic \&nf
989: request occurs even though the document already switched to no-fill mode
990: and did not switch back to fill mode yet.
991: It has no effect.
992: .It Sy "line scope broken"
993: .Pq man
994: While parsing the next-line scope of the previous macro,
995: another macro is found that prematurely terminates the previous one.
996: The previous, interrupted macro is deleted from the parse tree.
997: .El
998: .Ss "Warnings related to missing arguments"
999: .Bl -ohang
1000: .It Sy "skipping empty request"
1.118 schwarze 1001: .Pq roff , eqn
1002: The macro name is missing from a macro definition request,
1003: or an
1004: .Xr eqn 7
1005: control statement or operation keyword lacks its required argument.
1.106 schwarze 1006: .It Sy "conditional request controls empty scope"
1007: .Pq roff
1008: A conditional request is only useful if any of the following
1009: follows it on the same logical input line:
1010: .Bl -dash -compact
1011: .It
1012: The
1013: .Sq \e{
1014: keyword to open a multi-line scope.
1015: .It
1016: A request or macro or some text, resulting in a single-line scope.
1017: .It
1018: The immediate end of the logical line without any intervening whitespace,
1019: resulting in next-line scope.
1020: .El
1021: Here, a conditional request is followed by trailing whitespace only,
1022: and there is no other content on its logical input line.
1023: Note that it doesn't matter whether the logical input line is split
1024: across multiple physical input lines using
1025: .Sq \e
1026: line continuation characters.
1027: This is one of the rare cases
1028: where trailing whitespace is syntactically significant.
1029: The conditional request controls a scope containing whitespace only,
1030: so it is unlikely to have a significant effect,
1031: except that it may control a following
1032: .Ic \&el
1033: clause.
1034: .It Sy "skipping empty macro"
1035: .Pq mdoc
1.147 schwarze 1036: The indicated macro has no arguments and hence no effect.
1037: .It Sy "empty block"
1038: .Pq mdoc , man
1039: A
1040: .Ic \&Bd ,
1041: .Ic \&Bk ,
1042: .Ic \&Bl ,
1043: .Ic \&D1 ,
1044: .Ic \&Dl ,
1045: .Ic \&RS ,
1046: or
1047: .Ic \&UR
1048: block contains nothing in its body and will produce no output.
1.106 schwarze 1049: .It Sy "empty argument, using 0n"
1050: .Pq mdoc
1051: The required width is missing after
1052: .Ic \&Bd
1053: or
1054: .Ic \&Bl
1055: .Fl offset
1056: or
1057: .Fl width.
1058: .It Sy "missing display type, using -ragged"
1059: .Pq mdoc
1060: The
1061: .Ic \&Bd
1062: macro is invoked without the required display type.
1063: .It Sy "list type is not the first argument"
1064: .Pq mdoc
1065: In a
1066: .Ic \&Bl
1067: macro, at least one other argument precedes the type argument.
1068: The
1069: .Nm
1070: utility copes with any argument order, but some other
1071: .Xr mdoc 7
1072: implementations do not.
1073: .It Sy "missing -width in -tag list, using 8n"
1074: .Pq mdoc
1075: Every
1076: .Ic \&Bl
1077: macro having the
1078: .Fl tag
1079: argument requires
1080: .Fl width ,
1081: too.
1082: .It Sy "missing utility name, using \(dq\(dq"
1083: .Pq mdoc
1084: The
1085: .Ic \&Ex Fl std
1086: macro is called without an argument before
1087: .Ic \&Nm
1088: has first been called with an argument.
1.146 schwarze 1089: .It Sy "missing function name, using \(dq\(dq"
1090: .Pq mdoc
1091: The
1092: .Ic \&Fo
1093: macro is called without an argument.
1094: No function name is printed.
1.106 schwarze 1095: .It Sy "empty head in list item"
1096: .Pq mdoc
1097: In a
1098: .Ic \&Bl
1099: .Fl diag ,
1100: .Fl hang ,
1101: .Fl inset ,
1102: .Fl ohang ,
1103: or
1104: .Fl tag
1105: list, an
1106: .Ic \&It
1107: macro lacks the required argument.
1108: The item head is left empty.
1109: .It Sy "empty list item"
1110: .Pq mdoc
1111: In a
1112: .Ic \&Bl
1113: .Fl bullet ,
1114: .Fl dash ,
1115: .Fl enum ,
1116: or
1117: .Fl hyphen
1118: list, an
1119: .Ic \&It
1120: block is empty.
1121: An empty list item is shown.
1.152 schwarze 1122: .It Sy "missing font type, using \efR"
1.106 schwarze 1123: .Pq mdoc
1124: A
1125: .Ic \&Bf
1126: macro has no argument.
1.152 schwarze 1127: It switches to the default font.
1128: .It Sy "unknown font type, using \efR"
1.106 schwarze 1129: .Pq mdoc
1130: The
1131: .Ic \&Bf
1132: argument is invalid.
1.152 schwarze 1133: The default font is used instead.
1.127 schwarze 1134: .It Sy "nothing follows prefix"
1135: .Pq mdoc
1136: A
1137: .Ic \&Pf
1138: macro has no argument, or only one argument and no macro follows
1139: on the same input line.
1140: This defeats its purpose; in particular, spacing is not suppressed
1141: before the text or macros following on the next input line.
1.143 schwarze 1142: .It Sy "empty reference block"
1143: .Pq mdoc
1144: An
1145: .Ic \&Rs
1146: macro is immediately followed by an
1147: .Ic \&Re
1148: macro on the next input line.
1149: Such an empty block does not produce any output.
1.165 schwarze 1150: .It Sy "missing section argument"
1151: .Pq mdoc
1152: An
1153: .Ic \&Xr
1154: macro lacks its second, section number argument.
1155: The first argument, i.e. the name, is printed, but without subsequent
1.166 ! schwarze 1156: parentheses.
1.106 schwarze 1157: .It Sy "missing -std argument, adding it"
1158: .Pq mdoc
1159: An
1160: .Ic \&Ex
1161: or
1162: .Ic \&Rv
1163: macro lacks the required
1164: .Fl std
1165: argument.
1166: The
1167: .Nm
1168: utility assumes
1169: .Fl std
1170: even when it is not specified, but other implementations may not.
1.150 schwarze 1171: .It Sy "missing option string, using \(dq\(dq"
1172: .Pq man
1173: The
1174: .Ic \&OP
1175: macro is invoked without any argument.
1176: An empty pair of square brackets is shown.
1177: .It Sy "missing resource identifier, using \(dq\(dq"
1178: .Pq man
1179: The
1180: .Ic \&UR
1181: macro is invoked without any argument.
1182: An empty pair of angle brackets is shown.
1.118 schwarze 1183: .It Sy "missing eqn box, using \(dq\(dq"
1184: .Pq eqn
1185: A diacritic mark or a binary operator is found,
1186: but there is nothing to the left of it.
1187: An empty box is inserted.
1.106 schwarze 1188: .El
1189: .Ss "Warnings related to bad macro arguments"
1190: .Bl -ohang
1191: .It Sy "unterminated quoted argument"
1192: .Pq roff
1193: Macro arguments can be enclosed in double quote characters
1194: such that space characters and macro names contained in the quoted
1195: argument need not be escaped.
1196: The closing quote of the last argument of a macro can be omitted.
1197: However, omitting it is not recommended because it makes the code
1198: harder to read.
1199: .It Sy "duplicate argument"
1200: .Pq mdoc
1201: A
1202: .Ic \&Bd
1203: or
1204: .Ic \&Bl
1205: macro has more than one
1206: .Fl compact ,
1207: more than one
1208: .Fl offset ,
1209: or more than one
1210: .Fl width
1211: argument.
1212: All but the last instances of these arguments are ignored.
1213: .It Sy "skipping duplicate argument"
1214: .Pq mdoc
1215: An
1216: .Ic \&An
1217: macro has more than one
1218: .Fl split
1219: or
1220: .Fl nosplit
1221: argument.
1222: All but the first of these arguments are ignored.
1223: .It Sy "skipping duplicate display type"
1224: .Pq mdoc
1225: A
1226: .Ic \&Bd
1227: macro has more than one type argument; the first one is used.
1228: .It Sy "skipping duplicate list type"
1229: .Pq mdoc
1230: A
1231: .Ic \&Bl
1232: macro has more than one type argument; the first one is used.
1233: .It Sy "skipping -width argument"
1234: .Pq mdoc
1235: A
1236: .Ic \&Bl
1237: .Fl column ,
1238: .Fl diag ,
1239: .Fl ohang ,
1240: .Fl inset ,
1241: or
1242: .Fl item
1243: list has a
1244: .Fl width
1245: argument.
1246: That has no effect.
1.151 schwarze 1247: .It Sy "wrong number of cells"
1248: In a line of a
1249: .Ic \&Bl Fl column
1250: list, the number of tabs or
1251: .Ic \&Ta
1252: macros is less than the number expected from the list header line
1253: or exceeds the expected number by more than one.
1254: Missing cells remain empty, and all cells exceeding the number of
1255: columns are joined into one single cell.
1.106 schwarze 1256: .It Sy "unknown AT&T UNIX version"
1257: .Pq mdoc
1258: An
1259: .Ic \&At
1260: macro has an invalid argument.
1261: It is used verbatim, with
1262: .Qq "AT&T UNIX "
1263: prefixed to it.
1.113 schwarze 1264: .It Sy "comma in function argument"
1265: .Pq mdoc
1266: An argument of an
1267: .Ic \&Fa
1268: or
1269: .Ic \&Fn
1270: macro contains a comma; it should probably be split into two arguments.
1.117 schwarze 1271: .It Sy "parenthesis in function name"
1272: .Pq mdoc
1273: The first argument of an
1274: .Ic \&Fc
1275: or
1276: .Ic \&Fn
1277: macro contains an opening or closing parenthesis; that's probably wrong,
1278: parentheses are added automatically.
1.106 schwarze 1279: .It Sy "invalid content in Rs block"
1280: .Pq mdoc
1281: An
1282: .Ic \&Rs
1283: block contains plain text or non-% macros.
1284: The bogus content is left in the syntax tree.
1285: Formatting may be poor.
1286: .It Sy "invalid Boolean argument"
1287: .Pq mdoc
1288: An
1289: .Ic \&Sm
1290: macro has an argument other than
1291: .Cm on
1292: or
1293: .Cm off .
1294: The invalid argument is moved out of the macro, which leaves the macro
1295: empty, causing it to toggle the spacing mode.
1296: .It Sy "unknown font, skipping request"
1.115 schwarze 1297: .Pq man , tbl
1.106 schwarze 1298: A
1299: .Xr roff 7
1300: .Ic \&ft
1.115 schwarze 1301: request or a
1302: .Xr tbl 7
1303: .Ic \&f
1304: layout modifier has an unknown
1305: .Ar font
1306: argument.
1.151 schwarze 1307: .It Sy "odd number of characters in request"
1308: .Pq roff
1309: A
1310: .Ic \&tr
1311: request contains an odd number of characters.
1312: The last character is mapped to the blank character.
1.106 schwarze 1313: .El
1314: .Ss "Warnings related to plain text"
1315: .Bl -ohang
1316: .It Sy "blank line in fill mode, using .sp"
1317: .Pq mdoc
1318: The meaning of blank input lines is only well-defined in non-fill mode:
1319: In fill mode, line breaks of text input lines are not supposed to be
1320: significant.
1321: However, for compatibility with groff, blank lines in fill mode
1322: are replaced with
1323: .Ic \&sp
1324: requests.
1325: .It Sy "tab in filled text"
1326: .Pq mdoc , man
1327: The meaning of tab characters is only well-defined in non-fill mode:
1328: In fill mode, whitespace is not supposed to be significant
1329: on text input lines.
1330: As an implementation dependent choice, tab characters on text lines
1331: are passed through to the formatters in any case.
1332: Given that the text before the tab character will be filled,
1333: it is hard to predict which tab stop position the tab will advance to.
1334: .It Sy "whitespace at end of input line"
1335: .Pq mdoc , man , roff
1336: Whitespace at the end of input lines is almost never semantically
1337: significant \(em but in the odd case where it might be, it is
1338: extremely confusing when reviewing and maintaining documents.
1339: .It Sy "bad comment style"
1340: .Pq roff
1341: Comment lines start with a dot, a backslash, and a double-quote character.
1342: The
1343: .Nm
1344: utility treats the line as a comment line even without the backslash,
1345: but leaving out the backslash might not be portable.
1346: .It Sy "invalid escape sequence"
1347: .Pq roff
1348: An escape sequence has an invalid opening argument delimiter, lacks the
1349: closing argument delimiter, or the argument has too few characters.
1350: If the argument is incomplete,
1351: .Ic \e*
1352: and
1353: .Ic \en
1354: expand to an empty string,
1355: .Ic \eB
1356: to the digit
1357: .Sq 0 ,
1358: and
1359: .Ic \ew
1360: to the length of the incomplete argument.
1361: All other invalid escape sequences are ignored.
1362: .It Sy "undefined string, using \(dq\(dq"
1363: .Pq roff
1364: If a string is used without being defined before,
1365: its value is implicitly set to the empty string.
1366: However, defining strings explicitly before use
1367: keeps the code more readable.
1368: .El
1.138 schwarze 1369: .Ss "Warnings related to tables"
1370: .Bl -ohang
1371: .It Sy "tbl line starts with span"
1372: .Pq tbl
1373: The first cell in a table layout line is a horizontal span
1374: .Pq Sq Cm s .
1375: Data provided for this cell is ignored, and nothing is printed in the cell.
1376: .It Sy "tbl column starts with span"
1377: .Pq tbl
1378: The first line of a table layout specification
1379: requests a vertical span
1380: .Pq Sq Cm ^ .
1381: Data provided for this cell is ignored, and nothing is printed in the cell.
1382: .It Sy "skipping vertical bar in tbl layout"
1383: .Pq tbl
1384: A table layout specification contains more than two consecutive vertical bars.
1385: A double bar is printed, all additional bars are discarded.
1.106 schwarze 1386: .El
1387: .Ss "Errors related to tables"
1.136 schwarze 1388: .Bl -ohang
1389: .It Sy "non-alphabetic character in tbl options"
1390: .Pq tbl
1391: The table options line contains a character other than a letter,
1392: blank, or comma where the beginning of an option name is expected.
1393: The character is ignored.
1394: .It Sy "skipping unknown tbl option"
1395: .Pq tbl
1396: The table options line contains a string of letters that does not
1397: match any known option name.
1398: The word is ignored.
1399: .It Sy "missing tbl option argument"
1400: .Pq tbl
1401: A table option that requires an argument is not followed by an
1402: opening parenthesis, or the opening parenthesis is immediately
1403: followed by a closing parenthesis.
1404: The option is ignored.
1405: .It Sy "wrong tbl option argument size"
1406: .Pq tbl
1407: A table option argument contains an invalid number of characters.
1408: Both the option and the argument are ignored.
1.138 schwarze 1409: .It Sy "empty tbl layout"
1410: .Pq tbl
1411: A table layout specification is completely empty,
1412: specifying zero lines and zero columns.
1413: As a fallback, a single left-justified column is used.
1414: .It Sy "invalid character in tbl layout"
1415: .Pq tbl
1416: A table layout specification contains a character that can neither
1417: be interpreted as a layout key character nor as a layout modifier,
1418: or a modifier precedes the first key.
1419: The invalid character is discarded.
1420: .It Sy "unmatched parenthesis in tbl layout"
1421: .Pq tbl
1422: A table layout specification contains an opening parenthesis,
1423: but no matching closing parenthesis.
1424: The rest of the input line, starting from the parenthesis, has no effect.
1.139 schwarze 1425: .It Sy "tbl without any data cells"
1426: .Pq tbl
1427: A table does not contain any data cells.
1428: It will probably produce no output.
1429: .It Sy "ignoring data in spanned tbl cell"
1430: .Pq tbl
1431: A table cell is marked as a horizontal span
1432: .Pq Sq Cm s
1433: or vertical span
1434: .Pq Sq Cm ^
1435: in the table layout, but it contains data.
1436: The data is ignored.
1437: .It Sy "ignoring extra tbl data cells"
1438: .Pq tbl
1439: A data line contains more cells than the corresponding layout line.
1440: The data in the extra cells is ignored.
1441: .It Sy "data block open at end of tbl"
1442: .Pq tbl
1443: A data block is opened with
1444: .Cm T{ ,
1445: but never closed with a matching
1446: .Cm T} .
1447: The remaining data lines of the table are all put into one cell,
1448: and any remaining cells stay empty.
1.106 schwarze 1449: .El
1450: .Ss "Errors related to roff, mdoc, and man code"
1451: .Bl -ohang
1452: .It Sy "input stack limit exceeded, infinite loop?"
1453: .Pq roff
1454: Explicit recursion limits are implemented for the following features,
1455: in order to prevent infinite loops:
1456: .Bl -dash -compact
1457: .It
1458: expansion of nested escape sequences
1459: including expansion of strings and number registers,
1460: .It
1461: expansion of nested user-defined macros,
1462: .It
1463: and
1464: .Ic \&so
1465: file inclusion.
1466: .El
1467: When a limit is hit, the output is incorrect, typically losing
1468: some content, but the parser can continue.
1469: .It Sy "skipping bad character"
1470: .Pq mdoc , man , roff
1471: The input file contains a byte that is not a printable
1472: .Xr ascii 7
1473: character.
1474: The message mentions the character number.
1475: The offending byte is replaced with a question mark
1476: .Pq Sq \&? .
1477: Consider editing the input file to replace the byte with an ASCII
1478: transliteration of the intended character.
1479: .It Sy "skipping unknown macro"
1480: .Pq mdoc , man , roff
1481: The first identifier on a request or macro line is neither recognized as a
1482: .Xr roff 7
1483: request, nor as a user-defined macro, nor, respectively, as an
1484: .Xr mdoc 7
1485: or
1486: .Xr man 7
1487: macro.
1488: It may be mistyped or unsupported.
1489: The request or macro is discarded including its arguments.
1.133 schwarze 1490: .It Sy "skipping insecure request"
1491: .Pq roff
1492: An input file attempted to run a shell command
1493: or to read or write an external file.
1494: Such attempts are denied for security reasons.
1.106 schwarze 1495: .It Sy "skipping item outside list"
1.118 schwarze 1496: .Pq mdoc , eqn
1.106 schwarze 1497: An
1498: .Ic \&It
1499: macro occurs outside any
1500: .Ic \&Bl
1.118 schwarze 1501: list, or an
1502: .Xr eqn 7
1503: .Ic above
1504: delimiter occurs outside any pile.
1.106 schwarze 1505: It is discarded including its arguments.
1506: .It Sy "skipping column outside column list"
1507: .Pq mdoc
1508: A
1509: .Ic \&Ta
1510: macro occurs outside any
1511: .Ic \&Bl Fl column
1512: block.
1513: It is discarded including its arguments.
1514: .It Sy "skipping end of block that is not open"
1515: .Pq mdoc , man , eqn , tbl , roff
1516: Various syntax elements can only be used to explicitly close blocks
1517: that have previously been opened.
1518: An
1519: .Xr mdoc 7
1520: block closing macro, a
1521: .Xr man 7
1522: .Ic \&RE
1523: or
1524: .Ic \&UE
1.118 schwarze 1525: macro, an
1526: .Xr eqn 7
1527: right delimiter or closing brace, or the end of an equation, table, or
1.106 schwarze 1528: .Xr roff 7
1529: conditional request is encountered but no matching block is open.
1530: The offending request or macro is discarded.
1.135 schwarze 1531: .It Sy "fewer RS blocks open, skipping"
1532: .Pq man
1533: The
1534: .Ic \&RE
1535: macro is invoked with an argument, but less than the specified number of
1536: .Ic \&RS
1537: blocks is open.
1538: The
1539: .Ic \&RE
1540: macro is discarded.
1.106 schwarze 1541: .It Sy "inserting missing end of block"
1542: .Pq mdoc , tbl
1543: Various
1544: .Xr mdoc 7
1545: macros as well as tables require explicit closing by dedicated macros.
1546: A block that doesn't support bad nesting
1547: ends before all of its children are properly closed.
1548: The open child nodes are closed implicitly.
1.152 schwarze 1549: .It Sy "appending missing end of block"
1.106 schwarze 1550: .Pq mdoc , man , eqn , tbl , roff
1551: At the end of the document, an explicit
1552: .Xr mdoc 7
1553: block, a
1554: .Xr man 7
1555: next-line scope or
1556: .Ic \&RS
1557: or
1558: .Ic \&UR
1559: block, an equation, table, or
1560: .Xr roff 7
1561: conditional or ignore block is still open.
1562: The open block is closed implicitly.
1563: .It Sy "escaped character not allowed in a name"
1564: .Pq roff
1565: Macro, string and register identifiers consist of printable,
1566: non-whitespace ASCII characters.
1567: Escape sequences and characters and strings expressed in terms of them
1568: cannot form part of a name.
1569: The first argument of an
1570: .Ic \&am ,
1571: .Ic \&as ,
1572: .Ic \&de ,
1573: .Ic \&ds ,
1574: .Ic \&nr ,
1575: or
1576: .Ic \&rr
1577: request, or any argument of an
1578: .Ic \&rm
1579: request, or the name of a request or user defined macro being called,
1580: is terminated by an escape sequence.
1581: In the cases of
1582: .Ic \&as ,
1583: .Ic \&ds ,
1584: and
1585: .Ic \&nr ,
1586: the request has no effect at all.
1587: In the cases of
1588: .Ic \&am ,
1589: .Ic \&de ,
1590: .Ic \&rr ,
1591: and
1592: .Ic \&rm ,
1593: what was parsed up to this point is used as the arguments to the request,
1594: and the rest of the input line is discarded including the escape sequence.
1595: When parsing for a request or a user-defined macro name to be called,
1596: only the escape sequence is discarded.
1597: The characters preceding it are used as the request or macro name,
1598: the characters following it are used as the arguments to the request or macro.
1.124 schwarze 1599: .It Sy "NOT IMPLEMENTED: Bd -file"
1600: .Pq mdoc
1601: For security reasons, the
1602: .Ic \&Bd
1603: macro does not support the
1604: .Fl file
1605: argument.
1606: By requesting the inclusion of a sensitive file, a malicious document
1607: might otherwise trick a privileged user into inadvertently displaying
1608: the file on the screen, revealing the file content to bystanders.
1609: The argument is ignored including the file name following it.
1.163 schwarze 1610: .It Sy "skipping display without arguments"
1611: .Pq mdoc
1612: A
1613: .Ic \&Bd
1614: block macro does not have any arguments.
1615: The block is discarded, and the block content is displayed in
1616: whatever mode was active before the block.
1.106 schwarze 1617: .It Sy "missing list type, using -item"
1618: .Pq mdoc
1619: A
1620: .Ic \&Bl
1621: macro fails to specify the list type.
1622: .It Sy "missing manual name, using \(dq\(dq"
1623: .Pq mdoc
1624: The first call to
1625: .Ic \&Nm
1626: lacks the required argument.
1627: .It Sy "uname(3) system call failed, using UNKNOWN"
1628: .Pq mdoc
1629: The
1630: .Ic \&Os
1631: macro is called without arguments, and the
1632: .Xr uname 3
1633: system call failed.
1634: As a workaround,
1635: .Nm
1636: can be compiled with
1637: .Sm off
1638: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1639: .Sm on
1640: .It Sy "unknown standard specifier"
1641: .Pq mdoc
1642: An
1643: .Ic \&St
1644: macro has an unknown argument and is discarded.
1645: .It Sy "skipping request without numeric argument"
1.118 schwarze 1646: .Pq roff , eqn
1.106 schwarze 1647: An
1648: .Ic \&it
1.118 schwarze 1649: request or an
1650: .Xr eqn 7
1651: .Ic \&size
1652: or
1653: .Ic \&gsize
1654: statement has a non-numeric or negative argument or no argument at all.
1655: The invalid request or statement is ignored.
1.132 schwarze 1656: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1657: .Pq roff
1658: For security reasons,
1659: .Nm
1660: allows
1661: .Ic \&so
1662: file inclusion requests only with relative paths
1663: and only without ascending to any parent directory.
1664: By requesting the inclusion of a sensitive file, a malicious document
1665: might otherwise trick a privileged user into inadvertently displaying
1666: the file on the screen, revealing the file content to bystanders.
1667: .Nm
1668: only shows the path as it appears behind
1669: .Ic \&so .
1670: .It Sy ".so request failed"
1671: .Pq roff
1672: Servicing a
1673: .Ic \&so
1674: request requires reading an external file, but the file could not be
1675: opened.
1676: .Nm
1677: only shows the path as it appears behind
1678: .Ic \&so .
1.106 schwarze 1679: .It Sy "skipping all arguments"
1680: .Pq mdoc , man , eqn , roff
1681: An
1682: .Xr mdoc 7
1683: .Ic \&Bt ,
1684: .Ic \&Ed ,
1685: .Ic \&Ef ,
1686: .Ic \&Ek ,
1687: .Ic \&El ,
1.144 schwarze 1688: .Ic \&Lp ,
1689: .Ic \&Pp ,
1.106 schwarze 1690: .Ic \&Re ,
1.143 schwarze 1691: .Ic \&Rs ,
1.106 schwarze 1692: or
1693: .Ic \&Ud
1694: macro, an
1695: .Ic \&It
1696: macro in a list that don't support item heads, a
1697: .Xr man 7
1698: .Ic \&LP ,
1699: .Ic \&P ,
1700: or
1701: .Ic \&PP
1702: macro, an
1703: .Xr eqn 7
1.120 schwarze 1704: .Ic \&EQ
1705: or
1.106 schwarze 1706: .Ic \&EN
1707: macro, or a
1708: .Xr roff 7
1.148 schwarze 1709: .Ic \&br ,
1710: .Ic \&fi ,
1711: or
1712: .Ic \&nf
1.144 schwarze 1713: request or
1.106 schwarze 1714: .Sq \&..
1715: block closing request is invoked with at least one argument.
1716: All arguments are ignored.
1717: .It Sy "skipping excess arguments"
1.135 schwarze 1718: .Pq mdoc , man , roff
1.150 schwarze 1719: A macro or request is invoked with too many arguments:
1720: .Bl -dash -offset 2n -width 2n -compact
1721: .It
1722: .Ic \&Fo ,
1723: .Ic \&PD ,
1724: .Ic \&RS ,
1725: .Ic \&UR ,
1726: .Ic \&ft ,
1727: or
1728: .Ic \&sp
1729: with more than one argument
1730: .It
1.144 schwarze 1731: .Ic \&An
1.150 schwarze 1732: with another argument after
1.144 schwarze 1733: .Fl split
1734: or
1.150 schwarze 1735: .Fl nosplit
1736: .It
1737: .Ic \&RE
1738: with more than one argument or with a non-integer argument
1739: .It
1740: .Ic \&OP
1741: or a request of the
1742: .Ic \&de
1743: family with more than two arguments
1.154 schwarze 1744: .It
1745: .Ic \&Dt
1746: with more than three arguments
1.150 schwarze 1747: .It
1748: .Ic \&TH
1749: with more than five arguments
1750: .It
1.145 schwarze 1751: .Ic \&Bd ,
1752: .Ic \&Bk ,
1753: or
1754: .Ic \&Bl
1.150 schwarze 1755: with invalid arguments
1756: .El
1.106 schwarze 1757: The excess arguments are ignored.
1.133 schwarze 1758: .El
1759: .Ss Unsupported features
1760: .Bl -ohang
1761: .It Sy "input too large"
1762: .Pq mdoc , man
1763: Currently,
1764: .Nm
1765: cannot handle input files larger than its arbitrary size limit
1766: of 2^31 bytes (2 Gigabytes).
1767: Since useful manuals are always small, this is not a problem in practice.
1768: Parsing is aborted as soon as the condition is detected.
1.136 schwarze 1769: .It Sy "unsupported control character"
1770: .Pq roff
1771: An ASCII control character supported by other
1772: .Xr roff 7
1773: implementations but not by
1774: .Nm
1775: was found in an input file.
1776: It is replaced by a question mark.
1.133 schwarze 1777: .It Sy "unsupported roff request"
1778: .Pq roff
1779: An input file contains a
1780: .Xr roff 7
1781: request supported by GNU troff or Heirloom troff but not by
1782: .Nm ,
1783: and it is likely that this will cause information loss
1784: or considerable misformatting.
1.139 schwarze 1785: .It Sy "eqn delim option in tbl"
1786: .Pq eqn , tbl
1787: The options line of a table defines equation delimiters.
1788: Any equation source code contained in the table will be printed unformatted.
1789: .It Sy "unsupported table layout modifier"
1.138 schwarze 1790: .Pq tbl
1791: A table layout specification contains an
1792: .Sq Cm m
1793: modifier.
1794: The modifier is discarded.
1.133 schwarze 1795: .It Sy "ignoring macro in table"
1.139 schwarze 1796: .Pq tbl , mdoc , man
1797: A table contains an invocation of an
1798: .Xr mdoc 7
1799: or
1800: .Xr man 7
1801: macro or of an undefined macro.
1802: The macro is ignored, and its arguments are handled
1803: as if they were a text line.
1.106 schwarze 1804: .El
1.1 kristaps 1805: .Sh SEE ALSO
1.141 schwarze 1806: .Xr apropos 1 ,
1807: .Xr man 1 ,
1.85 kristaps 1808: .Xr eqn 7 ,
1.57 kristaps 1809: .Xr man 7 ,
1.13 kristaps 1810: .Xr mandoc_char 7 ,
1.84 kristaps 1811: .Xr mdoc 7 ,
1812: .Xr roff 7 ,
1813: .Xr tbl 7
1.1 kristaps 1814: .Sh AUTHORS
1.156 schwarze 1815: .An -nosplit
1.1 kristaps 1816: The
1817: .Nm
1.26 kristaps 1818: utility was written by
1.141 schwarze 1819: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
1820: and is maintained by
1821: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
1822: .Sh BUGS
1.39 kristaps 1823: In
1.156 schwarze 1824: .Fl T Cm html ,
1.39 kristaps 1825: the maximum size of an element attribute is determined by
1826: .Dv BUFSIZ ,
1.57 kristaps 1827: which is usually 1024 bytes.
1828: Be aware of this when setting long link
1.58 kristaps 1829: formats such as
1.156 schwarze 1830: .Fl O Cm style Ns = Ns Ar really/long/link .
CVSweb