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