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