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