Annotation of mandoc/mandoc.1, Revision 1.258
1.258 ! schwarze 1: .\" $Id: mandoc.1,v 1.257 2022/04/24 13:38:46 schwarze Exp $
1.1 kristaps 2: .\"
1.257 schwarze 3: .\" Copyright (c) 2012, 2014-2022 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.258 ! schwarze 18: .Dd $Mdocdate: April 24 2022 $
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.
1.251 schwarze 304: This prints the operating system name rather than the page title
305: on the right side of the footer line, and it implies
1.218 schwarze 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.256 schwarze 490: .Lk https://daringfireball.net/projects/markdown/syntax.text\
1.175 schwarze 491: "John Gruber's 2004 specification" .
1.178 schwarze 492: The output also almost conforms to the
1.256 schwarze 493: .Lk https://commonmark.org/ CommonMark
1.178 schwarze 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.255 schwarze 738: .Dl $ mandoc -a 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.
1.254 schwarze 838: Use your judgement to decide whether any particular
1.185 schwarze 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.
925: .El
926: .Ss Style suggestions
927: .Bl -ohang
1.200 schwarze 928: .It Sy "legacy man(7) date format"
929: .Pq mdoc
930: The
931: .Ic \&Dd
932: macro uses the legacy
933: .Xr man 7
934: date format
935: .Dq yyyy-dd-mm .
936: Consider using the conventional
937: .Xr mdoc 7
938: date format
939: .Dq "Month dd, yyyy"
940: instead.
1.226 schwarze 941: .It Sy "normalizing date format to" : No ...
942: .Pq mdoc , man
943: The
944: .Ic \&Dd
945: or
946: .Ic \&TH
947: macro provides an abbreviated month name or a day number with a
948: leading zero.
949: In the formatted output, the month name is written out in full
950: and the leading zero is omitted.
1.215 schwarze 951: .It Sy "lower case character in document title"
952: .Pq mdoc , man
953: The title is still used as given in the
954: .Ic \&Dt
955: or
956: .Ic \&TH
957: macro.
1.201 schwarze 958: .It Sy "duplicate RCS id"
959: A single manual page contains two copies of the RCS identifier for
960: the same operating system.
961: Consider deleting the later instance and moving the first one up
962: to the top of the page.
1.220 schwarze 963: .It Sy "possible typo in section name"
1.207 schwarze 964: .Pq mdoc
965: Fuzzy string matching revealed that the argument of an
966: .Ic \&Sh
967: macro is similar, but not identical to a standard section name.
1.215 schwarze 968: .It Sy "unterminated quoted argument"
969: .Pq roff
970: Macro arguments can be enclosed in double quote characters
971: such that space characters and macro names contained in the quoted
972: argument need not be escaped.
973: The closing quote of the last argument of a macro can be omitted.
974: However, omitting it is not recommended because it makes the code
975: harder to read.
1.189 schwarze 976: .It Sy "useless macro"
977: .Pq mdoc
978: A
979: .Ic \&Bt ,
980: .Ic \&Tn ,
981: or
1.190 schwarze 982: .Ic \&Ud
1.189 schwarze 983: macro was found.
1.190 schwarze 984: Simply delete it: it serves no useful purpose.
1.191 schwarze 985: .It Sy "consider using OS macro"
986: .Pq mdoc
987: A string was found in plain text or in a
988: .Ic \&Bx
989: macro that could be represented using
990: .Ic \&Ox ,
991: .Ic \&Nx ,
992: .Ic \&Fx ,
993: or
994: .Ic \&Dx .
1.195 schwarze 995: .It Sy "errnos out of order"
996: .Pq mdoc, Nx
997: The
998: .Ic \&Er
999: items in a
1000: .Ic \&Bl
1001: list are not in alphabetical order.
1002: .It Sy "duplicate errno"
1003: .Pq mdoc, Nx
1004: A
1005: .Ic \&Bl
1006: list contains two consecutive
1007: .Ic \&It
1008: entries describing the same
1009: .Ic \&Er
1010: number.
1.249 schwarze 1011: .It Sy "referenced manual not found"
1012: .Pq mdoc
1013: An
1014: .Ic \&Xr
1015: macro references a manual page that was not found.
1016: When running with
1017: .Fl W Cm base ,
1018: the search is restricted to the base system, by default to
1019: .Pa /usr/share/man : Ns Pa /usr/X11R6/man .
1020: This path can be configured at compile time using the
1021: .Dv MANPATH_BASE
1022: preprocessor macro.
1023: When running with
1024: .Fl W Cm style ,
1025: the search is done along the full search path as described in the
1026: .Xr man 1
1027: manual page, respecting the
1028: .Fl m
1029: and
1030: .Fl M
1031: command line options, the
1032: .Ev MANPATH
1033: environment variable, the
1034: .Xr man.conf 5
1035: file and falling back to the default of
1036: .Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man ,
1037: also configurable at compile time using the
1038: .Dv MANPATH_DEFAULT
1039: preprocessor macro.
1.213 schwarze 1040: .It Sy "trailing delimiter"
1.192 schwarze 1041: .Pq mdoc
1.213 schwarze 1042: The last argument of an
1043: .Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St ,
1044: or
1045: .Ic \&Sx
1046: macro ends with a trailing delimiter.
1047: This is usually bad style and often indicates typos.
1048: Most likely, the delimiter can be removed.
1.197 schwarze 1049: .It Sy "no blank before trailing delimiter"
1.198 schwarze 1050: .Pq mdoc
1.197 schwarze 1051: The last argument of a macro that supports trailing delimiter
1052: arguments is longer than one byte and ends with a trailing delimiter.
1053: Consider inserting a blank such that the delimiter becomes a separate
1054: argument, thus moving it out of the scope of the macro.
1.215 schwarze 1055: .It Sy "fill mode already enabled, skipping"
1056: .Pq man
1057: A
1058: .Ic \&fi
1059: request occurs even though the document is still in fill mode,
1060: or already switched back to fill mode.
1061: It has no effect.
1062: .It Sy "fill mode already disabled, skipping"
1063: .Pq man
1064: An
1065: .Ic \&nf
1066: request occurs even though the document already switched to no-fill mode
1067: and did not switch back to fill mode yet.
1068: It has no effect.
1.250 schwarze 1069: .It Sy "input text line longer than 80 bytes"
1070: Consider breaking the input text line
1071: at one of the blank characters before column 80.
1.222 schwarze 1072: .It Sy "verbatim \(dq--\(dq, maybe consider using \e(em"
1073: .Pq mdoc
1074: Even though the ASCII output device renders an em-dash as
1075: .Qq \-\- ,
1076: that is not a good way to write it in an input file
1077: because it renders poorly on all other output devices.
1.198 schwarze 1078: .It Sy "function name without markup"
1079: .Pq mdoc
1080: A word followed by an empty pair of parentheses occurs on a text line.
1081: Consider using an
1082: .Ic \&Fn
1083: or
1084: .Ic \&Xr
1085: macro.
1.215 schwarze 1086: .It Sy "whitespace at end of input line"
1087: .Pq mdoc , man , roff
1088: Whitespace at the end of input lines is almost never semantically
1089: significant \(em but in the odd case where it might be, it is
1090: extremely confusing when reviewing and maintaining documents.
1091: .It Sy "bad comment style"
1092: .Pq roff
1093: Comment lines start with a dot, a backslash, and a double-quote character.
1094: The
1095: .Nm
1096: utility treats the line as a comment line even without the backslash,
1097: but leaving out the backslash might not be portable.
1.189 schwarze 1098: .El
1.106 schwarze 1099: .Ss Warnings related to the document prologue
1100: .Bl -ohang
1101: .It Sy "missing manual title, using UNTITLED"
1102: .Pq mdoc
1103: A
1104: .Ic \&Dt
1105: macro has no arguments, or there is no
1106: .Ic \&Dt
1107: macro before the first non-prologue macro.
1108: .It Sy "missing manual title, using \(dq\(dq"
1109: .Pq man
1110: There is no
1111: .Ic \&TH
1112: macro, or it has no arguments.
1113: .It Sy "missing manual section, using \(dq\(dq"
1114: .Pq mdoc , man
1115: A
1116: .Ic \&Dt
1117: or
1118: .Ic \&TH
1119: macro lacks the mandatory section argument.
1120: .It Sy "unknown manual section"
1121: .Pq mdoc
1122: The section number in a
1123: .Ic \&Dt
1124: line is invalid, but still used.
1.243 schwarze 1125: .It Sy "filename/section mismatch"
1126: .Pq mdoc , man
1127: The name of the input file being processed is known and its file
1128: name extension starts with a non-zero digit, but the
1129: .Ic \&Dt
1130: or
1131: .Ic \&TH
1132: macro contains a
1133: .Ar section
1134: argument that starts with a different non-zero digit.
1135: The
1136: .Ar section
1137: argument is used as provided anyway.
1138: Consider checking whether the file name or the argument need a correction.
1.241 schwarze 1139: .It Sy "missing date, using \(dq\(dq"
1.106 schwarze 1140: .Pq mdoc, man
1141: The document was parsed as
1142: .Xr mdoc 7
1143: and it has no
1144: .Ic \&Dd
1145: macro, or the
1146: .Ic \&Dd
1147: macro has no arguments or only empty arguments;
1148: or the document was parsed as
1149: .Xr man 7
1150: and it has no
1151: .Ic \&TH
1152: macro, or the
1153: .Ic \&TH
1154: macro has less than three arguments or its third argument is empty.
1155: .It Sy "cannot parse date, using it verbatim"
1156: .Pq mdoc , man
1157: The date given in a
1158: .Ic \&Dd
1159: or
1160: .Ic \&TH
1161: macro does not follow the conventional format.
1.212 schwarze 1162: .It Sy "date in the future, using it anyway"
1163: .Pq mdoc , man
1164: The date given in a
1165: .Ic \&Dd
1166: or
1167: .Ic \&TH
1168: macro is more than a day ahead of the current system
1169: .Xr time 3 .
1.106 schwarze 1170: .It Sy "missing Os macro, using \(dq\(dq"
1171: .Pq mdoc
1172: The default or current system is not shown in this case.
1173: .It Sy "late prologue macro"
1174: .Pq mdoc
1175: A
1176: .Ic \&Dd
1177: or
1178: .Ic \&Os
1179: macro occurs after some non-prologue macro, but still takes effect.
1180: .It Sy "prologue macros out of order"
1181: .Pq mdoc
1182: The prologue macros are not given in the conventional order
1183: .Ic \&Dd ,
1184: .Ic \&Dt ,
1185: .Ic \&Os .
1186: All three macros are used even when given in another order.
1187: .El
1188: .Ss Warnings regarding document structure
1189: .Bl -ohang
1190: .It Sy ".so is fragile, better use ln(1)"
1191: .Pq roff
1192: Including files only works when the parser program runs with the correct
1193: current working directory.
1194: .It Sy "no document body"
1195: .Pq mdoc , man
1196: The document body contains neither text nor macros.
1197: An empty document is shown, consisting only of a header and a footer line.
1198: .It Sy "content before first section header"
1199: .Pq mdoc , man
1200: Some macros or text precede the first
1201: .Ic \&Sh
1202: or
1203: .Ic \&SH
1204: section header.
1205: The offending macros and text are parsed and added to the top level
1206: of the syntax tree, outside any section block.
1207: .It Sy "first section is not NAME"
1208: .Pq mdoc
1209: The argument of the first
1210: .Ic \&Sh
1211: macro is not
1212: .Sq NAME .
1213: This may confuse
1214: .Xr makewhatis 8
1215: and
1216: .Xr apropos 1 .
1.168 schwarze 1217: .It Sy "NAME section without Nm before Nd"
1.106 schwarze 1218: .Pq mdoc
1.155 schwarze 1219: The NAME section does not contain any
1220: .Ic \&Nm
1.168 schwarze 1221: child macro before the first
1222: .Ic \&Nd
1223: macro.
1.155 schwarze 1224: .It Sy "NAME section without description"
1225: .Pq mdoc
1226: The NAME section lacks the mandatory
1227: .Ic \&Nd
1228: child macro.
1229: .It Sy "description not at the end of NAME"
1230: .Pq mdoc
1231: The NAME section does contain an
1.106 schwarze 1232: .Ic \&Nd
1.155 schwarze 1233: child macro, but other content follows it.
1234: .It Sy "bad NAME section content"
1235: .Pq mdoc
1236: The NAME section contains plain text or macros other than
1237: .Ic \&Nm
1.106 schwarze 1238: and
1.155 schwarze 1239: .Ic \&Nd .
1.168 schwarze 1240: .It Sy "missing comma before name"
1241: .Pq mdoc
1242: The NAME section contains an
1243: .Ic \&Nm
1244: macro that is neither the first one nor preceded by a comma.
1.142 schwarze 1245: .It Sy "missing description line, using \(dq\(dq"
1246: .Pq mdoc
1247: The
1248: .Ic \&Nd
1249: macro lacks the required argument.
1250: The title line of the manual will end after the dash.
1.177 schwarze 1251: .It Sy "description line outside NAME section"
1252: .Pq mdoc
1253: An
1254: .Ic \&Nd
1255: macro appears outside the NAME section.
1256: The arguments are printed anyway and the following text is used for
1257: .Xr apropos 1 ,
1258: but none of that behaviour is portable.
1.106 schwarze 1259: .It Sy "sections out of conventional order"
1260: .Pq mdoc
1261: A standard section occurs after another section it usually precedes.
1262: All section titles are used as given,
1263: and the order of sections is not changed.
1264: .It Sy "duplicate section title"
1265: .Pq mdoc
1266: The same standard section title occurs more than once.
1267: .It Sy "unexpected section"
1268: .Pq mdoc
1269: A standard section header occurs in a section of the manual
1270: where it normally isn't useful.
1.211 schwarze 1271: .It Sy "cross reference to self"
1272: .Pq mdoc
1273: An
1274: .Ic \&Xr
1275: macro refers to a name and section matching the section of the present
1276: manual page and a name mentioned in an
1277: .Ic \&Nm
1278: macro in the NAME or SYNOPSIS section, or in an
1279: .Ic \&Fn
1280: or
1281: .Ic \&Fo
1282: macro in the SYNOPSIS.
1283: Consider using
1284: .Ic \&Nm
1285: or
1286: .Ic \&Fn
1287: instead of
1288: .Ic \&Xr .
1.112 schwarze 1289: .It Sy "unusual Xr order"
1290: .Pq mdoc
1291: In the SEE ALSO section, an
1292: .Ic \&Xr
1293: macro with a lower section number follows one with a higher number,
1294: or two
1295: .Ic \&Xr
1.157 schwarze 1296: macros referring to the same section are out of alphabetical order.
1.112 schwarze 1297: .It Sy "unusual Xr punctuation"
1298: .Pq mdoc
1299: In the SEE ALSO section, punctuation between two
1300: .Ic \&Xr
1301: macros differs from a single comma, or there is trailing punctuation
1302: after the last
1303: .Ic \&Xr
1304: macro.
1.111 schwarze 1305: .It Sy "AUTHORS section without An macro"
1306: .Pq mdoc
1307: An AUTHORS sections contains no
1308: .Ic \&An
1309: macros, or only empty ones.
1310: Probably, there are author names lacking markup.
1.106 schwarze 1311: .El
1312: .Ss "Warnings related to macros and nesting"
1313: .Bl -ohang
1314: .It Sy "obsolete macro"
1315: .Pq mdoc
1316: See the
1317: .Xr mdoc 7
1318: manual for replacements.
1.126 schwarze 1319: .It Sy "macro neither callable nor escaped"
1320: .Pq mdoc
1321: The name of a macro that is not callable appears on a macro line.
1322: It is printed verbatim.
1.152 schwarze 1323: If the intention is to call it, move it to its own input line;
1.126 schwarze 1324: otherwise, escape it by prepending
1325: .Sq \e& .
1.106 schwarze 1326: .It Sy "skipping paragraph macro"
1327: In
1328: .Xr mdoc 7
1329: documents, this happens
1330: .Bl -dash -compact
1331: .It
1332: at the beginning and end of sections and subsections
1333: .It
1334: right before non-compact lists and displays
1335: .It
1336: at the end of items in non-column, non-compact lists
1337: .It
1338: and for multiple consecutive paragraph macros.
1339: .El
1340: In
1341: .Xr man 7
1342: documents, it happens
1343: .Bl -dash -compact
1344: .It
1345: for empty
1346: .Ic \&P ,
1347: .Ic \&PP ,
1348: and
1349: .Ic \&LP
1350: macros
1351: .It
1352: for
1353: .Ic \&IP
1354: macros having neither head nor body arguments
1355: .It
1356: for
1357: .Ic \&br
1358: or
1359: .Ic \&sp
1360: right after
1361: .Ic \&SH
1362: or
1363: .Ic \&SS
1364: .El
1365: .It Sy "moving paragraph macro out of list"
1366: .Pq mdoc
1367: A list item in a
1368: .Ic \&Bl
1369: list contains a trailing paragraph macro.
1370: The paragraph macro is moved after the end of the list.
1371: .It Sy "skipping no-space macro"
1372: .Pq mdoc
1373: An input line begins with an
1374: .Ic \&Ns
1.208 schwarze 1375: macro, or the next argument after an
1376: .Ic \&Ns
1377: macro is an isolated closing delimiter.
1.106 schwarze 1378: The macro is ignored.
1379: .It Sy "blocks badly nested"
1380: .Pq mdoc
1381: If two blocks intersect, one should completely contain the other.
1382: Otherwise, rendered output is likely to look strange in any output
1383: format, and rendering in SGML-based output formats is likely to be
1384: outright wrong because such languages do not support badly nested
1385: blocks at all.
1386: Typical examples of badly nested blocks are
1387: .Qq Ic \&Ao \&Bo \&Ac \&Bc
1388: and
1389: .Qq Ic \&Ao \&Bq \&Ac .
1390: In these examples,
1391: .Ic \&Ac
1392: breaks
1393: .Ic \&Bo
1394: and
1395: .Ic \&Bq ,
1396: respectively.
1397: .It Sy "nested displays are not portable"
1398: .Pq mdoc
1399: A
1400: .Ic \&Bd ,
1401: .Ic \&D1 ,
1402: or
1403: .Ic \&Dl
1404: display occurs nested inside another
1405: .Ic \&Bd
1406: display.
1407: This works with
1408: .Nm ,
1409: but fails with most other implementations.
1410: .It Sy "moving content out of list"
1411: .Pq mdoc
1412: A
1413: .Ic \&Bl
1414: list block contains text or macros before the first
1415: .Ic \&It
1416: macro.
1417: The offending children are moved before the beginning of the list.
1.209 schwarze 1418: .It Sy "first macro on line"
1419: Inside a
1420: .Ic \&Bl Fl column
1421: list, a
1422: .Ic \&Ta
1423: macro occurs as the first macro on a line, which is not portable.
1.106 schwarze 1424: .It Sy "line scope broken"
1425: .Pq man
1426: While parsing the next-line scope of the previous macro,
1427: another macro is found that prematurely terminates the previous one.
1428: The previous, interrupted macro is deleted from the parse tree.
1429: .El
1430: .Ss "Warnings related to missing arguments"
1431: .Bl -ohang
1432: .It Sy "skipping empty request"
1.118 schwarze 1433: .Pq roff , eqn
1434: The macro name is missing from a macro definition request,
1435: or an
1436: .Xr eqn 7
1437: control statement or operation keyword lacks its required argument.
1.106 schwarze 1438: .It Sy "conditional request controls empty scope"
1439: .Pq roff
1440: A conditional request is only useful if any of the following
1441: follows it on the same logical input line:
1442: .Bl -dash -compact
1443: .It
1444: The
1445: .Sq \e{
1446: keyword to open a multi-line scope.
1447: .It
1448: A request or macro or some text, resulting in a single-line scope.
1449: .It
1450: The immediate end of the logical line without any intervening whitespace,
1451: resulting in next-line scope.
1452: .El
1453: Here, a conditional request is followed by trailing whitespace only,
1454: and there is no other content on its logical input line.
1455: Note that it doesn't matter whether the logical input line is split
1456: across multiple physical input lines using
1457: .Sq \e
1458: line continuation characters.
1459: This is one of the rare cases
1460: where trailing whitespace is syntactically significant.
1461: The conditional request controls a scope containing whitespace only,
1462: so it is unlikely to have a significant effect,
1463: except that it may control a following
1464: .Ic \&el
1465: clause.
1466: .It Sy "skipping empty macro"
1467: .Pq mdoc
1.147 schwarze 1468: The indicated macro has no arguments and hence no effect.
1469: .It Sy "empty block"
1470: .Pq mdoc , man
1471: A
1472: .Ic \&Bd ,
1473: .Ic \&Bk ,
1474: .Ic \&Bl ,
1475: .Ic \&D1 ,
1476: .Ic \&Dl ,
1.206 schwarze 1477: .Ic \&MT ,
1.147 schwarze 1478: .Ic \&RS ,
1479: or
1480: .Ic \&UR
1481: block contains nothing in its body and will produce no output.
1.106 schwarze 1482: .It Sy "empty argument, using 0n"
1483: .Pq mdoc
1484: The required width is missing after
1485: .Ic \&Bd
1486: or
1487: .Ic \&Bl
1488: .Fl offset
1489: or
1.186 schwarze 1490: .Fl width .
1.106 schwarze 1491: .It Sy "missing display type, using -ragged"
1492: .Pq mdoc
1493: The
1494: .Ic \&Bd
1495: macro is invoked without the required display type.
1496: .It Sy "list type is not the first argument"
1497: .Pq mdoc
1498: In a
1499: .Ic \&Bl
1500: macro, at least one other argument precedes the type argument.
1501: The
1502: .Nm
1503: utility copes with any argument order, but some other
1504: .Xr mdoc 7
1505: implementations do not.
1506: .It Sy "missing -width in -tag list, using 8n"
1507: .Pq mdoc
1508: Every
1509: .Ic \&Bl
1510: macro having the
1511: .Fl tag
1512: argument requires
1513: .Fl width ,
1514: too.
1515: .It Sy "missing utility name, using \(dq\(dq"
1516: .Pq mdoc
1517: The
1518: .Ic \&Ex Fl std
1519: macro is called without an argument before
1520: .Ic \&Nm
1521: has first been called with an argument.
1.146 schwarze 1522: .It Sy "missing function name, using \(dq\(dq"
1523: .Pq mdoc
1524: The
1525: .Ic \&Fo
1526: macro is called without an argument.
1527: No function name is printed.
1.106 schwarze 1528: .It Sy "empty head in list item"
1529: .Pq mdoc
1530: In a
1531: .Ic \&Bl
1532: .Fl diag ,
1533: .Fl hang ,
1534: .Fl inset ,
1535: .Fl ohang ,
1536: or
1537: .Fl tag
1538: list, an
1539: .Ic \&It
1540: macro lacks the required argument.
1541: The item head is left empty.
1542: .It Sy "empty list item"
1543: .Pq mdoc
1544: In a
1545: .Ic \&Bl
1546: .Fl bullet ,
1547: .Fl dash ,
1548: .Fl enum ,
1549: or
1550: .Fl hyphen
1551: list, an
1552: .Ic \&It
1553: block is empty.
1554: An empty list item is shown.
1.209 schwarze 1555: .It Sy "missing argument, using next line"
1556: .Pq mdoc
1557: An
1558: .Ic \&It
1559: macro in a
1560: .Ic \&Bd Fl column
1561: list has no arguments.
1562: While
1563: .Nm
1564: uses the text or macros of the following line, if any, for the cell,
1565: other formatters may misformat the list.
1.152 schwarze 1566: .It Sy "missing font type, using \efR"
1.106 schwarze 1567: .Pq mdoc
1568: A
1569: .Ic \&Bf
1570: macro has no argument.
1.152 schwarze 1571: It switches to the default font.
1572: .It Sy "unknown font type, using \efR"
1.106 schwarze 1573: .Pq mdoc
1574: The
1575: .Ic \&Bf
1576: argument is invalid.
1.152 schwarze 1577: The default font is used instead.
1.127 schwarze 1578: .It Sy "nothing follows prefix"
1579: .Pq mdoc
1580: A
1581: .Ic \&Pf
1582: macro has no argument, or only one argument and no macro follows
1583: on the same input line.
1584: This defeats its purpose; in particular, spacing is not suppressed
1585: before the text or macros following on the next input line.
1.143 schwarze 1586: .It Sy "empty reference block"
1587: .Pq mdoc
1588: An
1589: .Ic \&Rs
1590: macro is immediately followed by an
1591: .Ic \&Re
1592: macro on the next input line.
1593: Such an empty block does not produce any output.
1.165 schwarze 1594: .It Sy "missing section argument"
1595: .Pq mdoc
1596: An
1597: .Ic \&Xr
1598: macro lacks its second, section number argument.
1599: The first argument, i.e. the name, is printed, but without subsequent
1.166 schwarze 1600: parentheses.
1.106 schwarze 1601: .It Sy "missing -std argument, adding it"
1602: .Pq mdoc
1603: An
1604: .Ic \&Ex
1605: or
1606: .Ic \&Rv
1607: macro lacks the required
1608: .Fl std
1609: argument.
1610: The
1611: .Nm
1612: utility assumes
1613: .Fl std
1614: even when it is not specified, but other implementations may not.
1.150 schwarze 1615: .It Sy "missing option string, using \(dq\(dq"
1616: .Pq man
1617: The
1618: .Ic \&OP
1619: macro is invoked without any argument.
1620: An empty pair of square brackets is shown.
1621: .It Sy "missing resource identifier, using \(dq\(dq"
1622: .Pq man
1623: The
1.206 schwarze 1624: .Ic \&MT
1625: or
1.150 schwarze 1626: .Ic \&UR
1627: macro is invoked without any argument.
1628: An empty pair of angle brackets is shown.
1.118 schwarze 1629: .It Sy "missing eqn box, using \(dq\(dq"
1630: .Pq eqn
1631: A diacritic mark or a binary operator is found,
1632: but there is nothing to the left of it.
1633: An empty box is inserted.
1.106 schwarze 1634: .El
1635: .Ss "Warnings related to bad macro arguments"
1636: .Bl -ohang
1637: .It Sy "duplicate argument"
1638: .Pq mdoc
1639: A
1640: .Ic \&Bd
1641: or
1642: .Ic \&Bl
1643: macro has more than one
1644: .Fl compact ,
1645: more than one
1646: .Fl offset ,
1647: or more than one
1648: .Fl width
1649: argument.
1650: All but the last instances of these arguments are ignored.
1651: .It Sy "skipping duplicate argument"
1652: .Pq mdoc
1653: An
1654: .Ic \&An
1655: macro has more than one
1656: .Fl split
1657: or
1658: .Fl nosplit
1659: argument.
1660: All but the first of these arguments are ignored.
1661: .It Sy "skipping duplicate display type"
1662: .Pq mdoc
1663: A
1664: .Ic \&Bd
1665: macro has more than one type argument; the first one is used.
1666: .It Sy "skipping duplicate list type"
1667: .Pq mdoc
1668: A
1669: .Ic \&Bl
1670: macro has more than one type argument; the first one is used.
1671: .It Sy "skipping -width argument"
1672: .Pq mdoc
1673: A
1674: .Ic \&Bl
1675: .Fl column ,
1676: .Fl diag ,
1677: .Fl ohang ,
1678: .Fl inset ,
1679: or
1680: .Fl item
1681: list has a
1682: .Fl width
1683: argument.
1684: That has no effect.
1.151 schwarze 1685: .It Sy "wrong number of cells"
1686: In a line of a
1687: .Ic \&Bl Fl column
1688: list, the number of tabs or
1689: .Ic \&Ta
1690: macros is less than the number expected from the list header line
1691: or exceeds the expected number by more than one.
1692: Missing cells remain empty, and all cells exceeding the number of
1693: columns are joined into one single cell.
1.106 schwarze 1694: .It Sy "unknown AT&T UNIX version"
1695: .Pq mdoc
1696: An
1697: .Ic \&At
1698: macro has an invalid argument.
1699: It is used verbatim, with
1700: .Qq "AT&T UNIX "
1701: prefixed to it.
1.113 schwarze 1702: .It Sy "comma in function argument"
1703: .Pq mdoc
1704: An argument of an
1705: .Ic \&Fa
1706: or
1707: .Ic \&Fn
1708: macro contains a comma; it should probably be split into two arguments.
1.117 schwarze 1709: .It Sy "parenthesis in function name"
1710: .Pq mdoc
1711: The first argument of an
1712: .Ic \&Fc
1713: or
1714: .Ic \&Fn
1715: macro contains an opening or closing parenthesis; that's probably wrong,
1716: parentheses are added automatically.
1.196 schwarze 1717: .It Sy "unknown library name"
1718: .Pq mdoc, not on Ox
1719: An
1720: .Ic \&Lb
1721: macro has an unknown name argument and will be rendered as
1722: .Qq library Dq Ar name .
1.106 schwarze 1723: .It Sy "invalid content in Rs block"
1724: .Pq mdoc
1725: An
1726: .Ic \&Rs
1727: block contains plain text or non-% macros.
1728: The bogus content is left in the syntax tree.
1729: Formatting may be poor.
1730: .It Sy "invalid Boolean argument"
1731: .Pq mdoc
1732: An
1733: .Ic \&Sm
1734: macro has an argument other than
1735: .Cm on
1736: or
1737: .Cm off .
1738: The invalid argument is moved out of the macro, which leaves the macro
1739: empty, causing it to toggle the spacing mode.
1.228 schwarze 1740: .It Sy "argument contains two font escapes"
1741: .Pq roff
1742: The second argument of a
1743: .Ic char
1744: request contains more than one font escape sequence.
1745: A wrong font may remain active after using the character.
1.106 schwarze 1746: .It Sy "unknown font, skipping request"
1.115 schwarze 1747: .Pq man , tbl
1.106 schwarze 1748: A
1749: .Xr roff 7
1750: .Ic \&ft
1.115 schwarze 1751: request or a
1752: .Xr tbl 7
1753: .Ic \&f
1754: layout modifier has an unknown
1755: .Ar font
1756: argument.
1.258 ! schwarze 1757: .It Sy "ignoring distance argument"
! 1758: .Pq roff
! 1759: In addition to the margin character, an
! 1760: .Ic \&mc
! 1761: request has a second argument supposed to represent a distance, but the
! 1762: .Nm
! 1763: implementation of
! 1764: .Ic \&mc
! 1765: always ignores the second argument.
1.151 schwarze 1766: .It Sy "odd number of characters in request"
1767: .Pq roff
1768: A
1769: .Ic \&tr
1770: request contains an odd number of characters.
1771: The last character is mapped to the blank character.
1.106 schwarze 1772: .El
1773: .Ss "Warnings related to plain text"
1774: .Bl -ohang
1775: .It Sy "blank line in fill mode, using .sp"
1776: .Pq mdoc
1777: The meaning of blank input lines is only well-defined in non-fill mode:
1778: In fill mode, line breaks of text input lines are not supposed to be
1779: significant.
1780: However, for compatibility with groff, blank lines in fill mode
1.238 schwarze 1781: are formatted like
1.106 schwarze 1782: .Ic \&sp
1783: requests.
1.238 schwarze 1784: To request a paragraph break, use
1785: .Ic \&Pp
1786: instead of a blank line.
1.106 schwarze 1787: .It Sy "tab in filled text"
1788: .Pq mdoc , man
1789: The meaning of tab characters is only well-defined in non-fill mode:
1790: In fill mode, whitespace is not supposed to be significant
1791: on text input lines.
1792: As an implementation dependent choice, tab characters on text lines
1793: are passed through to the formatters in any case.
1794: Given that the text before the tab character will be filled,
1795: it is hard to predict which tab stop position the tab will advance to.
1.172 schwarze 1796: .It Sy "new sentence, new line"
1797: .Pq mdoc
1798: A new sentence starts in the middle of a text line.
1799: Start it on a new input line to help formatters produce correct spacing.
1.106 schwarze 1800: .It Sy "invalid escape sequence"
1801: .Pq roff
1802: An escape sequence has an invalid opening argument delimiter, lacks the
1.232 schwarze 1803: closing argument delimiter, the argument is of an invalid form, or it is
1804: a character escape sequence with an invalid name.
1.106 schwarze 1805: If the argument is incomplete,
1806: .Ic \e*
1807: and
1808: .Ic \en
1809: expand to an empty string,
1810: .Ic \eB
1811: to the digit
1812: .Sq 0 ,
1813: and
1814: .Ic \ew
1815: to the length of the incomplete argument.
1816: All other invalid escape sequences are ignored.
1.232 schwarze 1817: .It Sy "undefined escape, printing literally"
1818: .Pq roff
1819: In an escape sequence, the first character
1820: right after the leading backslash is invalid.
1821: That character is printed literally,
1822: which is equivalent to ignoring the backslash.
1.106 schwarze 1823: .It Sy "undefined string, using \(dq\(dq"
1824: .Pq roff
1825: If a string is used without being defined before,
1826: its value is implicitly set to the empty string.
1827: However, defining strings explicitly before use
1828: keeps the code more readable.
1829: .El
1.138 schwarze 1830: .Ss "Warnings related to tables"
1831: .Bl -ohang
1832: .It Sy "tbl line starts with span"
1833: .Pq tbl
1834: The first cell in a table layout line is a horizontal span
1835: .Pq Sq Cm s .
1836: Data provided for this cell is ignored, and nothing is printed in the cell.
1837: .It Sy "tbl column starts with span"
1838: .Pq tbl
1839: The first line of a table layout specification
1840: requests a vertical span
1841: .Pq Sq Cm ^ .
1842: Data provided for this cell is ignored, and nothing is printed in the cell.
1843: .It Sy "skipping vertical bar in tbl layout"
1844: .Pq tbl
1845: A table layout specification contains more than two consecutive vertical bars.
1846: A double bar is printed, all additional bars are discarded.
1.106 schwarze 1847: .El
1848: .Ss "Errors related to tables"
1.136 schwarze 1849: .Bl -ohang
1850: .It Sy "non-alphabetic character in tbl options"
1851: .Pq tbl
1852: The table options line contains a character other than a letter,
1853: blank, or comma where the beginning of an option name is expected.
1854: The character is ignored.
1855: .It Sy "skipping unknown tbl option"
1856: .Pq tbl
1857: The table options line contains a string of letters that does not
1858: match any known option name.
1859: The word is ignored.
1860: .It Sy "missing tbl option argument"
1861: .Pq tbl
1862: A table option that requires an argument is not followed by an
1863: opening parenthesis, or the opening parenthesis is immediately
1864: followed by a closing parenthesis.
1865: The option is ignored.
1866: .It Sy "wrong tbl option argument size"
1867: .Pq tbl
1868: A table option argument contains an invalid number of characters.
1869: Both the option and the argument are ignored.
1.138 schwarze 1870: .It Sy "empty tbl layout"
1871: .Pq tbl
1872: A table layout specification is completely empty,
1873: specifying zero lines and zero columns.
1874: As a fallback, a single left-justified column is used.
1875: .It Sy "invalid character in tbl layout"
1876: .Pq tbl
1877: A table layout specification contains a character that can neither
1878: be interpreted as a layout key character nor as a layout modifier,
1879: or a modifier precedes the first key.
1880: The invalid character is discarded.
1881: .It Sy "unmatched parenthesis in tbl layout"
1882: .Pq tbl
1883: A table layout specification contains an opening parenthesis,
1884: but no matching closing parenthesis.
1885: The rest of the input line, starting from the parenthesis, has no effect.
1.248 schwarze 1886: .It Sy "ignoring excessive spacing in tbl layout"
1887: .Pq tbl
1888: A spacing modifier in a table layout is unreasonably large.
1889: The default spacing of 3n is used instead.
1.139 schwarze 1890: .It Sy "tbl without any data cells"
1891: .Pq tbl
1892: A table does not contain any data cells.
1893: It will probably produce no output.
1894: .It Sy "ignoring data in spanned tbl cell"
1895: .Pq tbl
1896: A table cell is marked as a horizontal span
1897: .Pq Sq Cm s
1898: or vertical span
1899: .Pq Sq Cm ^
1900: in the table layout, but it contains data.
1901: The data is ignored.
1902: .It Sy "ignoring extra tbl data cells"
1903: .Pq tbl
1904: A data line contains more cells than the corresponding layout line.
1905: The data in the extra cells is ignored.
1906: .It Sy "data block open at end of tbl"
1907: .Pq tbl
1908: A data block is opened with
1909: .Cm T{ ,
1910: but never closed with a matching
1911: .Cm T} .
1912: The remaining data lines of the table are all put into one cell,
1913: and any remaining cells stay empty.
1.106 schwarze 1914: .El
1915: .Ss "Errors related to roff, mdoc, and man code"
1916: .Bl -ohang
1.215 schwarze 1917: .It Sy "duplicate prologue macro"
1918: .Pq mdoc
1919: One of the prologue macros occurs more than once.
1920: The last instance overrides all previous ones.
1921: .It Sy "skipping late title macro"
1922: .Pq mdoc
1923: The
1924: .Ic \&Dt
1925: macro appears after the first non-prologue macro.
1926: Traditional formatters cannot handle this because
1927: they write the page header before parsing the document body.
1928: Even though this technical restriction does not apply to
1929: .Nm ,
1930: traditional semantics is preserved.
1931: The late macro is discarded including its arguments.
1.106 schwarze 1932: .It Sy "input stack limit exceeded, infinite loop?"
1933: .Pq roff
1934: Explicit recursion limits are implemented for the following features,
1935: in order to prevent infinite loops:
1936: .Bl -dash -compact
1937: .It
1938: expansion of nested escape sequences
1939: including expansion of strings and number registers,
1940: .It
1941: expansion of nested user-defined macros,
1942: .It
1943: and
1944: .Ic \&so
1945: file inclusion.
1946: .El
1947: When a limit is hit, the output is incorrect, typically losing
1948: some content, but the parser can continue.
1949: .It Sy "skipping bad character"
1950: .Pq mdoc , man , roff
1951: The input file contains a byte that is not a printable
1952: .Xr ascii 7
1953: character.
1954: The message mentions the character number.
1955: The offending byte is replaced with a question mark
1956: .Pq Sq \&? .
1957: Consider editing the input file to replace the byte with an ASCII
1958: transliteration of the intended character.
1959: .It Sy "skipping unknown macro"
1960: .Pq mdoc , man , roff
1961: The first identifier on a request or macro line is neither recognized as a
1962: .Xr roff 7
1963: request, nor as a user-defined macro, nor, respectively, as an
1964: .Xr mdoc 7
1965: or
1966: .Xr man 7
1967: macro.
1968: It may be mistyped or unsupported.
1969: The request or macro is discarded including its arguments.
1.227 schwarze 1970: .It Sy "skipping request outside macro"
1971: .Pq roff
1972: A
1973: .Ic shift
1974: or
1975: .Ic return
1976: request occurs outside any macro definition and has no effect.
1.133 schwarze 1977: .It Sy "skipping insecure request"
1978: .Pq roff
1979: An input file attempted to run a shell command
1980: or to read or write an external file.
1981: Such attempts are denied for security reasons.
1.106 schwarze 1982: .It Sy "skipping item outside list"
1.118 schwarze 1983: .Pq mdoc , eqn
1.106 schwarze 1984: An
1985: .Ic \&It
1986: macro occurs outside any
1987: .Ic \&Bl
1.118 schwarze 1988: list, or an
1989: .Xr eqn 7
1990: .Ic above
1991: delimiter occurs outside any pile.
1.106 schwarze 1992: It is discarded including its arguments.
1993: .It Sy "skipping column outside column list"
1994: .Pq mdoc
1995: A
1996: .Ic \&Ta
1997: macro occurs outside any
1998: .Ic \&Bl Fl column
1999: block.
2000: It is discarded including its arguments.
2001: .It Sy "skipping end of block that is not open"
2002: .Pq mdoc , man , eqn , tbl , roff
2003: Various syntax elements can only be used to explicitly close blocks
2004: that have previously been opened.
2005: An
2006: .Xr mdoc 7
2007: block closing macro, a
2008: .Xr man 7
1.206 schwarze 2009: .Ic \&ME , \&RE
1.106 schwarze 2010: or
2011: .Ic \&UE
1.118 schwarze 2012: macro, an
2013: .Xr eqn 7
2014: right delimiter or closing brace, or the end of an equation, table, or
1.106 schwarze 2015: .Xr roff 7
2016: conditional request is encountered but no matching block is open.
2017: The offending request or macro is discarded.
1.135 schwarze 2018: .It Sy "fewer RS blocks open, skipping"
2019: .Pq man
2020: The
2021: .Ic \&RE
2022: macro is invoked with an argument, but less than the specified number of
2023: .Ic \&RS
2024: blocks is open.
2025: The
2026: .Ic \&RE
2027: macro is discarded.
1.106 schwarze 2028: .It Sy "inserting missing end of block"
2029: .Pq mdoc , tbl
2030: Various
2031: .Xr mdoc 7
2032: macros as well as tables require explicit closing by dedicated macros.
2033: A block that doesn't support bad nesting
2034: ends before all of its children are properly closed.
2035: The open child nodes are closed implicitly.
1.152 schwarze 2036: .It Sy "appending missing end of block"
1.106 schwarze 2037: .Pq mdoc , man , eqn , tbl , roff
2038: At the end of the document, an explicit
2039: .Xr mdoc 7
2040: block, a
2041: .Xr man 7
2042: next-line scope or
1.206 schwarze 2043: .Ic \&MT , \&RS
1.106 schwarze 2044: or
2045: .Ic \&UR
2046: block, an equation, table, or
2047: .Xr roff 7
2048: conditional or ignore block is still open.
2049: The open block is closed implicitly.
2050: .It Sy "escaped character not allowed in a name"
2051: .Pq roff
2052: Macro, string and register identifiers consist of printable,
2053: non-whitespace ASCII characters.
2054: Escape sequences and characters and strings expressed in terms of them
2055: cannot form part of a name.
2056: The first argument of an
2057: .Ic \&am ,
2058: .Ic \&as ,
2059: .Ic \&de ,
2060: .Ic \&ds ,
2061: .Ic \&nr ,
2062: or
2063: .Ic \&rr
2064: request, or any argument of an
2065: .Ic \&rm
2066: request, or the name of a request or user defined macro being called,
2067: is terminated by an escape sequence.
2068: In the cases of
2069: .Ic \&as ,
2070: .Ic \&ds ,
2071: and
2072: .Ic \&nr ,
2073: the request has no effect at all.
2074: In the cases of
2075: .Ic \&am ,
2076: .Ic \&de ,
2077: .Ic \&rr ,
2078: and
2079: .Ic \&rm ,
2080: what was parsed up to this point is used as the arguments to the request,
2081: and the rest of the input line is discarded including the escape sequence.
2082: When parsing for a request or a user-defined macro name to be called,
2083: only the escape sequence is discarded.
2084: The characters preceding it are used as the request or macro name,
2085: the characters following it are used as the arguments to the request or macro.
1.227 schwarze 2086: .It Sy "using macro argument outside macro"
2087: .Pq roff
2088: The escape sequence \e$ occurs outside any macro definition
2089: and expands to the empty string.
2090: .It Sy "argument number is not numeric"
2091: .Pq roff
2092: The argument of the escape sequence \e$ is not a digit;
2093: the escape sequence expands to the empty string.
1.257 schwarze 2094: .It Sy "negative argument, using 0"
2095: .Pq roff
2096: A
2097: .Ic \&shift
2098: request has a negative argument
2099: or an argument that is negative due to integer overflow.
2100: Macro argument numbering remains unchanged.
1.124 schwarze 2101: .It Sy "NOT IMPLEMENTED: Bd -file"
2102: .Pq mdoc
2103: For security reasons, the
2104: .Ic \&Bd
2105: macro does not support the
2106: .Fl file
2107: argument.
2108: By requesting the inclusion of a sensitive file, a malicious document
2109: might otherwise trick a privileged user into inadvertently displaying
2110: the file on the screen, revealing the file content to bystanders.
2111: The argument is ignored including the file name following it.
1.163 schwarze 2112: .It Sy "skipping display without arguments"
2113: .Pq mdoc
2114: A
2115: .Ic \&Bd
2116: block macro does not have any arguments.
2117: The block is discarded, and the block content is displayed in
2118: whatever mode was active before the block.
1.106 schwarze 2119: .It Sy "missing list type, using -item"
2120: .Pq mdoc
2121: A
2122: .Ic \&Bl
2123: macro fails to specify the list type.
1.194 schwarze 2124: .It Sy "argument is not numeric, using 1"
2125: .Pq roff
2126: The argument of a
2127: .Ic \&ce
2128: request is not a number.
1.228 schwarze 2129: .It Sy "argument is not a character"
2130: .Pq roff
2131: The first argument of a
2132: .Ic char
2133: request is neither a single ASCII character
2134: nor a single character escape sequence.
2135: The request is ignored including all its arguments.
1.258 ! schwarze 2136: .It Sy "skipping unusable escape sequence"
! 2137: .Pq roff
! 2138: The first argument of an
! 2139: .Ic mc
! 2140: request is neither a single ASCII character
! 2141: nor a single character escape sequence.
! 2142: All arguments are ignored and printing of a margin character is disabled.
1.106 schwarze 2143: .It Sy "missing manual name, using \(dq\(dq"
2144: .Pq mdoc
2145: The first call to
1.168 schwarze 2146: .Ic \&Nm ,
2147: or any call in the NAME section, lacks the required argument.
1.106 schwarze 2148: .It Sy "uname(3) system call failed, using UNKNOWN"
2149: .Pq mdoc
2150: The
2151: .Ic \&Os
2152: macro is called without arguments, and the
2153: .Xr uname 3
2154: system call failed.
2155: As a workaround,
2156: .Nm
2157: can be compiled with
2158: .Sm off
2159: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
2160: .Sm on
2161: .It Sy "unknown standard specifier"
2162: .Pq mdoc
2163: An
2164: .Ic \&St
2165: macro has an unknown argument and is discarded.
2166: .It Sy "skipping request without numeric argument"
1.118 schwarze 2167: .Pq roff , eqn
1.106 schwarze 2168: An
2169: .Ic \&it
1.118 schwarze 2170: request or an
2171: .Xr eqn 7
2172: .Ic \&size
2173: or
2174: .Ic \&gsize
2175: statement has a non-numeric or negative argument or no argument at all.
2176: The invalid request or statement is ignored.
1.227 schwarze 2177: .It Sy "excessive shift"
2178: .Pq roff
2179: The argument of a
2180: .Ic shift
2181: request is larger than the number of arguments of the macro that is
2182: currently being executed.
2183: All macro arguments are deleted and \en(.$ is set to zero.
1.132 schwarze 2184: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
2185: .Pq roff
2186: For security reasons,
2187: .Nm
2188: allows
2189: .Ic \&so
2190: file inclusion requests only with relative paths
2191: and only without ascending to any parent directory.
2192: By requesting the inclusion of a sensitive file, a malicious document
2193: might otherwise trick a privileged user into inadvertently displaying
2194: the file on the screen, revealing the file content to bystanders.
2195: .Nm
2196: only shows the path as it appears behind
2197: .Ic \&so .
2198: .It Sy ".so request failed"
2199: .Pq roff
2200: Servicing a
2201: .Ic \&so
2202: request requires reading an external file, but the file could not be
2203: opened.
2204: .Nm
2205: only shows the path as it appears behind
2206: .Ic \&so .
1.106 schwarze 2207: .It Sy "skipping all arguments"
2208: .Pq mdoc , man , eqn , roff
2209: An
2210: .Xr mdoc 7
2211: .Ic \&Bt ,
2212: .Ic \&Ed ,
2213: .Ic \&Ef ,
2214: .Ic \&Ek ,
2215: .Ic \&El ,
1.144 schwarze 2216: .Ic \&Lp ,
2217: .Ic \&Pp ,
1.106 schwarze 2218: .Ic \&Re ,
1.143 schwarze 2219: .Ic \&Rs ,
1.106 schwarze 2220: or
2221: .Ic \&Ud
2222: macro, an
2223: .Ic \&It
2224: macro in a list that don't support item heads, a
2225: .Xr man 7
2226: .Ic \&LP ,
2227: .Ic \&P ,
2228: or
2229: .Ic \&PP
2230: macro, an
2231: .Xr eqn 7
1.120 schwarze 2232: .Ic \&EQ
2233: or
1.106 schwarze 2234: .Ic \&EN
2235: macro, or a
2236: .Xr roff 7
1.148 schwarze 2237: .Ic \&br ,
2238: .Ic \&fi ,
2239: or
2240: .Ic \&nf
1.144 schwarze 2241: request or
1.106 schwarze 2242: .Sq \&..
2243: block closing request is invoked with at least one argument.
2244: All arguments are ignored.
2245: .It Sy "skipping excess arguments"
1.135 schwarze 2246: .Pq mdoc , man , roff
1.150 schwarze 2247: A macro or request is invoked with too many arguments:
2248: .Bl -dash -offset 2n -width 2n -compact
2249: .It
2250: .Ic \&Fo ,
1.206 schwarze 2251: .Ic \&MT ,
1.150 schwarze 2252: .Ic \&PD ,
2253: .Ic \&RS ,
2254: .Ic \&UR ,
2255: .Ic \&ft ,
2256: or
2257: .Ic \&sp
2258: with more than one argument
2259: .It
1.144 schwarze 2260: .Ic \&An
1.150 schwarze 2261: with another argument after
1.144 schwarze 2262: .Fl split
2263: or
1.150 schwarze 2264: .Fl nosplit
2265: .It
2266: .Ic \&RE
2267: with more than one argument or with a non-integer argument
2268: .It
2269: .Ic \&OP
2270: or a request of the
2271: .Ic \&de
2272: family with more than two arguments
1.154 schwarze 2273: .It
2274: .Ic \&Dt
2275: with more than three arguments
1.150 schwarze 2276: .It
2277: .Ic \&TH
2278: with more than five arguments
2279: .It
1.145 schwarze 2280: .Ic \&Bd ,
2281: .Ic \&Bk ,
2282: or
2283: .Ic \&Bl
1.150 schwarze 2284: with invalid arguments
2285: .El
1.106 schwarze 2286: The excess arguments are ignored.
1.133 schwarze 2287: .El
2288: .Ss Unsupported features
2289: .Bl -ohang
2290: .It Sy "input too large"
2291: .Pq mdoc , man
2292: Currently,
2293: .Nm
2294: cannot handle input files larger than its arbitrary size limit
2295: of 2^31 bytes (2 Gigabytes).
2296: Since useful manuals are always small, this is not a problem in practice.
2297: Parsing is aborted as soon as the condition is detected.
1.136 schwarze 2298: .It Sy "unsupported control character"
2299: .Pq roff
2300: An ASCII control character supported by other
2301: .Xr roff 7
2302: implementations but not by
2303: .Nm
2304: was found in an input file.
2305: It is replaced by a question mark.
1.232 schwarze 2306: .It Sy "unsupported escape sequence"
2307: .Pq roff
2308: An input file contains an escape sequence supported by GNU troff
2309: or Heirloom troff but not by
2310: .Nm ,
2311: and it is likely that this will cause information loss
2312: or considerable misformatting.
1.133 schwarze 2313: .It Sy "unsupported roff request"
2314: .Pq roff
2315: An input file contains a
2316: .Xr roff 7
2317: request supported by GNU troff or Heirloom troff but not by
2318: .Nm ,
2319: and it is likely that this will cause information loss
2320: or considerable misformatting.
1.139 schwarze 2321: .It Sy "eqn delim option in tbl"
2322: .Pq eqn , tbl
2323: The options line of a table defines equation delimiters.
2324: Any equation source code contained in the table will be printed unformatted.
2325: .It Sy "unsupported table layout modifier"
1.138 schwarze 2326: .Pq tbl
2327: A table layout specification contains an
2328: .Sq Cm m
2329: modifier.
2330: The modifier is discarded.
1.133 schwarze 2331: .It Sy "ignoring macro in table"
1.139 schwarze 2332: .Pq tbl , mdoc , man
2333: A table contains an invocation of an
2334: .Xr mdoc 7
2335: or
2336: .Xr man 7
2337: macro or of an undefined macro.
2338: The macro is ignored, and its arguments are handled
2339: as if they were a text line.
1.252 schwarze 2340: .It Sy "skipping tbl in -Tman mode"
2341: .Pq mdoc , tbl
2342: An input file contains the
2343: .Ic \&TS
2344: macro.
2345: This message is only generated in
2346: .Fl T Cm man
2347: output mode, where
2348: .Xr tbl 7
2349: input is not supported.
2350: .It Sy "skipping eqn in -Tman mode"
2351: .Pq mdoc , eqn
2352: An input file contains the
2353: .Ic \&EQ
2354: macro.
2355: This message is only generated in
2356: .Fl T Cm man
2357: output mode, where
2358: .Xr eqn 7
2359: input is not supported.
1.240 schwarze 2360: .El
2361: .Ss Bad command line arguments
2362: .Bl -ohang
2363: .It Sy "bad command line argument"
2364: The argument following one of the
2365: .Fl IKMmOTW
2366: command line options is invalid, or a
2367: .Ar file
2368: given as a command line argument cannot be opened.
2369: .It Sy "duplicate command line argument"
2370: The
2371: .Fl I
2372: command line option was specified twice.
2373: .It Sy "option has a superfluous value"
2374: An argument to the
2375: .Fl O
2376: option has a value but does not accept one.
2377: .It Sy "missing option value"
2378: An argument to the
2379: .Fl O
2380: option has no argument but requires one.
2381: .It Sy "bad option value"
2382: An argument to the
2383: .Fl O
2384: .Cm indent
2385: or
2386: .Cm width
2387: option has an invalid value.
2388: .It Sy "duplicate option value"
2389: The same
2390: .Fl O
2391: option is specified more than once.
2392: .It Sy "no such tag"
2393: The
2394: .Fl O Cm tag
2395: option was specified but the tag was not found in any of the displayed
2396: manual pages.
1.253 schwarze 2397: .It Sy "\-Tmarkdown unsupported for man(7) input"
2398: .Pq man
2399: The
2400: .Fl T Cm markdown
2401: option was specified but an input file uses the
2402: .Xr man 7
2403: language.
2404: No output is produced for that input file.
1.106 schwarze 2405: .El
1.1 kristaps 2406: .Sh SEE ALSO
1.141 schwarze 2407: .Xr apropos 1 ,
2408: .Xr man 1 ,
1.85 kristaps 2409: .Xr eqn 7 ,
1.57 kristaps 2410: .Xr man 7 ,
1.13 kristaps 2411: .Xr mandoc_char 7 ,
1.84 kristaps 2412: .Xr mdoc 7 ,
2413: .Xr roff 7 ,
2414: .Xr tbl 7
1.173 schwarze 2415: .Sh HISTORY
2416: The
2417: .Nm
2418: utility first appeared in
2419: .Ox 4.8 .
2420: The option
2421: .Fl I
2422: appeared in
2423: .Ox 5.2 ,
2424: and
2425: .Fl aCcfhKklMSsw
2426: in
2427: .Ox 5.7 .
1.1 kristaps 2428: .Sh AUTHORS
1.156 schwarze 2429: .An -nosplit
1.1 kristaps 2430: The
2431: .Nm
1.26 kristaps 2432: utility was written by
1.141 schwarze 2433: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
2434: and is maintained by
2435: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb