Penguin
Recent Changes
Blame: html2textrc(5)
EditPageHistoryDiffInfoLikePages
Annotated edit history of html2textrc(5) version 2 showing authors affecting page license. View with all changes included.
Rev Author # Line
1 perry 1 html2textrc
2 !!!html2textrc
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 AUTHOR
8 SEE ALSO
9 ----
10 !!NAME
11
12
13 html2textrc - formatting properties file for html2text(1)
14 !!SYNOPSIS
15
16
17 ''Key'' [[ __=__ | __:__ ] ''Value''
18 !!DESCRIPTION
19
20
21 The html2textrc(5) file defines a set of formatting
22 properties used by the html2text(1) utility, that
23 overrides the program's built-in formatting defaults. Each
24 line of the html2textrc(5) file is either a
25 formatting property or a comment.
26
27
28 Lines with a leading
29
30
31 __A property definition line consists of:__
32
33
34 (1)
35
36
37 Optional leading space,
38
39
40 (2)
41
42
43 the property key (a sequence of non-space characters except
44
45
46 (3)
47
48
49 an optional space,
50
51
52 (4)
53
54
55 an optional
56
57
58 (5)
59
60
61 optional space,
62
63
64 (6)
65
66
67 the property value as described below.
68 Everything up to the next newline is interpreted
69 ''literary'' as the value of the specified element.
70 Literary meant leading white-space must be quoted with
71 backslashes (i.e.
72 ''
73 !!OPTIONS
74
75
76 The following is the list of valid formatting properties,
77 together with their default values. If the __-style__
78 command line option of html2text(1) is used,
79 different default values apply.
80
81
82 Curly braces indicate alternatives, e.g. __{A B}C__
83 stands for __AC__ or __BC__.
84
85
86 __DOCUMENT.{vspace.{before after} indent.{left right}} =
87 0__
88
89
90 Specifies how many blank lines are inserted before and
91 after, and how many blank columns are inserted to the left
92 and to the right of the formatted document.
93 (Numeric.)
94
95
96 __BODY.{vspace.{before after} indent.{left right}} =
97 0__
98
99
100 Same for the document body. (Since the document body is
101 currently the only document part that is rendered, it is
102 virtually the same whether you specifiy __DOCUMENT__ or
103 __BODY__). (Numeric.)
104
105
106 __{OL UL DIR MENU DL}.vspace.{before between after} =
107 0__
108
109
110 Specifies how many blank lines are inserted before a list,
111 between the individual list items, and after the list.
112 (Numeric.)
113
114
115 __{OL UL DIR MENU}.indents = 6__
116
117
118 Specifies by how deep list items are indented. If an item
119 bullet would not fit into the space created by the
120 indentation, then the indentation is automatically increased
121 such that the bullet fits in (relevant for relatively wide
122 bullets, e.g. roman numbers). If ''N'' blank-separated
123 integers are specified instead of one, then the first
124 ''N-1'' integers specify indentation for the first
125 ''N-1'' list nesting levels, while the last integer
126 specifies the indentation for nesting levels ''N'' and
127 higher. (Numeric.)
128
129
130 __{UL DIR}.default_types = DISC CIRCLE
131 SQUARE__
132
133
134 Specifies the default list type (i.e. the bullet style), if
135 the HTML list tag does not specify an explicit type. Legal
136 values are __NO_BULLET__, __DISC__, __SQUARE__,
137 __CIRCLE__, __CUSTOM1__, __CUSTOM2__ and
138 __CUSTOM3__. If more than one value is specified, then
139 the values apply for the respective list nesting levels (see
140 __indents__). (Option.)
141
142
143 __MENU.default_types = NO_BULLET__
144
145
146 Same for
147 NO_BULLET__. (Option.)
148
149
150 __LI.{disc square circle custom1 custom2 custom3}_bullet =
151 {* # o + - ~}__
152
153
154 Specifies the strings used as list item bullets.
155 (String.)
156
157
158 __{DT DD}.{vspace.{before after} indent.{left right}} =
159 0__
160
161
162 Specifies how many blank lines are inserted before and
163 after, and how many blank columns are inserted to the left
164 and to the right of each
165
166
167 __HR.marker = =__
168
169
170 Specifies the character to use for horizontal rules.
171 (String.)
172
173
174 __HR.{vspace.{before after} indent.{left right}} =
175 0__
176
177
178 Specifies how many blank lines are inserted before and
179 after, and how many blank columns are inserted to the left
180 and to the right of the horizontal rule.
181 (Numeric.)
182
183
184 __{H1 H2 H3 H4 H5 H6}.prefix = {****** ***** **** *** **
185 *}__
186
187
188 Specifies how headings are decorated with a prefix. (The
189 default values have a trailing blank, e.g.
190
191
192 __{H1 H2 H3 H4 H5 H6}.suffix = {****** ***** **** *** **
193 *}__
194
195
196 Specifies how headings are decorated with a suffix. (The
197 default values have a leading blank, e.g.
198
199
200 __{H1 H2 H3 H4 H5 H6}.vspace.{before after} =
201 0__
202
203
204 Specifies how many blank lines are inserted before and after
205 headings. (Numeric.)
206
207
208 __{PRE P}.{vspace.{before after} indent.{left right}} =
209 0__
210
211
212 Specifies how many blank lines are inserted before and
213 after, and how many blank columns are inserted to the left
214 and to the right of these items. (Numeric.)
215
216
217 __{BLOCKQUOTE ADDRESS}.{vspace.{before after} indent.{left
218 right}} = {0 0 5 5}__
219
220
221 Specifies how many blank lines are inserted before and
222 after, and how many blank columns are inserted to the left
223 and to the right of these items. (Numeric.)
224
225
226 __TABLE.vspace.{before after} = 0__
227
228
229 Specifies how many blank lines are inserted before and after
230 tables. (Numeric.)
231
232
233 __{H1 H2 H3 H4 H5 H6}.attributes = BOLD__
234
235
236 Specifies the cell attributes for headings. The value is a
237 sequence of __NONE__, __BOLD__, __UNDERLINE__ and
238 __STRIKETHROUGH__. (Option.)
239
240
241 __{TT I BIG SMALL SUB SUP DFN CODE SAMP KBD
242 CITE}.attributes = NONE__
243
244
245 Specifies the cell attributes for these text items. Legal
246 values are: __NONE__, __BOLD__, __UNDERLINE__ or
247 __STRIKETHROUGH__. (Option.)
248
249
250 __U.attributes = UNDERLINE__
251
252
253 Same for
254
255
256 __{B EM STRONG}.attributes = BOLD__
257
258
259 Same for these elements, but with a different default value.
260 (Option.)
261
262
263 __STRIKE.attributes = STRIKETHROUGH__
264
265
266 Same for
267
268
269 __A.attributes.{internal_link external_link} =
270 UNDERLINE__
271
272
273 Specifies the cell attributes for links. A link is an
274 NONE__, __BOLD__, __UNDERLINE__ and
275 __STRIKETHROUGH__. (Option.)
276
277
278 __IMG.replace.{all noalt} =__ ''unset''
279
280
281 Specifies the string used to replace all
282
283
284 __IMG.alt.{prefix suffix} = {[[ ]}__
285
286
287 Specifies how the values (if any) of IMG elements'
288 !!AUTHOR
289
290
291 Current maintainer and primary download location for
292 __html2text__ is:
293 Martin Bayer
294 http://userpage.fu-berlin.de/~mbayer/tools/
295 !!SEE ALSO
296
297
298 html2text(1)
299 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.