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