Annotation of mandoc/mandoc.1, Revision 1.171
1.171 ! schwarze 1: .\" $Id: mandoc.1,v 1.170 2017/01/12 17:29:33 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.171 ! schwarze 18: .Dd $Mdocdate: January 12 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.170 schwarze 501: .Pp
502: The first paragraph shows meta data found in the
503: .Xr mdoc 7
504: prologue, on the
505: .Xr man 7
506: .Ic \&TH
507: line, or the fallbacks used.
508: .Pp
509: In the tree dump, each output line shows one syntax tree node.
1.161 schwarze 510: Child nodes are indented with respect to their parent node.
511: The columns are:
512: .Pp
513: .Bl -enum -compact
514: .It
515: For macro nodes, the macro name; for text and
516: .Xr tbl 7
1.162 schwarze 517: nodes, the content.
518: There is a special format for
1.161 schwarze 519: .Xr eqn 7
520: nodes.
521: .It
522: Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
523: .It
524: Flags:
525: .Bl -dash -compact
526: .It
527: An opening parenthesis if the node is an opening delimiter.
528: .It
529: An asterisk if the node starts a new input line.
530: .It
531: The input line number (starting at one).
532: .It
533: A colon.
534: .It
535: The input column number (starting at one).
536: .It
537: A closing parenthesis if the node is a closing delimiter.
538: .It
539: A full stop if the node ends a sentence.
1.169 schwarze 540: .It
541: NOSRC if the node is not in the input file,
542: but automatically generated from macros.
543: .It
544: NOPRT if the node is not supposed to generate output
545: for any output format.
1.161 schwarze 546: .El
547: .El
1.108 schwarze 548: .Sh ENVIRONMENT
549: .Bl -tag -width MANPAGER
550: .It Ev MANPAGER
551: Any non-empty value of the environment variable
552: .Ev MANPAGER
553: will be used instead of the standard pagination program,
554: .Xr more 1 .
555: .It Ev PAGER
556: Specifies the pagination program to use when
557: .Ev MANPAGER
558: is not defined.
559: If neither PAGER nor MANPAGER is defined,
1.159 schwarze 560: .Xr more 1
561: .Fl s
1.108 schwarze 562: will be used.
563: .El
1.77 schwarze 564: .Sh EXIT STATUS
565: The
566: .Nm
567: utility exits with one of the following values, controlled by the message
568: .Ar level
569: associated with the
570: .Fl W
571: option:
572: .Pp
573: .Bl -tag -width Ds -compact
574: .It 0
575: No warnings or errors occurred, or those that did were ignored because
576: they were lower than the requested
577: .Ar level .
578: .It 2
579: At least one warning occurred, but no error, and
1.156 schwarze 580: .Fl W Cm warning
1.77 schwarze 581: was specified.
582: .It 3
1.133 schwarze 583: At least one parsing error occurred,
584: but no unsupported feature was encountered, and
1.156 schwarze 585: .Fl W Cm error
1.133 schwarze 586: or
1.156 schwarze 587: .Fl W Cm warning
1.133 schwarze 588: was specified.
589: .It 4
1.134 schwarze 590: At least one unsupported feature was encountered, and
1.156 schwarze 591: .Fl W Cm unsupp ,
592: .Fl W Cm error
1.77 schwarze 593: or
1.156 schwarze 594: .Fl W Cm warning
1.77 schwarze 595: was specified.
596: .It 5
597: Invalid command line arguments were specified.
598: No input files have been read.
599: .It 6
1.131 schwarze 600: An operating system error occurred, for example exhaustion
601: of memory, file descriptors, or process table entries.
1.77 schwarze 602: Such errors cause
603: .Nm
604: to exit at once, possibly in the middle of parsing or formatting a file.
605: .El
606: .Pp
607: Note that selecting
1.156 schwarze 608: .Fl T Cm lint
1.77 schwarze 609: output mode implies
1.156 schwarze 610: .Fl W Cm warning .
1.1 kristaps 611: .Sh EXAMPLES
1.13 kristaps 612: To page manuals to the terminal:
1.1 kristaps 613: .Pp
1.156 schwarze 614: .Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less
1.82 kristaps 615: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.28 kristaps 616: .Pp
1.41 kristaps 617: To produce HTML manuals with
1.164 schwarze 618: .Pa mandoc.css
1.41 kristaps 619: as the style-sheet:
1.38 kristaps 620: .Pp
1.164 schwarze 621: .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
1.38 kristaps 622: .Pp
1.28 kristaps 623: To check over a large set of manuals:
624: .Pp
1.158 schwarze 625: .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
1.66 kristaps 626: .Pp
627: To produce a series of PostScript manuals for A4 paper:
628: .Pp
1.156 schwarze 629: .Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.91 schwarze 630: .Pp
631: Convert a modern
632: .Xr mdoc 7
633: manual to the older
634: .Xr man 7
635: format, for use on systems lacking an
636: .Xr mdoc 7
637: parser:
638: .Pp
1.156 schwarze 639: .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
1.77 schwarze 640: .Sh DIAGNOSTICS
1.106 schwarze 641: Messages displayed by
642: .Nm
643: follow this format:
1.77 schwarze 644: .Pp
1.106 schwarze 645: .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
1.77 schwarze 646: .Pp
1.106 schwarze 647: Line and column numbers start at 1.
648: Both are omitted for messages referring to an input file as a whole.
649: Macro names and arguments are omitted where meaningless.
650: Fatal messages about invalid command line arguments
651: or operating system errors, for example when memory is exhausted,
652: may also omit the
653: .Ar file
1.104 schwarze 654: and
1.106 schwarze 655: .Ar level
656: fields.
1.104 schwarze 657: .Pp
1.77 schwarze 658: Message levels have the following meanings:
659: .Bl -tag -width "warning"
1.133 schwarze 660: .It Cm unsupp
661: An input file uses unsupported low-level
662: .Xr roff 7
663: features.
664: The output may be incomplete and/or misformatted,
665: so using GNU troff instead of
666: .Nm
667: to process the file may be preferable.
1.77 schwarze 668: .It Cm error
1.133 schwarze 669: An input file contains invalid syntax that cannot be safely interpreted.
1.77 schwarze 670: By discarding part of the input or inserting missing tokens,
671: the parser is able to continue, and the error does not prevent
672: generation of formatted output, but typically, preparing that
673: output involves information loss, broken document structure
1.133 schwarze 674: or unintended formatting, no matter whether
675: .Nm
676: or GNU troff is used.
677: In many cases, the output of
678: .Nm
679: and GNU troff is identical, but in some,
680: .Nm
681: is more resilient than GNU troff with respect to malformed input.
1.131 schwarze 682: .Pp
683: Non-existent or unreadable input files are also reported on the
684: .Cm error
685: level.
686: In that case, the parser cannot even be started and no output
687: is produced from those input files.
1.77 schwarze 688: .It Cm warning
689: An input file uses obsolete, discouraged or non-portable syntax.
690: All the same, the meaning of the input is unambiguous and a correct
691: rendering can be produced.
692: Documents causing warnings may render poorly when using other
693: formatting tools instead of
694: .Nm .
695: .El
696: .Pp
697: Messages of the
1.133 schwarze 698: .Cm warning ,
699: .Cm error ,
1.77 schwarze 700: and
1.133 schwarze 701: .Cm unsupp
1.131 schwarze 702: levels except those about non-existent or unreadable input files
703: are hidden unless their level, or a lower level, is requested using a
1.77 schwarze 704: .Fl W
705: option or
1.156 schwarze 706: .Fl T Cm lint
1.77 schwarze 707: output mode.
1.106 schwarze 708: .Ss Warnings related to the document prologue
709: .Bl -ohang
710: .It Sy "missing manual title, using UNTITLED"
711: .Pq mdoc
712: A
713: .Ic \&Dt
714: macro has no arguments, or there is no
715: .Ic \&Dt
716: macro before the first non-prologue macro.
717: .It Sy "missing manual title, using \(dq\(dq"
718: .Pq man
719: There is no
720: .Ic \&TH
721: macro, or it has no arguments.
722: .It Sy "lower case character in document title"
723: .Pq mdoc , man
724: The title is still used as given in the
725: .Ic \&Dt
726: or
727: .Ic \&TH
728: macro.
729: .It Sy "missing manual section, using \(dq\(dq"
730: .Pq mdoc , man
731: A
732: .Ic \&Dt
733: or
734: .Ic \&TH
735: macro lacks the mandatory section argument.
736: .It Sy "unknown manual section"
737: .Pq mdoc
738: The section number in a
739: .Ic \&Dt
740: line is invalid, but still used.
741: .It Sy "missing date, using today's date"
742: .Pq mdoc, man
743: The document was parsed as
744: .Xr mdoc 7
745: and it has no
746: .Ic \&Dd
747: macro, or the
748: .Ic \&Dd
749: macro has no arguments or only empty arguments;
750: or the document was parsed as
751: .Xr man 7
752: and it has no
753: .Ic \&TH
754: macro, or the
755: .Ic \&TH
756: macro has less than three arguments or its third argument is empty.
757: .It Sy "cannot parse date, using it verbatim"
758: .Pq mdoc , man
759: The date given in a
760: .Ic \&Dd
761: or
762: .Ic \&TH
763: macro does not follow the conventional format.
764: .It Sy "missing Os macro, using \(dq\(dq"
765: .Pq mdoc
766: The default or current system is not shown in this case.
767: .It Sy "duplicate prologue macro"
768: .Pq mdoc
769: One of the prologue macros occurs more than once.
770: The last instance overrides all previous ones.
771: .It Sy "late prologue macro"
772: .Pq mdoc
773: A
774: .Ic \&Dd
775: or
776: .Ic \&Os
777: macro occurs after some non-prologue macro, but still takes effect.
778: .It Sy "skipping late title macro"
779: .Pq mdoc
780: The
781: .Ic \&Dt
1.152 schwarze 782: macro appears after the first non-prologue macro.
783: Traditional formatters cannot handle this because
784: they write the page header before parsing the document body.
1.106 schwarze 785: Even though this technical restriction does not apply to
786: .Nm ,
787: traditional semantics is preserved.
788: The late macro is discarded including its arguments.
789: .It Sy "prologue macros out of order"
790: .Pq mdoc
791: The prologue macros are not given in the conventional order
792: .Ic \&Dd ,
793: .Ic \&Dt ,
794: .Ic \&Os .
795: All three macros are used even when given in another order.
796: .El
797: .Ss Warnings regarding document structure
798: .Bl -ohang
799: .It Sy ".so is fragile, better use ln(1)"
800: .Pq roff
801: Including files only works when the parser program runs with the correct
802: current working directory.
803: .It Sy "no document body"
804: .Pq mdoc , man
805: The document body contains neither text nor macros.
806: An empty document is shown, consisting only of a header and a footer line.
807: .It Sy "content before first section header"
808: .Pq mdoc , man
809: Some macros or text precede the first
810: .Ic \&Sh
811: or
812: .Ic \&SH
813: section header.
814: The offending macros and text are parsed and added to the top level
815: of the syntax tree, outside any section block.
816: .It Sy "first section is not NAME"
817: .Pq mdoc
818: The argument of the first
819: .Ic \&Sh
820: macro is not
821: .Sq NAME .
822: This may confuse
823: .Xr makewhatis 8
824: and
825: .Xr apropos 1 .
1.168 schwarze 826: .It Sy "NAME section without Nm before Nd"
1.106 schwarze 827: .Pq mdoc
1.155 schwarze 828: The NAME section does not contain any
829: .Ic \&Nm
1.168 schwarze 830: child macro before the first
831: .Ic \&Nd
832: macro.
1.155 schwarze 833: .It Sy "NAME section without description"
834: .Pq mdoc
835: The NAME section lacks the mandatory
836: .Ic \&Nd
837: child macro.
838: .It Sy "description not at the end of NAME"
839: .Pq mdoc
840: The NAME section does contain an
1.106 schwarze 841: .Ic \&Nd
1.155 schwarze 842: child macro, but other content follows it.
843: .It Sy "bad NAME section content"
844: .Pq mdoc
845: The NAME section contains plain text or macros other than
846: .Ic \&Nm
1.106 schwarze 847: and
1.155 schwarze 848: .Ic \&Nd .
1.168 schwarze 849: .It Sy "missing comma before name"
850: .Pq mdoc
851: The NAME section contains an
852: .Ic \&Nm
853: macro that is neither the first one nor preceded by a comma.
1.142 schwarze 854: .It Sy "missing description line, using \(dq\(dq"
855: .Pq mdoc
856: The
857: .Ic \&Nd
858: macro lacks the required argument.
859: The title line of the manual will end after the dash.
1.106 schwarze 860: .It Sy "sections out of conventional order"
861: .Pq mdoc
862: A standard section occurs after another section it usually precedes.
863: All section titles are used as given,
864: and the order of sections is not changed.
865: .It Sy "duplicate section title"
866: .Pq mdoc
867: The same standard section title occurs more than once.
868: .It Sy "unexpected section"
869: .Pq mdoc
870: A standard section header occurs in a section of the manual
871: where it normally isn't useful.
1.112 schwarze 872: .It Sy "unusual Xr order"
873: .Pq mdoc
874: In the SEE ALSO section, an
875: .Ic \&Xr
876: macro with a lower section number follows one with a higher number,
877: or two
878: .Ic \&Xr
1.157 schwarze 879: macros referring to the same section are out of alphabetical order.
1.112 schwarze 880: .It Sy "unusual Xr punctuation"
881: .Pq mdoc
882: In the SEE ALSO section, punctuation between two
883: .Ic \&Xr
884: macros differs from a single comma, or there is trailing punctuation
885: after the last
886: .Ic \&Xr
887: macro.
1.111 schwarze 888: .It Sy "AUTHORS section without An macro"
889: .Pq mdoc
890: An AUTHORS sections contains no
891: .Ic \&An
892: macros, or only empty ones.
893: Probably, there are author names lacking markup.
1.106 schwarze 894: .El
895: .Ss "Warnings related to macros and nesting"
896: .Bl -ohang
897: .It Sy "obsolete macro"
898: .Pq mdoc
899: See the
900: .Xr mdoc 7
901: manual for replacements.
1.126 schwarze 902: .It Sy "macro neither callable nor escaped"
903: .Pq mdoc
904: The name of a macro that is not callable appears on a macro line.
905: It is printed verbatim.
1.152 schwarze 906: If the intention is to call it, move it to its own input line;
1.126 schwarze 907: otherwise, escape it by prepending
908: .Sq \e& .
1.106 schwarze 909: .It Sy "skipping paragraph macro"
910: In
911: .Xr mdoc 7
912: documents, this happens
913: .Bl -dash -compact
914: .It
915: at the beginning and end of sections and subsections
916: .It
917: right before non-compact lists and displays
918: .It
919: at the end of items in non-column, non-compact lists
920: .It
921: and for multiple consecutive paragraph macros.
922: .El
923: In
924: .Xr man 7
925: documents, it happens
926: .Bl -dash -compact
927: .It
928: for empty
929: .Ic \&P ,
930: .Ic \&PP ,
931: and
932: .Ic \&LP
933: macros
934: .It
935: for
936: .Ic \&IP
937: macros having neither head nor body arguments
938: .It
939: for
940: .Ic \&br
941: or
942: .Ic \&sp
943: right after
944: .Ic \&SH
945: or
946: .Ic \&SS
947: .El
948: .It Sy "moving paragraph macro out of list"
949: .Pq mdoc
950: A list item in a
951: .Ic \&Bl
952: list contains a trailing paragraph macro.
953: The paragraph macro is moved after the end of the list.
954: .It Sy "skipping no-space macro"
955: .Pq mdoc
956: An input line begins with an
957: .Ic \&Ns
958: macro.
959: The macro is ignored.
960: .It Sy "blocks badly nested"
961: .Pq mdoc
962: If two blocks intersect, one should completely contain the other.
963: Otherwise, rendered output is likely to look strange in any output
964: format, and rendering in SGML-based output formats is likely to be
965: outright wrong because such languages do not support badly nested
966: blocks at all.
967: Typical examples of badly nested blocks are
968: .Qq Ic \&Ao \&Bo \&Ac \&Bc
969: and
970: .Qq Ic \&Ao \&Bq \&Ac .
971: In these examples,
972: .Ic \&Ac
973: breaks
974: .Ic \&Bo
975: and
976: .Ic \&Bq ,
977: respectively.
978: .It Sy "nested displays are not portable"
979: .Pq mdoc
980: A
981: .Ic \&Bd ,
982: .Ic \&D1 ,
983: or
984: .Ic \&Dl
985: display occurs nested inside another
986: .Ic \&Bd
987: display.
988: This works with
989: .Nm ,
990: but fails with most other implementations.
991: .It Sy "moving content out of list"
992: .Pq mdoc
993: A
994: .Ic \&Bl
995: list block contains text or macros before the first
996: .Ic \&It
997: macro.
998: The offending children are moved before the beginning of the list.
999: .It Sy "fill mode already enabled, skipping"
1000: .Pq man
1001: A
1002: .Ic \&fi
1003: request occurs even though the document is still in fill mode,
1004: or already switched back to fill mode.
1005: It has no effect.
1006: .It Sy "fill mode already disabled, skipping"
1007: .Pq man
1008: An
1009: .Ic \&nf
1010: request occurs even though the document already switched to no-fill mode
1011: and did not switch back to fill mode yet.
1012: It has no effect.
1013: .It Sy "line scope broken"
1014: .Pq man
1015: While parsing the next-line scope of the previous macro,
1016: another macro is found that prematurely terminates the previous one.
1017: The previous, interrupted macro is deleted from the parse tree.
1018: .El
1019: .Ss "Warnings related to missing arguments"
1020: .Bl -ohang
1021: .It Sy "skipping empty request"
1.118 schwarze 1022: .Pq roff , eqn
1023: The macro name is missing from a macro definition request,
1024: or an
1025: .Xr eqn 7
1026: control statement or operation keyword lacks its required argument.
1.106 schwarze 1027: .It Sy "conditional request controls empty scope"
1028: .Pq roff
1029: A conditional request is only useful if any of the following
1030: follows it on the same logical input line:
1031: .Bl -dash -compact
1032: .It
1033: The
1034: .Sq \e{
1035: keyword to open a multi-line scope.
1036: .It
1037: A request or macro or some text, resulting in a single-line scope.
1038: .It
1039: The immediate end of the logical line without any intervening whitespace,
1040: resulting in next-line scope.
1041: .El
1042: Here, a conditional request is followed by trailing whitespace only,
1043: and there is no other content on its logical input line.
1044: Note that it doesn't matter whether the logical input line is split
1045: across multiple physical input lines using
1046: .Sq \e
1047: line continuation characters.
1048: This is one of the rare cases
1049: where trailing whitespace is syntactically significant.
1050: The conditional request controls a scope containing whitespace only,
1051: so it is unlikely to have a significant effect,
1052: except that it may control a following
1053: .Ic \&el
1054: clause.
1055: .It Sy "skipping empty macro"
1056: .Pq mdoc
1.147 schwarze 1057: The indicated macro has no arguments and hence no effect.
1058: .It Sy "empty block"
1059: .Pq mdoc , man
1060: A
1061: .Ic \&Bd ,
1062: .Ic \&Bk ,
1063: .Ic \&Bl ,
1064: .Ic \&D1 ,
1065: .Ic \&Dl ,
1066: .Ic \&RS ,
1067: or
1068: .Ic \&UR
1069: block contains nothing in its body and will produce no output.
1.106 schwarze 1070: .It Sy "empty argument, using 0n"
1071: .Pq mdoc
1072: The required width is missing after
1073: .Ic \&Bd
1074: or
1075: .Ic \&Bl
1076: .Fl offset
1077: or
1078: .Fl width.
1079: .It Sy "missing display type, using -ragged"
1080: .Pq mdoc
1081: The
1082: .Ic \&Bd
1083: macro is invoked without the required display type.
1084: .It Sy "list type is not the first argument"
1085: .Pq mdoc
1086: In a
1087: .Ic \&Bl
1088: macro, at least one other argument precedes the type argument.
1089: The
1090: .Nm
1091: utility copes with any argument order, but some other
1092: .Xr mdoc 7
1093: implementations do not.
1094: .It Sy "missing -width in -tag list, using 8n"
1095: .Pq mdoc
1096: Every
1097: .Ic \&Bl
1098: macro having the
1099: .Fl tag
1100: argument requires
1101: .Fl width ,
1102: too.
1103: .It Sy "missing utility name, using \(dq\(dq"
1104: .Pq mdoc
1105: The
1106: .Ic \&Ex Fl std
1107: macro is called without an argument before
1108: .Ic \&Nm
1109: has first been called with an argument.
1.146 schwarze 1110: .It Sy "missing function name, using \(dq\(dq"
1111: .Pq mdoc
1112: The
1113: .Ic \&Fo
1114: macro is called without an argument.
1115: No function name is printed.
1.106 schwarze 1116: .It Sy "empty head in list item"
1117: .Pq mdoc
1118: In a
1119: .Ic \&Bl
1120: .Fl diag ,
1121: .Fl hang ,
1122: .Fl inset ,
1123: .Fl ohang ,
1124: or
1125: .Fl tag
1126: list, an
1127: .Ic \&It
1128: macro lacks the required argument.
1129: The item head is left empty.
1130: .It Sy "empty list item"
1131: .Pq mdoc
1132: In a
1133: .Ic \&Bl
1134: .Fl bullet ,
1135: .Fl dash ,
1136: .Fl enum ,
1137: or
1138: .Fl hyphen
1139: list, an
1140: .Ic \&It
1141: block is empty.
1142: An empty list item is shown.
1.152 schwarze 1143: .It Sy "missing font type, using \efR"
1.106 schwarze 1144: .Pq mdoc
1145: A
1146: .Ic \&Bf
1147: macro has no argument.
1.152 schwarze 1148: It switches to the default font.
1149: .It Sy "unknown font type, using \efR"
1.106 schwarze 1150: .Pq mdoc
1151: The
1152: .Ic \&Bf
1153: argument is invalid.
1.152 schwarze 1154: The default font is used instead.
1.127 schwarze 1155: .It Sy "nothing follows prefix"
1156: .Pq mdoc
1157: A
1158: .Ic \&Pf
1159: macro has no argument, or only one argument and no macro follows
1160: on the same input line.
1161: This defeats its purpose; in particular, spacing is not suppressed
1162: before the text or macros following on the next input line.
1.143 schwarze 1163: .It Sy "empty reference block"
1164: .Pq mdoc
1165: An
1166: .Ic \&Rs
1167: macro is immediately followed by an
1168: .Ic \&Re
1169: macro on the next input line.
1170: Such an empty block does not produce any output.
1.165 schwarze 1171: .It Sy "missing section argument"
1172: .Pq mdoc
1173: An
1174: .Ic \&Xr
1175: macro lacks its second, section number argument.
1176: The first argument, i.e. the name, is printed, but without subsequent
1.166 schwarze 1177: parentheses.
1.106 schwarze 1178: .It Sy "missing -std argument, adding it"
1179: .Pq mdoc
1180: An
1181: .Ic \&Ex
1182: or
1183: .Ic \&Rv
1184: macro lacks the required
1185: .Fl std
1186: argument.
1187: The
1188: .Nm
1189: utility assumes
1190: .Fl std
1191: even when it is not specified, but other implementations may not.
1.150 schwarze 1192: .It Sy "missing option string, using \(dq\(dq"
1193: .Pq man
1194: The
1195: .Ic \&OP
1196: macro is invoked without any argument.
1197: An empty pair of square brackets is shown.
1198: .It Sy "missing resource identifier, using \(dq\(dq"
1199: .Pq man
1200: The
1201: .Ic \&UR
1202: macro is invoked without any argument.
1203: An empty pair of angle brackets is shown.
1.118 schwarze 1204: .It Sy "missing eqn box, using \(dq\(dq"
1205: .Pq eqn
1206: A diacritic mark or a binary operator is found,
1207: but there is nothing to the left of it.
1208: An empty box is inserted.
1.106 schwarze 1209: .El
1210: .Ss "Warnings related to bad macro arguments"
1211: .Bl -ohang
1212: .It Sy "unterminated quoted argument"
1213: .Pq roff
1214: Macro arguments can be enclosed in double quote characters
1215: such that space characters and macro names contained in the quoted
1216: argument need not be escaped.
1217: The closing quote of the last argument of a macro can be omitted.
1218: However, omitting it is not recommended because it makes the code
1219: harder to read.
1220: .It Sy "duplicate argument"
1221: .Pq mdoc
1222: A
1223: .Ic \&Bd
1224: or
1225: .Ic \&Bl
1226: macro has more than one
1227: .Fl compact ,
1228: more than one
1229: .Fl offset ,
1230: or more than one
1231: .Fl width
1232: argument.
1233: All but the last instances of these arguments are ignored.
1234: .It Sy "skipping duplicate argument"
1235: .Pq mdoc
1236: An
1237: .Ic \&An
1238: macro has more than one
1239: .Fl split
1240: or
1241: .Fl nosplit
1242: argument.
1243: All but the first of these arguments are ignored.
1244: .It Sy "skipping duplicate display type"
1245: .Pq mdoc
1246: A
1247: .Ic \&Bd
1248: macro has more than one type argument; the first one is used.
1249: .It Sy "skipping duplicate list type"
1250: .Pq mdoc
1251: A
1252: .Ic \&Bl
1253: macro has more than one type argument; the first one is used.
1254: .It Sy "skipping -width argument"
1255: .Pq mdoc
1256: A
1257: .Ic \&Bl
1258: .Fl column ,
1259: .Fl diag ,
1260: .Fl ohang ,
1261: .Fl inset ,
1262: or
1263: .Fl item
1264: list has a
1265: .Fl width
1266: argument.
1267: That has no effect.
1.151 schwarze 1268: .It Sy "wrong number of cells"
1269: In a line of a
1270: .Ic \&Bl Fl column
1271: list, the number of tabs or
1272: .Ic \&Ta
1273: macros is less than the number expected from the list header line
1274: or exceeds the expected number by more than one.
1275: Missing cells remain empty, and all cells exceeding the number of
1276: columns are joined into one single cell.
1.106 schwarze 1277: .It Sy "unknown AT&T UNIX version"
1278: .Pq mdoc
1279: An
1280: .Ic \&At
1281: macro has an invalid argument.
1282: It is used verbatim, with
1283: .Qq "AT&T UNIX "
1284: prefixed to it.
1.113 schwarze 1285: .It Sy "comma in function argument"
1286: .Pq mdoc
1287: An argument of an
1288: .Ic \&Fa
1289: or
1290: .Ic \&Fn
1291: macro contains a comma; it should probably be split into two arguments.
1.117 schwarze 1292: .It Sy "parenthesis in function name"
1293: .Pq mdoc
1294: The first argument of an
1295: .Ic \&Fc
1296: or
1297: .Ic \&Fn
1298: macro contains an opening or closing parenthesis; that's probably wrong,
1299: parentheses are added automatically.
1.106 schwarze 1300: .It Sy "invalid content in Rs block"
1301: .Pq mdoc
1302: An
1303: .Ic \&Rs
1304: block contains plain text or non-% macros.
1305: The bogus content is left in the syntax tree.
1306: Formatting may be poor.
1307: .It Sy "invalid Boolean argument"
1308: .Pq mdoc
1309: An
1310: .Ic \&Sm
1311: macro has an argument other than
1312: .Cm on
1313: or
1314: .Cm off .
1315: The invalid argument is moved out of the macro, which leaves the macro
1316: empty, causing it to toggle the spacing mode.
1317: .It Sy "unknown font, skipping request"
1.115 schwarze 1318: .Pq man , tbl
1.106 schwarze 1319: A
1320: .Xr roff 7
1321: .Ic \&ft
1.115 schwarze 1322: request or a
1323: .Xr tbl 7
1324: .Ic \&f
1325: layout modifier has an unknown
1326: .Ar font
1327: argument.
1.151 schwarze 1328: .It Sy "odd number of characters in request"
1329: .Pq roff
1330: A
1331: .Ic \&tr
1332: request contains an odd number of characters.
1333: The last character is mapped to the blank character.
1.106 schwarze 1334: .El
1335: .Ss "Warnings related to plain text"
1336: .Bl -ohang
1337: .It Sy "blank line in fill mode, using .sp"
1338: .Pq mdoc
1339: The meaning of blank input lines is only well-defined in non-fill mode:
1340: In fill mode, line breaks of text input lines are not supposed to be
1341: significant.
1342: However, for compatibility with groff, blank lines in fill mode
1343: are replaced with
1344: .Ic \&sp
1345: requests.
1346: .It Sy "tab in filled text"
1347: .Pq mdoc , man
1348: The meaning of tab characters is only well-defined in non-fill mode:
1349: In fill mode, whitespace is not supposed to be significant
1350: on text input lines.
1351: As an implementation dependent choice, tab characters on text lines
1352: are passed through to the formatters in any case.
1353: Given that the text before the tab character will be filled,
1354: it is hard to predict which tab stop position the tab will advance to.
1355: .It Sy "whitespace at end of input line"
1356: .Pq mdoc , man , roff
1357: Whitespace at the end of input lines is almost never semantically
1358: significant \(em but in the odd case where it might be, it is
1359: extremely confusing when reviewing and maintaining documents.
1360: .It Sy "bad comment style"
1361: .Pq roff
1362: Comment lines start with a dot, a backslash, and a double-quote character.
1363: The
1364: .Nm
1365: utility treats the line as a comment line even without the backslash,
1366: but leaving out the backslash might not be portable.
1367: .It Sy "invalid escape sequence"
1368: .Pq roff
1369: An escape sequence has an invalid opening argument delimiter, lacks the
1370: closing argument delimiter, or the argument has too few characters.
1371: If the argument is incomplete,
1372: .Ic \e*
1373: and
1374: .Ic \en
1375: expand to an empty string,
1376: .Ic \eB
1377: to the digit
1378: .Sq 0 ,
1379: and
1380: .Ic \ew
1381: to the length of the incomplete argument.
1382: All other invalid escape sequences are ignored.
1383: .It Sy "undefined string, using \(dq\(dq"
1384: .Pq roff
1385: If a string is used without being defined before,
1386: its value is implicitly set to the empty string.
1387: However, defining strings explicitly before use
1388: keeps the code more readable.
1389: .El
1.138 schwarze 1390: .Ss "Warnings related to tables"
1391: .Bl -ohang
1392: .It Sy "tbl line starts with span"
1393: .Pq tbl
1394: The first cell in a table layout line is a horizontal span
1395: .Pq Sq Cm s .
1396: Data provided for this cell is ignored, and nothing is printed in the cell.
1397: .It Sy "tbl column starts with span"
1398: .Pq tbl
1399: The first line of a table layout specification
1400: requests a vertical span
1401: .Pq Sq Cm ^ .
1402: Data provided for this cell is ignored, and nothing is printed in the cell.
1403: .It Sy "skipping vertical bar in tbl layout"
1404: .Pq tbl
1405: A table layout specification contains more than two consecutive vertical bars.
1406: A double bar is printed, all additional bars are discarded.
1.106 schwarze 1407: .El
1408: .Ss "Errors related to tables"
1.136 schwarze 1409: .Bl -ohang
1410: .It Sy "non-alphabetic character in tbl options"
1411: .Pq tbl
1412: The table options line contains a character other than a letter,
1413: blank, or comma where the beginning of an option name is expected.
1414: The character is ignored.
1415: .It Sy "skipping unknown tbl option"
1416: .Pq tbl
1417: The table options line contains a string of letters that does not
1418: match any known option name.
1419: The word is ignored.
1420: .It Sy "missing tbl option argument"
1421: .Pq tbl
1422: A table option that requires an argument is not followed by an
1423: opening parenthesis, or the opening parenthesis is immediately
1424: followed by a closing parenthesis.
1425: The option is ignored.
1426: .It Sy "wrong tbl option argument size"
1427: .Pq tbl
1428: A table option argument contains an invalid number of characters.
1429: Both the option and the argument are ignored.
1.138 schwarze 1430: .It Sy "empty tbl layout"
1431: .Pq tbl
1432: A table layout specification is completely empty,
1433: specifying zero lines and zero columns.
1434: As a fallback, a single left-justified column is used.
1435: .It Sy "invalid character in tbl layout"
1436: .Pq tbl
1437: A table layout specification contains a character that can neither
1438: be interpreted as a layout key character nor as a layout modifier,
1439: or a modifier precedes the first key.
1440: The invalid character is discarded.
1441: .It Sy "unmatched parenthesis in tbl layout"
1442: .Pq tbl
1443: A table layout specification contains an opening parenthesis,
1444: but no matching closing parenthesis.
1445: The rest of the input line, starting from the parenthesis, has no effect.
1.139 schwarze 1446: .It Sy "tbl without any data cells"
1447: .Pq tbl
1448: A table does not contain any data cells.
1449: It will probably produce no output.
1450: .It Sy "ignoring data in spanned tbl cell"
1451: .Pq tbl
1452: A table cell is marked as a horizontal span
1453: .Pq Sq Cm s
1454: or vertical span
1455: .Pq Sq Cm ^
1456: in the table layout, but it contains data.
1457: The data is ignored.
1458: .It Sy "ignoring extra tbl data cells"
1459: .Pq tbl
1460: A data line contains more cells than the corresponding layout line.
1461: The data in the extra cells is ignored.
1462: .It Sy "data block open at end of tbl"
1463: .Pq tbl
1464: A data block is opened with
1465: .Cm T{ ,
1466: but never closed with a matching
1467: .Cm T} .
1468: The remaining data lines of the table are all put into one cell,
1469: and any remaining cells stay empty.
1.106 schwarze 1470: .El
1471: .Ss "Errors related to roff, mdoc, and man code"
1472: .Bl -ohang
1473: .It Sy "input stack limit exceeded, infinite loop?"
1474: .Pq roff
1475: Explicit recursion limits are implemented for the following features,
1476: in order to prevent infinite loops:
1477: .Bl -dash -compact
1478: .It
1479: expansion of nested escape sequences
1480: including expansion of strings and number registers,
1481: .It
1482: expansion of nested user-defined macros,
1483: .It
1484: and
1485: .Ic \&so
1486: file inclusion.
1487: .El
1488: When a limit is hit, the output is incorrect, typically losing
1489: some content, but the parser can continue.
1490: .It Sy "skipping bad character"
1491: .Pq mdoc , man , roff
1492: The input file contains a byte that is not a printable
1493: .Xr ascii 7
1494: character.
1495: The message mentions the character number.
1496: The offending byte is replaced with a question mark
1497: .Pq Sq \&? .
1498: Consider editing the input file to replace the byte with an ASCII
1499: transliteration of the intended character.
1500: .It Sy "skipping unknown macro"
1501: .Pq mdoc , man , roff
1502: The first identifier on a request or macro line is neither recognized as a
1503: .Xr roff 7
1504: request, nor as a user-defined macro, nor, respectively, as an
1505: .Xr mdoc 7
1506: or
1507: .Xr man 7
1508: macro.
1509: It may be mistyped or unsupported.
1510: The request or macro is discarded including its arguments.
1.133 schwarze 1511: .It Sy "skipping insecure request"
1512: .Pq roff
1513: An input file attempted to run a shell command
1514: or to read or write an external file.
1515: Such attempts are denied for security reasons.
1.106 schwarze 1516: .It Sy "skipping item outside list"
1.118 schwarze 1517: .Pq mdoc , eqn
1.106 schwarze 1518: An
1519: .Ic \&It
1520: macro occurs outside any
1521: .Ic \&Bl
1.118 schwarze 1522: list, or an
1523: .Xr eqn 7
1524: .Ic above
1525: delimiter occurs outside any pile.
1.106 schwarze 1526: It is discarded including its arguments.
1527: .It Sy "skipping column outside column list"
1528: .Pq mdoc
1529: A
1530: .Ic \&Ta
1531: macro occurs outside any
1532: .Ic \&Bl Fl column
1533: block.
1534: It is discarded including its arguments.
1535: .It Sy "skipping end of block that is not open"
1536: .Pq mdoc , man , eqn , tbl , roff
1537: Various syntax elements can only be used to explicitly close blocks
1538: that have previously been opened.
1539: An
1540: .Xr mdoc 7
1541: block closing macro, a
1542: .Xr man 7
1543: .Ic \&RE
1544: or
1545: .Ic \&UE
1.118 schwarze 1546: macro, an
1547: .Xr eqn 7
1548: right delimiter or closing brace, or the end of an equation, table, or
1.106 schwarze 1549: .Xr roff 7
1550: conditional request is encountered but no matching block is open.
1551: The offending request or macro is discarded.
1.135 schwarze 1552: .It Sy "fewer RS blocks open, skipping"
1553: .Pq man
1554: The
1555: .Ic \&RE
1556: macro is invoked with an argument, but less than the specified number of
1557: .Ic \&RS
1558: blocks is open.
1559: The
1560: .Ic \&RE
1561: macro is discarded.
1.106 schwarze 1562: .It Sy "inserting missing end of block"
1563: .Pq mdoc , tbl
1564: Various
1565: .Xr mdoc 7
1566: macros as well as tables require explicit closing by dedicated macros.
1567: A block that doesn't support bad nesting
1568: ends before all of its children are properly closed.
1569: The open child nodes are closed implicitly.
1.152 schwarze 1570: .It Sy "appending missing end of block"
1.106 schwarze 1571: .Pq mdoc , man , eqn , tbl , roff
1572: At the end of the document, an explicit
1573: .Xr mdoc 7
1574: block, a
1575: .Xr man 7
1576: next-line scope or
1577: .Ic \&RS
1578: or
1579: .Ic \&UR
1580: block, an equation, table, or
1581: .Xr roff 7
1582: conditional or ignore block is still open.
1583: The open block is closed implicitly.
1584: .It Sy "escaped character not allowed in a name"
1585: .Pq roff
1586: Macro, string and register identifiers consist of printable,
1587: non-whitespace ASCII characters.
1588: Escape sequences and characters and strings expressed in terms of them
1589: cannot form part of a name.
1590: The first argument of an
1591: .Ic \&am ,
1592: .Ic \&as ,
1593: .Ic \&de ,
1594: .Ic \&ds ,
1595: .Ic \&nr ,
1596: or
1597: .Ic \&rr
1598: request, or any argument of an
1599: .Ic \&rm
1600: request, or the name of a request or user defined macro being called,
1601: is terminated by an escape sequence.
1602: In the cases of
1603: .Ic \&as ,
1604: .Ic \&ds ,
1605: and
1606: .Ic \&nr ,
1607: the request has no effect at all.
1608: In the cases of
1609: .Ic \&am ,
1610: .Ic \&de ,
1611: .Ic \&rr ,
1612: and
1613: .Ic \&rm ,
1614: what was parsed up to this point is used as the arguments to the request,
1615: and the rest of the input line is discarded including the escape sequence.
1616: When parsing for a request or a user-defined macro name to be called,
1617: only the escape sequence is discarded.
1618: The characters preceding it are used as the request or macro name,
1619: the characters following it are used as the arguments to the request or macro.
1.124 schwarze 1620: .It Sy "NOT IMPLEMENTED: Bd -file"
1621: .Pq mdoc
1622: For security reasons, the
1623: .Ic \&Bd
1624: macro does not support the
1625: .Fl file
1626: argument.
1627: By requesting the inclusion of a sensitive file, a malicious document
1628: might otherwise trick a privileged user into inadvertently displaying
1629: the file on the screen, revealing the file content to bystanders.
1630: The argument is ignored including the file name following it.
1.163 schwarze 1631: .It Sy "skipping display without arguments"
1632: .Pq mdoc
1633: A
1634: .Ic \&Bd
1635: block macro does not have any arguments.
1636: The block is discarded, and the block content is displayed in
1637: whatever mode was active before the block.
1.106 schwarze 1638: .It Sy "missing list type, using -item"
1639: .Pq mdoc
1640: A
1641: .Ic \&Bl
1642: macro fails to specify the list type.
1643: .It Sy "missing manual name, using \(dq\(dq"
1644: .Pq mdoc
1645: The first call to
1.168 schwarze 1646: .Ic \&Nm ,
1647: or any call in the NAME section, lacks the required argument.
1.106 schwarze 1648: .It Sy "uname(3) system call failed, using UNKNOWN"
1649: .Pq mdoc
1650: The
1651: .Ic \&Os
1652: macro is called without arguments, and the
1653: .Xr uname 3
1654: system call failed.
1655: As a workaround,
1656: .Nm
1657: can be compiled with
1658: .Sm off
1659: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1660: .Sm on
1661: .It Sy "unknown standard specifier"
1662: .Pq mdoc
1663: An
1664: .Ic \&St
1665: macro has an unknown argument and is discarded.
1666: .It Sy "skipping request without numeric argument"
1.118 schwarze 1667: .Pq roff , eqn
1.106 schwarze 1668: An
1669: .Ic \&it
1.118 schwarze 1670: request or an
1671: .Xr eqn 7
1672: .Ic \&size
1673: or
1674: .Ic \&gsize
1675: statement has a non-numeric or negative argument or no argument at all.
1676: The invalid request or statement is ignored.
1.132 schwarze 1677: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1678: .Pq roff
1679: For security reasons,
1680: .Nm
1681: allows
1682: .Ic \&so
1683: file inclusion requests only with relative paths
1684: and only without ascending to any parent directory.
1685: By requesting the inclusion of a sensitive file, a malicious document
1686: might otherwise trick a privileged user into inadvertently displaying
1687: the file on the screen, revealing the file content to bystanders.
1688: .Nm
1689: only shows the path as it appears behind
1690: .Ic \&so .
1691: .It Sy ".so request failed"
1692: .Pq roff
1693: Servicing a
1694: .Ic \&so
1695: request requires reading an external file, but the file could not be
1696: opened.
1697: .Nm
1698: only shows the path as it appears behind
1699: .Ic \&so .
1.106 schwarze 1700: .It Sy "skipping all arguments"
1701: .Pq mdoc , man , eqn , roff
1702: An
1703: .Xr mdoc 7
1704: .Ic \&Bt ,
1705: .Ic \&Ed ,
1706: .Ic \&Ef ,
1707: .Ic \&Ek ,
1708: .Ic \&El ,
1.144 schwarze 1709: .Ic \&Lp ,
1710: .Ic \&Pp ,
1.106 schwarze 1711: .Ic \&Re ,
1.143 schwarze 1712: .Ic \&Rs ,
1.106 schwarze 1713: or
1714: .Ic \&Ud
1715: macro, an
1716: .Ic \&It
1717: macro in a list that don't support item heads, a
1718: .Xr man 7
1719: .Ic \&LP ,
1720: .Ic \&P ,
1721: or
1722: .Ic \&PP
1723: macro, an
1724: .Xr eqn 7
1.120 schwarze 1725: .Ic \&EQ
1726: or
1.106 schwarze 1727: .Ic \&EN
1728: macro, or a
1729: .Xr roff 7
1.148 schwarze 1730: .Ic \&br ,
1731: .Ic \&fi ,
1732: or
1733: .Ic \&nf
1.144 schwarze 1734: request or
1.106 schwarze 1735: .Sq \&..
1736: block closing request is invoked with at least one argument.
1737: All arguments are ignored.
1738: .It Sy "skipping excess arguments"
1.135 schwarze 1739: .Pq mdoc , man , roff
1.150 schwarze 1740: A macro or request is invoked with too many arguments:
1741: .Bl -dash -offset 2n -width 2n -compact
1742: .It
1743: .Ic \&Fo ,
1744: .Ic \&PD ,
1745: .Ic \&RS ,
1746: .Ic \&UR ,
1747: .Ic \&ft ,
1748: or
1749: .Ic \&sp
1750: with more than one argument
1751: .It
1.144 schwarze 1752: .Ic \&An
1.150 schwarze 1753: with another argument after
1.144 schwarze 1754: .Fl split
1755: or
1.150 schwarze 1756: .Fl nosplit
1757: .It
1758: .Ic \&RE
1759: with more than one argument or with a non-integer argument
1760: .It
1761: .Ic \&OP
1762: or a request of the
1763: .Ic \&de
1764: family with more than two arguments
1.154 schwarze 1765: .It
1766: .Ic \&Dt
1767: with more than three arguments
1.150 schwarze 1768: .It
1769: .Ic \&TH
1770: with more than five arguments
1771: .It
1.145 schwarze 1772: .Ic \&Bd ,
1773: .Ic \&Bk ,
1774: or
1775: .Ic \&Bl
1.150 schwarze 1776: with invalid arguments
1777: .El
1.106 schwarze 1778: The excess arguments are ignored.
1.133 schwarze 1779: .El
1780: .Ss Unsupported features
1781: .Bl -ohang
1782: .It Sy "input too large"
1783: .Pq mdoc , man
1784: Currently,
1785: .Nm
1786: cannot handle input files larger than its arbitrary size limit
1787: of 2^31 bytes (2 Gigabytes).
1788: Since useful manuals are always small, this is not a problem in practice.
1789: Parsing is aborted as soon as the condition is detected.
1.136 schwarze 1790: .It Sy "unsupported control character"
1791: .Pq roff
1792: An ASCII control character supported by other
1793: .Xr roff 7
1794: implementations but not by
1795: .Nm
1796: was found in an input file.
1797: It is replaced by a question mark.
1.133 schwarze 1798: .It Sy "unsupported roff request"
1799: .Pq roff
1800: An input file contains a
1801: .Xr roff 7
1802: request supported by GNU troff or Heirloom troff but not by
1803: .Nm ,
1804: and it is likely that this will cause information loss
1805: or considerable misformatting.
1.139 schwarze 1806: .It Sy "eqn delim option in tbl"
1807: .Pq eqn , tbl
1808: The options line of a table defines equation delimiters.
1809: Any equation source code contained in the table will be printed unformatted.
1810: .It Sy "unsupported table layout modifier"
1.138 schwarze 1811: .Pq tbl
1812: A table layout specification contains an
1813: .Sq Cm m
1814: modifier.
1815: The modifier is discarded.
1.133 schwarze 1816: .It Sy "ignoring macro in table"
1.139 schwarze 1817: .Pq tbl , mdoc , man
1818: A table contains an invocation of an
1819: .Xr mdoc 7
1820: or
1821: .Xr man 7
1822: macro or of an undefined macro.
1823: The macro is ignored, and its arguments are handled
1824: as if they were a text line.
1.106 schwarze 1825: .El
1.1 kristaps 1826: .Sh SEE ALSO
1.141 schwarze 1827: .Xr apropos 1 ,
1828: .Xr man 1 ,
1.85 kristaps 1829: .Xr eqn 7 ,
1.57 kristaps 1830: .Xr man 7 ,
1.13 kristaps 1831: .Xr mandoc_char 7 ,
1.84 kristaps 1832: .Xr mdoc 7 ,
1833: .Xr roff 7 ,
1834: .Xr tbl 7
1.1 kristaps 1835: .Sh AUTHORS
1.156 schwarze 1836: .An -nosplit
1.1 kristaps 1837: The
1838: .Nm
1.26 kristaps 1839: utility was written by
1.141 schwarze 1840: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
1841: and is maintained by
1842: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb