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