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