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