[BACK]Return to mandoc.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mandoc.1, Revision 1.95

1.95    ! kristaps    1: .\"    $Id: mandoc.1,v 1.94 2011/10/05 21:35:17 kristaps Exp $
1.1       kristaps    2: .\"
1.92      schwarze    3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
1.16      kristaps    6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
1.1       kristaps    8: .\"
1.16      kristaps    9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16: .\"
1.95    ! kristaps   17: .Dd $Mdocdate: October 5 2011 $
1.14      kristaps   18: .Dt MANDOC 1
1.1       kristaps   19: .Os
                     20: .Sh NAME
                     21: .Nm mandoc
1.8       kristaps   22: .Nd format and display UNIX manuals
1.1       kristaps   23: .Sh SYNOPSIS
                     24: .Nm mandoc
1.58      kristaps   25: .Op Fl V
1.8       kristaps   26: .Op Fl m Ns Ar format
1.58      kristaps   27: .Op Fl O Ns Ar option
1.37      kristaps   28: .Op Fl T Ns Ar output
1.77      schwarze   29: .Op Fl W Ns Ar level
1.89      kristaps   30: .Op Ar
1.1       kristaps   31: .Sh DESCRIPTION
                     32: The
                     33: .Nm
1.26      kristaps   34: utility formats
1.8       kristaps   35: .Ux
1.57      kristaps   36: manual pages for display.
                     37: The arguments are as follows:
1.19      kristaps   38: .Bl -tag -width Ds
                     39: .It Fl m Ns Ar format
1.57      kristaps   40: Input format.
                     41: See
1.8       kristaps   42: .Sx Input Formats
1.57      kristaps   43: for available formats.
                     44: Defaults to
1.58      kristaps   45: .Fl m Ns Cm andoc .
                     46: .It Fl O Ns Ar option
1.57      kristaps   47: Comma-separated output options.
1.19      kristaps   48: .It Fl T Ns Ar output
1.57      kristaps   49: Output format.
                     50: See
1.1       kristaps   51: .Sx Output Formats
1.57      kristaps   52: for available formats.
                     53: Defaults to
1.58      kristaps   54: .Fl T Ns Cm ascii .
1.1       kristaps   55: .It Fl V
                     56: Print version and exit.
1.77      schwarze   57: .It Fl W Ns Ar level
                     58: Specify the minimum message
                     59: .Ar level
                     60: to be reported on the standard error output and to affect the exit status.
                     61: The
                     62: .Ar level
                     63: can be
                     64: .Cm warning ,
                     65: .Cm error ,
                     66: or
                     67: .Cm fatal .
                     68: The default is
                     69: .Fl W Ns Cm fatal ;
1.58      kristaps   70: .Fl W Ns Cm all
1.77      schwarze   71: is an alias for
                     72: .Fl W Ns Cm warning .
                     73: See
                     74: .Sx EXIT STATUS
                     75: and
                     76: .Sx DIAGNOSTICS
                     77: for details.
                     78: .Pp
                     79: The special option
                     80: .Fl W Ns Cm stop
                     81: tells
                     82: .Nm
                     83: to exit after parsing a file that causes warnings or errors of at least
                     84: the requested level.
                     85: No formatted output will be produced from that file.
                     86: If both a
                     87: .Ar level
                     88: and
                     89: .Cm stop
                     90: are requested, they can be joined with a comma, for example
                     91: .Fl W Ns Cm error , Ns Cm stop .
1.58      kristaps   92: .It Ar file
                     93: Read input from zero or more files.
1.57      kristaps   94: If unspecified, reads from stdin.
                     95: If multiple files are specified,
1.2       kristaps   96: .Nm
                     97: will halt with the first failed parse.
1.1       kristaps   98: .El
                     99: .Pp
1.26      kristaps  100: By default,
                    101: .Nm
                    102: reads
1.8       kristaps  103: .Xr mdoc 7
1.12      kristaps  104: or
                    105: .Xr man 7
1.8       kristaps  106: text from stdin, implying
1.58      kristaps  107: .Fl m Ns Cm andoc ,
1.48      kristaps  108: and produces
1.58      kristaps  109: .Fl T Ns Cm ascii
1.48      kristaps  110: output.
1.8       kristaps  111: .Ss Input Formats
                    112: The
                    113: .Nm
                    114: utility accepts
                    115: .Xr mdoc 7
                    116: and
                    117: .Xr man 7
                    118: input with
1.58      kristaps  119: .Fl m Ns Cm doc
1.8       kristaps  120: and
1.58      kristaps  121: .Fl m Ns Cm an ,
1.57      kristaps  122: respectively.
                    123: The
1.8       kristaps  124: .Xr mdoc 7
                    125: format is
                    126: .Em strongly
1.26      kristaps  127: recommended;
1.8       kristaps  128: .Xr man 7
                    129: should only be used for legacy manuals.
1.11      kristaps  130: .Pp
1.12      kristaps  131: A third option,
1.58      kristaps  132: .Fl m Ns Cm andoc ,
1.13      kristaps  133: which is also the default, determines encoding on-the-fly: if the first
1.26      kristaps  134: non-comment macro is
1.27      kristaps  135: .Sq \&Dd
1.13      kristaps  136: or
1.27      kristaps  137: .Sq \&Dt ,
1.26      kristaps  138: the
1.13      kristaps  139: .Xr mdoc 7
                    140: parser is used; otherwise, the
                    141: .Xr man 7
                    142: parser is used.
                    143: .Pp
                    144: If multiple
1.26      kristaps  145: files are specified with
1.58      kristaps  146: .Fl m Ns Cm andoc ,
1.57      kristaps  147: each has its file-type determined this way.
                    148: If multiple files are
1.13      kristaps  149: specified and
1.58      kristaps  150: .Fl m Ns Cm doc
1.12      kristaps  151: or
1.58      kristaps  152: .Fl m Ns Cm an
1.12      kristaps  153: is specified, then this format is used exclusively.
1.1       kristaps  154: .Ss Output Formats
                    155: The
                    156: .Nm
                    157: utility accepts the following
                    158: .Fl T
1.66      kristaps  159: arguments, which correspond to output modes:
1.93      schwarze  160: .Bl -tag -width "-Tlocale"
1.58      kristaps  161: .It Fl T Ns Cm ascii
1.81      kristaps  162: Produce 7-bit ASCII output.
1.57      kristaps  163: This is the default.
                    164: See
1.48      kristaps  165: .Sx ASCII Output .
1.58      kristaps  166: .It Fl T Ns Cm html
1.81      kristaps  167: Produce strict CSS1/HTML-4.01 output.
1.57      kristaps  168: See
1.48      kristaps  169: .Sx HTML Output .
1.58      kristaps  170: .It Fl T Ns Cm lint
                    171: Parse only: produce no output.
                    172: Implies
1.77      schwarze  173: .Fl W Ns Cm warning .
1.93      schwarze  174: .It Fl T Ns Cm locale
                    175: Encode output using the current locale.
                    176: See
                    177: .Sx Locale Output .
1.91      schwarze  178: .It Fl T Ns Cm man
1.95    ! kristaps  179: Produce
1.91      schwarze  180: .Xr man 7
1.95    ! kristaps  181: format output.
        !           182: See
        !           183: .Sx Man Output .
1.73      kristaps  184: .It Fl T Ns Cm pdf
                    185: Produce PDF output.
                    186: See
                    187: .Sx PDF Output .
1.62      kristaps  188: .It Fl T Ns Cm ps
                    189: Produce PostScript output.
                    190: See
                    191: .Sx PostScript Output .
1.58      kristaps  192: .It Fl T Ns Cm tree
                    193: Produce an indented parse tree.
1.93      schwarze  194: .It Fl T Ns Cm utf8
                    195: Encode output in the UTF\-8 multi-byte format.
                    196: See
                    197: .Sx UTF\-8 Output .
1.58      kristaps  198: .It Fl T Ns Cm xhtml
1.81      kristaps  199: Produce strict CSS1/XHTML-1.0 output.
1.57      kristaps  200: See
1.50      kristaps  201: .Sx XHTML Output .
1.1       kristaps  202: .El
1.13      kristaps  203: .Pp
                    204: If multiple input files are specified, these will be processed by the
                    205: corresponding filter in-order.
1.66      kristaps  206: .Ss ASCII Output
                    207: Output produced by
                    208: .Fl T Ns Cm ascii ,
                    209: which is the default, is rendered in standard 7-bit ASCII documented in
                    210: .Xr ascii 7 .
                    211: .Pp
                    212: Font styles are applied by using back-spaced encoding such that an
                    213: underlined character
                    214: .Sq c
                    215: is rendered as
                    216: .Sq _ Ns \e[bs] Ns c ,
                    217: where
                    218: .Sq \e[bs]
                    219: is the back-space character number 8.
                    220: Emboldened characters are rendered as
                    221: .Sq c Ns \e[bs] Ns c .
                    222: .Pp
                    223: The special characters documented in
                    224: .Xr mandoc_char 7
                    225: are rendered best-effort in an ASCII equivalent.
1.87      kristaps  226: If no equivalent is found,
                    227: .Sq \&?
                    228: is used instead.
1.66      kristaps  229: .Pp
                    230: Output width is limited to 78 visible columns unless literal input lines
                    231: exceed this limit.
                    232: .Pp
                    233: The following
                    234: .Fl O
                    235: arguments are accepted:
1.19      kristaps  236: .Bl -tag -width Ds
1.66      kristaps  237: .It Cm width Ns = Ns Ar width
                    238: The output width is set to
                    239: .Ar width ,
                    240: which will normalise to \(>=60.
1.1       kristaps  241: .El
1.66      kristaps  242: .Ss HTML Output
                    243: Output produced by
                    244: .Fl T Ns Cm html
                    245: conforms to HTML-4.01 strict.
                    246: .Pp
1.61      kristaps  247: The
1.66      kristaps  248: .Pa example.style.css
1.83      kristaps  249: file documents style-sheet classes available for customising output.
                    250: If a style-sheet is not specified with
                    251: .Fl O Ns Ar style ,
                    252: .Fl T Ns Cm html
                    253: defaults to simple output readable in any graphical or text-based web
                    254: browser.
1.66      kristaps  255: .Pp
1.89      kristaps  256: Special characters are rendered in decimal-encoded UTF\-8.
1.66      kristaps  257: .Pp
                    258: The following
1.64      kristaps  259: .Fl O
1.66      kristaps  260: arguments are accepted:
1.37      kristaps  261: .Bl -tag -width Ds
1.94      kristaps  262: .It Cm fragment
                    263: Do not emit doctype, html, and body elements.
                    264: The
                    265: .Cm style
                    266: argument shall be unused.
                    267: This is useful when embedding manual content within existing documents.
1.64      kristaps  268: .It Cm includes Ns = Ns Ar fmt
1.40      kristaps  269: The string
                    270: .Ar fmt ,
1.49      kristaps  271: for example,
1.40      kristaps  272: .Ar ../src/%I.html ,
                    273: is used as a template for linked header files (usually via the
                    274: .Sq \&In
1.57      kristaps  275: macro).
                    276: Instances of
1.43      kristaps  277: .Sq \&%I
1.57      kristaps  278: are replaced with the include filename.
                    279: The default is not to present a
1.40      kristaps  280: hyperlink.
1.64      kristaps  281: .It Cm man Ns = Ns Ar fmt
1.39      kristaps  282: The string
                    283: .Ar fmt ,
1.49      kristaps  284: for example,
1.39      kristaps  285: .Ar ../html%S/%N.%S.html ,
                    286: is used as a template for linked manuals (usually via the
1.37      kristaps  287: .Sq \&Xr
1.57      kristaps  288: macro).
                    289: Instances of
1.43      kristaps  290: .Sq \&%N
1.40      kristaps  291: and
                    292: .Sq %S
                    293: are replaced with the linked manual's name and section, respectively.
1.57      kristaps  294: If no section is included, section 1 is assumed.
                    295: The default is not to
1.40      kristaps  296: present a hyperlink.
1.64      kristaps  297: .It Cm style Ns = Ns Ar style.css
1.58      kristaps  298: The file
                    299: .Ar style.css
                    300: is used for an external style-sheet.
                    301: This must be a valid absolute or
                    302: relative URI.
1.61      kristaps  303: .El
1.93      schwarze  304: .Ss Locale Output
                    305: Locale-depending output encoding is triggered with
                    306: .Fl T Ns Cm locale .
                    307: This option is not available on all systems: systems without locale
                    308: support, or those whose internal representation is not natively UCS-4,
                    309: will fall back to
                    310: .Fl T Ns Cm ascii .
                    311: See
                    312: .Sx ASCII Output
                    313: for font style specification and available command-line arguments.
1.95    ! kristaps  314: .Ss Man Output
        !           315: Translate input format into
        !           316: .Xr man 7
        !           317: output format.
        !           318: This is useful for distributing manual sources to legancy systems
        !           319: lacking
        !           320: .Xr mdoc 7
        !           321: formatters.
        !           322: .Pp
        !           323: If
        !           324: .Xr mdoc 7
        !           325: is passed as input, it is translated into
        !           326: .Xr man 7 ;
        !           327: if the input format is
        !           328: .Xr man 7 ,
        !           329: it is parsed and re-outputted.
        !           330: In either case, the
        !           331: .Xr roff 7
        !           332: .Sq so
        !           333: macros are processed prior to producing output.
1.93      schwarze  334: .Ss PDF Output
                    335: PDF-1.1 output may be generated by
                    336: .Fl T Ns Cm pdf .
                    337: See
                    338: .Sx PostScript Output
                    339: for
                    340: .Fl O
                    341: arguments and defaults.
1.62      kristaps  342: .Ss PostScript Output
1.65      kristaps  343: PostScript
                    344: .Qq Adobe-3.0
                    345: Level-2 pages may be generated by
1.62      kristaps  346: .Fl T Ns Cm ps .
1.67      kristaps  347: Output pages default to letter sized and are rendered in the Times font
1.70      kristaps  348: family, 11-point.
                    349: Margins are calculated as 1/9 the page length and width.
1.71      kristaps  350: Line-height is 1.4m.
1.66      kristaps  351: .Pp
                    352: Special characters are rendered as in
                    353: .Sx ASCII Output .
                    354: .Pp
                    355: The following
                    356: .Fl O
                    357: arguments are accepted:
                    358: .Bl -tag -width Ds
                    359: .It Cm paper Ns = Ns Ar name
                    360: The paper size
                    361: .Ar name
                    362: may be one of
1.68      kristaps  363: .Ar a3 ,
                    364: .Ar a4 ,
                    365: .Ar a5 ,
                    366: .Ar legal ,
1.66      kristaps  367: or
                    368: .Ar letter .
1.68      kristaps  369: You may also manually specify dimensions as
                    370: .Ar NNxNN ,
                    371: width by height in millimetres.
                    372: If an unknown value is encountered,
                    373: .Ar letter
                    374: is used.
1.66      kristaps  375: .El
1.93      schwarze  376: .Ss UTF\-8 Output
                    377: Use
                    378: .Fl T Ns Cm utf8
                    379: to force a UTF\-8 locale.
1.73      kristaps  380: See
1.93      schwarze  381: .Sx Locale Output
                    382: for details and options.
1.50      kristaps  383: .Ss XHTML Output
                    384: Output produced by
1.58      kristaps  385: .Fl T Ns Cm xhtml
1.50      kristaps  386: conforms to XHTML-1.0 strict.
                    387: .Pp
                    388: See
                    389: .Sx HTML Output
                    390: for details; beyond generating XHTML tags instead of HTML tags, these
                    391: output modes are identical.
1.77      schwarze  392: .Sh EXIT STATUS
                    393: The
                    394: .Nm
                    395: utility exits with one of the following values, controlled by the message
                    396: .Ar level
                    397: associated with the
                    398: .Fl W
                    399: option:
                    400: .Pp
                    401: .Bl -tag -width Ds -compact
                    402: .It 0
                    403: No warnings or errors occurred, or those that did were ignored because
                    404: they were lower than the requested
                    405: .Ar level .
                    406: .It 2
                    407: At least one warning occurred, but no error, and
                    408: .Fl W Ns Cm warning
                    409: was specified.
                    410: .It 3
                    411: At least one parsing error occurred, but no fatal error, and
                    412: .Fl W Ns Cm error
                    413: or
                    414: .Fl W Ns Cm warning
                    415: was specified.
                    416: .It 4
                    417: A fatal parsing error occurred.
                    418: .It 5
                    419: Invalid command line arguments were specified.
                    420: No input files have been read.
                    421: .It 6
                    422: An operating system error occurred, for example memory exhaustion or an
                    423: error accessing input files.
                    424: Such errors cause
                    425: .Nm
                    426: to exit at once, possibly in the middle of parsing or formatting a file.
                    427: .El
                    428: .Pp
                    429: Note that selecting
                    430: .Fl T Ns Cm lint
                    431: output mode implies
                    432: .Fl W Ns Cm warning .
1.1       kristaps  433: .Sh EXAMPLES
1.13      kristaps  434: To page manuals to the terminal:
1.1       kristaps  435: .Pp
1.82      kristaps  436: .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
                    437: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.28      kristaps  438: .Pp
1.41      kristaps  439: To produce HTML manuals with
                    440: .Ar style.css
                    441: as the style-sheet:
1.38      kristaps  442: .Pp
1.82      kristaps  443: .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
1.38      kristaps  444: .Pp
1.28      kristaps  445: To check over a large set of manuals:
                    446: .Pp
1.77      schwarze  447: .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
1.66      kristaps  448: .Pp
                    449: To produce a series of PostScript manuals for A4 paper:
                    450: .Pp
1.82      kristaps  451: .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.91      schwarze  452: .Pp
                    453: Convert a modern
                    454: .Xr mdoc 7
                    455: manual to the older
                    456: .Xr man 7
                    457: format, for use on systems lacking an
                    458: .Xr mdoc 7
                    459: parser:
                    460: .Pp
                    461: .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
1.77      schwarze  462: .Sh DIAGNOSTICS
                    463: Standard error messages reporting parsing errors are prefixed by
                    464: .Pp
                    465: .Sm off
                    466: .D1 Ar file : line : column : \ level :
                    467: .Sm on
                    468: .Pp
                    469: where the fields have the following meanings:
                    470: .Bl -tag -width "column"
                    471: .It Ar file
                    472: The name of the input file causing the message.
                    473: .It Ar line
                    474: The line number in that input file.
                    475: Line numbering starts at 1.
                    476: .It Ar column
                    477: The column number in that input file.
                    478: Column numbering starts at 1.
                    479: If the issue is caused by a word, the column number usually
                    480: points to the first character of the word.
                    481: .It Ar level
                    482: The message level, printed in capital letters.
                    483: .El
                    484: .Pp
                    485: Message levels have the following meanings:
                    486: .Bl -tag -width "warning"
                    487: .It Cm fatal
                    488: The parser is unable to parse a given input file at all.
                    489: No formatted output is produced from that input file.
                    490: .It Cm error
                    491: An input file contains syntax that cannot be safely interpreted,
                    492: either because it is invalid or because
                    493: .Nm
                    494: does not implement it yet.
                    495: By discarding part of the input or inserting missing tokens,
                    496: the parser is able to continue, and the error does not prevent
                    497: generation of formatted output, but typically, preparing that
                    498: output involves information loss, broken document structure
                    499: or unintended formatting.
                    500: .It Cm warning
                    501: An input file uses obsolete, discouraged or non-portable syntax.
                    502: All the same, the meaning of the input is unambiguous and a correct
                    503: rendering can be produced.
                    504: Documents causing warnings may render poorly when using other
                    505: formatting tools instead of
                    506: .Nm .
                    507: .El
                    508: .Pp
                    509: Messages of the
                    510: .Cm warning
                    511: and
                    512: .Cm error
                    513: levels are hidden unless their level, or a lower level, is requested using a
                    514: .Fl W
                    515: option or
                    516: .Fl T Ns Cm lint
                    517: output mode.
                    518: .Pp
                    519: The
                    520: .Nm
                    521: utility may also print messages related to invalid command line arguments
                    522: or operating system errors, for example when memory is exhausted or
1.78      schwarze  523: input files cannot be read.
                    524: Such messages do not carry the prefix described above.
1.20      kristaps  525: .Sh COMPATIBILITY
1.26      kristaps  526: This section summarises
1.20      kristaps  527: .Nm
1.76      kristaps  528: compatibility with GNU troff.
1.32      kristaps  529: Each input and output format is separately noted.
1.48      kristaps  530: .Ss ASCII Compatibility
1.37      kristaps  531: .Bl -bullet -compact
1.29      kristaps  532: .It
1.87      kristaps  533: Unrenderable unicode codepoints specified with
1.86      kristaps  534: .Sq \e[uNNNN]
                    535: escapes are printed as
                    536: .Sq \&?
                    537: in mandoc.
                    538: In GNU troff, these raise an error.
                    539: .It
1.49      kristaps  540: The
1.33      kristaps  541: .Sq \&Bd \-literal
1.49      kristaps  542: and
1.32      kristaps  543: .Sq \&Bd \-unfilled
                    544: macros of
                    545: .Xr mdoc 7
                    546: in
1.58      kristaps  547: .Fl T Ns Cm ascii
1.32      kristaps  548: are synonyms, as are \-filled and \-ragged.
1.26      kristaps  549: .It
1.86      kristaps  550: In historic GNU troff, the
1.27      kristaps  551: .Sq \&Pa
1.32      kristaps  552: .Xr mdoc 7
                    553: macro does not underline when scoped under an
1.30      kristaps  554: .Sq \&It
1.57      kristaps  555: in the FILES section.
                    556: This behaves correctly in
1.27      kristaps  557: .Nm .
                    558: .It
1.58      kristaps  559: A list or display following the
1.27      kristaps  560: .Sq \&Ss
1.32      kristaps  561: .Xr mdoc 7
                    562: macro in
1.58      kristaps  563: .Fl T Ns Cm ascii
1.20      kristaps  564: does not assert a prior vertical break, just as it doesn't with
1.27      kristaps  565: .Sq \&Sh .
1.20      kristaps  566: .It
1.32      kristaps  567: The
                    568: .Sq \&na
                    569: .Xr man 7
1.34      kristaps  570: macro in
1.58      kristaps  571: .Fl T Ns Cm ascii
1.34      kristaps  572: has no effect.
1.20      kristaps  573: .It
                    574: Words aren't hyphenated.
                    575: .El
1.50      kristaps  576: .Ss HTML/XHTML Compatibility
1.42      kristaps  577: .Bl -bullet -compact
                    578: .It
                    579: The
1.47      kristaps  580: .Sq \efP
                    581: escape will revert the font to the previous
                    582: .Sq \ef
                    583: escape, not to the last rendered decoration, which is now dictated by
1.57      kristaps  584: CSS instead of hard-coded.
                    585: It also will not span past the current scope,
                    586: for the same reason.
                    587: Note that in
1.47      kristaps  588: .Sx ASCII Output
                    589: mode, this will work fine.
                    590: .It
                    591: The
1.42      kristaps  592: .Xr mdoc 7
                    593: .Sq \&Bl \-hang
                    594: and
                    595: .Sq \&Bl \-tag
                    596: list types render similarly (no break following overreached left-hand
                    597: side) due to the expressive constraints of HTML.
                    598: .It
                    599: The
                    600: .Xr man 7
                    601: .Sq IP
                    602: and
                    603: .Sq TP
                    604: lists render similarly.
                    605: .El
1.1       kristaps  606: .Sh SEE ALSO
1.85      kristaps  607: .Xr eqn 7 ,
1.57      kristaps  608: .Xr man 7 ,
1.13      kristaps  609: .Xr mandoc_char 7 ,
1.84      kristaps  610: .Xr mdoc 7 ,
                    611: .Xr roff 7 ,
                    612: .Xr tbl 7
1.1       kristaps  613: .Sh AUTHORS
                    614: The
                    615: .Nm
1.26      kristaps  616: utility was written by
1.90      kristaps  617: .An Kristaps Dzonsons ,
                    618: .Mt kristaps@bsd.lv .
1.39      kristaps  619: .Sh CAVEATS
                    620: In
1.58      kristaps  621: .Fl T Ns Cm html
1.50      kristaps  622: and
1.58      kristaps  623: .Fl T Ns Cm xhtml ,
1.39      kristaps  624: the maximum size of an element attribute is determined by
                    625: .Dv BUFSIZ ,
1.57      kristaps  626: which is usually 1024 bytes.
                    627: Be aware of this when setting long link
1.58      kristaps  628: formats such as
                    629: .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1.51      kristaps  630: .Pp
                    631: Nesting elements within next-line element scopes of
1.58      kristaps  632: .Fl m Ns Cm an ,
1.51      kristaps  633: such as
                    634: .Sq br
                    635: within an empty
                    636: .Sq B ,
                    637: will confuse
1.58      kristaps  638: .Fl T Ns Cm html
1.51      kristaps  639: and
1.58      kristaps  640: .Fl T Ns Cm xhtml
1.52      kristaps  641: and cause them to forget the formatting of the prior next-line scope.
1.53      kristaps  642: .Pp
1.54      kristaps  643: The
                    644: .Sq \(aq
1.55      kristaps  645: control character is an alias for the standard macro control character
                    646: and does not emit a line-break as stipulated in GNU troff.

CVSweb