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

Diff for /mandoc/mandoc.1 between version 1.47 and 1.48

version 1.47, 2009/11/16 08:46:59 version 1.48, 2009/11/16 09:52:47
Line 96  or
Line 96  or
 .Xr man 7  .Xr man 7
 text from stdin, implying  text from stdin, implying
 .Fl m Ns Ar andoc ,  .Fl m Ns Ar andoc ,
 and prints 78-column backspace-encoded output to stdout as if  and produces
 .Fl T Ns Ar ascii  .Fl T Ns Ar ascii
 were provided.  output.
 .  .
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .  .
 .  .
 .Ss Punctuation and Spacing  
 If punctuation is set apart from words, such as in the phrase  
 .Dq to be \&, or not to be ,  
 it's processed by  
 .Nm  
 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 whitespace.  
 .  
 .Pp  
 If the input is  
 .Xr mdoc 7 ,  
 these rules are also applied to macro arguments when appropriate.  
 .  
 .Pp  
 White-space, in non-literal (normal) mode, is stripped from input and  
 replaced on output by a single space.  Thus, if you wish to preserve multiple  
 spaces, they must be space-escaped or used in a literal display mode, e.g.,  
 .Sq \&Bd \-literal  
 in  
 .Xr mdoc 7 .  
 .  
 .  
 .Ss Input Formats  .Ss Input Formats
 The  The
 .Nm  .Nm
Line 195  The
Line 154  The
 .Nm  .Nm
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments:  arguments (see
   .Sx OUTPUT ) :
 .  .
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl T Ns Ar ascii  .It Fl T Ns Ar ascii
 Produce 7-bit ASCII output, backspace-encoded for bold and underline  Produce 7-bit ASCII output, backspace-encoded for bold and underline
 styles.  This is the default.  styles.  This is the default.  See
   .Sx ASCII Output .
 .  .
 .It Fl T Ns Ar html  .It Fl T Ns Ar html
 Produce strict HTML-4.01 output, with a sane default style.  Produce strict HTML-4.01 output, with a sane default style.  See
   .Sx HTML Output .
 .  .
 .It Fl T Ns Ar tree  .It Fl T Ns Ar tree
 Produce an indented parse tree.  Produce an indented parse tree.
Line 255  Don't halt when encountering parse errors.  Useful wit
Line 217  Don't halt when encountering parse errors.  Useful wit
 over a large set of manuals passed on the command line.  over a large set of manuals passed on the command line.
 .El  .El
 .  .
   .
 .Ss Output Options  .Ss Output Options
 For the time being, only  For the time being, only
 .Fl T Ns Ar html  .Fl T Ns Ar html
 is the only mode with output options:  accepts output options:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl O Ns Ar style=style.css  .It Fl O Ns Ar style=style.css
 The file  The file
Line 292  If no section is included, section 1 is assumed.  The 
Line 255  If no section is included, section 1 is assumed.  The 
 present a hyperlink.  present a hyperlink.
 .El  .El
 .  .
   .
   .Sh OUTPUT
   This section documents output details of
   .Nm .
   In general, output conforms to the traditional manual style of a header,
   a body composed of sections and sub-sections, and a footer.
   .Pp
   The text style of output characters (non-macro characters, punctuation,
   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
   and
   .Xr man 7 ) .
   .Pp
   If non-macro punctuation is set apart from words, such as in the phrase
   .Dq to be \&, or not to be ,
   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
   If the input is
   .Xr mdoc 7 ,
   however, these rules are also applied to macro arguments when appropriate.
   .
   .
   .Ss ASCII Output
   Output produced by
   .Fl T Ns Ar ascii ,
   which is the default, is rendered in standard 7-bit ASCII documented in
   .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.
   .Pp
   Output width is limited to 78 visible columns unless literal input lines
   exceed this limit.
   .
   .
   .Ss HTML Output
   Output produced by
   .Fl T Ns Ar html
   comforms 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 Ar ascii .
   .Pp
   Special characters are rendered in decimal-encoded UTF-8.
   .
   .
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .  .
Line 304  To produce HTML manuals with
Line 360  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 > mdoc.7.html  .D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > mdoc.7.html
 .Pp  .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .  .
Line 320  compatibility with
Line 376  compatibility with
 Each input and output format is separately noted.  Each input and output format is separately noted.
 .  .
 .  .
 .Ss ASCII output  .Ss ASCII Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 The  The
Line 380  retains spaces.
Line 436  retains spaces.
 Sentences are unilaterally monospaced.  Sentences are unilaterally monospaced.
 .El  .El
 .  .
 .Ss HTML output  .
   .Ss HTML Compatibility
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 The  The
Line 409  and
Line 466  and
 .Sq TP  .Sq TP
 lists render similarly.  lists render similarly.
 .El  .El
 .\" SECTION  .
   .
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
Line 421  The
Line 479  The
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .  .
   .
 .Sh CAVEATS  .Sh CAVEATS
   The
   .Fl T Ns Ar html
   CSS2 styling used for
   .Fl m Ns Ar doc
   input lists does not render properly in brain-dead browsers, such as
   Internet Explorer 6 and earlier.
   .Pp
 In  In
 .Fl T Ns Ar html ,  .Fl T Ns Ar html ,
 the maximum size of an element attribute is determined by  the maximum size of an element attribute is determined by
 .Dv BUFSIZ ,  .Dv BUFSIZ ,
 which is usually 1024 bytes.  Be aware of this when setting long link  which is usually 1024 bytes.  Be aware of this when setting long link
 formats with  formats, e.g.,
 .Fl O Ns Ar man=fmt .  .Fl O Ns Ar style=really/long/link .
 .Pp  .Pp
 The  The
 .Fl T Ns Ar html  .Fl T Ns Ar html
 utility doesn't yet render the  output mode doesn't render the
 .Sq \es  .Sq \es
 font size escape documented in  font size escape documented in
 .Xr mdoc 7  .Xr mdoc 7

Legend:
Removed from v.1.47  
changed lines
  Added in v.1.48

CVSweb