Debian Codegraph @

doc/3-cmdref.html

raw
1 <HTML>
2 <BODY>
3
4 <!-- FOOTER RIGHT "3-$CHAPTERPAGE" -->
5 <DIV ALIGN="justify">
6
7 <H1 ALIGN="RIGHT"><A NAME="CMDREF">Chapter 3 - Command-Line Reference</A></H1>
8
9 <P>This chapter describes all of the command-line options supported by
10 HTMLDOC.
11
12 <H2>Basic Usage</H2>
13
14 <p>The basic command-line usage for HTMLDOC is:
15
16 <PRE>
17 % <KBD>htmldoc <I>options</I> filename1.html ... filenameN.md <I>ENTER</I></KBD>
18 % <KBD>htmldoc <I>options</I> filename.book <I>ENTER</I></KBD>
19 </PRE>
20
21 <p>The first form converts the named HTML or Markdown files to the specified output format immediately. The second form loads the specified <CODE>.book</CODE> file and displays the HTMLDOC window, allowing a user to make changes and/or generate the document interactively.
22
23 <P>If no output file or directory is specified, then all output is sent to the standard output file.
24
25 <p>On return, HTMLDOC returns an exit code of 0 if it was successful and non-zero if there were errors.</p>
26
27 <H2>Options</H2>
28
29 <p>The following command-line options are recognized by HTMLDOC.
30
31 <H3>-d directory</H3>
32
33 <p>The <CODE>-d</CODE> option specifies an output directory for the document files.
34
35 <P>This option is not compatible with the EPUB or PDF output formats.
36
37 <H3>-f filename</H3>
38
39 <p>The <CODE>-f</CODE> option specifies an output file for the document.
40
41 <H3>-t format</H3>
42
43 <P>The <CODE>-t</CODE> option specifies the output format for the document and
44 can be one of the following:</P>
45
46 <CENTER><TABLE BORDER="1" CELLPADDING="5">
47 <TR><TH>Format</TH><TH>Description</TH></TR>
48 <TR><TD>epub</TD><TD>Generate an EPUB file.</TD></TR>
49 <TR><TD>html</TD><TD>Generate one or more indexed HTML files.</TD></TR>
50 <TR><TD>htmlsep</TD><TD>Generate separate HTML files for each heading in
51 the table-of-contents.</TD></TR>
52 <TR><TD>pdf</TD><TD>Generate a PDF file (default version - 1.4).</TD></TR>
53 <TR><TD>pdf11</TD><TD>Generate a PDF 1.1 file for Acrobat Reader 2.0 and later.</TD></TR>
54 <TR><TD>pdf12</TD><TD>Generate a PDF 1.2 file for Acrobat Reader 3.0 and later.</TD></TR>
55 <TR><TD>pdf13</TD><TD>Generate a PDF 1.3 file for Acrobat Reader 4.0 and later.</TD></TR>
56 <TR><TD>pdf14</TD><TD>Generate a PDF 1.4 file for Acrobat Reader 5.0 and later.</TD></TR>
57 <TR><TD>ps</TD><TD>Generate one or more PostScript files (default level - 2).</TD></TR>
58 <TR><TD>ps1</TD><TD>Generate one or more Level 1 PostScript files.</TD></TR>
59 <TR><TD>ps2</TD><TD>Generate one or more Level 2 PostScript files.</TD></TR>
60 <TR><TD>ps3</TD><TD>Generate one or more Level 3 PostScript files.</TD></TR>
61 </TABLE></CENTER>
62
63 <H3>-v</H3>
64
65 <p>The <CODE>-v</CODE> option specifies that progress information should be sent/displayed to the standard error file.
66
67 <H3>--batch filename.book</H3>
68
69 <p>The <CODE>--batch</CODE> option specifies a book file that you would like to generate without the GUI popping up. This option can be combined with other options to generate the same book in different formats and sizes:
70
71 <PRE>
72 % <KBD>htmldoc --batch filename.book -f filename.ps <I>ENTER</I></KBD>
73 % <KBD>htmldoc --batch filename.book -f filename.pdf <I>ENTER</I></KBD>
74 </PRE>
75
76 <H3>--bodycolor color</H3>
77
78 <p>The <CODE>--bodycolor</CODE> option specifies the background color for all pages in the document. The color can be specified by a standard HTML color name or as a 6-digit hexadecimal number of the form <CODE>#RRGGBB</CODE>.
79
80 <!-- NEED 6in -->
81 <H3>--bodyfont typeface</H3>
82
83 <P>The <CODE>--bodyfont</CODE> option specifies the default text font used for text in the document body. The <CODE>typeface</CODE> parameter can be one of the following:</P>
84
85 <CENTER><TABLE BORDER="1" CELLPADDING="5">
86 <TR><TH>typeface</TH><TH>Actual Font</TH></TR>
87 <TR><TD>Arial</TD><TD>Helvetica</TD></TR>
88 <TR><TD>Courier</TD><TD>Courier</TD></TR>
89 <TR><TD>Helvetica</TD><TD>Helvetica</TD></TR>
90 <TR><TD>Monospace</TD><TD>DejaVu Sans Mono</TD></TR>
91 <TR><TD>Sans</TD><TD>DevaVu Sans</TD></TR>
92 <TR><TD>Serif</TD><TD>DejaVu Serif</TD></TR>
93 <TR><TD>Times</TD><TD>Times</TD></TR>
94 </TABLE></CENTER>
95
96 <H3>--bodyimage filename</H3>
97
98 <P>The <CODE>--bodyimage</CODE> option specifies the background image for all pages in the document. The supported formats are GIF, JPEG, and PNG.
99
100 <H3>--book</H3>
101
102 <P>The <CODE>--book</CODE> option specifies that the input files comprise a book with chapters and headings.
103
104 <H3>--bottom margin</H3>
105
106 <P>The <CODE>--bottom</CODE> option specifies the bottom margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.
107
108 <P>This option is only available when generating PostScript or PDF files.
109
110 <H3>--browserwidth pixels</H3>
111
112 <P>The <CODE>--browserwidth</CODE> option specifies the browser width in pixels. The browser width is used to scale images and pixel measurements when generating PostScript and PDF files. It does not affect the font size of text.
113
114 <P>The default browser width is 680 pixels which corresponds roughly to a 96 DPI display. Please note that your images and table sizes are equal to or smaller than the browser width, or your output will overlap or truncate in places.
115
116 <!-- NEED 6in -->
117 <H3>--charset charset</H3>
118
119 <P>The <CODE>--charset</CODE> option specifies the 8-bit character set encoding to use for the entire document. HTMLDOC comes with the following character set files:</P>
120
121 <CENTER><TABLE BORDER="1" CELLPADDING="5">
122 <TR><TH>charset</TH><TH>Character Set</TH></TR>
123 <TR><TD>cp-874</TD><TD>Windows code page 874</TD></TR>
124 <TR><TD>cp-1250</TD><TD>Windows code page 1250</TD></TR>
125 <TR><TD>cp-1251</TD><TD>Windows code page 1251</TD></TR>
126 <TR><TD>cp-1252</TD><TD>Windows code page 1252</TD></TR>
127 <TR><TD>cp-1253</TD><TD>Windows code page 1253</TD></TR>
128 <TR><TD>cp-1254</TD><TD>Windows code page 1254</TD></TR>
129 <TR><TD>cp-1255</TD><TD>Windows code page 1255</TD></TR>
130 <TR><TD>cp-1256</TD><TD>Windows code page 1256</TD></TR>
131 <TR><TD>cp-1257</TD><TD>Windows code page 1257</TD></TR>
132 <TR><TD>cp-1258</TD><TD>Windows code page 1258</TD></TR>
133 <TR><TD>iso-8859-1</TD><TD>ISO-8859-1</TD></TR>
134 <TR><TD>iso-8859-2</TD><TD>ISO-8859-2</TD></TR>
135 <TR><TD>iso-8859-3</TD><TD>ISO-8859-3</TD></TR>
136 <TR><TD>iso-8859-4</TD><TD>ISO-8859-4</TD></TR>
137 <TR><TD>iso-8859-5</TD><TD>ISO-8859-5</TD></TR>
138 <TR><TD>iso-8859-6</TD><TD>ISO-8859-6</TD></TR>
139 <TR><TD>iso-8859-7</TD><TD>ISO-8859-7</TD></TR>
140 <TR><TD>iso-8859-8</TD><TD>ISO-8859-8</TD></TR>
141 <TR><TD>iso-8859-9</TD><TD>ISO-8859-9</TD></TR>
142 <TR><TD>iso-8859-14</TD><TD>ISO-8859-14</TD></TR>
143 <TR><TD>iso-8859-15</TD><TD>ISO-8859-15</TD></TR>
144 <TR><TD>koi8-r</TD><TD>KOI8-R</TD></TR>
145 <TR><TD>utf-8</TD><TD>UTF-8</TD></TR>
146 </TABLE></CENTER>
147
148 <blockquote><b>Note:</b> UTF-8 support is limited to the first 128 Unicode characters found in the input.</blockquote>
149
150 <H3>--color</H3>
151
152 <p>The <CODE>--color</CODE> option specifies that color output is desired.
153
154 <P>This option is only available when generating PostScript or PDF files.
155
156 <H3>--compression[=level]</H3>
157
158 <p>The <CODE>--compression</CODE> option specifies that Flate compression should be performed on the output file(s). The optional <CODE>level</CODE> parameter is a number from 1 (fastest and least amount of compression) to 9 (slowest and most amount of compression).
159
160 <P>This option is only available when generating PDF or Level 3 PostScript files.
161
162 <H3>--continuous</H3>
163
164 <p>The <CODE>--continuous</CODE> option specifies that the input files comprise a web page (or site) and that no title page or table-of-contents should be generated. Unlike the <CODE>--webpage</CODE> option described later in this chapter, page breaks are not inserted between each input file.
165
166 <P>This option is only available when generating PostScript or PDF files.
167
168 <h3>--cookies 'name=\"value with space\"; name=value'</h3>
169
170 <p>The <code>--cookies</code> option specifies one or more HTTP cookies that should be sent when converting remote URLs. Each cookie must be separated from the others by a semicolon and a space, and values containing whitespace or the semicolon must be placed inside double-quotes. When specifying multiple cookies, the entire cookie string must be surrounded by single quotes in order for the string to be processed correctly.</p>
171
172 <H3>--datadir directory</H3>
173
174 <p>The <CODE>--datadir</CODE> option specifies the location of data files used by HTMLDOC.
175
176 <H3>--duplex</H3>
177
178 <p>The <CODE>--duplex</CODE> option specifies that the output should be formatted for two sided printing.
179
180 <P>This option is only available when generating PostScript or PDF files. Use the <CODE>--pscommands</CODE> option to generate PostScript duplex mode commands.
181
182 <H3>--effectduration seconds</H3>
183
184 <p>The <CODE>--effectduration</CODE> option specifies the duration of a page transition effect in seconds.
185
186 <P>This option is only available when generating PDF files.
187
188 <H3>--embedfonts</H3>
189
190 <P>The <CODE>--embedfonts</CODE> option specifies that fonts should be embedded in PostScript and PDF output. This is especially useful when generating documents in character sets other than ISO-8859-1.
191
192 <H3>--encryption</H3>
193
194 <P>The <CODE>--encryption</CODE> option enables encryption and security features for PDF output.
195
196 <P>This option is only available when generating PDF files.
197
198 <!-- NEED 4in -->
199 <H3>--firstpage page</H3>
200
201 <P>The <CODE>--firstpage</CODE> option specifies the first page that will be displayed in a PDF file. The <CODE>page</CODE> parameter can be one of the following:</P>
202
203 <CENTER><TABLE BORDER="1" CELLPADDING="5">
204 <TR><TH>page</TH><TH>Description</TH></TR>
205 <TR><TD>p1</TD><TD>The first page of the document.</TD></TR>
206 <TR><TD>toc</TD><TD>The first page of the table-of-contents.</TD></TR>
207 <TR><TD>c1</TD><TD>The first page of chapter 1.</TD></TR>
208 </TABLE></CENTER>
209
210 <P>This option is only available when generating PDF files.
211
212 <H3>--fontsize size</H3>
213
214 <p>The <CODE>--fontsize</CODE> option specifies the base font size for the entire document in points (1 point = 1/72nd inch).
215
216 <H3>--fontspacing spacing</H3>
217
218 <p>The <CODE>--fontspacing</CODE> option specifies the line spacing for the entire document as a multiplier of the base font size. A <CODE>spacing</CODE> value of 1 makes each line of text the same height as the font.
219
220 <!-- NEED 6in -->
221 <H3><A NAME="footer">--footer lcr</A></H3>
222
223 <P>The <CODE>--footer</CODE> option specifies the contents of the page footer. The <CODE>lcr</CODE> parameter is a three-character string representing the left, center, and right footer fields. Each character can be one of the following:</P>
224
225 <CENTER><TABLE BORDER="1" WIDTH="80%" CELLPADDING="5">
226 <TR><TH>lcr</TH><TH>Description</TH></TR>
227 <TR><TD ALIGN="CENTER">.</TD><TD>A period indicates that the field should be blank.</TD></TR>
228 <TR><TD ALIGN="CENTER">:</TD><TD>A colon indicates that the field should contain the current and
229 total number of pages in the chapter (n/N).</TD></TR>
230 <TR><TD ALIGN="CENTER">/</TD><TD>A slash indicates that the field should contain the current and
231 total number of pages (n/N).</TD></TR>
232 <TR><TD ALIGN="CENTER">1</TD><TD>The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...)</TD></TR>
233 <TR><TD ALIGN="CENTER">a</TD><TD>A lowercase "a" indicates that the field should contain the current page number using lowercase letters.</TD></TR>
234 <TR><TD ALIGN="CENTER">A</TD><TD>An uppercase "A" indicates that the field should contain the current page number using UPPERCASE letters.</TD></TR>
235 <TR><TD ALIGN="CENTER">c</TD><TD>A lowercase "c" indicates that the field should contain the current chapter title.</TD></TR>
236 <TR><TD ALIGN="CENTER">C</TD><TD>An uppercase "C" indicates that the field should contain the current chapter page number.</TD></TR>
237 <TR><TD ALIGN="CENTER">d</TD><TD>A lowercase "d" indicates that the field should contain the current date.</TD></TR>
238 <TR><TD ALIGN="CENTER">D</TD><TD>An uppercase "D" indicates that the field should contain the current date and time.</TD></TR>
239 <TR><TD ALIGN="CENTER">h</TD><TD>An "h" indicates that the field should contain the current heading.</TD></TR>
240 <TR><TD ALIGN="CENTER">i</TD><TD>A lowercase "i" indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...)</TD></TR>
241 <TR><TD ALIGN="CENTER">I</TD><TD>An uppercase "I" indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...)</TD></TR>
242 <TR><TD ALIGN="CENTER">l</TD><TD>A lowercase "l" indicates that the field should contain the logo image.</TD></TR>
243 <TR><TD ALIGN="CENTER">l</TD><TD>An uppercase "L" indicates that the field should contain the logo image as a letterhead (shown at full size).</TD></TR>
244 <TR><TD ALIGN="CENTER">t</TD><TD>A lowercase "t" indicates that the field should contain the document title.</TD></TR>
245 <TR><TD ALIGN="CENTER">T</TD><TD>An uppercase "T" indicates that the field should contain the current time.</TD></TR>
246 <TR><TD ALIGN="CENTER">u</TD><TD>A lowercase "u" indicates that the field should contain the current filename or URL.</TD></TR>
247 </TABLE></CENTER>
248
249 <P>Setting the footer to "<CODE>...</CODE>" disables the footer entirely.
250
251 <!-- NEED 4in -->
252 <H3>--format format</H3>
253
254 <P>The <CODE>--format</CODE> option specifies the output format for the document and can be one of the following:</P>
255
256 <CENTER><TABLE BORDER="1" CELLPADDING="5">
257 <TR><TH>Format</TH><TH>Description</TH></TR>
258 <TR><TD>epub</TD><TD>Generate an EPUB file.</TD></TR>
259 <TR><TD>html</TD><TD>Generate one or more indexed HTML files.</TD></TR>
260 <TR><TD>htmlsep</TD><TD>Generate separate HTML files for each heading in
261 the table-of-contents.</TD></TR>
262 <TR><TD>pdf</TD><TD>Generate a PDF file (default version - 1.4).</TD></TR>
263 <TR><TD>pdf11</TD><TD>Generate a PDF 1.1 file for Acrobat Reader 2.0 and later.</TD></TR>
264 <TR><TD>pdf12</TD><TD>Generate a PDF 1.2 file for Acrobat Reader 3.0 and later.</TD></TR>
265 <TR><TD>pdf13</TD><TD>Generate a PDF 1.3 file for Acrobat Reader 4.0 and later.</TD></TR>
266 <TR><TD>pdf14</TD><TD>Generate a PDF 1.4 file for Acrobat Reader 5.0 and later.</TD></TR>
267 <TR><TD>ps</TD><TD>Generate one or more PostScript files (default level - 2).</TD></TR>
268 <TR><TD>ps1</TD><TD>Generate one or more Level 1 PostScript files.</TD></TR>
269 <TR><TD>ps2</TD><TD>Generate one or more Level 2 PostScript files.</TD></TR>
270 <TR><TD>ps3</TD><TD>Generate one or more Level 3 PostScript files.</TD></TR>
271 </TABLE></CENTER>
272
273 <H3>--gray</H3>
274
275 <p>The <CODE>--gray</CODE> option specifies that grayscale output is desired.
276
277 <P>This option is only available when generating PostScript or PDF files.
278
279 <H3>--header lcr</H3>
280
281 <p>The <CODE>--header</CODE> option specifies the contents of the page header. The <CODE>lcr</CODE> parameter is a three-character string representing the left, center, and right header fields. See the <A HREF="#footer"><CODE>--footer</CODE></A> option for the list of formatting characters.
282
283 <P>Setting the header to "<CODE>...</CODE>" disables the header entirely.
284
285 <H3>--header1 lcr</H3>
286
287 <p>The <CODE>--header1</CODE> option specifies the contents of the page header for the first body/chapter page. The <CODE>lcr</CODE> parameter is a three-character string representing the left, center, and right header fields. See the <A HREF="#footer"><CODE>--footer</CODE></A> option for the list of formatting characters.
288
289 <P>Setting the header to "<CODE>...</CODE>" disables the first page header entirely.
290
291 <!-- NEED 4in -->
292 <H3>--headfootfont font</H3>
293
294 <p>The <CODE>--headfootfont</CODE> option specifies the font that is used for the header and footer text. The <CODE>font</CODE> parameter can be one of the following:
295
296 <UL>
297
298 <LI>Courier
299
300 <LI>Courier-Bold
301
302 <LI>Courier-Oblique
303
304 <LI>Courier-BoldOblique
305
306 <LI>Helvetica
307
308 <LI>Helvetica-Bold
309
310 <LI>Helvetica-Oblique
311
312 <LI>Helvetica-BoldOblique
313
314
315 <LI>Monospace
316
317 <LI>Monospace-Bold
318
319 <LI>Monospace-Oblique
320
321 <LI>Monospace-BoldOblique
322
323 <LI>Sans
324
325 <LI>Sans-Bold
326
327 <LI>Sans-Oblique
328
329 <LI>Sans-BoldOblique
330
331 <LI>Serif
332
333 <LI>Serif-Roman
334
335 <LI>Serif-Bold
336
337 <LI>Serif-Italic
338
339 <LI>Serif-BoldItalic
340
341 <LI>Times
342
343 <LI>Times-Roman
344
345 <LI>Times-Bold
346
347 <LI>Times-Italic
348
349 <LI>Times-BoldItalic
350
351 </UL>
352
353 <P>This option is only available when generating PostScript or PDF files.
354
355 <H3>--headfootsize size</H3>
356
357 <p>The <CODE>--headfootsize</CODE> option sets the size of the header and footer text in points (1 point = 1/72nd inch).
358
359 <P>This option is only available when generating PostScript or PDF files.
360
361 <!-- NEED 4in -->
362 <H3>--headingfont typeface</H3>
363
364 <P>The <CODE>--headingfont</CODE> options sets the typeface that is used for headings in the document. The <CODE>typeface</CODE> parameter can be one of the following:</P>
365
366 <CENTER><TABLE BORDER="1" CELLPADDING="5">
367 <TR><TH>typeface</TH><TH>Actual Font</TH></TR>
368 <TR><TD>Arial</TD><TD>Helvetica</TD></TR>
369 <TR><TD>Courier</TD><TD>Courier</TD></TR>
370 <TR><TD>Helvetica</TD><TD>Helvetica</TD></TR>
371 <TR><TD>Monospace</TD><TD>DejaVu Sans Mono</TD></TR>
372 <TR><TD>Sans</TD><TD>DevaVu Sans</TD></TR>
373 <TR><TD>Serif</TD><TD>DejaVu Serif</TD></TR>
374 <TR><TD>Times</TD><TD>Times</TD></TR>
375 </TABLE></CENTER>
376
377 <H3>--help</H3>
378
379 <p>The <CODE>--help</CODE> option displays all of the available options to the standard output file.
380
381 <H3>--helpdir directory</H3>
382
383 <p>The <CODE>--helpdir</CODE> option specifies the location of the on-line help files.
384
385 <h3>--hfimage<i>N</i> filename</h3>
386
387 <p>The <code>--hfimage<i>N</i></code> option specifies an image to use in the header and/or footer, where N is a number from 1 to 10. The supported formats are GIF, JPEG, and PNG.</p>
388
389 <H3>--jpeg[=quality]</H3>
390
391 <p>The <CODE>--jpeg</CODE> option enables JPEG compression of continuous-tone images. The optional <CODE>quality</CODE> parameter specifies the output quality from 0 (worst) to 100 (best).
392
393 <P>This option is only available when generating PDF or Level 2 and Level 3 PostScript files.
394
395 <H3>--landscape</H3>
396
397 <p>The <CODE>--landscape</CODE> option specifies that the output should be in landscape orientation (long edge on top).
398
399 <P>This option is only available when generating PostScript or PDF files.
400
401 <H3>--left margin</H3>
402
403 <p>The <CODE>--left</CODE> option specifies the left margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.
404
405 <P>This option is only available when generating PostScript or PDF files.
406
407 <!-- NEED 5in -->
408 <H3>--letterhead filename</H3>
409
410 <P>The <CODE>--letterhead</CODE> option specifies the letterhead image for the page headers and footers for PostScript and PDF files. The supported formats are GIF, JPEG, and PNG.</p>
411
412 <blockquote><b>Note:</b> You need to use the <CODE>--header</CODE> and/or <CODE>--footer</CODE> options with the <CODE>L</CODE> parameter or use the corresponding HTML page comments to display the logo image in the header or footer.</blockquote>
413
414 <H3>--linkcolor color</H3>
415
416 <p>The <CODE>--linkcolor</CODE> option specifies the color of links in EPUB, HTML. and PDF output. The color can be specified by name or as a 6-digit hexadecimal number of the form <CODE>#RRGGBB</CODE>.
417
418 <H3>--links</H3>
419
420 <P>The <CODE>--links</CODE> option specifies that PDF output should contain hyperlinks.
421
422 <H3>--linkstyle style</H3>
423
424 <p>The <CODE>--linkstyle</CODE> option specifies the style of links in EPUB, HTML, and PDF output. The style can be "plain" for no decoration or "underline" to underline links.
425
426 <!-- NEED 5in -->
427 <H3>--logoimage filename</H3>
428
429 <P>The <CODE>--logoimage</CODE> option specifies the logo image for the HTML navigation bar and page headers and footers for PostScript and PDF files. The supported formats are GIF, JPEG, and PNG.</p>
430
431 <blockquote><b>Note:</b> You need to use the <CODE>--header</CODE> and/or <CODE>--footer</CODE> options with the <CODE>l</CODE> parameter or use the corresponding HTML page comments to display the logo image in the header or footer.</blockquote>
432
433 <H3>--no-compression</H3>
434
435 <p>The <CODE>--no-compression</CODE> option specifies that Flate compression should not be performed on the output files.
436
437 <H3>--no-duplex</H3>
438
439 <p>The <CODE>--no-duplex</CODE> option specifies that the output should be formatted for one sided printing.
440
441 <P>This option is only available when generating PostScript or PDF files. Use the <CODE>--pscommands</CODE> option to generate PostScript duplex mode commands.
442
443 <H3>--no-embedfonts</H3>
444
445 <p>The <CODE>--no-embedfonts</CODE> option specifies that fonts should not be embedded in PostScript and PDF output.
446
447 <H3>--no-encryption</H3>
448
449 <P>The <CODE>--no-encryption</CODE> option specifies that no encryption/security features should be enabled in PDF output.
450
451 <P>This option is only available when generating PDF files.
452
453 <H3>--no-jpeg</H3>
454
455 <p>The <CODE>--no-jpeg</CODE> option specifies that JPEG compression should not be performed on large images.
456
457 <H3>--no-links</H3>
458
459 <P>The <CODE>--no-links</CODE> option specifies that PDF output should not contain hyperlinks.
460
461 <H3>--no-localfiles</H3>
462
463 <p>The <CODE>--no-localfiles</CODE> option disables access to local files on the system. This option should be used when providing remote document conversion services.
464
465 <H3>--no-numbered</H3>
466
467 <p>The <CODE>--no-numbered</CODE> option specifies that headings should not be numbered.
468
469 <H3>--no-pscommands</H3>
470
471 <p>The <CODE>--no-pscommands</CODE> option specifies that PostScript device commands should not be written to the output files.
472
473 <H3>--no-strict</H3>
474
475 <P>The <CODE>--no-strict</CODE> option turns off strict HTML conformance checking.
476
477 <H3>--no-title</H3>
478
479 <p>The <CODE>--no-title</CODE> option specifies that the title page should not be generated.
480
481 <H3>--no-toc</H3>
482
483 <p>The <CODE>--no-toc</CODE> option specifies that the table-of-contents pages should not be generated.
484
485 <H3>--no-xrxcomments</H3>
486
487 <p>The <CODE>--no-xrxcomments</CODE> option specifies that Xerox PostScript job comments should not be written to the output files.
488
489 <P>This option is only available when generating PostScript files.
490
491 <H3>--numbered</H3>
492
493 <p>The <CODE>--numbered</CODE> option specifies that headings should be numbered.
494
495 <H3>--nup pages</H3>
496
497 <p>The <CODE>--nup</CODE> option sets the number of pages that are placed on each output page. Valid values for the <CODE>pages</CODE> parameter are 1, 2, 4, 6, 9, and 16.
498
499 <H3>--outdir directory</H3>
500
501 <p>The <CODE>--outdir</CODE> option specifies an output directory for the
502 document files.
503
504 <P>This option is not compatible with the PDF output format.
505
506 <H3>--outfile filename</H3>
507
508 <p>The <CODE>--outfile</CODE> option specifies an output file for the document.
509
510 <H3>--owner-password password</H3>
511
512 <P>The <CODE>--owner-password</CODE> option specifies the owner password for a PDF file. If not specified or the empty string (""), a random password is generated.
513
514 <P>This option is only available when generating PDF files.
515
516 <H3>--pageduration seconds</H3>
517
518 <p>The <CODE>--pageduration</CODE> option specifies the number of seconds that each page will be displayed in the document.
519
520 <P>This option is only available when generating PDF files.
521
522 <!-- NEED 8in -->
523 <H3>--pageeffect effect</H3>
524
525 <P>The <CODE>--pageeffect</CODE> option specifies the page effect to use in PDF files. The <CODE>effect</CODE> parameter can be one of the following:</P>
526
527 <CENTER><TABLE BORDER="1" CELLPADDING="5">
528 <TR><TH>effect</TH><TH>Description</TH></TR>
529 <TR><TD>none</TD><TD>No effect is generated.</TD></TR>
530 <TR><TD>bi</TD><TD>Box Inward</TD></TR>
531 <TR><TD>bo</TD><TD>Box Outward</TD></TR>
532 <TR><TD>d</TD><TD>Dissolve</TD></TR>
533 <TR><TD>gd</TD><TD>Glitter Down</TD></TR>
534 <TR><TD>gdr</TD><TD>Glitter Down and Right</TD></TR>
535 <TR><TD>gr</TD><TD>Glitter Right</TD></TR>
536 <TR><TD>hb</TD><TD>Horizontal Blinds</TD></TR>
537 <TR><TD>hsi</TD><TD>Horizontal Sweet Inward</TD></TR>
538 <TR><TD>hso</TD><TD>Horizontal Sweep Outward</TD></TR>
539 <TR><TD>vb</TD><TD>Vertical Blinds</TD></TR>
540 <TR><TD>vsi</TD><TD>Vertical Sweep Inward</TD></TR>
541 <TR><TD>vso</TD><TD>Vertical Sweep Outward</TD></TR>
542 <TR><TD>wd</TD><TD>Wipe Down</TD></TR>
543 <TR><TD>wl</TD><TD>Wipe Left</TD></TR>
544 <TR><TD>wr</TD><TD>Wipe Right</TD></TR>
545 <TR><TD>wu</TD><TD>Wipe Up</TD></TR>
546 </TABLE></CENTER>
547
548 <P>This option is only available when generating PDF files.
549
550 <!-- NEED 4in -->
551 <H3>--pagelayout layout</H3>
552
553 <P>The <CODE>--pagelayout</CODE> option specifies the initial page layout in the PDF viewer. The <CODE>layout</CODE> parameter can be one of the following:</P>
554
555 <CENTER><TABLE BORDER="1" CELLPADDING="5">
556 <TR><TH>layout</TH><TH>Description</TH></TR>
557 <TR><TD>single</TD><TD>A single page is displayed.</TD></TR>
558 <TR><TD>one</TD><TD>A single column is displayed.</TD></TR>
559 <TR><TD>twoleft</TD><TD>Two columns are displayed with the first page on the left.</TD></TR>
560 <TR><TD>tworight</TD><TD>Two columns are displayed with the first page on the right.</TD></TR>
561 </TABLE></CENTER>
562
563 <P>This option is only available when generating PDF files.
564
565 <!-- NEED 4in -->
566 <H3>--pagemode mode</H3>
567
568 <P>The <CODE>--pagemode</CODE> option specifies the initial viewing mode in the PDF viewer. The <CODE>mode</CODE> parameter can be one of the following:</P>
569
570 <CENTER><TABLE BORDER="1" CELLPADDING="5">
571 <TR><TH>mode</TH><TH>Description</TH></TR>
572 <TR><TD>document</TD><TD>The document pages are displayed in a normal window.</TD></TR>
573 <TR><TD>outline</TD><TD>The document outline and pages are displayed.</TD></TR>
574 <TR><TD>fullscreen</TD><TD>The document pages are displayed on the entire screen in "slideshow" mode.</TD></TR>
575 </TABLE></CENTER>
576
577 <P>This option is only available when generating PDF files.
578
579 <H3>--path dir1;dir2;dir3;...;dirN</H3>
580
581 <P>The <CODE>--path</CODE> option specifies a search path for files that are loaded by HTMLDOC. It is usually used to get images that use absolute server paths to load.
582
583 <P>Directories are separated by the semicolon (;) so that drive letters and URLs can be specified. Quotes around the directory parameter are optional. They are usually used when the directory string contains spaces.
584
585 <PRE>
586 <KBD>--path "dir1;dir2;dir3;...;dirN"</KBD>
587 </PRE>
588
589 <!-- NEED 5in -->
590 <H3>--permissions permission[,permission,...]</H3>
591
592 <P>The <CODE>--permissions</CODE> option specifies the document permissions. The available permission parameters are listed below:</P>
593
594 <CENTER><TABLE BORDER="1" CELLPADDING="5">
595 <TR><TH>Permission</TH><TH>Description</TH></TR>
596 <TR><TD>all</TD><TD>All permissions</TD></TR>
597 <TR><TD>annotate</TD><TD>User can annotate document</TD></TR>
598 <TR><TD>copy</TD><TD>User can copy text and images from document</TD></TR>
599 <TR><TD>modify</TD><TD>User can modify document</TD></TR>
600 <TR><TD>print</TD><TD>User can print document</TD></TR>
601 <TR><TD>no-annotate</TD><TD>User cannot annotate document</TD></TR>
602 <TR><TD>no-copy</TD><TD>User cannot copy text and images from document</TD></TR>
603 <TR><TD>no-modify</TD><TD>User cannot modify document</TD></TR>
604 <TR><TD>no-print</TD><TD>User cannot print document</TD></TR>
605 <TR><TD>none</TD><TD>No permissions</TD></TR>
606 </TABLE></CENTER>
607
608 <P>The <CODE>--encryption</CODE> option must be used in conjunction with the <CODE>--permissions</CODE> parameter.
609
610 <PRE>
611 <KBD>--permissions no-print --encryption</KBD>
612 </PRE>
613
614 <P>Multiple options can be specified by separating them with commas:</p>
615
616 <PRE>
617 <KBD>--permissions no-print,no-copy --encryption</KBD>
618 </PRE>
619
620 <P>This option is only available when generating PDF files.</P>
621
622 <H3>--portrait</H3>
623
624 <p>The <CODE>--portrait</CODE> option specifies that the output should be in portrait orientation (short edge on top).
625
626 <P>This option is only available when generating PostScript or PDF files.
627
628 <H3>--pdf-indent margin</H3>
629
630 <p>The <CODE>--pdf-indent</CODE> option specifies the indentation for pre-formatted content. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.
631
632 <H3>--pscommands</H3>
633
634 <p>The <CODE>--pscommands</CODE> option specifies that PostScript device commands should be written to the output files.
635
636 <P>This option is only available when generating Level 2 and Level 3 PostScript files.
637
638 <H3>--quiet</H3>
639
640 <P>The <CODE>--quiet</CODE> option prevents error messages from being sent to stderr.
641
642 <H3>--referer url</H3>
643
644 <P>The <CODE>--referer</CODE> option sets the URL that is passed in the <CODE>Referer:</CODE> field of HTTP requests.</P>
645
646 <H3>--right margin</H3>
647
648 <p>The <CODE>--right</CODE> option specifies the right margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.
649
650 <P>This option is only available when generating PostScript or PDF files.
651
652 <H3>--size size</H3>
653
654 <P>The <CODE>--size</CODE> option specifies the page size. The <CODE>size</CODE> parameter can be one of the following standard sizes:</P>
655
656 <CENTER><TABLE BORDER="1" CELLPADDING="5">
657 <TR><TH>size</TH><TH>Description</TH></TR>
658 <TR><TD>Letter</TD><TD>8.5x11in (216x279mm)</TD></TR>
659 <TR><TD>A4</TD><TD>8.27x11.69in (210x297mm)</TD></TR>
660 <TR><TD>Universal</TD><TD>8.27x11in (210x279mm)</TD></TR>
661 </TABLE></CENTER>
662
663 <P>Custom sizes are specified by the page width and length separated by the letter "x" to select a custom page size. Append the letters "in" for inches, "mm" for millimeters, or "cm" for centimeters.
664
665 <P>This option is only available when generating PostScript or PDF files. Use the <CODE>--pscommands</CODE> option to generate PostScript page size commands.
666
667 <H3>--strict</H3>
668
669 <P>The <CODE>--strict</CODE> option turns on strict HTML conformance checking. When enabled, HTML elements that are improperly nested and dangling close elements will produce error messages.
670
671 <H3>--textcolor color</H3>
672
673 <p>The <CODE>--textcolor</CODE> option specifies the default text color for all pages in the document. The color can be specified by a standard HTML color name or as a 6-digit hexadecimal number of the form <CODE>#RRGGBB</CODE>.
674
675 <!-- NEED 4in -->
676 <H3>--textfont typeface</H3>
677
678 <P>The <CODE>--textfont</CODE> options sets the typeface that is used for text in the document. The <CODE>typeface</CODE> parameter can be one of the following:</P>
679
680 <CENTER><TABLE BORDER="1" CELLPADDING="5">
681 <TR><TH>typeface</TH><TH>Actual Font</TH></TR>
682 <TR><TD>Arial</TD><TD>Helvetica</TD></TR>
683 <TR><TD>Courier</TD><TD>Courier</TD></TR>
684 <TR><TD>Helvetica</TD><TD>Helvetica</TD></TR>
685 <TR><TD>Monospace</TD><TD>DejaVu Sans Mono</TD></TR>
686 <TR><TD>Sans</TD><TD>DevaVu Sans</TD></TR>
687 <TR><TD>Serif</TD><TD>DejaVu Serif</TD></TR>
688 <TR><TD>Times</TD><TD>Times</TD></TR>
689 </TABLE></CENTER>
690
691 <H3>--title</H3>
692
693 <p>The <CODE>--title</CODE> option specifies that a title page should be generated.
694
695 <H3>--titlefile filename</H3>
696
697 <p>The <CODE>--titlefile</CODE> option specifies a HTML or Markdown file to use for the title page.
698
699 <H3>--titleimage filename</H3>
700
701 <p>The <CODE>--titleimage</CODE> option specifies the title image for the title page. The supported formats are GIF, JPEG, and PNG.
702
703 <H3>--tocfooter lcr</H3>
704
705 <p>The <CODE>--tocfooter</CODE> option specifies the contents of the table-of-contents footer. The <CODE>lcr</CODE> parameter is a three-character string representing the left, center, and right footer fields. See the <A HREF="#footer"><CODE>--footer</CODE></A> option for the list of formatting characters.
706
707 <P>Setting the TOC footer to "<CODE>...</CODE>" disables the TOC footer entirely.
708
709 <H3>--tocheader lcr</H3>
710
711 <p>The <CODE>--tocheader</CODE> option specifies the contents of the table-of-contents header. The <CODE>lcr</CODE> parameter is a three-character string representing the left, center, and right header fields. See the <A HREF="#footer"><CODE>--footer</CODE></A> option for the list of formatting characters.
712
713 <P>Setting the TOC header to "<CODE>...</CODE>" disables the TOC header entirely.
714
715 <H3>--toclevels levels</H3>
716
717 <p>The <CODE>--toclevels</CODE> options specifies the number of heading levels to include in the table-of-contents pages. The <CODE>levels</CODE> parameter is a number from 1 to 6.
718
719 <H3>--toctitle string</H3>
720
721 <p>The <CODE>--toctitle</CODE> options specifies the string to display at the top of the table-of-contents; the default string is "Table of Contents".
722
723 <H3>--top margin</H3>
724
725 <p>The <CODE>--top</CODE> option specifies the top margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.
726
727 <P>This option is only available when generating PostScript or PDF files.
728
729 <H3>--user-password password</H3>
730
731 <P>The <CODE>--user-password</CODE> option specifies the user password for a PDF file. If not specified or the empty string (""), no password will be required to view the document.
732
733 <P>This option is only available when generating PDF files.
734
735 <H3>--verbose</H3>
736
737 <P>The <CODE>--verbose</CODE> option specifies that progress information should be sent/displayed to the standard error file.
738
739 <H3>--version</H3>
740
741 <P>The <CODE>--version</CODE> option displays the HTMLDOC version number.
742
743 <H3>--webpage</H3>
744
745 <P>The <CODE>--webpage</CODE> option specifies that the input files comprise a web page (or site) and that no title page or table-of-contents should be generated. HTMLDOC will insert a page break between each input file.
746
747 <P>This option is only available when generating PostScript or PDF files.
748
749 <H3>--xrxcomments</H3>
750
751 <p>The <CODE>--xrxcomments</CODE> option specifies that Xerox PostScript job comments should be written to the output files.
752
753 <P>This option is only available when generating PostScript files.
754
755 <!-- NEW PAGE -->
756 <H2>Environment Variables</H2>
757
758 <p>HTMLDOC looks for several environment variables which can override the default directories, display additional debugging information, and disable CGI mode.</p>
759
760 <H3>HTMLDOC_DATA</H3>
761
762 <p>This environment variable specifies the location of HTMLDOC's <VAR>data</VAR> and <VAR>fonts</VAR> directories, normally <VAR>/usr/share/htmldoc</VAR> or <VAR>C:\Program Files\HTMLDOC</VAR>.</p>
763
764 <H3>HTMLDOC_DEBUG</H3>
765
766 <p>This environment variable enables debugging information that is sent to stderr. The value is a list of keywords separated by spaces:</p>
767
768 <CENTER><TABLE BORDER="1" CELLPADDING="5">
769 <TR><TH>keyword</TH><TH>Information Shown</TH></TR>
770 <TR><TD><CODE>links</CODE></TD><TD>Shows all of the links in a document</TD></TR>
771 <TR><TD><CODE>memory</CODE></TD><TD>Shows memory usage statistics</TD></TR>
772 <TR><TD><CODE>remotebytes</CODE></TD><TD>Shows the number of bytes that were transferred via HTTP</TD></TR>
773 <TR><TD><CODE>table</CODE></TD><TD>Puts a box around each table, row, and cell</TD></TR>
774 <TR><TD><CODE>tempfiles</CODE></TD><TD>Shows the temporary files that were created, and preserves them for debugging</TD></TR>
775 <TR><TD><CODE>timing</CODE></TD><TD>Shows the load and render times</TD></TR>
776 <TR><TD><CODE>all</CODE></TD><TD>All of the above</TD></TR>
777 </TABLE></CENTER>
778
779 <H3>HTMLDOC_HELP</H3>
780
781 <p>This environment variable specifies the location of HTMLDOC's documentation directory, normally <VAR>/usr/share/doc/htmldoc</VAR> or <VAR>C:\Program Files\HTMLDOC\doc</VAR>.</p>
782
783 <H3>HTMLDOC_NOCGI</H3>
784
785 <p>This environment variable, when set (the value doesn't matter), disables CGI mode. It is most useful for using HTMLDOC on a web server from a scripting language or invocation from a program.</p>
786
787
788 <!-- NEW PAGE -->
789 <H2>Messages</H2>
790
791 <P>HTMLDOC sends error and status messages to stderr unless the <CODE>--quiet</CODE> option is provided on the command-line. Applications can capture these messages to relay errors or statistics to the user.
792
793 <H3>BYTES: Message</H3>
794
795 <P>The <CODE>BYTES:</CODE> message specifies the number of bytes that were written to an output file. If the output is directed at a directory then multiple <CODE>BYTES:</CODE> messages will be sent.
796
797 <H3>DEBUG: Messages</H3>
798
799 <P>The <CODE>DEBUG:</CODE> messages contain debugging information based on the value of the <CODE>HTMLDOC_DEBUG</CODE> environment variable. Normally, no <CODE>DEBUG:</CODE> messages are sent by HTMLDOC.</P>
800
801 <H3>ERRnnn: Messages</H3>
802
803 <P>The <CODE>ERRnnn:</CODE> messages specify an error condition. Error numbers 1 to 14 map to the following errors:
804
805 <OL>
806
807 <LI>No files were found or loadable.</LI>
808
809 <LI>No pages were generated.</LI>
810
811 <LI>The document contains too many files or chapters.</LI>
812
813 <LI>HTMLDOC ran out of memory.</LI>
814
815 <LI>The specified file could not be found.</LI>
816
817 <LI>The comment contains a bad HTMLDOC formatting command.</LI>
818
819 <LI>The image file is not in a known format.</LI>
820
821 <LI>HTMLDOC was unable to remove a temporary file.</LI>
822
823 <LI>HTMLDOC had an unspecified internal error.</LI>
824
825 <LI>HTMLDOC encountered a networking error when retrieving a file via a URL.</LI>
826
827 <LI>HTMLDOC was unable to read a file.</LI>
828
829 <LI>HTMLDOC was unable to write a file.</LI>
830
831 <LI>A HTML error was found in a source file.</LI>
832
833 <LI>A table, image, or text fragment was too large to fit in the space provided.</LI>
834
835 <LI>A hyperlink in the source files was unresolved.</LI>
836
837 <LI>A header/footer string in the document contains a bad $ command.</LI>
838
839 <LI>The content is too nested to safely render.</LI>
840
841 </OL>
842
843 <P>Error numbers 100 to 505 correspond directly to a HTTP status code.
844
845 <H3>INFO: Messages</H3>
846
847 <P>The <CODE>INFO:</CODE> messages contain general information that is logged when HTMLDOC is running in CGI mode or when you use the <CODE>--verbose</CODE> option.</P>
848
849 <H3>PAGES: Message</H3>
850
851 <P>The <CODE>PAGES:</CODE> message specifies the number of pages that were written to an output file. If the output is directed at a directory then multiple <CODE>PAGES:</CODE> messages will be sent. No <CODE>PAGES:</CODE> messages are sent when generating HTML or EPUB output.
852
853 <H3>REMOTEBYTES: Message</H3>
854
855 <P>The <CODE>REMOTEBYTES:</CODE> message specifies the number of bytes that were transferred using HTTP. This message is only displayed if the <CODE>HTMLDOC_DEBUG</CODE> environment variable has the keyword <CODE>remotebytes</CODE> or <CODE>all</CODE>.</P>
856
857 <H3>TIMING: Message</H3>
858
859 <P>The <CODE>TIMING:</CODE> message specifies the load, render, and total time in seconds for the current command. This message is only displayed if the <CODE>HTMLDOC_DEBUG</CODE> environment variable has the keyword <CODE>timing</CODE> or <CODE>all</CODE>.</P>
860
861 </DIV>
862
863 </BODY>
864 </HTML>