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