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

Diff for /mandoc/mandoc.1 between version 1.29 and 1.100

version 1.29, 2009/07/26 19:30:50 version 1.100, 2011/12/25 19:35:44
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MANDOC 1  .Dt MANDOC 1
 .Os  .Os
 .\" SECTION  
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display UNIX manuals  .Nd format and display UNIX manuals
 .\" SECTION  
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl V  .Op Fl V
 .Op Fl f Ns Ar option...  
 .Op Fl m Ns Ar format  .Op Fl m Ns Ar format
 .Op Fl W Ns Ar err...  .Op Fl O Ns Ar option
 .Op Fl T Ns Ar output  .Op Fl T Ns Ar output
 .Op Ar infile...  .Op Fl W Ns Ar level
 .\" SECTION  .Op Ar
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility formats  utility formats
 .Ux  .Ux
 manual pages for display.  The arguments are as follows:  manual pages for display.
 .Bl -tag -width Ds  
 .\" ITEM  
 .It Fl f Ns Ar option...  
 Override default compiler behaviour.  See  
 .Sx Compiler Options  
 for details.  
 .\" ITEM  
 .It Fl m Ns Ar format  
 Input format.  See  
 .Sx Input Formats  
 for available formats.  Defaults to  
 .Fl m Ns Ar andoc .  
 .\" ITEM  
 .It Fl T Ns Ar output  
 Output format.  See  
 .Sx Output Formats  
 for available formats.  Defaults to  
 .Fl T Ns Ar ascii .  
 .\" ITEM  
 .It Fl V  
 Print version and exit.  
 .\" ITEM  
 .It Fl W Ns Ar err...  
 Configure warning messages.  Use  
 .Fl W Ns Ar all  
 to print warnings,  
 .Fl W Ns Ar error  
 for warnings to be considered errors and cause utility  
 termination.  Multiple  
 .Fl W  
 arguments may be comma-separated, such as  
 .Fl W Ns Ar error,all .  
 .\" ITEM  
 .It Ar infile...  
 Read input from zero or more  
 .Ar infile .  
 If unspecified, reads from stdin.  If multiple files are specified,  
 .Nm  
 will halt with the first failed parse.  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
Line 86  reads
Line 42  reads
 or  or
 .Xr man 7  .Xr man 7
 text from stdin, implying  text from stdin, implying
 .Fl m Ns Ar andoc ,  .Fl m Ns Cm andoc ,
 and prints 78-column backspace-encoded output to stdout as if  and produces
 .Fl T Ns Ar ascii  .Fl T Ns Cm ascii
 were provided.  output.
 .\" PARAGRAPH  
 .Pp  .Pp
 .Ex -std mandoc  The arguments are as follows:
 .\" SUB-SECTION  .Bl -tag -width Ds
 .Ss Punctuation and Spacing  .It Fl m Ns Ar format
 If punctuation is set apart from words, such as in the phrase  Input format.
 .Dq to be \&, or not to be ,  See
 it's processed by  .Sx Input Formats
 .Nm  for available formats.
 according to the following rules:  opening punctuation  Defaults to
 .Po  .Fl m Ns Cm andoc .
 .Sq \&( ,  .It Fl O Ns Ar option
 .Sq \&[ ,  Comma-separated output options.
   .It Fl T Ns Ar output
   Output format.
   See
   .Sx Output Formats
   for available formats.
   Defaults to
   .Fl T Ns Cm ascii .
   .It Fl V
   Print version and exit.
   .It Fl W Ns Ar level
   Specify the minimum message
   .Ar level
   to be reported on the standard error output and to affect the exit status.
   The
   .Ar level
   can be
   .Cm warning ,
   .Cm error ,
   or
   .Cm fatal .
   The default is
   .Fl W Ns Cm fatal ;
   .Fl W Ns Cm all
   is an alias for
   .Fl W Ns Cm warning .
   See
   .Sx EXIT STATUS
 and  and
 .Sq \&{  .Sx DIAGNOSTICS
 .Pc  for details.
 is not followed by a space; closing punctuation  
 .Po  
 .Sq \&. ,  
 .Sq \&, ,  
 .Sq \&; ,  
 .Sq \&: ,  
 .Sq \&? ,  
 .Sq \&! ,  
 .Sq \&) ,  
 .Sq \&]  
 and  
 .Sq \&}  
 .Pc  
 is not preceded by whitespace.  
 .Pp  .Pp
 If the input is  The special option
 .Xr mdoc 7 ,  .Fl W Ns Cm stop
 these rules are also applied to macro arguments when appropriate.  tells
 .Pp  .Nm
 White-space, in non-literal (normal) mode, is stripped from input and  to exit after parsing a file that causes warnings or errors of at least
 replaced on output by a single space.  Thus, if you wish to preserve  the requested level.
 multiple spaces, they must be space-escaped  No formatted output will be produced from that file.
 .Sq \e\  If both a
 or used in a literal display mode, e.g.,  .Ar level
 .Sq \&Bd \-literal  and
 in  .Cm stop
 .Xr mdoc 7 .  are requested, they can be joined with a comma, for example
 .\" SUB-SECTION  .Fl W Ns Cm error , Ns Cm stop .
   .It Ar file
   Read input from zero or more files.
   If unspecified, reads from stdin.
   If multiple files are specified,
   .Nm
   will halt with the first failed parse.
   .El
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 142  utility accepts
Line 117  utility accepts
 and  and
 .Xr man 7  .Xr man 7
 input with  input with
 .Fl m Ns Ar doc  .Fl m Ns Cm doc
 and  and
 .Fl m Ns Ar an ,  .Fl m Ns Cm an ,
 respectively.  The  respectively.
   The
 .Xr mdoc 7  .Xr mdoc 7
 format is  format is
 .Em strongly  .Em strongly
Line 154  recommended;
Line 130  recommended;
 should only be used for legacy manuals.  should only be used for legacy manuals.
 .Pp  .Pp
 A third option,  A third option,
 .Fl m Ns Ar andoc ,  .Fl m Ns Cm andoc ,
 which is also the default, determines encoding on-the-fly: if the first  which is also the default, determines encoding on-the-fly: if the first
 non-comment macro is  non-comment macro is
 .Sq \&Dd  .Sq \&Dd
Line 168  parser is used.
Line 144  parser is used.
 .Pp  .Pp
 If multiple  If multiple
 files are specified with  files are specified with
 .Fl m Ns Ar andoc ,  .Fl m Ns Cm andoc ,
 each has its file-type determined this way.  If multiple files are  each has its file-type determined this way.
   If multiple files are
 specified and  specified and
 .Fl m Ns Ar doc  .Fl m Ns Cm doc
 or  or
 .Fl m Ns Ar an  .Fl m Ns Cm an
 is specified, then this format is used exclusively.  is specified, then this format is used exclusively.
 .\" .Pp  
 .\" The following escape sequences are recognised, although the per-format  
 .\" compiler may not allow certain sequences.  
 .\" .Bl -tag -width Ds -offset XXXX  
 .\" .It \efX  
 .\" sets the font mode to X (B, I, R or P, where P resets the font)  
 .\" .It \eX, \e(XX, \e[XN]  
 .\" queries the special-character table for a corresponding symbol  
 .\" .It \e*X, \e*(XX, \e*[XN]  
 .\" deprecated special-character format  
 .\" .El  
 .\" SUB-SECTION  
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments:  arguments, which correspond to output modes:
 .Bl -tag -width Ds  .Bl -tag -width "-Tlocale"
 .It Fl T Ns Ar ascii  .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output, backspace-encoded for bold and underline  Produce 7-bit ASCII output.
 styles.  This is the default.  This is the default.
 .It Fl T Ns Ar tree  See
 Produce an indented parse tree.  .Sx ASCII Output .
 .It Fl T Ns Ar lint  .It Fl T Ns Cm html
   Produce strict CSS1/HTML-4.01 output.
   See
   .Sx HTML Output .
   .It Fl T Ns Cm lint
 Parse only: produce no output.  Parse only: produce no output.
   Implies
   .Fl W Ns Cm warning .
   .It Fl T Ns Cm locale
   Encode output using the current locale.
   See
   .Sx Locale Output .
   .It Fl T Ns Cm man
   Produce
   .Xr man 7
   format output.
   See
   .Sx Man Output .
   .It Fl T Ns Cm pdf
   Produce PDF output.
   See
   .Sx PDF Output .
   .It Fl T Ns Cm ps
   Produce PostScript output.
   See
   .Sx PostScript Output .
   .It Fl T Ns Cm tree
   Produce an indented parse tree.
   .It Fl T Ns Cm utf8
   Encode output in the UTF\-8 multi-byte format.
   See
   .Sx UTF\-8 Output .
   .It Fl T Ns Cm xhtml
   Produce strict CSS1/XHTML-1.0 output.
   See
   .Sx XHTML Output .
 .El  .El
 .Pp  .Pp
 If multiple input files are specified, these will be processed by the  If multiple input files are specified, these will be processed by the
 corresponding filter in-order.  corresponding filter in-order.
 .\" SUB-SECTION  .Ss ASCII Output
 .Ss Compiler Options  Output produced by
 Default compiler behaviour may be overriden with the  .Fl T Ns Cm ascii ,
 .Fl f  which is the default, is rendered in standard 7-bit ASCII documented in
 flag.  .Xr ascii 7 .
   .Pp
   Font styles are applied by using back-spaced encoding such that an
   underlined character
   .Sq c
   is rendered as
   .Sq _ Ns \e[bs] Ns c ,
   where
   .Sq \e[bs]
   is the back-space character number 8.
   Emboldened characters are rendered as
   .Sq c Ns \e[bs] Ns c .
   .Pp
   The special characters documented in
   .Xr mandoc_char 7
   are rendered best-effort in an ASCII equivalent.
   If no equivalent is found,
   .Sq \&?
   is used instead.
   .Pp
   Output width is limited to 78 visible columns unless literal input lines
   exceed this limit.
   .Pp
   The following
   .Fl O
   arguments are accepted:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl f Ns Ar ign-scope  .It Cm indent Ns = Ns Ar indent
 When rewinding the scope of a block macro, forces the compiler to ignore  The left margin for normal text is set to
 scope violations.  This can seriously mangle the resulting tree.  .Ar indent
 .Pq mdoc only  blank characters instead of the default of five for
 .It Fl f Ns Ar no-ign-escape  .Xr mdoc 7
 Don't ignore invalid escape sequences.  and seven for
 .It Fl f Ns Ar no-ign-macro  .Xr man 7 .
 Do not ignore unknown macros at the start of input lines.  Increasing this is not recommended; it may result in degraded formatting,
 .It Fl f Ns Ar no-ign-chars  for example overfull lines or ugly line breaks.
 Do not ignore disallowed characters.  .It Cm width Ns = Ns Ar width
 .It Fl f Ns Ar strict  The output width is set to
 Implies  .Ar width ,
 .Fl f Ns Ar no-ign-escape ,  which will normalise to \(>=60.
 .Fl f Ns Ar no-ign-macro  .El
   .Ss HTML Output
   Output produced by
   .Fl T Ns Cm html
   conforms to HTML-4.01 strict.
   .Pp
   The
   .Pa example.style.css
   file documents style-sheet classes available for customising output.
   If a style-sheet is not specified with
   .Fl O Ns Ar style ,
   .Fl T Ns Cm html
   defaults to simple output readable in any graphical or text-based web
   browser.
   .Pp
   Special characters are rendered in decimal-encoded UTF\-8.
   .Pp
   The following
   .Fl O
   arguments are accepted:
   .Bl -tag -width Ds
   .It Cm fragment
   Omit the
   .Aq !DOCTYPE
   declaration and the
   .Aq html ,
   .Aq head ,
 and  and
 .Fl f Ns Ar no-ign-chars .  .Aq body
 .It Fl f Ns Ar ign-errors  elements and only emit the subtree below the
 Don't halt when encountering parse errors.  Useful with  .Aq body
 .Fl T Ns Ar lint  element.
 over a large set of manuals passed on the command line.  The
   .Cm style
   argument will be ignored.
   This is useful when embedding manual content within existing documents.
   .It Cm includes Ns = Ns Ar fmt
   The string
   .Ar fmt ,
   for example,
   .Ar ../src/%I.html ,
   is used as a template for linked header files (usually via the
   .Sq \&In
   macro).
   Instances of
   .Sq \&%I
   are replaced with the include filename.
   The default is not to present a
   hyperlink.
   .It Cm man Ns = Ns Ar fmt
   The string
   .Ar fmt ,
   for example,
   .Ar ../html%S/%N.%S.html ,
   is used as a template for linked manuals (usually via the
   .Sq \&Xr
   macro).
   Instances of
   .Sq \&%N
   and
   .Sq %S
   are replaced with the linked manual's name and section, respectively.
   If no section is included, section 1 is assumed.
   The default is not to
   present a hyperlink.
   .It Cm style Ns = Ns Ar style.css
   The file
   .Ar style.css
   is used for an external style-sheet.
   This must be a valid absolute or
   relative URI.
 .El  .El
 .\" PARAGRAPH  .Ss Locale Output
   Locale-depending output encoding is triggered with
   .Fl T Ns Cm locale .
   This option is not available on all systems: systems without locale
   support, or those whose internal representation is not natively UCS-4,
   will fall back to
   .Fl T Ns Cm ascii .
   See
   .Sx ASCII Output
   for font style specification and available command-line arguments.
   .Ss Man Output
   Translate input format into
   .Xr man 7
   output format.
   This is useful for distributing manual sources to legancy systems
   lacking
   .Xr mdoc 7
   formatters.
 .Pp  .Pp
 As with the  If
   .Xr mdoc 7
   is passed as input, it is translated into
   .Xr man 7 .
   If the input format is
   .Xr man 7 ,
   the input is copied to the output, expanding any
   .Xr roff 7
   .Sq so
   requests.
   The parser is also run, and as usual, the
 .Fl W  .Fl W
 flag, multiple  level controls which
 .Fl f  .Sx DIAGNOSTICS
 options may be grouped and delimited with a comma.  Using  are displayed before copying the input to the output.
 .Fl f Ns Ar ign-scope,no-ign-escape ,  .Ss PDF Output
 for example, will try to ignore scope and not ignore character-escape  PDF-1.1 output may be generated by
 errors.  .Fl T Ns Cm pdf .
 .\" SECTION  See
   .Sx PostScript Output
   for
   .Fl O
   arguments and defaults.
   .Ss PostScript Output
   PostScript
   .Qq Adobe-3.0
   Level-2 pages may be generated by
   .Fl T Ns Cm ps .
   Output pages default to letter sized and are rendered in the Times font
   family, 11-point.
   Margins are calculated as 1/9 the page length and width.
   Line-height is 1.4m.
   .Pp
   Special characters are rendered as in
   .Sx ASCII Output .
   .Pp
   The following
   .Fl O
   arguments are accepted:
   .Bl -tag -width Ds
   .It Cm paper Ns = Ns Ar name
   The paper size
   .Ar name
   may be one of
   .Ar a3 ,
   .Ar a4 ,
   .Ar a5 ,
   .Ar legal ,
   or
   .Ar letter .
   You may also manually specify dimensions as
   .Ar NNxNN ,
   width by height in millimetres.
   If an unknown value is encountered,
   .Ar letter
   is used.
   .El
   .Ss UTF\-8 Output
   Use
   .Fl T Ns Cm utf8
   to force a UTF\-8 locale.
   See
   .Sx Locale Output
   for details and options.
   .Ss XHTML Output
   Output produced by
   .Fl T Ns Cm xhtml
   conforms to XHTML-1.0 strict.
   .Pp
   See
   .Sx HTML Output
   for details; beyond generating XHTML tags instead of HTML tags, these
   output modes are identical.
   .Sh EXIT STATUS
   The
   .Nm
   utility exits with one of the following values, controlled by the message
   .Ar level
   associated with the
   .Fl W
   option:
   .Pp
   .Bl -tag -width Ds -compact
   .It 0
   No warnings or errors occurred, or those that did were ignored because
   they were lower than the requested
   .Ar level .
   .It 2
   At least one warning occurred, but no error, and
   .Fl W Ns Cm warning
   was specified.
   .It 3
   At least one parsing error occurred, but no fatal error, and
   .Fl W Ns Cm error
   or
   .Fl W Ns Cm warning
   was specified.
   .It 4
   A fatal parsing error occurred.
   .It 5
   Invalid command line arguments were specified.
   No input files have been read.
   .It 6
   An operating system error occurred, for example memory exhaustion or an
   error accessing input files.
   Such errors cause
   .Nm
   to exit at once, possibly in the middle of parsing or formatting a file.
   .El
   .Pp
   Note that selecting
   .Fl T Ns Cm lint
   output mode implies
   .Fl W Ns Cm warning .
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .\" PARAGRAPH  
 .Pp  .Pp
 .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less  .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less  .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .\" PARAGRAPH  
 .Pp  .Pp
   To produce HTML manuals with
   .Ar style.css
   as the style-sheet:
   .Pp
   .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
   .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .\" PARAGRAPH  
 .Pp  .Pp
 .Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`  .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
 .\" SECTION  .Pp
   To produce a series of PostScript manuals for A4 paper:
   .Pp
   .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
   .Pp
   Convert a modern
   .Xr mdoc 7
   manual to the older
   .Xr man 7
   format, for use on systems lacking an
   .Xr mdoc 7
   parser:
   .Pp
   .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
   .Sh DIAGNOSTICS
   Standard error messages reporting parsing errors are prefixed by
   .Pp
   .Sm off
   .D1 Ar file : line : column : \ level :
   .Sm on
   .Pp
   where the fields have the following meanings:
   .Bl -tag -width "column"
   .It Ar file
   The name of the input file causing the message.
   .It Ar line
   The line number in that input file.
   Line numbering starts at 1.
   .It Ar column
   The column number in that input file.
   Column numbering starts at 1.
   If the issue is caused by a word, the column number usually
   points to the first character of the word.
   .It Ar level
   The message level, printed in capital letters.
   .El
   .Pp
   Message levels have the following meanings:
   .Bl -tag -width "warning"
   .It Cm fatal
   The parser is unable to parse a given input file at all.
   No formatted output is produced from that input file.
   .It Cm error
   An input file contains syntax that cannot be safely interpreted,
   either because it is invalid or because
   .Nm
   does not implement it yet.
   By discarding part of the input or inserting missing tokens,
   the parser is able to continue, and the error does not prevent
   generation of formatted output, but typically, preparing that
   output involves information loss, broken document structure
   or unintended formatting.
   .It Cm warning
   An input file uses obsolete, discouraged or non-portable syntax.
   All the same, the meaning of the input is unambiguous and a correct
   rendering can be produced.
   Documents causing warnings may render poorly when using other
   formatting tools instead of
   .Nm .
   .El
   .Pp
   Messages of the
   .Cm warning
   and
   .Cm error
   levels are hidden unless their level, or a lower level, is requested using a
   .Fl W
   option or
   .Fl T Ns Cm lint
   output mode.
   .Pp
   The
   .Nm
   utility may also print messages related to invalid command line arguments
   or operating system errors, for example when memory is exhausted or
   input files cannot be read.
   Such messages do not carry the prefix described above.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section summarises  This section summarises
 .Nm  .Nm
 compatibility with  compatibility with GNU troff.
 .Xr groff 1 .  Each input and output format is separately noted.
 .Pp  .Ss ASCII Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .\" LIST-ITEM  
 .It  .It
 The  Unrenderable unicode codepoints specified with
 .Sq \e~  .Sq \e[uNNNN]
 special character doesn't produce expected behaviour.  escapes are printed as
 .\" LIST-ITEM  .Sq \&?
   in mandoc.
   In GNU troff, these raise an error.
 .It  .It
 In  The
 .Xr groff 1 ,  .Sq \&Bd \-literal
 the  and
   .Sq \&Bd \-unfilled
   macros of
   .Xr mdoc 7
   in
   .Fl T Ns Cm ascii
   are synonyms, as are \-filled and \-ragged.
   .It
   In historic GNU troff, the
 .Sq \&Pa  .Sq \&Pa
 macro does not underline when under a  .Xr mdoc 7
 .Sq \&It .  macro does not underline when scoped under an
   .Sq \&It
   in the FILES section.
 This behaves correctly in  This behaves correctly in
 .Nm .  .Nm .
 .\" LIST-ITEM  
 .It  .It
 A list or display following  A list or display following the
 .Sq \&Ss  .Sq \&Ss
   .Xr mdoc 7
   macro in
   .Fl T Ns Cm ascii
 does not assert a prior vertical break, just as it doesn't with  does not assert a prior vertical break, just as it doesn't with
 .Sq \&Sh .  .Sq \&Sh .
 .It  .It
 The \-literal and \-unfilled  The
 .Sq \&Bd  .Sq \&na
 displays types are synonyms, as are \-filled and \-ragged.  .Xr man 7
 .\" LIST-ITEM  macro in
   .Fl T Ns Cm ascii
   has no effect.
 .It  .It
 Words aren't hyphenated.  Words aren't hyphenated.
 .\" LIST-ITEM  .El
   .Ss HTML/XHTML Compatibility
   .Bl -bullet -compact
 .It  .It
 In normal mode (not a literal block), blocks of spaces aren't preserved,  The
 so double spaces following sentence closure are reduced to a single space.  .Sq \efP
   escape will revert the font to the previous
   .Sq \ef
   escape, not to the last rendered decoration, which is now dictated by
   CSS instead of hard-coded.
   It also will not span past the current scope,
   for the same reason.
   Note that in
   .Sx ASCII Output
   mode, this will work fine.
   .It
   The
   .Xr mdoc 7
   .Sq \&Bl \-hang
   and
   .Sq \&Bl \-tag
   list types render similarly (no break following overreached left-hand
   side) due to the expressive constraints of HTML.
   .It
   The
   .Xr man 7
   .Sq IP
   and
   .Sq TP
   lists render similarly.
 .El  .El
 .\" SECTION  
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr eqn 7 ,
   .Xr man 7 ,
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr man 7  .Xr roff 7 ,
 .\" SECTION  .Xr tbl 7
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons ,
   .Mt kristaps@bsd.lv .
   .Sh CAVEATS
   In
   .Fl T Ns Cm html
   and
   .Fl T Ns Cm xhtml ,
   the maximum size of an element attribute is determined by
   .Dv BUFSIZ ,
   which is usually 1024 bytes.
   Be aware of this when setting long link
   formats such as
   .Fl O Ns Cm style Ns = Ns Ar really/long/link .
   .Pp
   Nesting elements within next-line element scopes of
   .Fl m Ns Cm an ,
   such as
   .Sq br
   within an empty
   .Sq B ,
   will confuse
   .Fl T Ns Cm html
   and
   .Fl T Ns Cm xhtml
   and cause them to forget the formatting of the prior next-line scope.
   .Pp
   The
   .Sq \(aq
   control character is an alias for the standard macro control character
   and does not emit a line-break as stipulated in GNU troff.
Legend:
Removed from v.1.29  
changed lines
  Added in v.1.100
CVSweb