Annotation of mandoc/mandoc.1, Revision 1.179
1.179 ! schwarze 1: .\" $Id: mandoc.1,v 1.178 2017/03/08 19:40:59 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.179 ! schwarze 18: .Dd $Mdocdate: March 8 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
1.179 ! schwarze 614: is used instead of the standard pagination program,
! 615: .Xr more 1 ;
! 616: see
! 617: .Xr man 1
! 618: for details.
! 619: Only used if
! 620: .Fl a
! 621: or
! 622: .Fl l
! 623: is specified.
1.108 schwarze 624: .It Ev PAGER
625: Specifies the pagination program to use when
626: .Ev MANPAGER
627: is not defined.
628: If neither PAGER nor MANPAGER is defined,
1.159 schwarze 629: .Xr more 1
630: .Fl s
1.179 ! schwarze 631: is used.
! 632: Only used if
! 633: .Fl a
! 634: or
! 635: .Fl l
! 636: is specified.
1.108 schwarze 637: .El
1.77 schwarze 638: .Sh EXIT STATUS
639: The
640: .Nm
641: utility exits with one of the following values, controlled by the message
642: .Ar level
643: associated with the
644: .Fl W
645: option:
646: .Pp
647: .Bl -tag -width Ds -compact
648: .It 0
649: No warnings or errors occurred, or those that did were ignored because
650: they were lower than the requested
651: .Ar level .
652: .It 2
653: At least one warning occurred, but no error, and
1.156 schwarze 654: .Fl W Cm warning
1.77 schwarze 655: was specified.
656: .It 3
1.133 schwarze 657: At least one parsing error occurred,
658: but no unsupported feature was encountered, and
1.156 schwarze 659: .Fl W Cm error
1.133 schwarze 660: or
1.156 schwarze 661: .Fl W Cm warning
1.133 schwarze 662: was specified.
663: .It 4
1.134 schwarze 664: At least one unsupported feature was encountered, and
1.156 schwarze 665: .Fl W Cm unsupp ,
666: .Fl W Cm error
1.77 schwarze 667: or
1.156 schwarze 668: .Fl W Cm warning
1.77 schwarze 669: was specified.
670: .It 5
671: Invalid command line arguments were specified.
672: No input files have been read.
673: .It 6
1.131 schwarze 674: An operating system error occurred, for example exhaustion
675: of memory, file descriptors, or process table entries.
1.77 schwarze 676: Such errors cause
677: .Nm
678: to exit at once, possibly in the middle of parsing or formatting a file.
679: .El
680: .Pp
681: Note that selecting
1.156 schwarze 682: .Fl T Cm lint
1.77 schwarze 683: output mode implies
1.156 schwarze 684: .Fl W Cm warning .
1.1 kristaps 685: .Sh EXAMPLES
1.13 kristaps 686: To page manuals to the terminal:
1.1 kristaps 687: .Pp
1.156 schwarze 688: .Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less
1.82 kristaps 689: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.28 kristaps 690: .Pp
1.41 kristaps 691: To produce HTML manuals with
1.164 schwarze 692: .Pa mandoc.css
1.41 kristaps 693: as the style-sheet:
1.38 kristaps 694: .Pp
1.164 schwarze 695: .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
1.38 kristaps 696: .Pp
1.28 kristaps 697: To check over a large set of manuals:
698: .Pp
1.158 schwarze 699: .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
1.66 kristaps 700: .Pp
701: To produce a series of PostScript manuals for A4 paper:
702: .Pp
1.156 schwarze 703: .Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.91 schwarze 704: .Pp
705: Convert a modern
706: .Xr mdoc 7
707: manual to the older
708: .Xr man 7
709: format, for use on systems lacking an
710: .Xr mdoc 7
711: parser:
712: .Pp
1.156 schwarze 713: .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
1.77 schwarze 714: .Sh DIAGNOSTICS
1.106 schwarze 715: Messages displayed by
716: .Nm
717: follow this format:
1.77 schwarze 718: .Pp
1.106 schwarze 719: .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
1.77 schwarze 720: .Pp
1.106 schwarze 721: Line and column numbers start at 1.
722: Both are omitted for messages referring to an input file as a whole.
723: Macro names and arguments are omitted where meaningless.
724: Fatal messages about invalid command line arguments
725: or operating system errors, for example when memory is exhausted,
726: may also omit the
727: .Ar file
1.104 schwarze 728: and
1.106 schwarze 729: .Ar level
730: fields.
1.104 schwarze 731: .Pp
1.77 schwarze 732: Message levels have the following meanings:
733: .Bl -tag -width "warning"
1.133 schwarze 734: .It Cm unsupp
735: An input file uses unsupported low-level
736: .Xr roff 7
737: features.
738: The output may be incomplete and/or misformatted,
739: so using GNU troff instead of
740: .Nm
741: to process the file may be preferable.
1.77 schwarze 742: .It Cm error
1.133 schwarze 743: An input file contains invalid syntax that cannot be safely interpreted.
1.77 schwarze 744: By discarding part of the input or inserting missing tokens,
745: the parser is able to continue, and the error does not prevent
746: generation of formatted output, but typically, preparing that
747: output involves information loss, broken document structure
1.133 schwarze 748: or unintended formatting, no matter whether
749: .Nm
750: or GNU troff is used.
751: In many cases, the output of
752: .Nm
753: and GNU troff is identical, but in some,
754: .Nm
755: is more resilient than GNU troff with respect to malformed input.
1.131 schwarze 756: .Pp
757: Non-existent or unreadable input files are also reported on the
758: .Cm error
759: level.
760: In that case, the parser cannot even be started and no output
761: is produced from those input files.
1.77 schwarze 762: .It Cm warning
763: An input file uses obsolete, discouraged or non-portable syntax.
764: All the same, the meaning of the input is unambiguous and a correct
765: rendering can be produced.
766: Documents causing warnings may render poorly when using other
767: formatting tools instead of
768: .Nm .
769: .El
770: .Pp
771: Messages of the
1.133 schwarze 772: .Cm warning ,
773: .Cm error ,
1.77 schwarze 774: and
1.133 schwarze 775: .Cm unsupp
1.131 schwarze 776: levels except those about non-existent or unreadable input files
777: are hidden unless their level, or a lower level, is requested using a
1.77 schwarze 778: .Fl W
779: option or
1.156 schwarze 780: .Fl T Cm lint
1.77 schwarze 781: output mode.
1.106 schwarze 782: .Ss Warnings related to the document prologue
783: .Bl -ohang
784: .It Sy "missing manual title, using UNTITLED"
785: .Pq mdoc
786: A
787: .Ic \&Dt
788: macro has no arguments, or there is no
789: .Ic \&Dt
790: macro before the first non-prologue macro.
791: .It Sy "missing manual title, using \(dq\(dq"
792: .Pq man
793: There is no
794: .Ic \&TH
795: macro, or it has no arguments.
796: .It Sy "lower case character in document title"
797: .Pq mdoc , man
798: The title is still used as given in the
799: .Ic \&Dt
800: or
801: .Ic \&TH
802: macro.
803: .It Sy "missing manual section, using \(dq\(dq"
804: .Pq mdoc , man
805: A
806: .Ic \&Dt
807: or
808: .Ic \&TH
809: macro lacks the mandatory section argument.
810: .It Sy "unknown manual section"
811: .Pq mdoc
812: The section number in a
813: .Ic \&Dt
814: line is invalid, but still used.
815: .It Sy "missing date, using today's date"
816: .Pq mdoc, man
817: The document was parsed as
818: .Xr mdoc 7
819: and it has no
820: .Ic \&Dd
821: macro, or the
822: .Ic \&Dd
823: macro has no arguments or only empty arguments;
824: or the document was parsed as
825: .Xr man 7
826: and it has no
827: .Ic \&TH
828: macro, or the
829: .Ic \&TH
830: macro has less than three arguments or its third argument is empty.
831: .It Sy "cannot parse date, using it verbatim"
832: .Pq mdoc , man
833: The date given in a
834: .Ic \&Dd
835: or
836: .Ic \&TH
837: macro does not follow the conventional format.
838: .It Sy "missing Os macro, using \(dq\(dq"
839: .Pq mdoc
840: The default or current system is not shown in this case.
841: .It Sy "duplicate prologue macro"
842: .Pq mdoc
843: One of the prologue macros occurs more than once.
844: The last instance overrides all previous ones.
845: .It Sy "late prologue macro"
846: .Pq mdoc
847: A
848: .Ic \&Dd
849: or
850: .Ic \&Os
851: macro occurs after some non-prologue macro, but still takes effect.
852: .It Sy "skipping late title macro"
853: .Pq mdoc
854: The
855: .Ic \&Dt
1.152 schwarze 856: macro appears after the first non-prologue macro.
857: Traditional formatters cannot handle this because
858: they write the page header before parsing the document body.
1.106 schwarze 859: Even though this technical restriction does not apply to
860: .Nm ,
861: traditional semantics is preserved.
862: The late macro is discarded including its arguments.
863: .It Sy "prologue macros out of order"
864: .Pq mdoc
865: The prologue macros are not given in the conventional order
866: .Ic \&Dd ,
867: .Ic \&Dt ,
868: .Ic \&Os .
869: All three macros are used even when given in another order.
870: .El
871: .Ss Warnings regarding document structure
872: .Bl -ohang
873: .It Sy ".so is fragile, better use ln(1)"
874: .Pq roff
875: Including files only works when the parser program runs with the correct
876: current working directory.
877: .It Sy "no document body"
878: .Pq mdoc , man
879: The document body contains neither text nor macros.
880: An empty document is shown, consisting only of a header and a footer line.
881: .It Sy "content before first section header"
882: .Pq mdoc , man
883: Some macros or text precede the first
884: .Ic \&Sh
885: or
886: .Ic \&SH
887: section header.
888: The offending macros and text are parsed and added to the top level
889: of the syntax tree, outside any section block.
890: .It Sy "first section is not NAME"
891: .Pq mdoc
892: The argument of the first
893: .Ic \&Sh
894: macro is not
895: .Sq NAME .
896: This may confuse
897: .Xr makewhatis 8
898: and
899: .Xr apropos 1 .
1.168 schwarze 900: .It Sy "NAME section without Nm before Nd"
1.106 schwarze 901: .Pq mdoc
1.155 schwarze 902: The NAME section does not contain any
903: .Ic \&Nm
1.168 schwarze 904: child macro before the first
905: .Ic \&Nd
906: macro.
1.155 schwarze 907: .It Sy "NAME section without description"
908: .Pq mdoc
909: The NAME section lacks the mandatory
910: .Ic \&Nd
911: child macro.
912: .It Sy "description not at the end of NAME"
913: .Pq mdoc
914: The NAME section does contain an
1.106 schwarze 915: .Ic \&Nd
1.155 schwarze 916: child macro, but other content follows it.
917: .It Sy "bad NAME section content"
918: .Pq mdoc
919: The NAME section contains plain text or macros other than
920: .Ic \&Nm
1.106 schwarze 921: and
1.155 schwarze 922: .Ic \&Nd .
1.168 schwarze 923: .It Sy "missing comma before name"
924: .Pq mdoc
925: The NAME section contains an
926: .Ic \&Nm
927: macro that is neither the first one nor preceded by a comma.
1.142 schwarze 928: .It Sy "missing description line, using \(dq\(dq"
929: .Pq mdoc
930: The
931: .Ic \&Nd
932: macro lacks the required argument.
933: The title line of the manual will end after the dash.
1.177 schwarze 934: .It Sy "description line outside NAME section"
935: .Pq mdoc
936: An
937: .Ic \&Nd
938: macro appears outside the NAME section.
939: The arguments are printed anyway and the following text is used for
940: .Xr apropos 1 ,
941: but none of that behaviour is portable.
1.106 schwarze 942: .It Sy "sections out of conventional order"
943: .Pq mdoc
944: A standard section occurs after another section it usually precedes.
945: All section titles are used as given,
946: and the order of sections is not changed.
947: .It Sy "duplicate section title"
948: .Pq mdoc
949: The same standard section title occurs more than once.
950: .It Sy "unexpected section"
951: .Pq mdoc
952: A standard section header occurs in a section of the manual
953: where it normally isn't useful.
1.112 schwarze 954: .It Sy "unusual Xr order"
955: .Pq mdoc
956: In the SEE ALSO section, an
957: .Ic \&Xr
958: macro with a lower section number follows one with a higher number,
959: or two
960: .Ic \&Xr
1.157 schwarze 961: macros referring to the same section are out of alphabetical order.
1.112 schwarze 962: .It Sy "unusual Xr punctuation"
963: .Pq mdoc
964: In the SEE ALSO section, punctuation between two
965: .Ic \&Xr
966: macros differs from a single comma, or there is trailing punctuation
967: after the last
968: .Ic \&Xr
969: macro.
1.111 schwarze 970: .It Sy "AUTHORS section without An macro"
971: .Pq mdoc
972: An AUTHORS sections contains no
973: .Ic \&An
974: macros, or only empty ones.
975: Probably, there are author names lacking markup.
1.106 schwarze 976: .El
977: .Ss "Warnings related to macros and nesting"
978: .Bl -ohang
979: .It Sy "obsolete macro"
980: .Pq mdoc
981: See the
982: .Xr mdoc 7
983: manual for replacements.
1.126 schwarze 984: .It Sy "macro neither callable nor escaped"
985: .Pq mdoc
986: The name of a macro that is not callable appears on a macro line.
987: It is printed verbatim.
1.152 schwarze 988: If the intention is to call it, move it to its own input line;
1.126 schwarze 989: otherwise, escape it by prepending
990: .Sq \e& .
1.106 schwarze 991: .It Sy "skipping paragraph macro"
992: In
993: .Xr mdoc 7
994: documents, this happens
995: .Bl -dash -compact
996: .It
997: at the beginning and end of sections and subsections
998: .It
999: right before non-compact lists and displays
1000: .It
1001: at the end of items in non-column, non-compact lists
1002: .It
1003: and for multiple consecutive paragraph macros.
1004: .El
1005: In
1006: .Xr man 7
1007: documents, it happens
1008: .Bl -dash -compact
1009: .It
1010: for empty
1011: .Ic \&P ,
1012: .Ic \&PP ,
1013: and
1014: .Ic \&LP
1015: macros
1016: .It
1017: for
1018: .Ic \&IP
1019: macros having neither head nor body arguments
1020: .It
1021: for
1022: .Ic \&br
1023: or
1024: .Ic \&sp
1025: right after
1026: .Ic \&SH
1027: or
1028: .Ic \&SS
1029: .El
1030: .It Sy "moving paragraph macro out of list"
1031: .Pq mdoc
1032: A list item in a
1033: .Ic \&Bl
1034: list contains a trailing paragraph macro.
1035: The paragraph macro is moved after the end of the list.
1036: .It Sy "skipping no-space macro"
1037: .Pq mdoc
1038: An input line begins with an
1039: .Ic \&Ns
1040: macro.
1041: The macro is ignored.
1042: .It Sy "blocks badly nested"
1043: .Pq mdoc
1044: If two blocks intersect, one should completely contain the other.
1045: Otherwise, rendered output is likely to look strange in any output
1046: format, and rendering in SGML-based output formats is likely to be
1047: outright wrong because such languages do not support badly nested
1048: blocks at all.
1049: Typical examples of badly nested blocks are
1050: .Qq Ic \&Ao \&Bo \&Ac \&Bc
1051: and
1052: .Qq Ic \&Ao \&Bq \&Ac .
1053: In these examples,
1054: .Ic \&Ac
1055: breaks
1056: .Ic \&Bo
1057: and
1058: .Ic \&Bq ,
1059: respectively.
1060: .It Sy "nested displays are not portable"
1061: .Pq mdoc
1062: A
1063: .Ic \&Bd ,
1064: .Ic \&D1 ,
1065: or
1066: .Ic \&Dl
1067: display occurs nested inside another
1068: .Ic \&Bd
1069: display.
1070: This works with
1071: .Nm ,
1072: but fails with most other implementations.
1073: .It Sy "moving content out of list"
1074: .Pq mdoc
1075: A
1076: .Ic \&Bl
1077: list block contains text or macros before the first
1078: .Ic \&It
1079: macro.
1080: The offending children are moved before the beginning of the list.
1081: .It Sy "fill mode already enabled, skipping"
1082: .Pq man
1083: A
1084: .Ic \&fi
1085: request occurs even though the document is still in fill mode,
1086: or already switched back to fill mode.
1087: It has no effect.
1088: .It Sy "fill mode already disabled, skipping"
1089: .Pq man
1090: An
1091: .Ic \&nf
1092: request occurs even though the document already switched to no-fill mode
1093: and did not switch back to fill mode yet.
1094: It has no effect.
1095: .It Sy "line scope broken"
1096: .Pq man
1097: While parsing the next-line scope of the previous macro,
1098: another macro is found that prematurely terminates the previous one.
1099: The previous, interrupted macro is deleted from the parse tree.
1100: .El
1101: .Ss "Warnings related to missing arguments"
1102: .Bl -ohang
1103: .It Sy "skipping empty request"
1.118 schwarze 1104: .Pq roff , eqn
1105: The macro name is missing from a macro definition request,
1106: or an
1107: .Xr eqn 7
1108: control statement or operation keyword lacks its required argument.
1.106 schwarze 1109: .It Sy "conditional request controls empty scope"
1110: .Pq roff
1111: A conditional request is only useful if any of the following
1112: follows it on the same logical input line:
1113: .Bl -dash -compact
1114: .It
1115: The
1116: .Sq \e{
1117: keyword to open a multi-line scope.
1118: .It
1119: A request or macro or some text, resulting in a single-line scope.
1120: .It
1121: The immediate end of the logical line without any intervening whitespace,
1122: resulting in next-line scope.
1123: .El
1124: Here, a conditional request is followed by trailing whitespace only,
1125: and there is no other content on its logical input line.
1126: Note that it doesn't matter whether the logical input line is split
1127: across multiple physical input lines using
1128: .Sq \e
1129: line continuation characters.
1130: This is one of the rare cases
1131: where trailing whitespace is syntactically significant.
1132: The conditional request controls a scope containing whitespace only,
1133: so it is unlikely to have a significant effect,
1134: except that it may control a following
1135: .Ic \&el
1136: clause.
1137: .It Sy "skipping empty macro"
1138: .Pq mdoc
1.147 schwarze 1139: The indicated macro has no arguments and hence no effect.
1140: .It Sy "empty block"
1141: .Pq mdoc , man
1142: A
1143: .Ic \&Bd ,
1144: .Ic \&Bk ,
1145: .Ic \&Bl ,
1146: .Ic \&D1 ,
1147: .Ic \&Dl ,
1148: .Ic \&RS ,
1149: or
1150: .Ic \&UR
1151: block contains nothing in its body and will produce no output.
1.106 schwarze 1152: .It Sy "empty argument, using 0n"
1153: .Pq mdoc
1154: The required width is missing after
1155: .Ic \&Bd
1156: or
1157: .Ic \&Bl
1158: .Fl offset
1159: or
1160: .Fl width.
1161: .It Sy "missing display type, using -ragged"
1162: .Pq mdoc
1163: The
1164: .Ic \&Bd
1165: macro is invoked without the required display type.
1166: .It Sy "list type is not the first argument"
1167: .Pq mdoc
1168: In a
1169: .Ic \&Bl
1170: macro, at least one other argument precedes the type argument.
1171: The
1172: .Nm
1173: utility copes with any argument order, but some other
1174: .Xr mdoc 7
1175: implementations do not.
1176: .It Sy "missing -width in -tag list, using 8n"
1177: .Pq mdoc
1178: Every
1179: .Ic \&Bl
1180: macro having the
1181: .Fl tag
1182: argument requires
1183: .Fl width ,
1184: too.
1185: .It Sy "missing utility name, using \(dq\(dq"
1186: .Pq mdoc
1187: The
1188: .Ic \&Ex Fl std
1189: macro is called without an argument before
1190: .Ic \&Nm
1191: has first been called with an argument.
1.146 schwarze 1192: .It Sy "missing function name, using \(dq\(dq"
1193: .Pq mdoc
1194: The
1195: .Ic \&Fo
1196: macro is called without an argument.
1197: No function name is printed.
1.106 schwarze 1198: .It Sy "empty head in list item"
1199: .Pq mdoc
1200: In a
1201: .Ic \&Bl
1202: .Fl diag ,
1203: .Fl hang ,
1204: .Fl inset ,
1205: .Fl ohang ,
1206: or
1207: .Fl tag
1208: list, an
1209: .Ic \&It
1210: macro lacks the required argument.
1211: The item head is left empty.
1212: .It Sy "empty list item"
1213: .Pq mdoc
1214: In a
1215: .Ic \&Bl
1216: .Fl bullet ,
1217: .Fl dash ,
1218: .Fl enum ,
1219: or
1220: .Fl hyphen
1221: list, an
1222: .Ic \&It
1223: block is empty.
1224: An empty list item is shown.
1.152 schwarze 1225: .It Sy "missing font type, using \efR"
1.106 schwarze 1226: .Pq mdoc
1227: A
1228: .Ic \&Bf
1229: macro has no argument.
1.152 schwarze 1230: It switches to the default font.
1231: .It Sy "unknown font type, using \efR"
1.106 schwarze 1232: .Pq mdoc
1233: The
1234: .Ic \&Bf
1235: argument is invalid.
1.152 schwarze 1236: The default font is used instead.
1.127 schwarze 1237: .It Sy "nothing follows prefix"
1238: .Pq mdoc
1239: A
1240: .Ic \&Pf
1241: macro has no argument, or only one argument and no macro follows
1242: on the same input line.
1243: This defeats its purpose; in particular, spacing is not suppressed
1244: before the text or macros following on the next input line.
1.143 schwarze 1245: .It Sy "empty reference block"
1246: .Pq mdoc
1247: An
1248: .Ic \&Rs
1249: macro is immediately followed by an
1250: .Ic \&Re
1251: macro on the next input line.
1252: Such an empty block does not produce any output.
1.165 schwarze 1253: .It Sy "missing section argument"
1254: .Pq mdoc
1255: An
1256: .Ic \&Xr
1257: macro lacks its second, section number argument.
1258: The first argument, i.e. the name, is printed, but without subsequent
1.166 schwarze 1259: parentheses.
1.106 schwarze 1260: .It Sy "missing -std argument, adding it"
1261: .Pq mdoc
1262: An
1263: .Ic \&Ex
1264: or
1265: .Ic \&Rv
1266: macro lacks the required
1267: .Fl std
1268: argument.
1269: The
1270: .Nm
1271: utility assumes
1272: .Fl std
1273: even when it is not specified, but other implementations may not.
1.150 schwarze 1274: .It Sy "missing option string, using \(dq\(dq"
1275: .Pq man
1276: The
1277: .Ic \&OP
1278: macro is invoked without any argument.
1279: An empty pair of square brackets is shown.
1280: .It Sy "missing resource identifier, using \(dq\(dq"
1281: .Pq man
1282: The
1283: .Ic \&UR
1284: macro is invoked without any argument.
1285: An empty pair of angle brackets is shown.
1.118 schwarze 1286: .It Sy "missing eqn box, using \(dq\(dq"
1287: .Pq eqn
1288: A diacritic mark or a binary operator is found,
1289: but there is nothing to the left of it.
1290: An empty box is inserted.
1.106 schwarze 1291: .El
1292: .Ss "Warnings related to bad macro arguments"
1293: .Bl -ohang
1294: .It Sy "unterminated quoted argument"
1295: .Pq roff
1296: Macro arguments can be enclosed in double quote characters
1297: such that space characters and macro names contained in the quoted
1298: argument need not be escaped.
1299: The closing quote of the last argument of a macro can be omitted.
1300: However, omitting it is not recommended because it makes the code
1301: harder to read.
1302: .It Sy "duplicate argument"
1303: .Pq mdoc
1304: A
1305: .Ic \&Bd
1306: or
1307: .Ic \&Bl
1308: macro has more than one
1309: .Fl compact ,
1310: more than one
1311: .Fl offset ,
1312: or more than one
1313: .Fl width
1314: argument.
1315: All but the last instances of these arguments are ignored.
1316: .It Sy "skipping duplicate argument"
1317: .Pq mdoc
1318: An
1319: .Ic \&An
1320: macro has more than one
1321: .Fl split
1322: or
1323: .Fl nosplit
1324: argument.
1325: All but the first of these arguments are ignored.
1326: .It Sy "skipping duplicate display type"
1327: .Pq mdoc
1328: A
1329: .Ic \&Bd
1330: macro has more than one type argument; the first one is used.
1331: .It Sy "skipping duplicate list type"
1332: .Pq mdoc
1333: A
1334: .Ic \&Bl
1335: macro has more than one type argument; the first one is used.
1336: .It Sy "skipping -width argument"
1337: .Pq mdoc
1338: A
1339: .Ic \&Bl
1340: .Fl column ,
1341: .Fl diag ,
1342: .Fl ohang ,
1343: .Fl inset ,
1344: or
1345: .Fl item
1346: list has a
1347: .Fl width
1348: argument.
1349: That has no effect.
1.151 schwarze 1350: .It Sy "wrong number of cells"
1351: In a line of a
1352: .Ic \&Bl Fl column
1353: list, the number of tabs or
1354: .Ic \&Ta
1355: macros is less than the number expected from the list header line
1356: or exceeds the expected number by more than one.
1357: Missing cells remain empty, and all cells exceeding the number of
1358: columns are joined into one single cell.
1.106 schwarze 1359: .It Sy "unknown AT&T UNIX version"
1360: .Pq mdoc
1361: An
1362: .Ic \&At
1363: macro has an invalid argument.
1364: It is used verbatim, with
1365: .Qq "AT&T UNIX "
1366: prefixed to it.
1.113 schwarze 1367: .It Sy "comma in function argument"
1368: .Pq mdoc
1369: An argument of an
1370: .Ic \&Fa
1371: or
1372: .Ic \&Fn
1373: macro contains a comma; it should probably be split into two arguments.
1.117 schwarze 1374: .It Sy "parenthesis in function name"
1375: .Pq mdoc
1376: The first argument of an
1377: .Ic \&Fc
1378: or
1379: .Ic \&Fn
1380: macro contains an opening or closing parenthesis; that's probably wrong,
1381: parentheses are added automatically.
1.106 schwarze 1382: .It Sy "invalid content in Rs block"
1383: .Pq mdoc
1384: An
1385: .Ic \&Rs
1386: block contains plain text or non-% macros.
1387: The bogus content is left in the syntax tree.
1388: Formatting may be poor.
1389: .It Sy "invalid Boolean argument"
1390: .Pq mdoc
1391: An
1392: .Ic \&Sm
1393: macro has an argument other than
1394: .Cm on
1395: or
1396: .Cm off .
1397: The invalid argument is moved out of the macro, which leaves the macro
1398: empty, causing it to toggle the spacing mode.
1399: .It Sy "unknown font, skipping request"
1.115 schwarze 1400: .Pq man , tbl
1.106 schwarze 1401: A
1402: .Xr roff 7
1403: .Ic \&ft
1.115 schwarze 1404: request or a
1405: .Xr tbl 7
1406: .Ic \&f
1407: layout modifier has an unknown
1408: .Ar font
1409: argument.
1.151 schwarze 1410: .It Sy "odd number of characters in request"
1411: .Pq roff
1412: A
1413: .Ic \&tr
1414: request contains an odd number of characters.
1415: The last character is mapped to the blank character.
1.106 schwarze 1416: .El
1417: .Ss "Warnings related to plain text"
1418: .Bl -ohang
1419: .It Sy "blank line in fill mode, using .sp"
1420: .Pq mdoc
1421: The meaning of blank input lines is only well-defined in non-fill mode:
1422: In fill mode, line breaks of text input lines are not supposed to be
1423: significant.
1424: However, for compatibility with groff, blank lines in fill mode
1425: are replaced with
1426: .Ic \&sp
1427: requests.
1428: .It Sy "tab in filled text"
1429: .Pq mdoc , man
1430: The meaning of tab characters is only well-defined in non-fill mode:
1431: In fill mode, whitespace is not supposed to be significant
1432: on text input lines.
1433: As an implementation dependent choice, tab characters on text lines
1434: are passed through to the formatters in any case.
1435: Given that the text before the tab character will be filled,
1436: it is hard to predict which tab stop position the tab will advance to.
1437: .It Sy "whitespace at end of input line"
1438: .Pq mdoc , man , roff
1439: Whitespace at the end of input lines is almost never semantically
1440: significant \(em but in the odd case where it might be, it is
1441: extremely confusing when reviewing and maintaining documents.
1.172 schwarze 1442: .It Sy "new sentence, new line"
1443: .Pq mdoc
1444: A new sentence starts in the middle of a text line.
1445: Start it on a new input line to help formatters produce correct spacing.
1.106 schwarze 1446: .It Sy "bad comment style"
1447: .Pq roff
1448: Comment lines start with a dot, a backslash, and a double-quote character.
1449: The
1450: .Nm
1451: utility treats the line as a comment line even without the backslash,
1452: but leaving out the backslash might not be portable.
1453: .It Sy "invalid escape sequence"
1454: .Pq roff
1455: An escape sequence has an invalid opening argument delimiter, lacks the
1456: closing argument delimiter, or the argument has too few characters.
1457: If the argument is incomplete,
1458: .Ic \e*
1459: and
1460: .Ic \en
1461: expand to an empty string,
1462: .Ic \eB
1463: to the digit
1464: .Sq 0 ,
1465: and
1466: .Ic \ew
1467: to the length of the incomplete argument.
1468: All other invalid escape sequences are ignored.
1469: .It Sy "undefined string, using \(dq\(dq"
1470: .Pq roff
1471: If a string is used without being defined before,
1472: its value is implicitly set to the empty string.
1473: However, defining strings explicitly before use
1474: keeps the code more readable.
1475: .El
1.138 schwarze 1476: .Ss "Warnings related to tables"
1477: .Bl -ohang
1478: .It Sy "tbl line starts with span"
1479: .Pq tbl
1480: The first cell in a table layout line is a horizontal span
1481: .Pq Sq Cm s .
1482: Data provided for this cell is ignored, and nothing is printed in the cell.
1483: .It Sy "tbl column starts with span"
1484: .Pq tbl
1485: The first line of a table layout specification
1486: requests a vertical span
1487: .Pq Sq Cm ^ .
1488: Data provided for this cell is ignored, and nothing is printed in the cell.
1489: .It Sy "skipping vertical bar in tbl layout"
1490: .Pq tbl
1491: A table layout specification contains more than two consecutive vertical bars.
1492: A double bar is printed, all additional bars are discarded.
1.106 schwarze 1493: .El
1494: .Ss "Errors related to tables"
1.136 schwarze 1495: .Bl -ohang
1496: .It Sy "non-alphabetic character in tbl options"
1497: .Pq tbl
1498: The table options line contains a character other than a letter,
1499: blank, or comma where the beginning of an option name is expected.
1500: The character is ignored.
1501: .It Sy "skipping unknown tbl option"
1502: .Pq tbl
1503: The table options line contains a string of letters that does not
1504: match any known option name.
1505: The word is ignored.
1506: .It Sy "missing tbl option argument"
1507: .Pq tbl
1508: A table option that requires an argument is not followed by an
1509: opening parenthesis, or the opening parenthesis is immediately
1510: followed by a closing parenthesis.
1511: The option is ignored.
1512: .It Sy "wrong tbl option argument size"
1513: .Pq tbl
1514: A table option argument contains an invalid number of characters.
1515: Both the option and the argument are ignored.
1.138 schwarze 1516: .It Sy "empty tbl layout"
1517: .Pq tbl
1518: A table layout specification is completely empty,
1519: specifying zero lines and zero columns.
1520: As a fallback, a single left-justified column is used.
1521: .It Sy "invalid character in tbl layout"
1522: .Pq tbl
1523: A table layout specification contains a character that can neither
1524: be interpreted as a layout key character nor as a layout modifier,
1525: or a modifier precedes the first key.
1526: The invalid character is discarded.
1527: .It Sy "unmatched parenthesis in tbl layout"
1528: .Pq tbl
1529: A table layout specification contains an opening parenthesis,
1530: but no matching closing parenthesis.
1531: The rest of the input line, starting from the parenthesis, has no effect.
1.139 schwarze 1532: .It Sy "tbl without any data cells"
1533: .Pq tbl
1534: A table does not contain any data cells.
1535: It will probably produce no output.
1536: .It Sy "ignoring data in spanned tbl cell"
1537: .Pq tbl
1538: A table cell is marked as a horizontal span
1539: .Pq Sq Cm s
1540: or vertical span
1541: .Pq Sq Cm ^
1542: in the table layout, but it contains data.
1543: The data is ignored.
1544: .It Sy "ignoring extra tbl data cells"
1545: .Pq tbl
1546: A data line contains more cells than the corresponding layout line.
1547: The data in the extra cells is ignored.
1548: .It Sy "data block open at end of tbl"
1549: .Pq tbl
1550: A data block is opened with
1551: .Cm T{ ,
1552: but never closed with a matching
1553: .Cm T} .
1554: The remaining data lines of the table are all put into one cell,
1555: and any remaining cells stay empty.
1.106 schwarze 1556: .El
1557: .Ss "Errors related to roff, mdoc, and man code"
1558: .Bl -ohang
1559: .It Sy "input stack limit exceeded, infinite loop?"
1560: .Pq roff
1561: Explicit recursion limits are implemented for the following features,
1562: in order to prevent infinite loops:
1563: .Bl -dash -compact
1564: .It
1565: expansion of nested escape sequences
1566: including expansion of strings and number registers,
1567: .It
1568: expansion of nested user-defined macros,
1569: .It
1570: and
1571: .Ic \&so
1572: file inclusion.
1573: .El
1574: When a limit is hit, the output is incorrect, typically losing
1575: some content, but the parser can continue.
1576: .It Sy "skipping bad character"
1577: .Pq mdoc , man , roff
1578: The input file contains a byte that is not a printable
1579: .Xr ascii 7
1580: character.
1581: The message mentions the character number.
1582: The offending byte is replaced with a question mark
1583: .Pq Sq \&? .
1584: Consider editing the input file to replace the byte with an ASCII
1585: transliteration of the intended character.
1586: .It Sy "skipping unknown macro"
1587: .Pq mdoc , man , roff
1588: The first identifier on a request or macro line is neither recognized as a
1589: .Xr roff 7
1590: request, nor as a user-defined macro, nor, respectively, as an
1591: .Xr mdoc 7
1592: or
1593: .Xr man 7
1594: macro.
1595: It may be mistyped or unsupported.
1596: The request or macro is discarded including its arguments.
1.133 schwarze 1597: .It Sy "skipping insecure request"
1598: .Pq roff
1599: An input file attempted to run a shell command
1600: or to read or write an external file.
1601: Such attempts are denied for security reasons.
1.106 schwarze 1602: .It Sy "skipping item outside list"
1.118 schwarze 1603: .Pq mdoc , eqn
1.106 schwarze 1604: An
1605: .Ic \&It
1606: macro occurs outside any
1607: .Ic \&Bl
1.118 schwarze 1608: list, or an
1609: .Xr eqn 7
1610: .Ic above
1611: delimiter occurs outside any pile.
1.106 schwarze 1612: It is discarded including its arguments.
1613: .It Sy "skipping column outside column list"
1614: .Pq mdoc
1615: A
1616: .Ic \&Ta
1617: macro occurs outside any
1618: .Ic \&Bl Fl column
1619: block.
1620: It is discarded including its arguments.
1621: .It Sy "skipping end of block that is not open"
1622: .Pq mdoc , man , eqn , tbl , roff
1623: Various syntax elements can only be used to explicitly close blocks
1624: that have previously been opened.
1625: An
1626: .Xr mdoc 7
1627: block closing macro, a
1628: .Xr man 7
1629: .Ic \&RE
1630: or
1631: .Ic \&UE
1.118 schwarze 1632: macro, an
1633: .Xr eqn 7
1634: right delimiter or closing brace, or the end of an equation, table, or
1.106 schwarze 1635: .Xr roff 7
1636: conditional request is encountered but no matching block is open.
1637: The offending request or macro is discarded.
1.135 schwarze 1638: .It Sy "fewer RS blocks open, skipping"
1639: .Pq man
1640: The
1641: .Ic \&RE
1642: macro is invoked with an argument, but less than the specified number of
1643: .Ic \&RS
1644: blocks is open.
1645: The
1646: .Ic \&RE
1647: macro is discarded.
1.106 schwarze 1648: .It Sy "inserting missing end of block"
1649: .Pq mdoc , tbl
1650: Various
1651: .Xr mdoc 7
1652: macros as well as tables require explicit closing by dedicated macros.
1653: A block that doesn't support bad nesting
1654: ends before all of its children are properly closed.
1655: The open child nodes are closed implicitly.
1.152 schwarze 1656: .It Sy "appending missing end of block"
1.106 schwarze 1657: .Pq mdoc , man , eqn , tbl , roff
1658: At the end of the document, an explicit
1659: .Xr mdoc 7
1660: block, a
1661: .Xr man 7
1662: next-line scope or
1663: .Ic \&RS
1664: or
1665: .Ic \&UR
1666: block, an equation, table, or
1667: .Xr roff 7
1668: conditional or ignore block is still open.
1669: The open block is closed implicitly.
1670: .It Sy "escaped character not allowed in a name"
1671: .Pq roff
1672: Macro, string and register identifiers consist of printable,
1673: non-whitespace ASCII characters.
1674: Escape sequences and characters and strings expressed in terms of them
1675: cannot form part of a name.
1676: The first argument of an
1677: .Ic \&am ,
1678: .Ic \&as ,
1679: .Ic \&de ,
1680: .Ic \&ds ,
1681: .Ic \&nr ,
1682: or
1683: .Ic \&rr
1684: request, or any argument of an
1685: .Ic \&rm
1686: request, or the name of a request or user defined macro being called,
1687: is terminated by an escape sequence.
1688: In the cases of
1689: .Ic \&as ,
1690: .Ic \&ds ,
1691: and
1692: .Ic \&nr ,
1693: the request has no effect at all.
1694: In the cases of
1695: .Ic \&am ,
1696: .Ic \&de ,
1697: .Ic \&rr ,
1698: and
1699: .Ic \&rm ,
1700: what was parsed up to this point is used as the arguments to the request,
1701: and the rest of the input line is discarded including the escape sequence.
1702: When parsing for a request or a user-defined macro name to be called,
1703: only the escape sequence is discarded.
1704: The characters preceding it are used as the request or macro name,
1705: the characters following it are used as the arguments to the request or macro.
1.124 schwarze 1706: .It Sy "NOT IMPLEMENTED: Bd -file"
1707: .Pq mdoc
1708: For security reasons, the
1709: .Ic \&Bd
1710: macro does not support the
1711: .Fl file
1712: argument.
1713: By requesting the inclusion of a sensitive file, a malicious document
1714: might otherwise trick a privileged user into inadvertently displaying
1715: the file on the screen, revealing the file content to bystanders.
1716: The argument is ignored including the file name following it.
1.163 schwarze 1717: .It Sy "skipping display without arguments"
1718: .Pq mdoc
1719: A
1720: .Ic \&Bd
1721: block macro does not have any arguments.
1722: The block is discarded, and the block content is displayed in
1723: whatever mode was active before the block.
1.106 schwarze 1724: .It Sy "missing list type, using -item"
1725: .Pq mdoc
1726: A
1727: .Ic \&Bl
1728: macro fails to specify the list type.
1729: .It Sy "missing manual name, using \(dq\(dq"
1730: .Pq mdoc
1731: The first call to
1.168 schwarze 1732: .Ic \&Nm ,
1733: or any call in the NAME section, lacks the required argument.
1.106 schwarze 1734: .It Sy "uname(3) system call failed, using UNKNOWN"
1735: .Pq mdoc
1736: The
1737: .Ic \&Os
1738: macro is called without arguments, and the
1739: .Xr uname 3
1740: system call failed.
1741: As a workaround,
1742: .Nm
1743: can be compiled with
1744: .Sm off
1745: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1746: .Sm on
1747: .It Sy "unknown standard specifier"
1748: .Pq mdoc
1749: An
1750: .Ic \&St
1751: macro has an unknown argument and is discarded.
1752: .It Sy "skipping request without numeric argument"
1.118 schwarze 1753: .Pq roff , eqn
1.106 schwarze 1754: An
1755: .Ic \&it
1.118 schwarze 1756: request or an
1757: .Xr eqn 7
1758: .Ic \&size
1759: or
1760: .Ic \&gsize
1761: statement has a non-numeric or negative argument or no argument at all.
1762: The invalid request or statement is ignored.
1.132 schwarze 1763: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1764: .Pq roff
1765: For security reasons,
1766: .Nm
1767: allows
1768: .Ic \&so
1769: file inclusion requests only with relative paths
1770: and only without ascending to any parent directory.
1771: By requesting the inclusion of a sensitive file, a malicious document
1772: might otherwise trick a privileged user into inadvertently displaying
1773: the file on the screen, revealing the file content to bystanders.
1774: .Nm
1775: only shows the path as it appears behind
1776: .Ic \&so .
1777: .It Sy ".so request failed"
1778: .Pq roff
1779: Servicing a
1780: .Ic \&so
1781: request requires reading an external file, but the file could not be
1782: opened.
1783: .Nm
1784: only shows the path as it appears behind
1785: .Ic \&so .
1.106 schwarze 1786: .It Sy "skipping all arguments"
1787: .Pq mdoc , man , eqn , roff
1788: An
1789: .Xr mdoc 7
1790: .Ic \&Bt ,
1791: .Ic \&Ed ,
1792: .Ic \&Ef ,
1793: .Ic \&Ek ,
1794: .Ic \&El ,
1.144 schwarze 1795: .Ic \&Lp ,
1796: .Ic \&Pp ,
1.106 schwarze 1797: .Ic \&Re ,
1.143 schwarze 1798: .Ic \&Rs ,
1.106 schwarze 1799: or
1800: .Ic \&Ud
1801: macro, an
1802: .Ic \&It
1803: macro in a list that don't support item heads, a
1804: .Xr man 7
1805: .Ic \&LP ,
1806: .Ic \&P ,
1807: or
1808: .Ic \&PP
1809: macro, an
1810: .Xr eqn 7
1.120 schwarze 1811: .Ic \&EQ
1812: or
1.106 schwarze 1813: .Ic \&EN
1814: macro, or a
1815: .Xr roff 7
1.148 schwarze 1816: .Ic \&br ,
1817: .Ic \&fi ,
1818: or
1819: .Ic \&nf
1.144 schwarze 1820: request or
1.106 schwarze 1821: .Sq \&..
1822: block closing request is invoked with at least one argument.
1823: All arguments are ignored.
1824: .It Sy "skipping excess arguments"
1.135 schwarze 1825: .Pq mdoc , man , roff
1.150 schwarze 1826: A macro or request is invoked with too many arguments:
1827: .Bl -dash -offset 2n -width 2n -compact
1828: .It
1829: .Ic \&Fo ,
1830: .Ic \&PD ,
1831: .Ic \&RS ,
1832: .Ic \&UR ,
1833: .Ic \&ft ,
1834: or
1835: .Ic \&sp
1836: with more than one argument
1837: .It
1.144 schwarze 1838: .Ic \&An
1.150 schwarze 1839: with another argument after
1.144 schwarze 1840: .Fl split
1841: or
1.150 schwarze 1842: .Fl nosplit
1843: .It
1844: .Ic \&RE
1845: with more than one argument or with a non-integer argument
1846: .It
1847: .Ic \&OP
1848: or a request of the
1849: .Ic \&de
1850: family with more than two arguments
1.154 schwarze 1851: .It
1852: .Ic \&Dt
1853: with more than three arguments
1.150 schwarze 1854: .It
1855: .Ic \&TH
1856: with more than five arguments
1857: .It
1.145 schwarze 1858: .Ic \&Bd ,
1859: .Ic \&Bk ,
1860: or
1861: .Ic \&Bl
1.150 schwarze 1862: with invalid arguments
1863: .El
1.106 schwarze 1864: The excess arguments are ignored.
1.133 schwarze 1865: .El
1866: .Ss Unsupported features
1867: .Bl -ohang
1868: .It Sy "input too large"
1869: .Pq mdoc , man
1870: Currently,
1871: .Nm
1872: cannot handle input files larger than its arbitrary size limit
1873: of 2^31 bytes (2 Gigabytes).
1874: Since useful manuals are always small, this is not a problem in practice.
1875: Parsing is aborted as soon as the condition is detected.
1.136 schwarze 1876: .It Sy "unsupported control character"
1877: .Pq roff
1878: An ASCII control character supported by other
1879: .Xr roff 7
1880: implementations but not by
1881: .Nm
1882: was found in an input file.
1883: It is replaced by a question mark.
1.133 schwarze 1884: .It Sy "unsupported roff request"
1885: .Pq roff
1886: An input file contains a
1887: .Xr roff 7
1888: request supported by GNU troff or Heirloom troff but not by
1889: .Nm ,
1890: and it is likely that this will cause information loss
1891: or considerable misformatting.
1.139 schwarze 1892: .It Sy "eqn delim option in tbl"
1893: .Pq eqn , tbl
1894: The options line of a table defines equation delimiters.
1895: Any equation source code contained in the table will be printed unformatted.
1896: .It Sy "unsupported table layout modifier"
1.138 schwarze 1897: .Pq tbl
1898: A table layout specification contains an
1899: .Sq Cm m
1900: modifier.
1901: The modifier is discarded.
1.133 schwarze 1902: .It Sy "ignoring macro in table"
1.139 schwarze 1903: .Pq tbl , mdoc , man
1904: A table contains an invocation of an
1905: .Xr mdoc 7
1906: or
1907: .Xr man 7
1908: macro or of an undefined macro.
1909: The macro is ignored, and its arguments are handled
1910: as if they were a text line.
1.106 schwarze 1911: .El
1.1 kristaps 1912: .Sh SEE ALSO
1.141 schwarze 1913: .Xr apropos 1 ,
1914: .Xr man 1 ,
1.85 kristaps 1915: .Xr eqn 7 ,
1.57 kristaps 1916: .Xr man 7 ,
1.13 kristaps 1917: .Xr mandoc_char 7 ,
1.84 kristaps 1918: .Xr mdoc 7 ,
1919: .Xr roff 7 ,
1920: .Xr tbl 7
1.173 schwarze 1921: .Sh HISTORY
1922: The
1923: .Nm
1924: utility first appeared in
1925: .Ox 4.8 .
1926: The option
1927: .Fl I
1928: appeared in
1929: .Ox 5.2 ,
1930: and
1931: .Fl aCcfhKklMSsw
1932: in
1933: .Ox 5.7 .
1.1 kristaps 1934: .Sh AUTHORS
1.156 schwarze 1935: .An -nosplit
1.1 kristaps 1936: The
1937: .Nm
1.26 kristaps 1938: utility was written by
1.141 schwarze 1939: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
1940: and is maintained by
1941: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandoc.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc