1 .\" $Id: mandoc.1,v 1.112 2014/09/12 00:10:26 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: September 12 2014 $
23 .Nd format and display UNIX manuals
28 .Op Fl I Cm os Li = Ar name
40 manual pages for display.
48 text from stdin, implying
54 The options are as follows:
57 If the standard output is a terminal device and
61 to paginate the output, just like
65 Copy the formatted manual pages to the standard output without using
69 It can be specified to override
74 This overrides any earlier
80 .It Fl I Cm os Li = Ar name
82 Override the default operating system
89 Display only the SYNOPSIS lines.
95 This overrides any earlier
103 Also reverts any earlier
108 .It Fl m Ns Ar format
112 for available formats.
115 .It Fl O Ns Ar option
116 Comma-separated output options.
117 .It Fl T Ns Ar output
121 for available formats.
125 Print version and exit.
127 Specify the minimum message
129 to be reported on the standard error output and to affect the exit status.
141 .Fl W Ns Cm warning .
152 to exit after parsing a file that causes warnings or errors of at least
154 No formatted output will be produced from that file.
159 are requested, they can be joined with a comma, for example
160 .Fl W Ns Cm error , Ns Cm stop .
162 Read input from zero or more files.
163 If unspecified, reads from stdin.
164 If multiple files are specified,
166 will halt with the first failed parse.
175 also supports the options
198 should only be used for legacy manuals.
202 which is also the default, determines encoding on-the-fly: if the first
209 parser is used; otherwise, the
214 files are specified with
216 each has its file-type determined this way.
217 If multiple files are
222 is specified, then this format is used exclusively.
226 utility accepts the following
228 arguments, which correspond to output modes:
229 .Bl -tag -width "-Tlocale"
231 Produce 7-bit ASCII output.
236 Produce strict CSS1/HTML-4.01 output.
240 Parse only: produce no output.
242 .Fl W Ns Cm warning .
243 .It Fl T Ns Cm locale
244 Encode output using the current locale.
258 Produce PostScript output.
260 .Sx PostScript Output .
262 Produce an indented parse tree.
264 Encode output in the UTF\-8 multi-byte format.
268 Produce strict CSS1/XHTML-1.0 output.
273 If multiple input files are specified, these will be processed by the
274 corresponding filter in-order.
278 which is the default, is rendered in standard 7-bit ASCII documented in
281 Font styles are applied by using back-spaced encoding such that an
285 .Sq _ Ns \e[bs] Ns c ,
288 is the back-space character number 8.
289 Emboldened characters are rendered as
290 .Sq c Ns \e[bs] Ns c .
292 The special characters documented in
294 are rendered best-effort in an ASCII equivalent.
295 If no equivalent is found,
299 Output width is limited to 78 visible columns unless literal input lines
304 arguments are accepted:
306 .It Cm indent Ns = Ns Ar indent
307 The left margin for normal text is set to
309 blank characters instead of the default of five for
313 Increasing this is not recommended; it may result in degraded formatting,
314 for example overfull lines or ugly line breaks.
315 .It Cm width Ns = Ns Ar width
316 The output width is set to
318 which will normalise to \(>=60.
323 conforms to HTML-4.01 strict.
326 .Pa example.style.css
327 file documents style-sheet classes available for customising output.
328 If a style-sheet is not specified with
331 defaults to simple output readable in any graphical or text-based web
334 Special characters are rendered in decimal-encoded UTF\-8.
338 arguments are accepted:
348 elements and only emit the subtree below the
353 argument will be ignored.
354 This is useful when embedding manual content within existing documents.
355 .It Cm includes Ns = Ns Ar fmt
360 is used as a template for linked header files (usually via the
365 are replaced with the include filename.
366 The default is not to present a
368 .It Cm man Ns = Ns Ar fmt
372 .Ar ../html%S/%N.%S.html ,
373 is used as a template for linked manuals (usually via the
380 are replaced with the linked manual's name and section, respectively.
381 If no section is included, section 1 is assumed.
382 The default is not to
384 .It Cm style Ns = Ns Ar style.css
387 is used for an external style-sheet.
388 This must be a valid absolute or
392 Locale-depending output encoding is triggered with
394 This option is not available on all systems: systems without locale
395 support, or those whose internal representation is not natively UCS-4,
400 for font style specification and available command-line arguments.
402 Translate input format into
405 This is useful for distributing manual sources to legacy systems
412 is passed as input, it is translated into
414 If the input format is
416 the input is copied to the output, expanding any
420 The parser is also run, and as usual, the
424 are displayed before copying the input to the output.
426 PDF-1.1 output may be generated by
429 .Sx PostScript Output
432 arguments and defaults.
433 .Ss PostScript Output
436 Level-2 pages may be generated by
438 Output pages default to letter sized and are rendered in the Times font
440 Margins are calculated as 1/9 the page length and width.
443 Special characters are rendered as in
448 arguments are accepted:
450 .It Cm paper Ns = Ns Ar name
460 You may also manually specify dimensions as
462 width by height in millimetres.
463 If an unknown value is encountered,
470 to force a UTF\-8 locale.
473 for details and options.
477 conforms to XHTML-1.0 strict.
481 for details; beyond generating XHTML tags instead of HTML tags, these
482 output modes are identical.
484 .Bl -tag -width MANPAGER
486 Any non-empty value of the environment variable
488 will be used instead of the standard pagination program,
491 Specifies the pagination program to use when
494 If neither PAGER nor MANPAGER is defined,
495 .Pa /usr/bin/more Fl s
501 utility exits with one of the following values, controlled by the message
507 .Bl -tag -width Ds -compact
509 No warnings or errors occurred, or those that did were ignored because
510 they were lower than the requested
513 At least one warning occurred, but no error, and
517 At least one parsing error occurred, but no fatal error, and
523 A fatal parsing error occurred.
525 Invalid command line arguments were specified.
526 No input files have been read.
528 An operating system error occurred, for example memory exhaustion or an
529 error accessing input files.
532 to exit at once, possibly in the middle of parsing or formatting a file.
538 .Fl W Ns Cm warning .
540 To page manuals to the terminal:
542 .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
543 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
545 To produce HTML manuals with
549 .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
551 To check over a large set of manuals:
553 .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
555 To produce a series of PostScript manuals for A4 paper:
557 .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
563 format, for use on systems lacking an
567 .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
569 Messages displayed by
573 .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
575 Line and column numbers start at 1.
576 Both are omitted for messages referring to an input file as a whole.
577 Macro names and arguments are omitted where meaningless.
578 Fatal messages about invalid command line arguments
579 or operating system errors, for example when memory is exhausted,
586 Message levels have the following meanings:
587 .Bl -tag -width "warning"
589 Opening or reading an input file failed, so the parser cannot
590 even be started and no output is produced from that input file.
592 The parser is unable to parse a given input file at all.
593 No formatted output is produced from that input file.
595 An input file contains syntax that cannot be safely interpreted,
596 either because it is invalid or because
598 does not implement it yet.
599 By discarding part of the input or inserting missing tokens,
600 the parser is able to continue, and the error does not prevent
601 generation of formatted output, but typically, preparing that
602 output involves information loss, broken document structure
603 or unintended formatting.
605 An input file uses obsolete, discouraged or non-portable syntax.
606 All the same, the meaning of the input is unambiguous and a correct
607 rendering can be produced.
608 Documents causing warnings may render poorly when using other
609 formatting tools instead of
617 levels are hidden unless their level, or a lower level, is requested using a
622 .Ss Warnings related to the document prologue
624 .It Sy "missing manual title, using UNTITLED"
628 macro has no arguments, or there is no
630 macro before the first non-prologue macro.
631 .It Sy "missing manual title, using \(dq\(dq"
635 macro, or it has no arguments.
636 .It Sy "lower case character in document title"
638 The title is still used as given in the
643 .It Sy "missing manual section, using \(dq\(dq"
649 macro lacks the mandatory section argument.
650 .It Sy "unknown manual section"
652 The section number in a
654 line is invalid, but still used.
655 .It Sy "unknown manual volume or arch"
659 line is invalid, but still used.
660 The manual is assumed to be architecture-independent.
661 .It Sy "missing date, using today's date"
663 The document was parsed as
669 macro has no arguments or only empty arguments;
670 or the document was parsed as
676 macro has less than three arguments or its third argument is empty.
677 .It Sy "cannot parse date, using it verbatim"
683 macro does not follow the conventional format.
684 .It Sy "missing Os macro, using \(dq\(dq"
686 The default or current system is not shown in this case.
687 .It Sy "duplicate prologue macro"
689 One of the prologue macros occurs more than once.
690 The last instance overrides all previous ones.
691 .It Sy "late prologue macro"
697 macro occurs after some non-prologue macro, but still takes effect.
698 .It Sy "skipping late title macro"
702 macro can only occur before the first non-prologue macro
703 because traditional formatters write the page header
704 before parsing the document body.
705 Even though this technical restriction does not apply to
707 traditional semantics is preserved.
708 The late macro is discarded including its arguments.
709 .It Sy "prologue macros out of order"
711 The prologue macros are not given in the conventional order
715 All three macros are used even when given in another order.
717 .Ss Warnings regarding document structure
719 .It Sy ".so is fragile, better use ln(1)"
721 Including files only works when the parser program runs with the correct
722 current working directory.
723 .It Sy "no document body"
725 The document body contains neither text nor macros.
726 An empty document is shown, consisting only of a header and a footer line.
727 .It Sy "content before first section header"
729 Some macros or text precede the first
734 The offending macros and text are parsed and added to the top level
735 of the syntax tree, outside any section block.
736 .It Sy "first section is not NAME"
738 The argument of the first
746 .It Sy "bad NAME section contents"
748 The last node in the NAME section is not an
750 macro, or any preceding macro is not
752 or the NAME section is completely empty.
757 .It Sy "sections out of conventional order"
759 A standard section occurs after another section it usually precedes.
760 All section titles are used as given,
761 and the order of sections is not changed.
762 .It Sy "duplicate section title"
764 The same standard section title occurs more than once.
765 .It Sy "unexpected section"
767 A standard section header occurs in a section of the manual
768 where it normally isn't useful.
769 .It Sy "unusual Xr order"
771 In the SEE ALSO section, an
773 macro with a lower section number follows one with a higher number,
776 macros refering to the same section are out of alphabetical order.
777 .It Sy "unusual Xr punctuation"
779 In the SEE ALSO section, punctuation between two
781 macros differs from a single comma, or there is trailing punctuation
785 .It Sy "AUTHORS section without An macro"
787 An AUTHORS sections contains no
789 macros, or only empty ones.
790 Probably, there are author names lacking markup.
792 .Ss "Warnings related to macros and nesting"
794 .It Sy "obsolete macro"
798 manual for replacements.
799 .It Sy "skipping paragraph macro"
802 documents, this happens
805 at the beginning and end of sections and subsections
807 right before non-compact lists and displays
809 at the end of items in non-column, non-compact lists
811 and for multiple consecutive paragraph macros.
815 documents, it happens
827 macros having neither head nor body arguments
838 .It Sy "moving paragraph macro out of list"
842 list contains a trailing paragraph macro.
843 The paragraph macro is moved after the end of the list.
844 .It Sy "skipping no-space macro"
846 An input line begins with an
849 The macro is ignored.
850 .It Sy "blocks badly nested"
852 If two blocks intersect, one should completely contain the other.
853 Otherwise, rendered output is likely to look strange in any output
854 format, and rendering in SGML-based output formats is likely to be
855 outright wrong because such languages do not support badly nested
857 Typical examples of badly nested blocks are
858 .Qq Ic \&Ao \&Bo \&Ac \&Bc
860 .Qq Ic \&Ao \&Bq \&Ac .
868 .It Sy "nested displays are not portable"
875 display occurs nested inside another
880 but fails with most other implementations.
881 .It Sy "moving content out of list"
885 list block contains text or macros before the first
888 The offending children are moved before the beginning of the list.
889 .It Sy ".Vt block has child macro"
893 macro supports plain text arguments only.
894 Formatting may be ugly and semantic searching
895 for the affected content might not work.
896 .It Sy "fill mode already enabled, skipping"
900 request occurs even though the document is still in fill mode,
901 or already switched back to fill mode.
903 .It Sy "fill mode already disabled, skipping"
907 request occurs even though the document already switched to no-fill mode
908 and did not switch back to fill mode yet.
910 .It Sy "line scope broken"
912 While parsing the next-line scope of the previous macro,
913 another macro is found that prematurely terminates the previous one.
914 The previous, interrupted macro is deleted from the parse tree.
916 .Ss "Warnings related to missing arguments"
918 .It Sy "skipping empty request"
920 The macro name is missing from a macro definition request.
921 .It Sy "conditional request controls empty scope"
923 A conditional request is only useful if any of the following
924 follows it on the same logical input line:
929 keyword to open a multi-line scope.
931 A request or macro or some text, resulting in a single-line scope.
933 The immediate end of the logical line without any intervening whitespace,
934 resulting in next-line scope.
936 Here, a conditional request is followed by trailing whitespace only,
937 and there is no other content on its logical input line.
938 Note that it doesn't matter whether the logical input line is split
939 across multiple physical input lines using
941 line continuation characters.
942 This is one of the rare cases
943 where trailing whitespace is syntactically significant.
944 The conditional request controls a scope containing whitespace only,
945 so it is unlikely to have a significant effect,
946 except that it may control a following
949 .It Sy "skipping empty macro"
951 The indicated macro has no arguments and hence no effect.
952 .It Sy "empty argument, using 0n"
954 The required width is missing after
961 .It Sy "argument count wrong"
963 The indicated macro has too few or too many arguments.
964 The syntax tree will contain the wrong number of arguments as given.
965 Formatting behaviour depends on the specific macro in question.
966 Note that the same message may also occur as an ERROR, see below.
967 .It Sy "missing display type, using -ragged"
971 macro is invoked without the required display type.
972 .It Sy "list type is not the first argument"
976 macro, at least one other argument precedes the type argument.
979 utility copes with any argument order, but some other
981 implementations do not.
982 .It Sy "missing -width in -tag list, using 8n"
991 .It Sy "missing utility name, using \(dq\(dq"
995 macro is called without an argument before
997 has first been called with an argument.
998 .It Sy "empty head in list item"
1010 macro lacks the required argument.
1011 The item head is left empty.
1012 .It Sy "empty list item"
1024 An empty list item is shown.
1025 .It Sy "missing font type"
1029 macro has no argument.
1030 It switches to the default font,
1032 .It Sy "unknown font type"
1036 argument is invalid.
1040 .It Sy "missing -std argument, adding it"
1046 macro lacks the required
1053 even when it is not specified, but other implementations may not.
1055 .Ss "Warnings related to bad macro arguments"
1057 .It Sy "unterminated quoted argument"
1059 Macro arguments can be enclosed in double quote characters
1060 such that space characters and macro names contained in the quoted
1061 argument need not be escaped.
1062 The closing quote of the last argument of a macro can be omitted.
1063 However, omitting it is not recommended because it makes the code
1065 .It Sy "duplicate argument"
1071 macro has more than one
1078 All but the last instances of these arguments are ignored.
1079 .It Sy "skipping duplicate argument"
1083 macro has more than one
1088 All but the first of these arguments are ignored.
1089 .It Sy "skipping duplicate display type"
1093 macro has more than one type argument; the first one is used.
1094 .It Sy "skipping duplicate list type"
1098 macro has more than one type argument; the first one is used.
1099 .It Sy "skipping -width argument"
1113 .It Sy "unknown AT&T UNIX version"
1117 macro has an invalid argument.
1118 It is used verbatim, with
1121 .It Sy "invalid content in Rs block"
1125 block contains plain text or non-% macros.
1126 The bogus content is left in the syntax tree.
1127 Formatting may be poor.
1128 .It Sy "invalid Boolean argument"
1132 macro has an argument other than
1136 The invalid argument is moved out of the macro, which leaves the macro
1137 empty, causing it to toggle the spacing mode.
1138 .It Sy "unknown font, skipping request"
1143 request has an invalid argument.
1145 .Ss "Warnings related to plain text"
1147 .It Sy "blank line in fill mode, using .sp"
1149 The meaning of blank input lines is only well-defined in non-fill mode:
1150 In fill mode, line breaks of text input lines are not supposed to be
1152 However, for compatibility with groff, blank lines in fill mode
1156 .It Sy "tab in filled text"
1158 The meaning of tab characters is only well-defined in non-fill mode:
1159 In fill mode, whitespace is not supposed to be significant
1160 on text input lines.
1161 As an implementation dependent choice, tab characters on text lines
1162 are passed through to the formatters in any case.
1163 Given that the text before the tab character will be filled,
1164 it is hard to predict which tab stop position the tab will advance to.
1165 .It Sy "whitespace at end of input line"
1166 .Pq mdoc , man , roff
1167 Whitespace at the end of input lines is almost never semantically
1168 significant \(em but in the odd case where it might be, it is
1169 extremely confusing when reviewing and maintaining documents.
1170 .It Sy "bad comment style"
1172 Comment lines start with a dot, a backslash, and a double-quote character.
1175 utility treats the line as a comment line even without the backslash,
1176 but leaving out the backslash might not be portable.
1177 .It Sy "invalid escape sequence"
1179 An escape sequence has an invalid opening argument delimiter, lacks the
1180 closing argument delimiter, or the argument has too few characters.
1181 If the argument is incomplete,
1185 expand to an empty string,
1191 to the length of the incomplete argument.
1192 All other invalid escape sequences are ignored.
1193 .It Sy "undefined string, using \(dq\(dq"
1195 If a string is used without being defined before,
1196 its value is implicitly set to the empty string.
1197 However, defining strings explicitly before use
1198 keeps the code more readable.
1200 .Ss "Errors related to equations"
1202 .It "unexpected equation scope closure"
1203 .It "equation scope open on exit"
1204 .It "overlapping equation scopes"
1205 .It "unexpected end of equation"
1206 .It "equation syntax error"
1208 .Ss "Errors related to tables"
1210 .It "bad table syntax"
1211 .It "bad table option"
1212 .It "bad table layout"
1213 .It "no table layout cells specified"
1214 .It "no table data cells specified"
1215 .It "ignore data in cell"
1216 .It "data block still open"
1217 .It "ignoring extra data cells"
1219 .Ss "Errors related to roff, mdoc, and man code"
1221 .It Sy "input stack limit exceeded, infinite loop?"
1223 Explicit recursion limits are implemented for the following features,
1224 in order to prevent infinite loops:
1227 expansion of nested escape sequences
1228 including expansion of strings and number registers,
1230 expansion of nested user-defined macros,
1236 When a limit is hit, the output is incorrect, typically losing
1237 some content, but the parser can continue.
1238 .It Sy "skipping bad character"
1239 .Pq mdoc , man , roff
1240 The input file contains a byte that is not a printable
1243 The message mentions the character number.
1244 The offending byte is replaced with a question mark
1246 Consider editing the input file to replace the byte with an ASCII
1247 transliteration of the intended character.
1248 .It Sy "skipping unknown macro"
1249 .Pq mdoc , man , roff
1250 The first identifier on a request or macro line is neither recognized as a
1252 request, nor as a user-defined macro, nor, respectively, as an
1257 It may be mistyped or unsupported.
1258 The request or macro is discarded including its arguments.
1259 .It Sy "skipping item outside list"
1263 macro occurs outside any
1266 It is discarded including its arguments.
1267 .It Sy "skipping column outside column list"
1271 macro occurs outside any
1274 It is discarded including its arguments.
1275 .It Sy "skipping end of block that is not open"
1276 .Pq mdoc , man , eqn , tbl , roff
1277 Various syntax elements can only be used to explicitly close blocks
1278 that have previously been opened.
1281 block closing macro, a
1286 macro, or the end of an equation, table, or
1288 conditional request is encountered but no matching block is open.
1289 The offending request or macro is discarded.
1290 .It Sy "inserting missing end of block"
1294 macros as well as tables require explicit closing by dedicated macros.
1295 A block that doesn't support bad nesting
1296 ends before all of its children are properly closed.
1297 The open child nodes are closed implicitly.
1298 .It Sy "scope open on exit"
1299 .Pq mdoc , man , eqn , tbl , roff
1300 At the end of the document, an explicit
1308 block, an equation, table, or
1310 conditional or ignore block is still open.
1311 The open block is closed implicitly.
1312 .It Sy "escaped character not allowed in a name"
1314 Macro, string and register identifiers consist of printable,
1315 non-whitespace ASCII characters.
1316 Escape sequences and characters and strings expressed in terms of them
1317 cannot form part of a name.
1318 The first argument of an
1326 request, or any argument of an
1328 request, or the name of a request or user defined macro being called,
1329 is terminated by an escape sequence.
1335 the request has no effect at all.
1342 what was parsed up to this point is used as the arguments to the request,
1343 and the rest of the input line is discarded including the escape sequence.
1344 When parsing for a request or a user-defined macro name to be called,
1345 only the escape sequence is discarded.
1346 The characters preceding it are used as the request or macro name,
1347 the characters following it are used as the arguments to the request or macro.
1348 .It Sy "argument count wrong"
1349 .Pq mdoc , man , roff
1350 The indicated request or macro has too few or too many arguments.
1351 The syntax tree will contain the wrong number of arguments as given.
1352 Formatting behaviour depends on the specific request or macro in question.
1353 Note that the same message may also occur as a WARNING, see above.
1354 .It Sy "missing list type, using -item"
1358 macro fails to specify the list type.
1359 .It Sy "missing manual name, using \(dq\(dq"
1363 lacks the required argument.
1364 .It Sy "uname(3) system call failed, using UNKNOWN"
1368 macro is called without arguments, and the
1373 can be compiled with
1375 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1377 .It Sy "unknown standard specifier"
1381 macro has an unknown argument and is discarded.
1382 .It Sy "skipping request without numeric argument"
1386 request has a non-numeric or negative argument or no argument at all.
1387 The invalid request is ignored.
1388 .It Sy "skipping all arguments"
1389 .Pq mdoc , man , eqn , roff
1402 macro in a list that don't support item heads, a
1414 block closing request is invoked with at least one argument.
1415 All arguments are ignored.
1416 .It Sy "skipping excess arguments"
1420 macro is invoked with more than one argument, or a request of the
1422 family is invoked with more than two arguments.
1423 The excess arguments are ignored.
1427 .It Sy "input too large"
1431 cannot handle input files larger than its arbitrary size limit
1432 of 2^31 bytes (2 Gigabytes).
1433 Since useful manuals are always small, this is not a problem in practice.
1434 Parsing is aborted as soon as the condition is detected.
1435 .It Sy "NOT IMPLEMENTED: Bd -file"
1437 For security reasons, the
1439 macro does not support the
1442 By requesting the inclusion of a sensitive file, a malicious document
1443 might otherwise trick a privileged user into inadvertently displaying
1444 the file on the screen, revealing the file content to bystanders.
1445 The parser exits immediately.
1446 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1448 For security reasons,
1452 file inclusion requests only with relative paths
1453 and only without ascending to any parent directory.
1454 By requesting the inclusion of a sensitive file, a malicious document
1455 might otherwise trick a privileged user into inadvertently displaying
1456 the file on the screen, revealing the file content to bystanders.
1457 The parser exits immediately.
1458 .It Sy ".so request failed"
1462 request requires reading an external file.
1463 While trying to do so, an
1469 The parser exits immediately.
1470 Before showing this message,
1472 always shows another message explaining why the system call failed.
1475 This section summarises
1477 compatibility with GNU troff.
1478 Each input and output format is separately noted.
1479 .Ss ASCII Compatibility
1480 .Bl -bullet -compact
1482 Unrenderable unicode codepoints specified with
1484 escapes are printed as
1487 In GNU troff, these raise an error.
1497 are synonyms, as are \-filled and \-ragged.
1499 In historic GNU troff, the
1502 macro does not underline when scoped under an
1504 in the FILES section.
1505 This behaves correctly in
1508 A list or display following the
1513 does not assert a prior vertical break, just as it doesn't with
1523 Words aren't hyphenated.
1525 .Ss HTML/XHTML Compatibility
1526 .Bl -bullet -compact
1530 escape will revert the font to the previous
1532 escape, not to the last rendered decoration, which is now dictated by
1533 CSS instead of hard-coded.
1534 It also will not span past the current scope,
1535 for the same reason.
1538 mode, this will work fine.
1545 list types render similarly (no break following overreached left-hand
1546 side) due to the expressive constraints of HTML.
1553 lists render similarly.
1565 utility was written by
1566 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1572 the maximum size of an element attribute is determined by
1574 which is usually 1024 bytes.
1575 Be aware of this when setting long link
1577 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1579 Nesting elements within next-line element scopes of
1589 and cause them to forget the formatting of the prior next-line scope.
1593 control character is an alias for the standard macro control character
1594 and does not emit a line-break as stipulated in GNU troff.
git.ckatri.com / mandoc.git / blob