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

Diff for /mandoc/mandoc.1 between version 1.58 and 1.99

version 1.58, 2010/04/12 19:27:22 version 1.99, 2011/11/13 14:50:54
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
 .  
 .  
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display UNIX manuals  .Nd format and display UNIX manuals
 .  
 .  
 .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 O Ns Ar option  .Op Fl O Ns Ar option
 .Op Fl T Ns Ar output  .Op Fl T Ns Ar output
 .Op Fl W Ns Ar err  .Op Fl W Ns Ar level
 .Op Ar file...  .Op Ar
 .  
 .  
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
Line 42  utility formats
Line 35  utility formats
 .Ux  .Ux
 manual pages for display.  manual pages for display.
 The arguments are as follows:  The arguments are as follows:
 .  
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl f Ns Ar option  
 Comma-separated compiler options.  
 See  
 .Sx Compiler Options  
 for details.  
 .  
 .It Fl m Ns Ar format  .It Fl m Ns Ar format
 Input format.  Input format.
 See  See
Line 57  See
Line 43  See
 for available formats.  for available formats.
 Defaults to  Defaults to
 .Fl m Ns Cm andoc .  .Fl m Ns Cm andoc .
 .  
 .It Fl O Ns Ar option  .It Fl O Ns Ar option
 Comma-separated output options.  Comma-separated output options.
 See  
 .Sx Output Options  
 for details.  
 .  
 .It Fl T Ns Ar output  .It Fl T Ns Ar output
 Output format.  Output format.
 See  See
Line 71  See
Line 52  See
 for available formats.  for available formats.
 Defaults to  Defaults to
 .Fl T Ns Cm ascii .  .Fl T Ns Cm ascii .
 .  
 .It Fl V  .It Fl V
 Print version and exit.  Print version and exit.
 .  .It Fl W Ns Ar level
 .It Fl W Ns Ar err  Specify the minimum message
 Comma-separated warning options.  .Ar level
 Use  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  .Fl W Ns Cm all
 to print warnings,  is an alias for
 .Fl W Ns Cm error  .Fl W Ns Cm warning .
 for warnings to be considered errors and cause utility  See
 termination.  .Sx EXIT STATUS
 Multiple  and
 .Fl W  .Sx DIAGNOSTICS
 arguments may be comma-separated, such as  for details.
 .Fl W Ns Cm error , Ns Cm all .  .Pp
 .  The special option
   .Fl W Ns Cm stop
   tells
   .Nm
   to exit after parsing a file that causes warnings or errors of at least
   the requested level.
   No formatted output will be produced from that file.
   If both a
   .Ar level
   and
   .Cm stop
   are requested, they can be joined with a comma, for example
   .Fl W Ns Cm error , Ns Cm stop .
 .It Ar file  .It Ar file
 Read input from zero or more files.  Read input from zero or more files.
 If unspecified, reads from stdin.  If unspecified, reads from stdin.
Line 95  If multiple files are specified,
Line 96  If multiple files are specified,
 .Nm  .Nm
 will halt with the first failed parse.  will halt with the first failed parse.
 .El  .El
 .  
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
Line 108  text from stdin, implying
Line 108  text from stdin, implying
 and produces  and produces
 .Fl T Ns Cm ascii  .Fl T Ns Cm ascii
 output.  output.
 .  
 .Pp  
 .Ex -std mandoc  
 .  
 .  
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 132  format is
Line 127  format is
 recommended;  recommended;
 .Xr man 7  .Xr man 7
 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 Cm andoc ,  .Fl m Ns Cm andoc ,
Line 146  the
Line 140  the
 parser is used; otherwise, the  parser is used; otherwise, the
 .Xr man 7  .Xr man 7
 parser is used.  parser is used.
 .  
 .Pp  .Pp
 If multiple  If multiple
 files are specified with  files are specified with
Line 158  specified and
Line 151  specified and
 or  or
 .Fl m Ns Cm an  .Fl m Ns Cm an
 is specified, then this format is used exclusively.  is specified, then this format is used exclusively.
 .  
 .  
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments (see  arguments, which correspond to output modes:
 .Sx OUTPUT ) :  .Bl -tag -width "-Tlocale"
 .  
 .Bl -tag -width Ds  
 .It Fl T Ns Cm 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.
 See  See
 .Sx ASCII Output .  .Sx ASCII Output .
 .  
 .It Fl T Ns Cm html  .It Fl T Ns Cm html
 Produce strict HTML-4.01 output, with a sane default style.  Produce strict CSS1/HTML-4.01 output.
 See  See
 .Sx HTML Output .  .Sx HTML Output .
 .  
 .It Fl T Ns Cm lint  .It Fl T Ns Cm lint
 Parse only: produce no output.  Parse only: produce no output.
 Implies  Implies
 .Fl W Ns Cm all  .Fl W Ns Cm warning .
 and  .It Fl T Ns Cm locale
 .Fl f Ns Cm strict .  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  .It Fl T Ns Cm tree
 Produce an indented parse 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  .It Fl T Ns Cm xhtml
 Produce strict XHTML-1.0 output, with a sane default style.  Produce strict CSS1/XHTML-1.0 output.
 See  See
 .Sx XHTML Output .  .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.
 .  .Ss ASCII Output
 .  Output produced by
 .Ss Compiler Options  .Fl T Ns Cm ascii ,
 Default compiler behaviour may be overridden with the  which is the default, is rendered in standard 7-bit ASCII documented in
 .Fl f  .Xr ascii 7 .
 flag.  .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 Cm ign-errors  .It Cm indent Ns = Ns Ar indent
 When parsing multiple files, don't halt when one errors out.  The left margin for normal text is set to
 Useful with  .Ar indent
 .Fl T Ns Cm lint  blank characters instead of the default of five for
 over a large set of manuals passed on the command line.  .Xr mdoc 7
 .  and seven for
 .It Fl f Ns Cm ign-escape  .Xr man 7 .
 Ignore invalid escape sequences.  Increasing this is not recommended; it may result in degraded formatting,
 This is the default, but the option can be used to override an earlier  for example overfull lines or ugly line breaks.
 .Fl f Ns Cm strict .  .It Cm width Ns = Ns Ar width
 .  The output width is set to
 .It Fl f Ns Cm ign-scope  .Ar width ,
 When rewinding the scope of a block macro, forces the compiler to ignore  which will normalise to \(>=60.
 scope violations.  
 This can seriously mangle the resulting tree.  
 .Pq mdoc only  
 .  
 .It Fl f Ns Cm no-ign-chars  
 Do not ignore disallowed characters.  
 .  
 .It Fl f Ns Cm no-ign-escape  
 Do not ignore invalid escape sequences.  
 .  
 .It Fl f Ns Cm no-ign-macro  
 Do not ignore unknown macros at the start of input lines.  
 .  
 .It Fl f Ns Cm strict  
 Implies  
 .Fl f Ns Cm no-ign-escape ,  
 .Fl f Ns Cm no-ign-macro ,  
 and  
 .Fl f Ns Cm no-ign-chars .  
 .El  .El
 .  .Ss HTML Output
 .  Output produced by
 .Ss Output Options  .Fl T Ns Cm html
 For the time being, only  conforms to HTML-4.01 strict.
 .Fl T Ns Ar html  .Pp
 and  The
 .Fl T Ns Ar xhtml  .Pa example.style.css
 accept output options:  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  .Bl -tag -width Ds
 .It Fl O Ns Cm includes Ns = Ns Ar fmt  .It Cm fragment
   Omit the
   .Aq !DOCTYPE
   declaration and the
   .Aq html ,
   .Aq head ,
   and
   .Aq body
   elements and only emit the subtree below the
   .Aq body
   element.
   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  The string
 .Ar fmt ,  .Ar fmt ,
 for example,  for example,
Line 263  Instances of
Line 296  Instances of
 are replaced with the include filename.  are replaced with the include filename.
 The default is not to present a  The default is not to present a
 hyperlink.  hyperlink.
 .It Fl O Ns Cm man Ns = Ns Ar fmt  .It Cm man Ns = Ns Ar fmt
 The string  The string
 .Ar fmt ,  .Ar fmt ,
 for example,  for example,
Line 279  are replaced with the linked manual's name and section
Line 312  are replaced with the linked manual's name and section
 If no section is included, section 1 is assumed.  If no section is included, section 1 is assumed.
 The default is not to  The default is not to
 present a hyperlink.  present a hyperlink.
 .It Fl O Ns Cm style Ns = Ns Ar style.css  .It Cm style Ns = Ns Ar style.css
 The file  The file
 .Ar style.css  .Ar style.css
 is used for an external style-sheet.  is used for an external style-sheet.
 This must be a valid absolute or  This must be a valid absolute or
 relative URI.  relative URI.
 .El  .El
 .  .Ss Locale Output
 .  Locale-depending output encoding is triggered with
 .Sh OUTPUT  .Fl T Ns Cm locale .
 This section documents output details of  This option is not available on all systems: systems without locale
 .Nm .  support, or those whose internal representation is not natively UCS-4,
 In general, output conforms to the traditional manual style of a header,  will fall back to
 a body composed of sections and sub-sections, and a footer.  .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
 The text style of output characters (non-macro characters, punctuation,  If
 and white-space) is dictated by context.  
 .Pp  
 White-space is generally stripped from input.  
 This can be changed with  
 character escapes (specified in  
 .Xr mandoc_char 7 )  
 or literal modes (specified in  
 .Xr mdoc 7  .Xr mdoc 7
 and  is passed as input, it is translated into
 .Xr man 7 ) .  .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
   level controls which
   .Sx DIAGNOSTICS
   are displayed before copying the input to the output.
   .Ss PDF Output
   PDF-1.1 output may be generated by
   .Fl T Ns Cm pdf .
   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  .Pp
 If non-macro punctuation is set apart from words, such as in the phrase  Special characters are rendered as in
 .Dq to be \&, or not to be ,  .Sx ASCII Output .
 it's processed by  
 .Nm ,  
 regardless of output format, according to the following rules:  opening  
 punctuation  
 .Po  
 .Sq \&( ,  
 .Sq \&[ ,  
 and  
 .Sq \&{  
 .Pc  
 is not followed by a space; closing punctuation  
 .Po  
 .Sq \&. ,  
 .Sq \&, ,  
 .Sq \&; ,  
 .Sq \&: ,  
 .Sq \&? ,  
 .Sq \&! ,  
 .Sq \&) ,  
 .Sq \&]  
 and  
 .Sq \&}  
 .Pc  
 is not preceded by white-space.  
 .  
 .Pp  .Pp
 If the input is  The following
 .Xr mdoc 7 ,  .Fl O
 however, these rules are also applied to macro arguments when appropriate.  arguments are accepted:
 .  .Bl -tag -width Ds
 .  .It Cm paper Ns = Ns Ar name
 .Ss ASCII Output  The paper size
 Output produced by  .Ar name
 .Fl T Ns Cm ascii ,  may be one of
 which is the default, is rendered in standard 7-bit ASCII documented in  .Ar a3 ,
 .Xr ascii 7 .  .Ar a4 ,
 .Pp  .Ar a5 ,
 Font styles are applied by using back-spaced encoding such that an  .Ar legal ,
 underlined character  or
 .Sq c  .Ar letter .
 is rendered as  You may also manually specify dimensions as
 .Sq _ Ns \e[bs] Ns c ,  .Ar NNxNN ,
 where  width by height in millimetres.
 .Sq \e[bs]  If an unknown value is encountered,
 is the back-space character number 8.  .Ar letter
 Emboldened characters are rendered as  is used.
 .Sq c Ns \e[bs] Ns c .  .El
 .Pp  .Ss UTF\-8 Output
 The special characters documented in  Use
 .Xr mandoc_char 7  .Fl T Ns Cm utf8
 are rendered best-effort in an ASCII equivalent.  to force a UTF\-8 locale.
 .Pp  See
 Output width is limited to 78 visible columns unless literal input lines  .Sx Locale Output
 exceed this limit.  for details and options.
 .  
 .  
 .Ss HTML Output  
 Output produced by  
 .Fl T Ns Cm html  
 conforms to HTML-4.01 strict.  
 .Pp  
 Font styles and page structure are applied using CSS2.  
 By default, no font style is applied to any text,  
 although CSS2 is hard-coded to format  
 the basic structure of output.  
 .Pp  
 The  
 .Pa example.style.css  
 file documents the range of styles applied to output and, if used, will  
 cause rendered documents to appear as they do in  
 .Fl T Ns Cm ascii .  
 .Pp  
 Special characters are rendered in decimal-encoded UTF-8.  
 .  
 .  
 .Ss XHTML Output  .Ss XHTML Output
 Output produced by  Output produced by
 .Fl T Ns Cm xhtml  .Fl T Ns Cm xhtml
Line 392  See
Line 411  See
 .Sx HTML Output  .Sx HTML Output
 for details; beyond generating XHTML tags instead of HTML tags, these  for details; beyond generating XHTML tags instead of HTML tags, these
 output modes are identical.  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:
 .  
 .Pp  .Pp
 .D1 $ mandoc \-Wall,error \-fstrict mandoc.1 2\*(Gt&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
 .  
 .Pp  .Pp
 To produce HTML manuals with  To produce HTML manuals with
 .Ar style.css  .Ar style.css
 as the style-sheet:  as the style-sheet:
 .Pp  .Pp
 .D1 $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html  .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
 .Pp  .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .  
 .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]`
 .  .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.  Each input and output format is separately noted.
 .  
 .  
 .Ss ASCII Compatibility  .Ss ASCII Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 The  Unrenderable unicode codepoints specified with
 .Sq \e~  .Sq \e[uNNNN]
 special character doesn't produce expected behaviour in  escapes are printed as
 .Fl T Ns Cm ascii .  .Sq \&?
 .  in mandoc.
   In GNU troff, these raise an error.
 .It  .It
 The  The
 .Sq \&Bd \-literal  .Sq \&Bd \-literal
Line 440  macros of
Line 568  macros of
 in  in
 .Fl T Ns Cm ascii  .Fl T Ns Cm ascii
 are synonyms, as are \-filled and \-ragged.  are synonyms, as are \-filled and \-ragged.
 .  
 .It  .It
 In  In historic GNU troff, the
 .Xr groff 1 ,  
 the  
 .Sq \&Pa  .Sq \&Pa
 .Xr mdoc 7  .Xr mdoc 7
 macro does not underline when scoped under an  macro does not underline when scoped under an
Line 452  macro does not underline when scoped under an
Line 577  macro does not underline when scoped under an
 in the FILES section.  in the FILES section.
 This behaves correctly in  This behaves correctly in
 .Nm .  .Nm .
 .  
 .It  .It
 A list or display following the  A list or display following the
 .Sq \&Ss  .Sq \&Ss
Line 461  macro in
Line 585  macro in
 .Fl T Ns Cm ascii  .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  The
 .Sq \&na  .Sq \&na
Line 469  The
Line 592  The
 macro in  macro in
 .Fl T Ns Cm ascii  .Fl T Ns Cm ascii
 has no effect.  has no effect.
 .  
 .It  .It
 Words aren't hyphenated.  Words aren't hyphenated.
 .  
 .It  
 In normal mode (not a literal block), blocks of spaces aren't preserved,  
 so double spaces following sentence closure are reduced to a single space;  
 .Xr groff 1  
 retains spaces.  
 .  
 .It  
 Sentences are unilaterally monospaced.  
 .El  .El
 .  
 .  
 .Ss HTML/XHTML Compatibility  .Ss HTML/XHTML Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
Line 506  and
Line 617  and
 .Sq \&Bl \-tag  .Sq \&Bl \-tag
 list types render similarly (no break following overreached left-hand  list types render similarly (no break following overreached left-hand
 side) due to the expressive constraints of HTML.  side) due to the expressive constraints of HTML.
 .  
 .It  .It
 The  The
 .Xr man 7  .Xr man 7
Line 515  and
Line 625  and
 .Sq TP  .Sq TP
 lists render similarly.  lists render similarly.
 .El  .El
 .  
 .  
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr eqn 7 ,
 .Xr man 7 ,  .Xr man 7 ,
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr mdoc 7  .Xr mdoc 7 ,
 .  .Xr roff 7 ,
   .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  .Sh CAVEATS
 The  
 .Fl T Ns Cm html  
 and  
 .Fl T Ns Cm xhtml  
 CSS2 styling used for  
 .Fl m Ns Cm doc  
 input lists does not render properly in older browsers, such as Internet  
 Explorer 6 and earlier.  
 .  
 .Pp  
 In  In
 .Fl T Ns Cm html  .Fl T Ns Cm html
 and  and
Line 550  which is usually 1024 bytes.
Line 649  which is usually 1024 bytes.
 Be aware of this when setting long link  Be aware of this when setting long link
 formats such as  formats such as
 .Fl O Ns Cm style Ns = Ns Ar really/long/link .  .Fl O Ns Cm style Ns = Ns Ar really/long/link .
 .  
 .Pp  .Pp
 The  
 .Fl T Ns Cm html  
 and  
 .Fl T Ns Cm xhtml  
 output modes don't render the  
 .Sq \es  
 font size escape documented in  
 .Xr mdoc 7  
 and  
 .Xr man 7 .  
 .  
 .Pp  
 Nesting elements within next-line element scopes of  Nesting elements within next-line element scopes of
 .Fl m Ns Cm an ,  .Fl m Ns Cm an ,
 such as  such as
Line 575  will confuse
Line 661  will confuse
 and  and
 .Fl T Ns Cm xhtml  .Fl T Ns Cm xhtml
 and cause them to forget the formatting of the prior next-line scope.  and cause them to forget the formatting of the prior next-line scope.
 .  
 .Pp  .Pp
 The  
 .Sq i  
 macro in  
 .Fl m Ns Cm an  
 should italicise all subsequent text if a line argument is not provided.  
 This behaviour is not implemented.  
 .  
 The  The
 .Sq \(aq  .Sq \(aq
 control character is an alias for the standard macro control character  control character is an alias for the standard macro control character
Legend:
Removed from v.1.58  
changed lines
  Added in v.1.99
CVSweb