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