1 .\" $Id: mandoc.1,v 1.111 2014/09/07 23:25:01 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 7 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 "AUTHORS section without An macro"
771 An AUTHORS sections contains no
773 macros, or only empty ones.
774 Probably, there are author names lacking markup.
776 .Ss "Warnings related to macros and nesting"
778 .It Sy "obsolete macro"
782 manual for replacements.
783 .It Sy "skipping paragraph macro"
786 documents, this happens
789 at the beginning and end of sections and subsections
791 right before non-compact lists and displays
793 at the end of items in non-column, non-compact lists
795 and for multiple consecutive paragraph macros.
799 documents, it happens
811 macros having neither head nor body arguments
822 .It Sy "moving paragraph macro out of list"
826 list contains a trailing paragraph macro.
827 The paragraph macro is moved after the end of the list.
828 .It Sy "skipping no-space macro"
830 An input line begins with an
833 The macro is ignored.
834 .It Sy "blocks badly nested"
836 If two blocks intersect, one should completely contain the other.
837 Otherwise, rendered output is likely to look strange in any output
838 format, and rendering in SGML-based output formats is likely to be
839 outright wrong because such languages do not support badly nested
841 Typical examples of badly nested blocks are
842 .Qq Ic \&Ao \&Bo \&Ac \&Bc
844 .Qq Ic \&Ao \&Bq \&Ac .
852 .It Sy "nested displays are not portable"
859 display occurs nested inside another
864 but fails with most other implementations.
865 .It Sy "moving content out of list"
869 list block contains text or macros before the first
872 The offending children are moved before the beginning of the list.
873 .It Sy ".Vt block has child macro"
877 macro supports plain text arguments only.
878 Formatting may be ugly and semantic searching
879 for the affected content might not work.
880 .It Sy "fill mode already enabled, skipping"
884 request occurs even though the document is still in fill mode,
885 or already switched back to fill mode.
887 .It Sy "fill mode already disabled, skipping"
891 request occurs even though the document already switched to no-fill mode
892 and did not switch back to fill mode yet.
894 .It Sy "line scope broken"
896 While parsing the next-line scope of the previous macro,
897 another macro is found that prematurely terminates the previous one.
898 The previous, interrupted macro is deleted from the parse tree.
900 .Ss "Warnings related to missing arguments"
902 .It Sy "skipping empty request"
904 The macro name is missing from a macro definition request.
905 .It Sy "conditional request controls empty scope"
907 A conditional request is only useful if any of the following
908 follows it on the same logical input line:
913 keyword to open a multi-line scope.
915 A request or macro or some text, resulting in a single-line scope.
917 The immediate end of the logical line without any intervening whitespace,
918 resulting in next-line scope.
920 Here, a conditional request is followed by trailing whitespace only,
921 and there is no other content on its logical input line.
922 Note that it doesn't matter whether the logical input line is split
923 across multiple physical input lines using
925 line continuation characters.
926 This is one of the rare cases
927 where trailing whitespace is syntactically significant.
928 The conditional request controls a scope containing whitespace only,
929 so it is unlikely to have a significant effect,
930 except that it may control a following
933 .It Sy "skipping empty macro"
935 The indicated macro has no arguments and hence no effect.
936 .It Sy "empty argument, using 0n"
938 The required width is missing after
945 .It Sy "argument count wrong"
947 The indicated macro has too few or too many arguments.
948 The syntax tree will contain the wrong number of arguments as given.
949 Formatting behaviour depends on the specific macro in question.
950 Note that the same message may also occur as an ERROR, see below.
951 .It Sy "missing display type, using -ragged"
955 macro is invoked without the required display type.
956 .It Sy "list type is not the first argument"
960 macro, at least one other argument precedes the type argument.
963 utility copes with any argument order, but some other
965 implementations do not.
966 .It Sy "missing -width in -tag list, using 8n"
975 .It Sy "missing utility name, using \(dq\(dq"
979 macro is called without an argument before
981 has first been called with an argument.
982 .It Sy "empty head in list item"
994 macro lacks the required argument.
995 The item head is left empty.
996 .It Sy "empty list item"
1008 An empty list item is shown.
1009 .It Sy "missing font type"
1013 macro has no argument.
1014 It switches to the default font,
1016 .It Sy "unknown font type"
1020 argument is invalid.
1024 .It Sy "missing -std argument, adding it"
1030 macro lacks the required
1037 even when it is not specified, but other implementations may not.
1039 .Ss "Warnings related to bad macro arguments"
1041 .It Sy "unterminated quoted argument"
1043 Macro arguments can be enclosed in double quote characters
1044 such that space characters and macro names contained in the quoted
1045 argument need not be escaped.
1046 The closing quote of the last argument of a macro can be omitted.
1047 However, omitting it is not recommended because it makes the code
1049 .It Sy "duplicate argument"
1055 macro has more than one
1062 All but the last instances of these arguments are ignored.
1063 .It Sy "skipping duplicate argument"
1067 macro has more than one
1072 All but the first of these arguments are ignored.
1073 .It Sy "skipping duplicate display type"
1077 macro has more than one type argument; the first one is used.
1078 .It Sy "skipping duplicate list type"
1082 macro has more than one type argument; the first one is used.
1083 .It Sy "skipping -width argument"
1097 .It Sy "unknown AT&T UNIX version"
1101 macro has an invalid argument.
1102 It is used verbatim, with
1105 .It Sy "invalid content in Rs block"
1109 block contains plain text or non-% macros.
1110 The bogus content is left in the syntax tree.
1111 Formatting may be poor.
1112 .It Sy "invalid Boolean argument"
1116 macro has an argument other than
1120 The invalid argument is moved out of the macro, which leaves the macro
1121 empty, causing it to toggle the spacing mode.
1122 .It Sy "unknown font, skipping request"
1127 request has an invalid argument.
1129 .Ss "Warnings related to plain text"
1131 .It Sy "blank line in fill mode, using .sp"
1133 The meaning of blank input lines is only well-defined in non-fill mode:
1134 In fill mode, line breaks of text input lines are not supposed to be
1136 However, for compatibility with groff, blank lines in fill mode
1140 .It Sy "tab in filled text"
1142 The meaning of tab characters is only well-defined in non-fill mode:
1143 In fill mode, whitespace is not supposed to be significant
1144 on text input lines.
1145 As an implementation dependent choice, tab characters on text lines
1146 are passed through to the formatters in any case.
1147 Given that the text before the tab character will be filled,
1148 it is hard to predict which tab stop position the tab will advance to.
1149 .It Sy "whitespace at end of input line"
1150 .Pq mdoc , man , roff
1151 Whitespace at the end of input lines is almost never semantically
1152 significant \(em but in the odd case where it might be, it is
1153 extremely confusing when reviewing and maintaining documents.
1154 .It Sy "bad comment style"
1156 Comment lines start with a dot, a backslash, and a double-quote character.
1159 utility treats the line as a comment line even without the backslash,
1160 but leaving out the backslash might not be portable.
1161 .It Sy "invalid escape sequence"
1163 An escape sequence has an invalid opening argument delimiter, lacks the
1164 closing argument delimiter, or the argument has too few characters.
1165 If the argument is incomplete,
1169 expand to an empty string,
1175 to the length of the incomplete argument.
1176 All other invalid escape sequences are ignored.
1177 .It Sy "undefined string, using \(dq\(dq"
1179 If a string is used without being defined before,
1180 its value is implicitly set to the empty string.
1181 However, defining strings explicitly before use
1182 keeps the code more readable.
1184 .Ss "Errors related to equations"
1186 .It "unexpected equation scope closure"
1187 .It "equation scope open on exit"
1188 .It "overlapping equation scopes"
1189 .It "unexpected end of equation"
1190 .It "equation syntax error"
1192 .Ss "Errors related to tables"
1194 .It "bad table syntax"
1195 .It "bad table option"
1196 .It "bad table layout"
1197 .It "no table layout cells specified"
1198 .It "no table data cells specified"
1199 .It "ignore data in cell"
1200 .It "data block still open"
1201 .It "ignoring extra data cells"
1203 .Ss "Errors related to roff, mdoc, and man code"
1205 .It Sy "input stack limit exceeded, infinite loop?"
1207 Explicit recursion limits are implemented for the following features,
1208 in order to prevent infinite loops:
1211 expansion of nested escape sequences
1212 including expansion of strings and number registers,
1214 expansion of nested user-defined macros,
1220 When a limit is hit, the output is incorrect, typically losing
1221 some content, but the parser can continue.
1222 .It Sy "skipping bad character"
1223 .Pq mdoc , man , roff
1224 The input file contains a byte that is not a printable
1227 The message mentions the character number.
1228 The offending byte is replaced with a question mark
1230 Consider editing the input file to replace the byte with an ASCII
1231 transliteration of the intended character.
1232 .It Sy "skipping unknown macro"
1233 .Pq mdoc , man , roff
1234 The first identifier on a request or macro line is neither recognized as a
1236 request, nor as a user-defined macro, nor, respectively, as an
1241 It may be mistyped or unsupported.
1242 The request or macro is discarded including its arguments.
1243 .It Sy "skipping item outside list"
1247 macro occurs outside any
1250 It is discarded including its arguments.
1251 .It Sy "skipping column outside column list"
1255 macro occurs outside any
1258 It is discarded including its arguments.
1259 .It Sy "skipping end of block that is not open"
1260 .Pq mdoc , man , eqn , tbl , roff
1261 Various syntax elements can only be used to explicitly close blocks
1262 that have previously been opened.
1265 block closing macro, a
1270 macro, or the end of an equation, table, or
1272 conditional request is encountered but no matching block is open.
1273 The offending request or macro is discarded.
1274 .It Sy "inserting missing end of block"
1278 macros as well as tables require explicit closing by dedicated macros.
1279 A block that doesn't support bad nesting
1280 ends before all of its children are properly closed.
1281 The open child nodes are closed implicitly.
1282 .It Sy "scope open on exit"
1283 .Pq mdoc , man , eqn , tbl , roff
1284 At the end of the document, an explicit
1292 block, an equation, table, or
1294 conditional or ignore block is still open.
1295 The open block is closed implicitly.
1296 .It Sy "escaped character not allowed in a name"
1298 Macro, string and register identifiers consist of printable,
1299 non-whitespace ASCII characters.
1300 Escape sequences and characters and strings expressed in terms of them
1301 cannot form part of a name.
1302 The first argument of an
1310 request, or any argument of an
1312 request, or the name of a request or user defined macro being called,
1313 is terminated by an escape sequence.
1319 the request has no effect at all.
1326 what was parsed up to this point is used as the arguments to the request,
1327 and the rest of the input line is discarded including the escape sequence.
1328 When parsing for a request or a user-defined macro name to be called,
1329 only the escape sequence is discarded.
1330 The characters preceding it are used as the request or macro name,
1331 the characters following it are used as the arguments to the request or macro.
1332 .It Sy "argument count wrong"
1333 .Pq mdoc , man , roff
1334 The indicated request or macro has too few or too many arguments.
1335 The syntax tree will contain the wrong number of arguments as given.
1336 Formatting behaviour depends on the specific request or macro in question.
1337 Note that the same message may also occur as a WARNING, see above.
1338 .It Sy "missing list type, using -item"
1342 macro fails to specify the list type.
1343 .It Sy "missing manual name, using \(dq\(dq"
1347 lacks the required argument.
1348 .It Sy "uname(3) system call failed, using UNKNOWN"
1352 macro is called without arguments, and the
1357 can be compiled with
1359 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1361 .It Sy "unknown standard specifier"
1365 macro has an unknown argument and is discarded.
1366 .It Sy "skipping request without numeric argument"
1370 request has a non-numeric or negative argument or no argument at all.
1371 The invalid request is ignored.
1372 .It Sy "skipping all arguments"
1373 .Pq mdoc , man , eqn , roff
1386 macro in a list that don't support item heads, a
1398 block closing request is invoked with at least one argument.
1399 All arguments are ignored.
1400 .It Sy "skipping excess arguments"
1404 macro is invoked with more than one argument, or a request of the
1406 family is invoked with more than two arguments.
1407 The excess arguments are ignored.
1411 .It Sy "input too large"
1415 cannot handle input files larger than its arbitrary size limit
1416 of 2^31 bytes (2 Gigabytes).
1417 Since useful manuals are always small, this is not a problem in practice.
1418 Parsing is aborted as soon as the condition is detected.
1419 .It Sy "NOT IMPLEMENTED: Bd -file"
1421 For security reasons, the
1423 macro does not support the
1426 By requesting the inclusion of a sensitive file, a malicious document
1427 might otherwise trick a privileged user into inadvertently displaying
1428 the file on the screen, revealing the file content to bystanders.
1429 The parser exits immediately.
1430 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1432 For security reasons,
1436 file inclusion requests only with relative paths
1437 and only without ascending to any parent directory.
1438 By requesting the inclusion of a sensitive file, a malicious document
1439 might otherwise trick a privileged user into inadvertently displaying
1440 the file on the screen, revealing the file content to bystanders.
1441 The parser exits immediately.
1442 .It Sy ".so request failed"
1446 request requires reading an external file.
1447 While trying to do so, an
1453 The parser exits immediately.
1454 Before showing this message,
1456 always shows another message explaining why the system call failed.
1459 This section summarises
1461 compatibility with GNU troff.
1462 Each input and output format is separately noted.
1463 .Ss ASCII Compatibility
1464 .Bl -bullet -compact
1466 Unrenderable unicode codepoints specified with
1468 escapes are printed as
1471 In GNU troff, these raise an error.
1481 are synonyms, as are \-filled and \-ragged.
1483 In historic GNU troff, the
1486 macro does not underline when scoped under an
1488 in the FILES section.
1489 This behaves correctly in
1492 A list or display following the
1497 does not assert a prior vertical break, just as it doesn't with
1507 Words aren't hyphenated.
1509 .Ss HTML/XHTML Compatibility
1510 .Bl -bullet -compact
1514 escape will revert the font to the previous
1516 escape, not to the last rendered decoration, which is now dictated by
1517 CSS instead of hard-coded.
1518 It also will not span past the current scope,
1519 for the same reason.
1522 mode, this will work fine.
1529 list types render similarly (no break following overreached left-hand
1530 side) due to the expressive constraints of HTML.
1537 lists render similarly.
1549 utility was written by
1550 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1556 the maximum size of an element attribute is determined by
1558 which is usually 1024 bytes.
1559 Be aware of this when setting long link
1561 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1563 Nesting elements within next-line element scopes of
1573 and cause them to forget the formatting of the prior next-line scope.
1577 control character is an alias for the standard macro control character
1578 and does not emit a line-break as stipulated in GNU troff.
git.ckatri.com / mandoc.git / blob