html2textrc.4

将HTML转换为TXT文件的程序

' $Id: html2textrc.4,v 1.10 1999/12/20 19:40:37 arno Exp $
.TH HTML2TEXTRC 4 "November 1999" "Version 1.2.1"
.SH NAME
html2textrc \- formatting properties file for html2text(1)
.SH DESCRIPTION
The
.B html2textrc
file defines a set of formatting properties used by the
.B html2text(1)
utility. Each line of the
.B html2textrc
file is either a blank line (contains only white-space characters -- ignored),
or a comment line (first non-space character is "#" or "!" -- ignored), or it
specifies one property.
.PP
A property definition consists of
.TP
(A)
Optional leading space
.TP
(B)
The property key (a sequence of non-space characters except "=" and ":")
.TP
(C)
An optional "=" or ":"
.TP
(D)
Optional space
.TP
(E)
The property value
.PP
Both the property key and the property value can contain C-like escape
sequences to mask meta characters.
.PP
The following is the list of valid formatting properties, together with their
default values. If the
.B -style
command line option of
.B html2text(1)
is used, different default values apply.
.PP
Curly braces indicate alternatives, e.g.
.B {A\ B}C
stands for
.B AC
or
.BR BC .
.TP
.B DOCUMENT.{vspace.{before after} indent.{left right}} = 0
Specifies how many blank lines are inserted before and after, and how many
blank columns are inserted to the left and to the right of the formatted
document.
.TP
.B BODY.{vspace.{before after} indent.{left right}} = 0
Same for the document body. (Since the document body is currently the only
document part that is rendered, it is virtually the same whether you specifiy
.B DOCUMENT
or
.BR BODY ).
.TP
.B {OL\ UL\ DIR\ MENU\ DL}.vspace.{before\ between\ after} = 0
Specifies how many blank lines are inserted before a list, between the
individual list items, and after the list.
.TP
.B {OL UL DIR MENU}.indents = 6
Specifies by how deep list items are indented. If an
item bullet would not fit into the space created by the indentation, then
the indentation is automatically increased such that the bullet fits in
(relevant for relatively wide bullets, e.g. roman numbers).
.BR
If N blank-separated integers are specified instead of one, then the first N-1
integers specify indentation for the first N-1 list nesting levels, while
the last integer specifies the indentation for nesting levels N and higher.
.TP
.B {UL DIR}.default_types = DISC\ CIRCLE\ SQUARE
Specifies the default list type (i.e. the bullet style), if the HTML list
tag does not specify an explicit type. Legal values are
.BR NO_BULLET ,
.BR DISC ,
.BR SQUARE ,
.BR CIRCLE ,
.BR CUSTOM1 ,
.B CUSTOM2
and
.BR CUSTOM3 .
If more than one value is specified, then the values apply for the
respective list nesting levels (see
.BR indents ).
.TP
.B MENU.default_types = NO_BULLET
Same for <MENU>, but here the default is
.BR NO_BULLET .
.TP
.B LI.{disc square circle custom1 custom2 custom3}_bullet\ =\ {*\ #\ o\ +\ -\ ~}
Specifies the strings used as list item bullets.
.TP
.B {DT DD}.{vspace.{before after} indent.{left right}} = 0
Specifies how many blank lines are inserted before and after, and how many
blank columns are inserted to the left and to the right of each <DT> or <DD>
element.
.TP
.B HR.marker = =
Specifies the character to use for horizontal rules.
.TP
.B HR.{vspace.{before after} indent.{left right}} = 0
Specifies how many blank lines are inserted before and after, and how many
blank columns are inserted to the left and to the right of the horizontal rule.
.TP
.B {H1\ H2\ H3\ H4\ H5\ H6}.prefix\ =\ {******\ *****\ ****\ ***\ **\ *}
Specifies how headings are decorated with a prefix. (The default values
have a trailing blank, e.g. "****** ".)
.TP
.B {H1\ H2\ H3\ H4\ H5\ H6}.suffix\ =\ {******\ *****\ ****\ ***\ **\ *}
Specifies how headings are decorated with a suffix. (The default values
have a leading blank, e.g. " ******".)
.TP
.B {H1\ H2\ H3\ H4\ H5\ H6}.vspace.{before\ after}\ =\ 0
Specifies how many blank lines are inserted before and after headings.
.TP
.B {PRE\ P}.{vspace.{before\ after}\ indent.{left\ right}}\ =\ 0
Specifies how many blank lines are inserted before and after, and how many
blank columns are inserted to the left and to the right of these items.
.TP
.B {BLOCKQUOTE\ ADDRESS}.{vspace.{before\ after}\ indent.{left\ right}}\ =\ {\ 0\ 0\ 5\ 5\ }
Specifies how many blank lines are inserted before and after, and how many
blank columns are inserted to the left and to the right of these items.
.TP
.B TABLE.vspace.{before after} = 0
Specifies how many blank lines are inserted before and after tables.
.TP
.B {H1\ H2\ H3\ H4\ H5\ H6}.attributes = BOLD
Specifies the cell attributes for headings. The value is a sequence of
.BR NONE ,
.BR BOLD ,
.B UNDERLINE
and
.BR STRIKETHROUGH .
.TP
.B {TT\ I\ BIG\ SMALL\ SUB\ SUP\ DFN\ CODE\ SAMP\ KBD\ CITE}.attributes\ =\ NONE
Specifies the cell attributes for these text items.
.TP
.B U.attributes\ =\ UNDERLINE
Specifies the cell attributes for
.B <U>
items.
.TP
.B {B\ EM\ STRONG}.attributes\ =\ BOLD
Specifies the cell attributes for these text items.
.TP
.B STRIKE.attributes\ =\ STRIKETHROUGH
Specifies the cell attributes for
.B <STRIKE>
items.
.TP
.B A.attributes.{internal_link\ external_link}\ =\ UNDERLINE
Specifies the cell attributes for links. A link is an
.B <A>
item that has an
.B HREF
attribute. An internal link is a link who's
.B HREF
attribute starts with a hash character.
.SH SEE ALSO
.IR html2text (1),
.IR more (1),
.IR less (1)
.br
.I http://www.w3c.org
for the HTML 3.2 Reference Specification