1 .\" $Id: mandoc.1,v 1.208 2017/06/27 12:18:00 schwarze Exp $
3 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
6 .\" Permission to use, copy, modify, and distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
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.
18 .Dd $Mdocdate: June 27 2017 $
23 .Nd format manual pages
27 .Op Fl I Cm os Ns = Ns Ar name
39 manual pages for display.
47 text from stdin and produces
51 The options are as follows:
54 If the standard output is a terminal device and
58 to paginate the output, just like
62 Copy the formatted manual pages to the standard output without using
66 It can be specified to override
68 .It Fl I Cm os Ns = Ns Ar name
69 Override the default operating system
79 Specify the input encoding.
87 If not specified, autodetection uses the first match in the following
91 If the first three bytes of the input file are the UTF-8 byte order
92 mark (BOM, 0xefbbbf), input is interpreted as
95 If the first or second line of the input file matches the
99 .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
101 then input is interpreted according to
104 If the first non-ASCII byte in the file introduces a valid UTF-8
105 sequence, input is interpreted as
108 Otherwise, input is interpreted as
114 all input files are interpreted as
118 all input files are interpreted as
120 By default, the input language is automatically detected for each file:
121 if the the first macro is
127 parser is used; otherwise, the
130 With other arguments,
134 Comma-separated output options.
139 for available formats.
143 Specify the minimum message
145 to be reported on the standard error output and to affect the exit status.
157 level automatically derives the operating system from the contents of the
161 command line option, or from the
170 that bypass autodetection and request validation of base system
171 conventions for a particular operating system.
189 to exit after parsing a file that causes warnings or errors of at least
191 No formatted output will be produced from that file.
196 are requested, they can be joined with a comma, for example
197 .Fl W Cm error , Ns Cm stop .
199 Read input from zero or more files.
200 If unspecified, reads from stdin.
201 If multiple files are specified,
203 will halt with the first failed parse.
208 are also supported and are documented in man(1).
215 also supports the options
222 are mutually exclusive and override each other.
226 utility accepts the following
228 arguments, which correspond to output modes:
229 .Bl -tag -width "-T markdown"
231 Produce 7-bit ASCII output.
235 Produce HTML5, CSS1, and MathML output.
239 Parse only: produce no output.
243 Encode output using the current locale.
258 .Sx Markdown Output .
264 Produce PostScript output.
266 .Sx PostScript Output .
268 Produce an indented parse tree.
270 .Sx Syntax tree output .
272 Encode output in the UTF\-8 multi-byte format.
277 If multiple input files are specified, these will be processed by the
278 corresponding filter in-order.
282 is rendered in standard 7-bit ASCII documented in
285 Font styles are applied by using back-spaced encoding such that an
289 .Sq _ Ns \e[bs] Ns c ,
292 is the back-space character number 8.
293 Emboldened characters are rendered as
294 .Sq c Ns \e[bs] Ns c .
296 The special characters documented in
298 are rendered best-effort in an ASCII equivalent.
300 Output width is limited to 78 visible columns unless literal input lines
305 arguments are accepted:
307 .It Cm indent Ns = Ns Ar indent
308 The left margin for normal text is set to
310 blank characters instead of the default of five for
314 Increasing this is not recommended; it may result in degraded formatting,
315 for example overfull lines or ugly line breaks.
316 .It Cm width Ns = Ns Ar width
317 The output width is set to
323 conforms to HTML5 using optional self-closing tags.
324 Default styles use only CSS1.
325 Equations rendered from
331 file documents style-sheet classes available for customising output.
332 If a style-sheet is not specified with
335 defaults to simple output (via an embedded style-sheet)
336 readable in any graphical or text-based web
339 Special characters are rendered in decimal-encoded UTF\-8.
343 arguments are accepted:
346 Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
347 elements and only emit the subtree below the <body> element.
350 argument will be ignored.
351 This is useful when embedding manual content within existing documents.
352 .It Cm includes Ns = Ns Ar fmt
357 is used as a template for linked header files (usually via the
362 are replaced with the include filename.
363 The default is not to present a
365 .It Cm man Ns = Ns Ar fmt
369 .Ar ../html%S/%N.%S.html ,
370 is used as a template for linked manuals (usually via the
377 are replaced with the linked manual's name and section, respectively.
378 If no section is included, section 1 is assumed.
379 The default is not to
381 .It Cm style Ns = Ns Ar style.css
384 is used for an external style-sheet.
385 This must be a valid absolute or
389 Locale-depending output encoding is triggered with
393 This option is not available on all systems: systems without locale
394 support, or those whose internal representation is not natively UCS-4,
399 for font style specification and available command-line arguments.
401 Translate input format into
404 This is useful for distributing manual sources to legacy systems
411 is passed as input, it is translated into
413 If the input format is
415 the input is copied to the output, expanding any
419 The parser is also run, and as usual, the
423 are displayed before copying the input to the output.
430 .Lk http://daringfireball.net/projects/markdown/syntax.text\
431 "John Gruber's 2004 specification" .
432 The output also almost conforms to the
433 .Lk http://commonmark.org/ CommonMark
436 The character set used for the markdown output is ASCII.
437 Non-ASCII characters are encoded as HTML entities.
438 Since that is not possible in literal font contexts, because these
439 are rendered as code spans and code blocks in the markdown output,
440 non-ASCII characters are transliterated to ASCII approximations in
443 Markdown is a very weak markup language, so all semantic markup is
444 lost, and even part of the presentational markup may be lost.
445 Do not use this as an intermediate step in converting to HTML;
455 input languages are not supported by
459 PDF-1.1 output may be generated by
462 .Sx PostScript Output
465 arguments and defaults.
466 .Ss PostScript Output
469 Level-2 pages may be generated by
471 Output pages default to letter sized and are rendered in the Times font
473 Margins are calculated as 1/9 the page length and width.
476 Special characters are rendered as in
481 arguments are accepted:
483 .It Cm paper Ns = Ns Ar name
493 You may also manually specify dimensions as
495 width by height in millimetres.
496 If an unknown value is encountered,
503 to force a UTF\-8 locale.
506 for details and options.
507 .Ss Syntax tree output
510 to show a human readable representation of the syntax tree.
511 It is useful for debugging the source code of manual pages.
512 The exact format is subject to change, so don't write parsers for it.
514 The first paragraph shows meta data found in the
519 line, or the fallbacks used.
521 In the tree dump, each output line shows one syntax tree node.
522 Child nodes are indented with respect to their parent node.
527 For macro nodes, the macro name; for text and
530 There is a special format for
534 Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
539 An opening parenthesis if the node is an opening delimiter.
541 An asterisk if the node starts a new input line.
543 The input line number (starting at one).
547 The input column number (starting at one).
549 A closing parenthesis if the node is a closing delimiter.
551 A full stop if the node ends a sentence.
553 BROKEN if the node is a block broken by another block.
555 NOSRC if the node is not in the input file,
556 but automatically generated from macros.
558 NOPRT if the node is not supposed to generate output
559 for any output format.
565 argument is accepted:
568 Skip validation and show the unvalidated syntax tree.
569 This can help to find out whether a given behaviour is caused by
570 the parser or by the validator.
571 Meta data is not available in this case.
574 .Bl -tag -width MANPAGER
576 Any non-empty value of the environment variable
578 is used instead of the standard pagination program,
589 Specifies the pagination program to use when
592 If neither PAGER nor MANPAGER is defined,
605 utility exits with one of the following values, controlled by the message
611 .Bl -tag -width Ds -compact
613 No base system convention violations, style suggestions, warnings,
614 or errors occurred, or those that did were ignored because they
615 were lower than the requested
618 At least one base system convention violation or style suggestion
619 occurred, but no warning or error, and
625 At least one warning occurred, but no error, and
631 At least one parsing error occurred,
632 but no unsupported feature was encountered, and
638 At least one unsupported feature was encountered, and
644 Invalid command line arguments were specified.
645 No input files have been read.
647 An operating system error occurred, for example exhaustion
648 of memory, file descriptors, or process table entries.
651 to exit at once, possibly in the middle of parsing or formatting a file.
659 To page manuals to the terminal:
661 .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
663 To produce HTML manuals with
667 .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
669 To check over a large set of manuals:
671 .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
673 To produce a series of PostScript manuals for A4 paper:
675 .Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
681 format, for use on systems lacking an
685 .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
687 Messages displayed by
690 .Bd -ragged -offset indent
692 .Ar file : Ns Ar line : Ns Ar column : level : message : macro args
696 Line and column numbers start at 1.
697 Both are omitted for messages referring to an input file as a whole.
698 Macro names and arguments are omitted where meaningless.
701 operating system specifier is omitted for messages that are relevant
702 for all operating systems.
703 Fatal messages about invalid command line arguments
704 or operating system errors, for example when memory is exhausted,
711 Message levels have the following meanings:
712 .Bl -tag -width "warning"
714 An input file uses unsupported low-level
717 The output may be incomplete and/or misformatted,
718 so using GNU troff instead of
720 to process the file may be preferable.
722 An input file contains invalid syntax that cannot be safely interpreted.
723 By discarding part of the input or inserting missing tokens,
724 the parser is able to continue, and the error does not prevent
725 generation of formatted output, but typically, preparing that
726 output involves information loss, broken document structure
727 or unintended formatting, no matter whether
729 or GNU troff is used.
730 In many cases, the output of
732 and GNU troff is identical, but in some,
734 is more resilient than GNU troff with respect to malformed input.
736 Non-existent or unreadable input files are also reported on the
739 In that case, the parser cannot even be started and no output
740 is produced from those input files.
742 An input file uses obsolete, discouraged or non-portable syntax.
743 All the same, the meaning of the input is unambiguous and a correct
744 rendering can be produced.
745 Documents causing warnings may render poorly when using other
746 formatting tools instead of
749 An input file uses dubious or discouraged style.
750 This is not a complaint about the syntax, and probably neither
751 formatting nor portability are in danger.
752 While great care is taken to avoid false positives on the higher
755 level tries to reduce the probability that issues go unnoticed,
756 so it may occasionally issue bogus suggestions.
757 Please use your good judgement to decide whether any particular
759 suggestion really justifies a change to the input file.
761 A convertion used in the base system of a specific operating system
763 These are not markup mistakes, and neither the quality of formatting
764 nor portability are in danger.
774 levels except those about non-existent or unreadable input files
775 are hidden unless their level, or a lower level, is requested using a
781 As indicated below, all
785 checks are only performed if a specific operating system name occurs
786 in the arguments of the
788 command line option, of the
792 command line option, or, if neither are present, in the return value
796 .Ss Conventions for base system manuals
798 .It Sy "Mdocdate found"
804 keyword substitution, which is not supported by the
807 Consider using the conventional
810 .It Sy "Mdocdate missing"
814 macro does not use CVS
816 keyword substitution, but using it is conventionally expected in the
819 .It Sy "unknown architecture"
821 The third argument of the
823 macro does not match any of the architectures this operating system
825 .It Sy "operating system explicitly specified"
829 macro has an argument.
830 In the base system, it is conventionally left blank.
831 .It Sy "RCS id missing"
833 The manual page lacks the comment line with the RCS identifier
838 keyword substitution as conventionally used in these operating systems.
840 .Ss Style suggestions
842 .It Sy "legacy man(7) date format"
846 macro uses the legacy
850 Consider using the conventional
855 .It Sy "duplicate RCS id"
856 A single manual page contains two copies of the RCS identifier for
857 the same operating system.
858 Consider deleting the later instance and moving the first one up
859 to the top of the page.
860 .It Sy "typo in section name"
862 Fuzzy string matching revealed that the argument of an
864 macro is similar, but not identical to a standard section name.
865 .It Sy "useless macro"
873 Simply delete it: it serves no useful purpose.
874 .It Sy "consider using OS macro"
876 A string was found in plain text or in a
878 macro that could be represented using
884 .It Sy "errnos out of order"
890 list are not in alphabetical order.
891 .It Sy "duplicate errno"
895 list contains two consecutive
897 entries describing the same
900 .It Sy "description line ends with a full stop"
902 Do not use punctuation at the end of an
905 .It Sy "no blank before trailing delimiter"
907 The last argument of a macro that supports trailing delimiter
908 arguments is longer than one byte and ends with a trailing delimiter.
909 Consider inserting a blank such that the delimiter becomes a separate
910 argument, thus moving it out of the scope of the macro.
911 .It Sy "function name without markup"
913 A word followed by an empty pair of parentheses occurs on a text line.
920 .Ss Warnings related to the document prologue
922 .It Sy "missing manual title, using UNTITLED"
926 macro has no arguments, or there is no
928 macro before the first non-prologue macro.
929 .It Sy "missing manual title, using \(dq\(dq"
933 macro, or it has no arguments.
934 .It Sy "lower case character in document title"
936 The title is still used as given in the
941 .It Sy "missing manual section, using \(dq\(dq"
947 macro lacks the mandatory section argument.
948 .It Sy "unknown manual section"
950 The section number in a
952 line is invalid, but still used.
953 .It Sy "missing date, using today's date"
955 The document was parsed as
961 macro has no arguments or only empty arguments;
962 or the document was parsed as
968 macro has less than three arguments or its third argument is empty.
969 .It Sy "cannot parse date, using it verbatim"
975 macro does not follow the conventional format.
976 .It Sy "missing Os macro, using \(dq\(dq"
978 The default or current system is not shown in this case.
979 .It Sy "duplicate prologue macro"
981 One of the prologue macros occurs more than once.
982 The last instance overrides all previous ones.
983 .It Sy "late prologue macro"
989 macro occurs after some non-prologue macro, but still takes effect.
990 .It Sy "skipping late title macro"
994 macro appears after the first non-prologue macro.
995 Traditional formatters cannot handle this because
996 they write the page header before parsing the document body.
997 Even though this technical restriction does not apply to
999 traditional semantics is preserved.
1000 The late macro is discarded including its arguments.
1001 .It Sy "prologue macros out of order"
1003 The prologue macros are not given in the conventional order
1007 All three macros are used even when given in another order.
1009 .Ss Warnings regarding document structure
1011 .It Sy ".so is fragile, better use ln(1)"
1013 Including files only works when the parser program runs with the correct
1014 current working directory.
1015 .It Sy "no document body"
1017 The document body contains neither text nor macros.
1018 An empty document is shown, consisting only of a header and a footer line.
1019 .It Sy "content before first section header"
1021 Some macros or text precede the first
1026 The offending macros and text are parsed and added to the top level
1027 of the syntax tree, outside any section block.
1028 .It Sy "first section is not NAME"
1030 The argument of the first
1038 .It Sy "NAME section without Nm before Nd"
1040 The NAME section does not contain any
1042 child macro before the first
1045 .It Sy "NAME section without description"
1047 The NAME section lacks the mandatory
1050 .It Sy "description not at the end of NAME"
1052 The NAME section does contain an
1054 child macro, but other content follows it.
1055 .It Sy "bad NAME section content"
1057 The NAME section contains plain text or macros other than
1061 .It Sy "missing comma before name"
1063 The NAME section contains an
1065 macro that is neither the first one nor preceded by a comma.
1066 .It Sy "missing description line, using \(dq\(dq"
1070 macro lacks the required argument.
1071 The title line of the manual will end after the dash.
1072 .It Sy "description line outside NAME section"
1076 macro appears outside the NAME section.
1077 The arguments are printed anyway and the following text is used for
1079 but none of that behaviour is portable.
1080 .It Sy "sections out of conventional order"
1082 A standard section occurs after another section it usually precedes.
1083 All section titles are used as given,
1084 and the order of sections is not changed.
1085 .It Sy "duplicate section title"
1087 The same standard section title occurs more than once.
1088 .It Sy "unexpected section"
1090 A standard section header occurs in a section of the manual
1091 where it normally isn't useful.
1092 .It Sy "unusual Xr order"
1094 In the SEE ALSO section, an
1096 macro with a lower section number follows one with a higher number,
1099 macros referring to the same section are out of alphabetical order.
1100 .It Sy "unusual Xr punctuation"
1102 In the SEE ALSO section, punctuation between two
1104 macros differs from a single comma, or there is trailing punctuation
1108 .It Sy "AUTHORS section without An macro"
1110 An AUTHORS sections contains no
1112 macros, or only empty ones.
1113 Probably, there are author names lacking markup.
1115 .Ss "Warnings related to macros and nesting"
1117 .It Sy "obsolete macro"
1121 manual for replacements.
1122 .It Sy "macro neither callable nor escaped"
1124 The name of a macro that is not callable appears on a macro line.
1125 It is printed verbatim.
1126 If the intention is to call it, move it to its own input line;
1127 otherwise, escape it by prepending
1129 .It Sy "skipping paragraph macro"
1132 documents, this happens
1135 at the beginning and end of sections and subsections
1137 right before non-compact lists and displays
1139 at the end of items in non-column, non-compact lists
1141 and for multiple consecutive paragraph macros.
1145 documents, it happens
1157 macros having neither head nor body arguments
1168 .It Sy "moving paragraph macro out of list"
1172 list contains a trailing paragraph macro.
1173 The paragraph macro is moved after the end of the list.
1174 .It Sy "skipping no-space macro"
1176 An input line begins with an
1178 macro, or the next argument after an
1180 macro is an isolated closing delimiter.
1181 The macro is ignored.
1182 .It Sy "blocks badly nested"
1184 If two blocks intersect, one should completely contain the other.
1185 Otherwise, rendered output is likely to look strange in any output
1186 format, and rendering in SGML-based output formats is likely to be
1187 outright wrong because such languages do not support badly nested
1189 Typical examples of badly nested blocks are
1190 .Qq Ic \&Ao \&Bo \&Ac \&Bc
1192 .Qq Ic \&Ao \&Bq \&Ac .
1200 .It Sy "nested displays are not portable"
1207 display occurs nested inside another
1212 but fails with most other implementations.
1213 .It Sy "moving content out of list"
1217 list block contains text or macros before the first
1220 The offending children are moved before the beginning of the list.
1221 .It Sy "fill mode already enabled, skipping"
1225 request occurs even though the document is still in fill mode,
1226 or already switched back to fill mode.
1228 .It Sy "fill mode already disabled, skipping"
1232 request occurs even though the document already switched to no-fill mode
1233 and did not switch back to fill mode yet.
1235 .It Sy "line scope broken"
1237 While parsing the next-line scope of the previous macro,
1238 another macro is found that prematurely terminates the previous one.
1239 The previous, interrupted macro is deleted from the parse tree.
1241 .Ss "Warnings related to missing arguments"
1243 .It Sy "skipping empty request"
1245 The macro name is missing from a macro definition request,
1248 control statement or operation keyword lacks its required argument.
1249 .It Sy "conditional request controls empty scope"
1251 A conditional request is only useful if any of the following
1252 follows it on the same logical input line:
1257 keyword to open a multi-line scope.
1259 A request or macro or some text, resulting in a single-line scope.
1261 The immediate end of the logical line without any intervening whitespace,
1262 resulting in next-line scope.
1264 Here, a conditional request is followed by trailing whitespace only,
1265 and there is no other content on its logical input line.
1266 Note that it doesn't matter whether the logical input line is split
1267 across multiple physical input lines using
1269 line continuation characters.
1270 This is one of the rare cases
1271 where trailing whitespace is syntactically significant.
1272 The conditional request controls a scope containing whitespace only,
1273 so it is unlikely to have a significant effect,
1274 except that it may control a following
1277 .It Sy "skipping empty macro"
1279 The indicated macro has no arguments and hence no effect.
1280 .It Sy "empty block"
1292 block contains nothing in its body and will produce no output.
1293 .It Sy "empty argument, using 0n"
1295 The required width is missing after
1302 .It Sy "missing display type, using -ragged"
1306 macro is invoked without the required display type.
1307 .It Sy "list type is not the first argument"
1311 macro, at least one other argument precedes the type argument.
1314 utility copes with any argument order, but some other
1316 implementations do not.
1317 .It Sy "missing -width in -tag list, using 8n"
1326 .It Sy "missing utility name, using \(dq\(dq"
1330 macro is called without an argument before
1332 has first been called with an argument.
1333 .It Sy "missing function name, using \(dq\(dq"
1337 macro is called without an argument.
1338 No function name is printed.
1339 .It Sy "empty head in list item"
1351 macro lacks the required argument.
1352 The item head is left empty.
1353 .It Sy "empty list item"
1365 An empty list item is shown.
1366 .It Sy "missing font type, using \efR"
1370 macro has no argument.
1371 It switches to the default font.
1372 .It Sy "unknown font type, using \efR"
1376 argument is invalid.
1377 The default font is used instead.
1378 .It Sy "nothing follows prefix"
1382 macro has no argument, or only one argument and no macro follows
1383 on the same input line.
1384 This defeats its purpose; in particular, spacing is not suppressed
1385 before the text or macros following on the next input line.
1386 .It Sy "empty reference block"
1390 macro is immediately followed by an
1392 macro on the next input line.
1393 Such an empty block does not produce any output.
1394 .It Sy "missing section argument"
1398 macro lacks its second, section number argument.
1399 The first argument, i.e. the name, is printed, but without subsequent
1401 .It Sy "missing -std argument, adding it"
1407 macro lacks the required
1414 even when it is not specified, but other implementations may not.
1415 .It Sy "missing option string, using \(dq\(dq"
1419 macro is invoked without any argument.
1420 An empty pair of square brackets is shown.
1421 .It Sy "missing resource identifier, using \(dq\(dq"
1427 macro is invoked without any argument.
1428 An empty pair of angle brackets is shown.
1429 .It Sy "missing eqn box, using \(dq\(dq"
1431 A diacritic mark or a binary operator is found,
1432 but there is nothing to the left of it.
1433 An empty box is inserted.
1435 .Ss "Warnings related to bad macro arguments"
1437 .It Sy "unterminated quoted argument"
1439 Macro arguments can be enclosed in double quote characters
1440 such that space characters and macro names contained in the quoted
1441 argument need not be escaped.
1442 The closing quote of the last argument of a macro can be omitted.
1443 However, omitting it is not recommended because it makes the code
1445 .It Sy "duplicate argument"
1451 macro has more than one
1458 All but the last instances of these arguments are ignored.
1459 .It Sy "skipping duplicate argument"
1463 macro has more than one
1468 All but the first of these arguments are ignored.
1469 .It Sy "skipping duplicate display type"
1473 macro has more than one type argument; the first one is used.
1474 .It Sy "skipping duplicate list type"
1478 macro has more than one type argument; the first one is used.
1479 .It Sy "skipping -width argument"
1493 .It Sy "wrong number of cells"
1496 list, the number of tabs or
1498 macros is less than the number expected from the list header line
1499 or exceeds the expected number by more than one.
1500 Missing cells remain empty, and all cells exceeding the number of
1501 columns are joined into one single cell.
1502 .It Sy "unknown AT&T UNIX version"
1506 macro has an invalid argument.
1507 It is used verbatim, with
1510 .It Sy "comma in function argument"
1516 macro contains a comma; it should probably be split into two arguments.
1517 .It Sy "parenthesis in function name"
1519 The first argument of an
1523 macro contains an opening or closing parenthesis; that's probably wrong,
1524 parentheses are added automatically.
1525 .It Sy "unknown library name"
1529 macro has an unknown name argument and will be rendered as
1530 .Qq library Dq Ar name .
1531 .It Sy "invalid content in Rs block"
1535 block contains plain text or non-% macros.
1536 The bogus content is left in the syntax tree.
1537 Formatting may be poor.
1538 .It Sy "invalid Boolean argument"
1542 macro has an argument other than
1546 The invalid argument is moved out of the macro, which leaves the macro
1547 empty, causing it to toggle the spacing mode.
1548 .It Sy "unknown font, skipping request"
1556 layout modifier has an unknown
1559 .It Sy "odd number of characters in request"
1563 request contains an odd number of characters.
1564 The last character is mapped to the blank character.
1566 .Ss "Warnings related to plain text"
1568 .It Sy "blank line in fill mode, using .sp"
1570 The meaning of blank input lines is only well-defined in non-fill mode:
1571 In fill mode, line breaks of text input lines are not supposed to be
1573 However, for compatibility with groff, blank lines in fill mode
1577 .It Sy "tab in filled text"
1579 The meaning of tab characters is only well-defined in non-fill mode:
1580 In fill mode, whitespace is not supposed to be significant
1581 on text input lines.
1582 As an implementation dependent choice, tab characters on text lines
1583 are passed through to the formatters in any case.
1584 Given that the text before the tab character will be filled,
1585 it is hard to predict which tab stop position the tab will advance to.
1586 .It Sy "whitespace at end of input line"
1587 .Pq mdoc , man , roff
1588 Whitespace at the end of input lines is almost never semantically
1589 significant \(em but in the odd case where it might be, it is
1590 extremely confusing when reviewing and maintaining documents.
1591 .It Sy "new sentence, new line"
1593 A new sentence starts in the middle of a text line.
1594 Start it on a new input line to help formatters produce correct spacing.
1595 .It Sy "bad comment style"
1597 Comment lines start with a dot, a backslash, and a double-quote character.
1600 utility treats the line as a comment line even without the backslash,
1601 but leaving out the backslash might not be portable.
1602 .It Sy "invalid escape sequence"
1604 An escape sequence has an invalid opening argument delimiter, lacks the
1605 closing argument delimiter, or the argument has too few characters.
1606 If the argument is incomplete,
1610 expand to an empty string,
1616 to the length of the incomplete argument.
1617 All other invalid escape sequences are ignored.
1618 .It Sy "undefined string, using \(dq\(dq"
1620 If a string is used without being defined before,
1621 its value is implicitly set to the empty string.
1622 However, defining strings explicitly before use
1623 keeps the code more readable.
1625 .Ss "Warnings related to tables"
1627 .It Sy "tbl line starts with span"
1629 The first cell in a table layout line is a horizontal span
1631 Data provided for this cell is ignored, and nothing is printed in the cell.
1632 .It Sy "tbl column starts with span"
1634 The first line of a table layout specification
1635 requests a vertical span
1637 Data provided for this cell is ignored, and nothing is printed in the cell.
1638 .It Sy "skipping vertical bar in tbl layout"
1640 A table layout specification contains more than two consecutive vertical bars.
1641 A double bar is printed, all additional bars are discarded.
1643 .Ss "Errors related to tables"
1645 .It Sy "non-alphabetic character in tbl options"
1647 The table options line contains a character other than a letter,
1648 blank, or comma where the beginning of an option name is expected.
1649 The character is ignored.
1650 .It Sy "skipping unknown tbl option"
1652 The table options line contains a string of letters that does not
1653 match any known option name.
1654 The word is ignored.
1655 .It Sy "missing tbl option argument"
1657 A table option that requires an argument is not followed by an
1658 opening parenthesis, or the opening parenthesis is immediately
1659 followed by a closing parenthesis.
1660 The option is ignored.
1661 .It Sy "wrong tbl option argument size"
1663 A table option argument contains an invalid number of characters.
1664 Both the option and the argument are ignored.
1665 .It Sy "empty tbl layout"
1667 A table layout specification is completely empty,
1668 specifying zero lines and zero columns.
1669 As a fallback, a single left-justified column is used.
1670 .It Sy "invalid character in tbl layout"
1672 A table layout specification contains a character that can neither
1673 be interpreted as a layout key character nor as a layout modifier,
1674 or a modifier precedes the first key.
1675 The invalid character is discarded.
1676 .It Sy "unmatched parenthesis in tbl layout"
1678 A table layout specification contains an opening parenthesis,
1679 but no matching closing parenthesis.
1680 The rest of the input line, starting from the parenthesis, has no effect.
1681 .It Sy "tbl without any data cells"
1683 A table does not contain any data cells.
1684 It will probably produce no output.
1685 .It Sy "ignoring data in spanned tbl cell"
1687 A table cell is marked as a horizontal span
1691 in the table layout, but it contains data.
1692 The data is ignored.
1693 .It Sy "ignoring extra tbl data cells"
1695 A data line contains more cells than the corresponding layout line.
1696 The data in the extra cells is ignored.
1697 .It Sy "data block open at end of tbl"
1699 A data block is opened with
1701 but never closed with a matching
1703 The remaining data lines of the table are all put into one cell,
1704 and any remaining cells stay empty.
1706 .Ss "Errors related to roff, mdoc, and man code"
1708 .It Sy "input stack limit exceeded, infinite loop?"
1710 Explicit recursion limits are implemented for the following features,
1711 in order to prevent infinite loops:
1714 expansion of nested escape sequences
1715 including expansion of strings and number registers,
1717 expansion of nested user-defined macros,
1723 When a limit is hit, the output is incorrect, typically losing
1724 some content, but the parser can continue.
1725 .It Sy "skipping bad character"
1726 .Pq mdoc , man , roff
1727 The input file contains a byte that is not a printable
1730 The message mentions the character number.
1731 The offending byte is replaced with a question mark
1733 Consider editing the input file to replace the byte with an ASCII
1734 transliteration of the intended character.
1735 .It Sy "skipping unknown macro"
1736 .Pq mdoc , man , roff
1737 The first identifier on a request or macro line is neither recognized as a
1739 request, nor as a user-defined macro, nor, respectively, as an
1744 It may be mistyped or unsupported.
1745 The request or macro is discarded including its arguments.
1746 .It Sy "skipping insecure request"
1748 An input file attempted to run a shell command
1749 or to read or write an external file.
1750 Such attempts are denied for security reasons.
1751 .It Sy "skipping item outside list"
1755 macro occurs outside any
1760 delimiter occurs outside any pile.
1761 It is discarded including its arguments.
1762 .It Sy "skipping column outside column list"
1766 macro occurs outside any
1769 It is discarded including its arguments.
1770 .It Sy "skipping end of block that is not open"
1771 .Pq mdoc , man , eqn , tbl , roff
1772 Various syntax elements can only be used to explicitly close blocks
1773 that have previously been opened.
1776 block closing macro, a
1783 right delimiter or closing brace, or the end of an equation, table, or
1785 conditional request is encountered but no matching block is open.
1786 The offending request or macro is discarded.
1787 .It Sy "fewer RS blocks open, skipping"
1791 macro is invoked with an argument, but less than the specified number of
1797 .It Sy "inserting missing end of block"
1801 macros as well as tables require explicit closing by dedicated macros.
1802 A block that doesn't support bad nesting
1803 ends before all of its children are properly closed.
1804 The open child nodes are closed implicitly.
1805 .It Sy "appending missing end of block"
1806 .Pq mdoc , man , eqn , tbl , roff
1807 At the end of the document, an explicit
1815 block, an equation, table, or
1817 conditional or ignore block is still open.
1818 The open block is closed implicitly.
1819 .It Sy "escaped character not allowed in a name"
1821 Macro, string and register identifiers consist of printable,
1822 non-whitespace ASCII characters.
1823 Escape sequences and characters and strings expressed in terms of them
1824 cannot form part of a name.
1825 The first argument of an
1833 request, or any argument of an
1835 request, or the name of a request or user defined macro being called,
1836 is terminated by an escape sequence.
1842 the request has no effect at all.
1849 what was parsed up to this point is used as the arguments to the request,
1850 and the rest of the input line is discarded including the escape sequence.
1851 When parsing for a request or a user-defined macro name to be called,
1852 only the escape sequence is discarded.
1853 The characters preceding it are used as the request or macro name,
1854 the characters following it are used as the arguments to the request or macro.
1855 .It Sy "NOT IMPLEMENTED: Bd -file"
1857 For security reasons, the
1859 macro does not support the
1862 By requesting the inclusion of a sensitive file, a malicious document
1863 might otherwise trick a privileged user into inadvertently displaying
1864 the file on the screen, revealing the file content to bystanders.
1865 The argument is ignored including the file name following it.
1866 .It Sy "skipping display without arguments"
1870 block macro does not have any arguments.
1871 The block is discarded, and the block content is displayed in
1872 whatever mode was active before the block.
1873 .It Sy "missing list type, using -item"
1877 macro fails to specify the list type.
1878 .It Sy "argument is not numeric, using 1"
1882 request is not a number.
1883 .It Sy "missing manual name, using \(dq\(dq"
1887 or any call in the NAME section, lacks the required argument.
1888 .It Sy "uname(3) system call failed, using UNKNOWN"
1892 macro is called without arguments, and the
1897 can be compiled with
1899 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1901 .It Sy "unknown standard specifier"
1905 macro has an unknown argument and is discarded.
1906 .It Sy "skipping request without numeric argument"
1915 statement has a non-numeric or negative argument or no argument at all.
1916 The invalid request or statement is ignored.
1917 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1919 For security reasons,
1923 file inclusion requests only with relative paths
1924 and only without ascending to any parent directory.
1925 By requesting the inclusion of a sensitive file, a malicious document
1926 might otherwise trick a privileged user into inadvertently displaying
1927 the file on the screen, revealing the file content to bystanders.
1929 only shows the path as it appears behind
1931 .It Sy ".so request failed"
1935 request requires reading an external file, but the file could not be
1938 only shows the path as it appears behind
1940 .It Sy "skipping all arguments"
1941 .Pq mdoc , man , eqn , roff
1957 macro in a list that don't support item heads, a
1976 block closing request is invoked with at least one argument.
1977 All arguments are ignored.
1978 .It Sy "skipping excess arguments"
1979 .Pq mdoc , man , roff
1980 A macro or request is invoked with too many arguments:
1981 .Bl -dash -offset 2n -width 2n -compact
1991 with more than one argument
1994 with another argument after
2000 with more than one argument or with a non-integer argument
2005 family with more than two arguments
2008 with more than three arguments
2011 with more than five arguments
2017 with invalid arguments
2019 The excess arguments are ignored.
2021 .Ss Unsupported features
2023 .It Sy "input too large"
2027 cannot handle input files larger than its arbitrary size limit
2028 of 2^31 bytes (2 Gigabytes).
2029 Since useful manuals are always small, this is not a problem in practice.
2030 Parsing is aborted as soon as the condition is detected.
2031 .It Sy "unsupported control character"
2033 An ASCII control character supported by other
2035 implementations but not by
2037 was found in an input file.
2038 It is replaced by a question mark.
2039 .It Sy "unsupported roff request"
2041 An input file contains a
2043 request supported by GNU troff or Heirloom troff but not by
2045 and it is likely that this will cause information loss
2046 or considerable misformatting.
2047 .It Sy "eqn delim option in tbl"
2049 The options line of a table defines equation delimiters.
2050 Any equation source code contained in the table will be printed unformatted.
2051 .It Sy "unsupported table layout modifier"
2053 A table layout specification contains an
2056 The modifier is discarded.
2057 .It Sy "ignoring macro in table"
2058 .Pq tbl , mdoc , man
2059 A table contains an invocation of an
2063 macro or of an undefined macro.
2064 The macro is ignored, and its arguments are handled
2065 as if they were a text line.
2079 utility first appeared in
2093 utility was written by
2094 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
2095 and is maintained by
2096 .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
git.ckatri.com / mandoc.git / blob