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