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