1 .\" $Id: mandoc.1,v 1.122 2014/11/11 02:43:41 schwarze Exp $
3 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 .\" Copyright (c) 2012, 2014 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: November 11 2014 $
23 .Nd format and display UNIX manuals
28 .Op Fl I Cm os Li = Ar name
30 .Op Fl K Ns Ar encoding
41 manual pages for display.
49 text from stdin, implying
55 The options are as follows:
58 If the standard output is a terminal device and
62 to paginate the output, just like
66 Copy the formatted manual pages to the standard output without using
70 It can be specified to override
75 This overrides any earlier
81 .It Fl I Cm os Li = Ar name
83 Override the default operating system
90 Display only the SYNOPSIS lines.
93 .It Fl K Ns Ar encoding
94 Specify the input encoding.
102 If not specified, autodetection uses the first match:
103 .Bl -tag -width iso-8859-1
105 if the first three bytes of the input file
106 are the UTF-8 byte order mark (BOM, 0xefbbbf)
108 if the first or second line of the input file matches the
112 .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
114 if the first non-ASCII byte in the file introduces a valid UTF-8 sequence
121 This overrides any earlier
129 Also reverts any earlier
134 .It Fl m Ns Ar format
138 for available formats.
141 .It Fl O Ns Ar option
142 Comma-separated output options.
143 .It Fl T Ns Ar output
147 for available formats.
151 Print version and exit.
153 Specify the minimum message
155 to be reported on the standard error output and to affect the exit status.
167 .Fl W Ns Cm warning .
178 to exit after parsing a file that causes warnings or errors of at least
180 No formatted output will be produced from that file.
185 are requested, they can be joined with a comma, for example
186 .Fl W Ns Cm error , Ns Cm stop .
188 Read input from zero or more files.
189 If unspecified, reads from stdin.
190 If multiple files are specified,
192 will halt with the first failed parse.
201 also supports the options
224 should only be used for legacy manuals.
228 which is also the default, determines encoding on-the-fly: if the first
235 parser is used; otherwise, the
240 files are specified with
242 each has its file-type determined this way.
243 If multiple files are
248 is specified, then this format is used exclusively.
252 utility accepts the following
254 arguments, which correspond to output modes:
255 .Bl -tag -width "-Tlocale"
257 Produce 7-bit ASCII output.
262 Produce HTML5, CSS1, and MathML output.
266 Parse only: produce no output.
268 .Fl W Ns Cm warning .
269 .It Fl T Ns Cm locale
270 Encode output using the current locale.
284 Produce PostScript output.
286 .Sx PostScript Output .
288 Produce an indented parse tree.
290 Encode output in the UTF\-8 multi-byte format.
294 This is a synonym for
298 If multiple input files are specified, these will be processed by the
299 corresponding filter in-order.
303 which is the default, is rendered in standard 7-bit ASCII documented in
306 Font styles are applied by using back-spaced encoding such that an
310 .Sq _ Ns \e[bs] Ns c ,
313 is the back-space character number 8.
314 Emboldened characters are rendered as
315 .Sq c Ns \e[bs] Ns c .
317 The special characters documented in
319 are rendered best-effort in an ASCII equivalent.
320 If no equivalent is found,
324 Output width is limited to 78 visible columns unless literal input lines
329 arguments are accepted:
331 .It Cm indent Ns = Ns Ar indent
332 The left margin for normal text is set to
334 blank characters instead of the default of five for
338 Increasing this is not recommended; it may result in degraded formatting,
339 for example overfull lines or ugly line breaks.
340 .It Cm width Ns = Ns Ar width
341 The output width is set to
343 which will normalise to \(>=60.
348 conforms to HTML5 using optional self-closing tags.
349 Default styles use only CSS1.
350 Equations rendered from
355 .Pa example.style.css
356 file documents style-sheet classes available for customising output.
357 If a style-sheet is not specified with
360 defaults to simple output (via an embedded style-sheet)
361 readable in any graphical or text-based web
364 Special characters are rendered in decimal-encoded UTF\-8.
368 arguments are accepted:
378 elements and only emit the subtree below the
383 argument will be ignored.
384 This is useful when embedding manual content within existing documents.
385 .It Cm includes Ns = Ns Ar fmt
390 is used as a template for linked header files (usually via the
395 are replaced with the include filename.
396 The default is not to present a
398 .It Cm man Ns = Ns Ar fmt
402 .Ar ../html%S/%N.%S.html ,
403 is used as a template for linked manuals (usually via the
410 are replaced with the linked manual's name and section, respectively.
411 If no section is included, section 1 is assumed.
412 The default is not to
414 .It Cm style Ns = Ns Ar style.css
417 is used for an external style-sheet.
418 This must be a valid absolute or
422 Locale-depending output encoding is triggered with
424 This option is not available on all systems: systems without locale
425 support, or those whose internal representation is not natively UCS-4,
430 for font style specification and available command-line arguments.
432 Translate input format into
435 This is useful for distributing manual sources to legacy systems
442 is passed as input, it is translated into
444 If the input format is
446 the input is copied to the output, expanding any
450 The parser is also run, and as usual, the
454 are displayed before copying the input to the output.
456 PDF-1.1 output may be generated by
459 .Sx PostScript Output
462 arguments and defaults.
463 .Ss PostScript Output
466 Level-2 pages may be generated by
468 Output pages default to letter sized and are rendered in the Times font
470 Margins are calculated as 1/9 the page length and width.
473 Special characters are rendered as in
478 arguments are accepted:
480 .It Cm paper Ns = Ns Ar name
490 You may also manually specify dimensions as
492 width by height in millimetres.
493 If an unknown value is encountered,
500 to force a UTF\-8 locale.
503 for details and options.
505 .Bl -tag -width MANPAGER
507 Any non-empty value of the environment variable
509 will be used instead of the standard pagination program,
512 Specifies the pagination program to use when
515 If neither PAGER nor MANPAGER is defined,
516 .Pa /usr/bin/more Fl s
522 utility exits with one of the following values, controlled by the message
528 .Bl -tag -width Ds -compact
530 No warnings or errors occurred, or those that did were ignored because
531 they were lower than the requested
534 At least one warning occurred, but no error, and
538 At least one parsing error occurred, but no fatal error, and
544 A fatal parsing error occurred.
546 Invalid command line arguments were specified.
547 No input files have been read.
549 An operating system error occurred, for example memory exhaustion or an
550 error accessing input files.
553 to exit at once, possibly in the middle of parsing or formatting a file.
559 .Fl W Ns Cm warning .
561 To page manuals to the terminal:
563 .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
564 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
566 To produce HTML manuals with
570 .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
572 To check over a large set of manuals:
574 .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
576 To produce a series of PostScript manuals for A4 paper:
578 .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
584 format, for use on systems lacking an
588 .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
590 Messages displayed by
594 .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
596 Line and column numbers start at 1.
597 Both are omitted for messages referring to an input file as a whole.
598 Macro names and arguments are omitted where meaningless.
599 Fatal messages about invalid command line arguments
600 or operating system errors, for example when memory is exhausted,
607 Message levels have the following meanings:
608 .Bl -tag -width "warning"
610 Opening or reading an input file failed, so the parser cannot
611 even be started and no output is produced from that input file.
613 The parser is unable to parse a given input file at all.
614 No formatted output is produced from that input file.
616 An input file contains syntax that cannot be safely interpreted,
617 either because it is invalid or because
619 does not implement it yet.
620 By discarding part of the input or inserting missing tokens,
621 the parser is able to continue, and the error does not prevent
622 generation of formatted output, but typically, preparing that
623 output involves information loss, broken document structure
624 or unintended formatting.
626 An input file uses obsolete, discouraged or non-portable syntax.
627 All the same, the meaning of the input is unambiguous and a correct
628 rendering can be produced.
629 Documents causing warnings may render poorly when using other
630 formatting tools instead of
638 levels are hidden unless their level, or a lower level, is requested using a
643 .Ss Warnings related to the document prologue
645 .It Sy "missing manual title, using UNTITLED"
649 macro has no arguments, or there is no
651 macro before the first non-prologue macro.
652 .It Sy "missing manual title, using \(dq\(dq"
656 macro, or it has no arguments.
657 .It Sy "lower case character in document title"
659 The title is still used as given in the
664 .It Sy "missing manual section, using \(dq\(dq"
670 macro lacks the mandatory section argument.
671 .It Sy "unknown manual section"
673 The section number in a
675 line is invalid, but still used.
676 .It Sy "unknown manual volume or arch"
680 line is invalid, but still used.
681 The manual is assumed to be architecture-independent.
682 .It Sy "missing date, using today's date"
684 The document was parsed as
690 macro has no arguments or only empty arguments;
691 or the document was parsed as
697 macro has less than three arguments or its third argument is empty.
698 .It Sy "cannot parse date, using it verbatim"
704 macro does not follow the conventional format.
705 .It Sy "missing Os macro, using \(dq\(dq"
707 The default or current system is not shown in this case.
708 .It Sy "duplicate prologue macro"
710 One of the prologue macros occurs more than once.
711 The last instance overrides all previous ones.
712 .It Sy "late prologue macro"
718 macro occurs after some non-prologue macro, but still takes effect.
719 .It Sy "skipping late title macro"
723 macro can only occur before the first non-prologue macro
724 because traditional formatters write the page header
725 before parsing the document body.
726 Even though this technical restriction does not apply to
728 traditional semantics is preserved.
729 The late macro is discarded including its arguments.
730 .It Sy "prologue macros out of order"
732 The prologue macros are not given in the conventional order
736 All three macros are used even when given in another order.
738 .Ss Warnings regarding document structure
740 .It Sy ".so is fragile, better use ln(1)"
742 Including files only works when the parser program runs with the correct
743 current working directory.
744 .It Sy "no document body"
746 The document body contains neither text nor macros.
747 An empty document is shown, consisting only of a header and a footer line.
748 .It Sy "content before first section header"
750 Some macros or text precede the first
755 The offending macros and text are parsed and added to the top level
756 of the syntax tree, outside any section block.
757 .It Sy "first section is not NAME"
759 The argument of the first
767 .It Sy "bad NAME section contents"
769 The last node in the NAME section is not an
771 macro, or any preceding macro is not
773 or the NAME section is completely empty.
778 .It Sy "sections out of conventional order"
780 A standard section occurs after another section it usually precedes.
781 All section titles are used as given,
782 and the order of sections is not changed.
783 .It Sy "duplicate section title"
785 The same standard section title occurs more than once.
786 .It Sy "unexpected section"
788 A standard section header occurs in a section of the manual
789 where it normally isn't useful.
790 .It Sy "unusual Xr order"
792 In the SEE ALSO section, an
794 macro with a lower section number follows one with a higher number,
797 macros refering to the same section are out of alphabetical order.
798 .It Sy "unusual Xr punctuation"
800 In the SEE ALSO section, punctuation between two
802 macros differs from a single comma, or there is trailing punctuation
806 .It Sy "AUTHORS section without An macro"
808 An AUTHORS sections contains no
810 macros, or only empty ones.
811 Probably, there are author names lacking markup.
813 .Ss "Warnings related to macros and nesting"
815 .It Sy "obsolete macro"
819 manual for replacements.
820 .It Sy "skipping paragraph macro"
823 documents, this happens
826 at the beginning and end of sections and subsections
828 right before non-compact lists and displays
830 at the end of items in non-column, non-compact lists
832 and for multiple consecutive paragraph macros.
836 documents, it happens
848 macros having neither head nor body arguments
859 .It Sy "moving paragraph macro out of list"
863 list contains a trailing paragraph macro.
864 The paragraph macro is moved after the end of the list.
865 .It Sy "skipping no-space macro"
867 An input line begins with an
870 The macro is ignored.
871 .It Sy "blocks badly nested"
873 If two blocks intersect, one should completely contain the other.
874 Otherwise, rendered output is likely to look strange in any output
875 format, and rendering in SGML-based output formats is likely to be
876 outright wrong because such languages do not support badly nested
878 Typical examples of badly nested blocks are
879 .Qq Ic \&Ao \&Bo \&Ac \&Bc
881 .Qq Ic \&Ao \&Bq \&Ac .
889 .It Sy "nested displays are not portable"
896 display occurs nested inside another
901 but fails with most other implementations.
902 .It Sy "moving content out of list"
906 list block contains text or macros before the first
909 The offending children are moved before the beginning of the list.
910 .It Sy ".Vt block has child macro"
914 macro supports plain text arguments only.
915 Formatting may be ugly and semantic searching
916 for the affected content might not work.
917 .It Sy "fill mode already enabled, skipping"
921 request occurs even though the document is still in fill mode,
922 or already switched back to fill mode.
924 .It Sy "fill mode already disabled, skipping"
928 request occurs even though the document already switched to no-fill mode
929 and did not switch back to fill mode yet.
931 .It Sy "line scope broken"
933 While parsing the next-line scope of the previous macro,
934 another macro is found that prematurely terminates the previous one.
935 The previous, interrupted macro is deleted from the parse tree.
937 .Ss "Warnings related to missing arguments"
939 .It Sy "skipping empty request"
941 The macro name is missing from a macro definition request,
944 control statement or operation keyword lacks its required argument.
945 .It Sy "conditional request controls empty scope"
947 A conditional request is only useful if any of the following
948 follows it on the same logical input line:
953 keyword to open a multi-line scope.
955 A request or macro or some text, resulting in a single-line scope.
957 The immediate end of the logical line without any intervening whitespace,
958 resulting in next-line scope.
960 Here, a conditional request is followed by trailing whitespace only,
961 and there is no other content on its logical input line.
962 Note that it doesn't matter whether the logical input line is split
963 across multiple physical input lines using
965 line continuation characters.
966 This is one of the rare cases
967 where trailing whitespace is syntactically significant.
968 The conditional request controls a scope containing whitespace only,
969 so it is unlikely to have a significant effect,
970 except that it may control a following
973 .It Sy "skipping empty macro"
975 The indicated macro has no arguments and hence no effect.
976 .It Sy "empty argument, using 0n"
978 The required width is missing after
985 .It Sy "argument count wrong"
987 The indicated macro has too few or too many arguments.
988 The syntax tree will contain the wrong number of arguments as given.
989 Formatting behaviour depends on the specific macro in question.
990 Note that the same message may also occur as an ERROR, see below.
991 .It Sy "missing display type, using -ragged"
995 macro is invoked without the required display type.
996 .It Sy "list type is not the first argument"
1000 macro, at least one other argument precedes the type argument.
1003 utility copes with any argument order, but some other
1005 implementations do not.
1006 .It Sy "missing -width in -tag list, using 8n"
1015 .It Sy "missing utility name, using \(dq\(dq"
1019 macro is called without an argument before
1021 has first been called with an argument.
1022 .It Sy "empty head in list item"
1034 macro lacks the required argument.
1035 The item head is left empty.
1036 .It Sy "empty list item"
1048 An empty list item is shown.
1049 .It Sy "missing font type"
1053 macro has no argument.
1054 It switches to the default font,
1056 .It Sy "unknown font type"
1060 argument is invalid.
1064 .It Sy "missing -std argument, adding it"
1070 macro lacks the required
1077 even when it is not specified, but other implementations may not.
1078 .It Sy "missing eqn box, using \(dq\(dq"
1080 A diacritic mark or a binary operator is found,
1081 but there is nothing to the left of it.
1082 An empty box is inserted.
1084 .Ss "Warnings related to bad macro arguments"
1086 .It Sy "unterminated quoted argument"
1088 Macro arguments can be enclosed in double quote characters
1089 such that space characters and macro names contained in the quoted
1090 argument need not be escaped.
1091 The closing quote of the last argument of a macro can be omitted.
1092 However, omitting it is not recommended because it makes the code
1094 .It Sy "duplicate argument"
1100 macro has more than one
1107 All but the last instances of these arguments are ignored.
1108 .It Sy "skipping duplicate argument"
1112 macro has more than one
1117 All but the first of these arguments are ignored.
1118 .It Sy "skipping duplicate display type"
1122 macro has more than one type argument; the first one is used.
1123 .It Sy "skipping duplicate list type"
1127 macro has more than one type argument; the first one is used.
1128 .It Sy "skipping -width argument"
1142 .It Sy "unknown AT&T UNIX version"
1146 macro has an invalid argument.
1147 It is used verbatim, with
1150 .It Sy "comma in function argument"
1156 macro contains a comma; it should probably be split into two arguments.
1157 .It Sy "parenthesis in function name"
1159 The first argument of an
1163 macro contains an opening or closing parenthesis; that's probably wrong,
1164 parentheses are added automatically.
1165 .It Sy "invalid content in Rs block"
1169 block contains plain text or non-% macros.
1170 The bogus content is left in the syntax tree.
1171 Formatting may be poor.
1172 .It Sy "invalid Boolean argument"
1176 macro has an argument other than
1180 The invalid argument is moved out of the macro, which leaves the macro
1181 empty, causing it to toggle the spacing mode.
1182 .It Sy "unknown font, skipping request"
1190 layout modifier has an unknown
1194 .Ss "Warnings related to plain text"
1196 .It Sy "blank line in fill mode, using .sp"
1198 The meaning of blank input lines is only well-defined in non-fill mode:
1199 In fill mode, line breaks of text input lines are not supposed to be
1201 However, for compatibility with groff, blank lines in fill mode
1205 .It Sy "tab in filled text"
1207 The meaning of tab characters is only well-defined in non-fill mode:
1208 In fill mode, whitespace is not supposed to be significant
1209 on text input lines.
1210 As an implementation dependent choice, tab characters on text lines
1211 are passed through to the formatters in any case.
1212 Given that the text before the tab character will be filled,
1213 it is hard to predict which tab stop position the tab will advance to.
1214 .It Sy "whitespace at end of input line"
1215 .Pq mdoc , man , roff
1216 Whitespace at the end of input lines is almost never semantically
1217 significant \(em but in the odd case where it might be, it is
1218 extremely confusing when reviewing and maintaining documents.
1219 .It Sy "bad comment style"
1221 Comment lines start with a dot, a backslash, and a double-quote character.
1224 utility treats the line as a comment line even without the backslash,
1225 but leaving out the backslash might not be portable.
1226 .It Sy "invalid escape sequence"
1228 An escape sequence has an invalid opening argument delimiter, lacks the
1229 closing argument delimiter, or the argument has too few characters.
1230 If the argument is incomplete,
1234 expand to an empty string,
1240 to the length of the incomplete argument.
1241 All other invalid escape sequences are ignored.
1242 .It Sy "undefined string, using \(dq\(dq"
1244 If a string is used without being defined before,
1245 its value is implicitly set to the empty string.
1246 However, defining strings explicitly before use
1247 keeps the code more readable.
1249 .Ss "Errors related to equations"
1251 .It "unexpected equation scope closure"
1252 .It "equation scope open on exit"
1253 .It "overlapping equation scopes"
1254 .It "unexpected end of equation"
1256 .Ss "Errors related to tables"
1258 .It "bad table syntax"
1259 .It "bad table option"
1260 .It "bad table layout"
1261 .It "no table layout cells specified"
1262 .It "no table data cells specified"
1263 .It "ignore data in cell"
1264 .It "data block still open"
1265 .It "ignoring extra data cells"
1267 .Ss "Errors related to roff, mdoc, and man code"
1269 .It Sy "input stack limit exceeded, infinite loop?"
1271 Explicit recursion limits are implemented for the following features,
1272 in order to prevent infinite loops:
1275 expansion of nested escape sequences
1276 including expansion of strings and number registers,
1278 expansion of nested user-defined macros,
1284 When a limit is hit, the output is incorrect, typically losing
1285 some content, but the parser can continue.
1286 .It Sy "skipping bad character"
1287 .Pq mdoc , man , roff
1288 The input file contains a byte that is not a printable
1291 The message mentions the character number.
1292 The offending byte is replaced with a question mark
1294 Consider editing the input file to replace the byte with an ASCII
1295 transliteration of the intended character.
1296 .It Sy "skipping unknown macro"
1297 .Pq mdoc , man , roff
1298 The first identifier on a request or macro line is neither recognized as a
1300 request, nor as a user-defined macro, nor, respectively, as an
1305 It may be mistyped or unsupported.
1306 The request or macro is discarded including its arguments.
1307 .It Sy "skipping item outside list"
1311 macro occurs outside any
1316 delimiter occurs outside any pile.
1317 It is discarded including its arguments.
1318 .It Sy "skipping column outside column list"
1322 macro occurs outside any
1325 It is discarded including its arguments.
1326 .It Sy "skipping end of block that is not open"
1327 .Pq mdoc , man , eqn , tbl , roff
1328 Various syntax elements can only be used to explicitly close blocks
1329 that have previously been opened.
1332 block closing macro, a
1339 right delimiter or closing brace, or the end of an equation, table, or
1341 conditional request is encountered but no matching block is open.
1342 The offending request or macro is discarded.
1343 .It Sy "inserting missing end of block"
1347 macros as well as tables require explicit closing by dedicated macros.
1348 A block that doesn't support bad nesting
1349 ends before all of its children are properly closed.
1350 The open child nodes are closed implicitly.
1351 .It Sy "scope open on exit"
1352 .Pq mdoc , man , eqn , tbl , roff
1353 At the end of the document, an explicit
1361 block, an equation, table, or
1363 conditional or ignore block is still open.
1364 The open block is closed implicitly.
1365 .It Sy "escaped character not allowed in a name"
1367 Macro, string and register identifiers consist of printable,
1368 non-whitespace ASCII characters.
1369 Escape sequences and characters and strings expressed in terms of them
1370 cannot form part of a name.
1371 The first argument of an
1379 request, or any argument of an
1381 request, or the name of a request or user defined macro being called,
1382 is terminated by an escape sequence.
1388 the request has no effect at all.
1395 what was parsed up to this point is used as the arguments to the request,
1396 and the rest of the input line is discarded including the escape sequence.
1397 When parsing for a request or a user-defined macro name to be called,
1398 only the escape sequence is discarded.
1399 The characters preceding it are used as the request or macro name,
1400 the characters following it are used as the arguments to the request or macro.
1401 .It Sy "argument count wrong"
1402 .Pq mdoc , man , roff
1403 The indicated request or macro has too few or too many arguments.
1404 The syntax tree will contain the wrong number of arguments as given.
1405 Formatting behaviour depends on the specific request or macro in question.
1406 Note that the same message may also occur as a WARNING, see above.
1407 .It Sy "missing list type, using -item"
1411 macro fails to specify the list type.
1412 .It Sy "missing manual name, using \(dq\(dq"
1416 lacks the required argument.
1417 .It Sy "uname(3) system call failed, using UNKNOWN"
1421 macro is called without arguments, and the
1426 can be compiled with
1428 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1430 .It Sy "unknown standard specifier"
1434 macro has an unknown argument and is discarded.
1435 .It Sy "skipping request without numeric argument"
1444 statement has a non-numeric or negative argument or no argument at all.
1445 The invalid request or statement is ignored.
1446 .It Sy "skipping all arguments"
1447 .Pq mdoc , man , eqn , roff
1460 macro in a list that don't support item heads, a
1474 block closing request is invoked with at least one argument.
1475 All arguments are ignored.
1476 .It Sy "skipping excess arguments"
1480 macro is invoked with more than one argument, or a request of the
1482 family is invoked with more than two arguments.
1483 The excess arguments are ignored.
1487 .It Sy "input too large"
1491 cannot handle input files larger than its arbitrary size limit
1492 of 2^31 bytes (2 Gigabytes).
1493 Since useful manuals are always small, this is not a problem in practice.
1494 Parsing is aborted as soon as the condition is detected.
1495 .It Sy "NOT IMPLEMENTED: Bd -file"
1497 For security reasons, the
1499 macro does not support the
1502 By requesting the inclusion of a sensitive file, a malicious document
1503 might otherwise trick a privileged user into inadvertently displaying
1504 the file on the screen, revealing the file content to bystanders.
1505 The parser exits immediately.
1506 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1508 For security reasons,
1512 file inclusion requests only with relative paths
1513 and only without ascending to any parent directory.
1514 By requesting the inclusion of a sensitive file, a malicious document
1515 might otherwise trick a privileged user into inadvertently displaying
1516 the file on the screen, revealing the file content to bystanders.
1517 The parser exits immediately.
1518 .It Sy ".so request failed"
1522 request requires reading an external file.
1523 While trying to do so, an
1529 The parser exits immediately.
1530 Before showing this message,
1532 always shows another message explaining why the system call failed.
1535 This section summarises
1537 compatibility with GNU troff.
1538 Each input and output format is separately noted.
1539 .Ss ASCII Compatibility
1540 .Bl -bullet -compact
1542 Unrenderable unicode codepoints specified with
1544 escapes are printed as
1547 In GNU troff, these raise an error.
1557 are synonyms, as are \-filled and \-ragged.
1559 In historic GNU troff, the
1562 macro does not underline when scoped under an
1564 in the FILES section.
1565 This behaves correctly in
1568 A list or display following the
1573 does not assert a prior vertical break, just as it doesn't with
1583 Words aren't hyphenated.
1585 .Ss HTML Compatibility
1586 .Bl -bullet -compact
1590 escape will revert the font to the previous
1592 escape, not to the last rendered decoration, which is now dictated by
1593 CSS instead of hard-coded.
1594 It also will not span past the current scope,
1595 for the same reason.
1598 mode, this will work fine.
1605 list types render similarly (no break following overreached left-hand
1606 side) due to the expressive constraints of HTML.
1613 lists render similarly.
1625 utility was written by
1626 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1632 the maximum size of an element attribute is determined by
1634 which is usually 1024 bytes.
1635 Be aware of this when setting long link
1637 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1639 Nesting elements within next-line element scopes of
1649 and cause them to forget the formatting of the prior next-line scope.
1653 control character is an alias for the standard macro control character
1654 and does not emit a line-break as stipulated in GNU troff.
git.ckatri.com / mandoc.git / blob