« back to all changes in this revision
Viewing changes to doc/options.texi
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Peter Moulder
- Date: 2001-04-19 23:54:09 UTC
- Revision ID: james.westby@ubuntu.com-20010419235409-dhhac0xmknfwvmic
Tags: upstream-1.64-cvs20010402
Import upstream version 1.64-cvs20010402
- files added:
- Tests
- Tests/GermanNodeTest
- doc
added
removed
doc/options.texi
1
@c
2
@c This file is part of the ``Texinfo to HTML Converter'' manual
3
@c which is part of the ``texi2html'' distribution.
4
@c
5
@c License:
6
@c Copyright (C) 1999, 2000 Free Software Foundation, Inc.
7
@c
8
@c This program is free software; you can redistribute it
9
@c and/or modify it under the terms of the GNU General Public
10
@c License as published by the Free Software Foundation;
11
@c either version 2 of the License, or (at your option) any
12
@c later version.
13
@c
14
@c This program is distributed in the hope that it will be
15
@c useful, but WITHOUT ANY WARRANTY; without even the implied
16
@c warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
17
@c PURPOSE. See the GNU General Public License for more
18
@c details.
19
@c
20
@c You should have received a copy of the GNU General
21
@c Public License along with this program; if not, write to
22
@c the Free Software Foundation, Inc., 59 Temple Place, Suite
23
@c 330, Boston, MA 02111-1307 USA
24
@c
25
@c
26
@c Revisions:
27
@c $Id: options.texi,v 1.1 2000/08/14 18:10:23 texi2htm Exp $
28
@c
29
@c Author:
30
@c Karl Heinz Marbaise <khmarbaise@gmx.de>
31
@c
32
@c Description:
33
@c Here you can find the description on the
34
@c command line options.
35
@c
36
@c ========================================================
37
@chapter Command Line Options
38
39
@menu
40
* OptionDebug:: Debugging.
41
* OptionDocType:: DocType (HTML)
42
* OptionCheck:: Checking files.
43
* OptionExpand:: Expanding info, tex areas etc.
44
* OptionGlossary:: Glossary.
45
* OptionInvisible:: Invisible.
46
* OptionIso:: Iso.
47
* OptionInclude:: Include directories.
48
* OptionTopFile:: Top File.
49
* OptionTocFile:: Table of content File.
50
* OptionFrames:: Frames.
51
* OptionMenu:: Menu's.
52
* OptionNumber:: Number sections.
53
* OptionSplit:: Splitting.
54
* OptionSectionNavigation:: Navigation.
55
* OptionSubDir:: Subdirectory.
56
* OptionShortExt:: Short extension.
57
* OptionPrefix:: Prefix.
58
* OptionOutput:: Output.
59
* OptionShortRef:: Short Ref.
60
* OptionIndexSummary:: Index Summary.
61
* OptionVerbose:: Verbose.
62
* OptionLanguage:: Language.
63
* OptionL2H:: La@TeX{}2HTML.
64
@end menu
65
66
67
@c --------------------------------------------------------
68
@node OptionDebug, OptionDocType, Options, Options
69
@section Debugging
70
@cindex Debugging
71
@vindex DEBUG_TOC
72
@vindex DEBUG_INDEX
73
@vindex DEBUG_BIB
74
@vindex DEBUG_GLOSS
75
@vindex DEBUG_DEF
76
@vindex DEBUG_HTML
77
@vindex DEBUG_USER
78
@vindex DEBUG_L2H
79
@opindex debug
80
81
@option{-debug}
82
83
debugging: 0 --- no debugging; other values; see beginning
84
of texi2html
85
86
@var{$DEBUG_TOC} = 1;
87
@var{$DEBUG_INDEX} = 2;
88
@var{$DEBUG_BIB} = 4;
89
@var{$DEBUG_GLOSS} = 8;
90
@var{$DEBUG_DEF} = 16;
91
@var{$DEBUG_HTML} = 32;
92
@var{$DEBUG_USER} = 64;
93
@var{$DEBUG_L2H} = 128;
94
95
@c --------------------------------------------------------
96
@node OptionDocType, OptionCheck, OptionDebug, Options
97
@section DocType
98
@cindex HTML, Doc Type
99
@opindex doctype
100
@vindex T2H_DOCTYPE
101
@option{-doctype}
102
103
@example
104
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
105
@end example
106
107
@c --------------------------------------------------------
108
@node OptionCheck, OptionExpand, OptionDocType, Options
109
@section Check
110
@cindex Texinfo, checking
111
@opindex check
112
@vindex T2H_CHECK
113
@option{-check}
114
if set, only check files and give the list of all things
115
that look like untranslated Texinfo commands
116
117
@c --------------------------------------------------------
118
@node OptionExpand, OptionGlossary, OptionCheck, Options
119
@section Expand
120
@opindex expand
121
@vindex T2H_EXPAND
122
@option{-expand}
123
if set to @strong{tex} (or, @strong{info}) expand
124
@code{@@iftex} and @code{@@tex} (or, @code{@@ifinfo})
125
sections else, neither expand @code{@@iftex}, @code{@@tex},
126
nor @code{@@ifinfo} sections
127
128
@c $T2H_EXPAND = "info";
129
130
@c --------------------------------------------------------
131
@node OptionGlossary, OptionInvisible, OptionExpand, Options
132
@section Glossary
133
@cindex HTML, Glossary
134
@cindex Texinfo, Glossary
135
@opindex glossary
136
@vindex T2H_USE_GLOSSARY
137
@option{-glossary}
138
if set, uses section named @strong{Footnotes} for glossary
139
140
@c --------------------------------------------------------
141
@node OptionInvisible, OptionIso, OptionGlossary, Options
142
@section Invisible
143
@cindex Mark, invisible
144
@cindex invisible, Mark
145
@opindex invisible
146
@vindex T2H_INVISIBLE_MARK
147
@option{-invisible}
148
@var{$T2H_INVISIBLE_MARK} is the text used to create
149
invisible destination anchors for index links (you can for
150
instance use the @file{invisible.xbm} file shipped with
151
this program). This is a workaround for a known bug of many
152
@acronym{WWW} browsers, including Netscape. For me, it
153
works fine without it --- on the contrary: if there, it
154
inserts space between headers and start of text (obachman
155
3/99)
156
157
@example
158
$T2H_INVISIBLE_MARK = "";
159
# $T2H_INVISIBLE_MARK = ' ';
160
@end example
161
162
@c --------------------------------------------------------
163
@node OptionIso, OptionInclude, OptionInvisible, Options
164
@section Iso
165
@cindex ISO8859
166
@cindex Copyright
167
@opindex iso
168
@vindex T2H_USE_ISO
169
@option{-iso}
170
171
if set, ISO8859 characters are used for special symbols
172
(like Copyright @code{@copyright{}}, etc)
173
174
$T2H_USE_ISO = 0;
175
176
@c --------------------------------------------------------
177
@node OptionInclude, OptionTopFile, OptionIso, Options
178
@section Include Direcotry
179
@vindex Include directories
180
@opindex I
181
@vindex T2H_INCLUDE_DIRS
182
@option{-I}
183
184
list directories where @code{@@include} files are searched for
185
(besides the directory of the doc file) additional
186
@option{-I} args are add to this list.
187
188
@@T2H_INCLUDE_DIRS = (".");
189
190
@c --------------------------------------------------------
191
@node OptionTopFile, OptionTocFile, OptionInclude, Options
192
@section Top File
193
@cindex Top Level file
194
@cindex HTML, index.html
195
@opindex top_file
196
@vindex T2H_TOP_FILE
197
@option{-top_file}
198
uses file of this name for top-level file
199
extension is manipulated appropriately, if necessary.
200
If empty, @file{<basename of document>.html} is used
201
Typically, you would set this to @file{index.html}.
202
203
$T2H_TOP_FILE = "";
204
205
@c --------------------------------------------------------
206
@node OptionTocFile, OptionFrames, OptionTopFile, Options
207
@section Table Of content File
208
@cindex Table of content file
209
@opindex toc_file
210
@vindex T2H_TOC_FILE
211
@option{-toc_file}
212
uses file of this name for table of contents file extension
213
is manipulated appropriately, if necessary. If empty,
214
@file{<basename of document>_toc.html} is used
215
216
$T2H_TOC_FILE = "";
217
218
@c --------------------------------------------------------
219
@node OptionFrames, OptionMenu, OptionTocFile, Options
220
@section Frames
221
@vindex HTML, frames
222
@vindex HTML 4.0, frames
223
@opindex frames
224
@vindex T2H_FRAMES
225
@option{-frames}
226
if set, output two additional files which use HTML 4.0
227
@b{frames}.
228
229
$T2H_FRAMES = 0;
230
231
@c --------------------------------------------------------
232
@node OptionMenu, OptionNumber, OptionFrames, Options
233
@section Menu's
234
@cindex HTML, menu
235
@cindex Texinfo, menu
236
@opindex menu
237
@opindex nomenu
238
@vindex T2H_SHOW_MENU
239
@option{-menu} or @option{-nomenu} if set, show the Texinfo
240
menus
241
242
$T2H_SHOW_MENU = 1;
243
244
@c --------------------------------------------------------
245
@node OptionNumber, OptionSplit, OptionMenu, Options
246
@section Number sections
247
@cindex Section numbering
248
@opindex number
249
@opindex nonumber
250
@vindex T2H_NUMBER_SECTIONS
251
@option{-number} @option{-nonumber}
252
if set, number sections and show section names and numbers
253
in references and menus
254
255
@c Just think about it?
256
@c @defvar $T2H_NUMBER_SECTIONS
257
@c @c = 1;
258
@c @end defvar
259
260
@c --------------------------------------------------------
261
@node OptionSplit, OptionSectionNavigation, OptionNumber, Options
262
@section Split
263
@cindex HTML, split
264
@cindex File, split
265
@opindex split
266
@vindex T2H_SPLIT
267
@option{-split section|chapter|none}
268
if set to @strong{section} (resp. @strong{chapter}) create one
269
@acronym{HTML} file per (sub)section (resp. chapter) and
270
separate pages for Top, ToC, Overview, Index, Glossary,
271
About. otherwise, create monolithic @acronym{HTML} file which
272
contains whole document
273
274
#$T2H_SPLIT = 'section';
275
$T2H_SPLIT = undef;
276
277
@c --------------------------------------------------------
278
@node OptionSectionNavigation, OptionSubDir, OptionSplit, Options
279
@section Section navigation
280
@cindex HTML, Navigation
281
@opindex section_navigation
282
@opindex no-section_navigation
283
@vindex T2H_SECTION_NAVIGATION
284
@option{-section_navigation}|
285
@option{-no-section_navigation}
286
287
if set, then navigation panels are printed at the beginning
288
of each section and, possibly at the end (depending on
289
whether or not there were more than
290
@var{$T2H_WORDS_IN_PAGE} words on page). This is most useful
291
if you do not want to have section navigation on
292
@option{-split chapter}
293
294
@c @vindex T2H_SECTION_NAVIGATION
295
@c @defvar $T2H_SECTION_NAVIGATION
296
@c = 1;
297
@c @end defvar
298
299
@c --------------------------------------------------------
300
@node OptionSubDir, OptionShortExt, OptionSectionNavigation, Options
301
@section Subdirectory
302
@cindex Subdirectory
303
@vindex T2H_SUBDIR
304
@option{-subdir}
305
if set put result files in this directory if not set result
306
files are put into current directory
307
308
@c #$T2H_SUBDIR = 'html';
309
@var{$T2H_SUBDIR} = undef;
310
311
@c --------------------------------------------------------
312
@node OptionShortExt, OptionPrefix, OptionSubDir, Options
313
@section Short extension
314
@cindex HTML, .htm extension
315
@cindex HTML, .html extension
316
@cindex extension, .html
317
@cindex extension, .htm
318
@vindex T2H_SHORTEXTN
319
@opindex short_extn
320
@option{-short_extn}
321
If this is set all @acronym{HTML} file will have extension
322
@file{.htm} instead of @file{.html}. This is helpful when
323
shipping the document to PC systems.
324
@var{$T2H_SHORTEXTN} = 0;
325
326
@c --------------------------------------------------------
327
@node OptionPrefix, OptionOutput, OptionShortExt, Options
328
@section Prefix
329
@cindex Prefix
330
@vindex T2H_PREFIX
331
@opindex prefix
332
@option{-prefix}
333
Set the output file prefix, prepended to all @file{.html},
334
@file{.gif} and @file{.pl} files.
335
By default, this is the basename of the document
336
337
@var{$T2H_PREFIX} = "";
338
339
@c --------------------------------------------------------
340
@node OptionOutput, OptionShortRef, OptionPrefix, Options
341
@section Output filename
342
@cindex Output filename
343
@cindex Filename, output
344
@vindex T2H_OUT
345
@opindex o
346
@opindex out_file
347
348
@option{-o filename}|@option{-out_file}
349
If set, generate monolithic document output @acronym{HTML}
350
into @file{filename}.
351
352
@c --------------------------------------------------------
353
@node OptionShortRef, OptionIndexSummary, OptionOutput, Options
354
@section Short Cross References
355
@cindex References, short
356
@cindex sections without numbers
357
@vindex T2H_SHORT_REF
358
@opindex short_ref
359
@option{-short_ref}
360
if set cross-references are given without section numbers
361
362
@c --------------------------------------------------------
363
@node OptionIndexSummary, OptionVerbose, OptionShortRef, Options
364
@section Index Summary
365
@cindex Index, Summary
366
@cindex Summary Index
367
@cindex HTML, Index
368
@vindex T2H_IDX_SUMMARY
369
@opindex idx_sum
370
@option{-idx_sum}
371
If value is set, then for each @code{@@prinindex $what}
372
@file{$docu_name_$what.idx} is created which contains lines of the
373
form @strong{$key\t$ref} sorted alphabetically (case
374
matters).
375
376
@c --------------------------------------------------------
377
@node OptionVerbose, OptionLanguage, OptionIndexSummary, Options
378
@section Verbose output
379
@cindex Output, verbose
380
@cindex Verbose output
381
@cindex Debugging, verbose output
382
@vindex T2H_VERBOSE
383
@opindex verbose
384
@option{-verbose}
385
if set, chatter about what we are doing.
386
387
@c --------------------------------------------------------
388
@node OptionLanguage, OptionL2H, OptionVerbose, Options
389
@section Language Support
390
@cindex Language Support
391
@cindex Support different languages
392
@vindex $T2H_LANG
393
@vindex $T2H_WORDS
394
@opindex lang
395
@option{-lang}
396
For page titles, use
397
@code{$T2H_WORDS->@{$T2H_LANG@}->@{...@}} as title. To add
398
a new languages, supply list of titles (see
399
@var{$T2H_WORDS}), and use ISO 639 language codes (see e.g.
400
perl module @file{Locale-Codes-1.02.tar.gz} for
401
definitions).
402
403
If you don't give a @option{-lang} then we got it from the
404
Texinfo source file (@@documentlanguage
405
@c Put a table with the language codes here!
406
@c Or better put a reference into the Texinfo
407
@c Manual, which has a table of ISO 639-Codes.
408
@c
409
@c Currently the @xref etc. does not work with
410
@c external documents, cause we don't know
411
@c reference (anchor) value or there is no way
412
@c to get it.
413
@c The following reference does only work correctly
414
@c in Info!!!
415
@pxref{documentlanguage,,,Texinfo}). If there is no
416
@code{@@documentlanguage} we use the default @code{en} for
417
the language.
418
@c
419
@c put some information about Month names etc. here
420
@c $MONTH_NAMES !!
421
@c Suplemental should be naming scheme for variables in
422
@c different languages (MONTH_NAMES_DE etc.)
423
@c --------------------------------------------------------
424
@node OptionL2H, , OptionLanguage, Options
425
@section La@TeX{}2HTML for @code{@@math} and @code{@@tex}
426
@cindex La@TeX{}2HTML
427
@cindex Conversion of @@math and @@tex
428
@cindex @@tex
429
@cindex @@math
430
@vindex T2H_L2H
431
@opindex l2h
432
@option{-l2h}
433
if set, uses @command{latex2html} for generation of math
434
content.
435
436
@menu
437
* OptionL2HL2H:: Where to find La@TeX{}2HTML.
438
* OptionL2HSkip:: Skip calling La@TeX{}2HTML.
439
* OptionL2Htmp:: Temporary files for La@TeX{}2HTML.
440
@end menu
441
442
@c --------------------------------------------------------
443
@node OptionL2HL2H, OptionL2HSkip, OptionL2H, OptionL2H
444
@subsection Where to find @command{latex2html}
445
@cindex location, La@TeX{}2HTML
446
@cindex La@TeX{}2HTML, location
447
@vindex T2H_L2H_L2H
448
@opindex l2h_l2h
449
@option{-l2h_l2h}
450
name/location of @command{latex2html} progam.
451
452
@c --------------------------------------------------------
453
@node OptionL2HSkip, OptionL2Htmp, OptionL2HL2H, OptionL2H
454
@subsection Skip calling La@TeX{}2HTML
455
@cindex La@TeX{}2HTML, skip calling
456
@vindex T2H_L2H_SKIP
457
@opindex l2h_skip
458
@option{-l2h_skip}
459
if set, skips actual call to @command{atex2html} tries to
460
reuse previously generated content, instead.
461
462
@c --------------------------------------------------------
463
@node OptionL2Htmp, , OptionL2HSkip, OptionL2H
464
@subsection Temporary files for La@TeX{}2HTML
465
@cindex Temporary, La@TeX{}2HTML
466
@cindex La@TeX{}2HTML, Temporary files
467
@vindex T2H_L2H_TMP
468
@opindex l2h_tmp
469
@option{-l2h_tmp}
470
if set, l2h uses this directory for temporarary files. The
471
path leading to this directory may not contain a dot (i.e.,
472
a "."), otherwise, l2h will fail
Loggerhead is a web-based interface for Breezy
Version: 2.0.1