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