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