View Source: html2textrc(5) - Waikato Linux Users Group

You are viewing an old revision of this page. View the current version.
html2textrc
!!!html2textrc
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
AUTHOR
SEE ALSO
----
!!NAME


html2textrc - formatting properties file for html2text(1)
!!SYNOPSIS


''Key'' [[ __=__ | __:__ ] ''Value''
!!DESCRIPTION


The __html2textrc__(5) file defines a set of formatting
properties used by the __html2text__(1) utility, that
overrides the program's built-in formatting defaults. Each
line of the __html2textrc__(5) file is either a
formatting property or a comment.


Lines with a leading


__A property definition line consists of:__


(1)


Optional leading space,


(2)


the property key (a sequence of non-space characters except


(3)


an optional space,


(4)


an optional


(5)


optional space,


(6)


the property value as described below.
Everything up to the next newline is interpreted
''literary'' as the value of the specified element.
Literary meant leading white-space must be quoted with
backslashes (i.e.
''
!!OPTIONS


The following is the list of valid formatting properties,
together with their default values. If the __-style__
command line option of __html2text__(1) is used,
different default values apply.


Curly braces indicate alternatives, e.g. __{A B}C__
stands for __AC__ or __BC__.


__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.
(Numeric.)


__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 __DOCUMENT__ or
__BODY__). (Numeric.)


__{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.
(Numeric.)


__{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). 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. (Numeric.)


__{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 __NO_BULLET__, __DISC__, __SQUARE__,
__CIRCLE__, __CUSTOM1__, __CUSTOM2__ and
__CUSTOM3__. If more than one value is specified, then
the values apply for the respective list nesting levels (see
__indents__). (Option.)


__MENU.default_types = NO_BULLET__


Same for
NO_BULLET__. (Option.)


__LI.{disc square circle custom1 custom2 custom3}_bullet =
{* # o + - ~}__


Specifies the strings used as list item bullets.
(String.)


__{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


__HR.marker = =__


Specifies the character to use for horizontal rules.
(String.)


__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.
(Numeric.)


__{H1 H2 H3 H4 H5 H6}.prefix = {****** ***** **** *** **
*}__


Specifies how headings are decorated with a prefix. (The
default values have a trailing blank, e.g.


__{H1 H2 H3 H4 H5 H6}.suffix = {****** ***** **** *** **
*}__


Specifies how headings are decorated with a suffix. (The
default values have a leading blank, e.g.


__{H1 H2 H3 H4 H5 H6}.vspace.{before after} =
0__


Specifies how many blank lines are inserted before and after
headings. (Numeric.)


__{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. (Numeric.)


__{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. (Numeric.)


__TABLE.vspace.{before after} = 0__


Specifies how many blank lines are inserted before and after
tables. (Numeric.)


__{H1 H2 H3 H4 H5 H6}.attributes = BOLD__


Specifies the cell attributes for headings. The value is a
sequence of __NONE__, __BOLD__, __UNDERLINE__ and
__STRIKETHROUGH__. (Option.)


__{TT I BIG SMALL SUB SUP DFN CODE SAMP KBD
CITE}.attributes = NONE__


Specifies the cell attributes for these text items. Legal
values are: __NONE__, __BOLD__, __UNDERLINE__ or
__STRIKETHROUGH__. (Option.)


__U.attributes = UNDERLINE__


Same for


__{B EM STRONG}.attributes = BOLD__


Same for these elements, but with a different default value.
(Option.)


__STRIKE.attributes = STRIKETHROUGH__


Same for


__A.attributes.{internal_link external_link} =
UNDERLINE__


Specifies the cell attributes for links. A link is an
NONE__, __BOLD__, __UNDERLINE__ and
__STRIKETHROUGH__. (Option.)


__IMG.replace.{all noalt} =__ ''unset''


Specifies the string used to replace all


__IMG.alt.{prefix suffix} = {[[ ]}__


Specifies how the values (if any) of IMG elements'
!!AUTHOR


Current maintainer and primary download location for
__html2text__ is:
Martin Bayer
http://userpage.fu-berlin.de/~mbayer/tools/
!!SEE ALSO


__html2text__(1)
----
2 pages link to html2textrc(5):
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
Version 1, saved on Monday, June 3, 2002 6:55:57 pm by "perry"
Edit PageHistory Diff Info LikePages