HTMLDOC supports most HTML 3.2 elements, some HTML 4.0 elements, and can generate a title page and table of contents pages.
HTMLDOC can be used as a standalone application, in a batch document processing environment, or as a web-based report generation application.
No restrictions are placed upon the output produced by HTMLDOC .
sgi
that generated "compiled" Standard Generalized
Markup Language ("SGML") files that could be used by the Electronic
Book Technologies ("EBT") documentation products (EBT is now owned by
INSO.) When sgi
stopped supporting these tools we
turned to INSO, but the cost of their tools is prohibitive to small
businesses.
In the end we decided to write our own program to generate our documentation. HTML seemed to be the source format of choice since WYSIWYG HTML editors are widely (and freely) available and at worst you can use a plain text editor. We needed HTML output for documentation on our web server, PDF for customers to read and/or print from their computers, and PostScript for our own printing needs.
The result of our efforts is the HTMLDOC software which is available for UNIX® and Microsoft® Windows®. Among other things, this software users manual is produced using HTMLDOC.
The Graphics Interchange Format is the copyright and GIFSM is the service mark property of CompuServe Incorporated.
Compaq, Digital, and Tru64 are registered trademarks of Compaq.
Intel is a registered trademark of Intel Corporation.
IRIX and sgi
are registered trademarks of sgi
.
Linux is a registered trademark of Linus Torvalds.
Microsoft, Windows, Windows 95, Windows 98, and Windows NT are registered trademarks of Microsoft Corporation.
Red Hat and RPM are registered trademarks of Red Hat, Inc.
Solaris is a registered trademark of Sun Microsystems, Inc.
SPARC is a registered trademark of SPARC International, Inc.
UNIX is a registered trademark of the X/Open Company, Ltd.
HTMLDOC is copyright 1997-1999 by Easy Software Products. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
A copy of the GNU General Public License is included in Appendix A of this manual. If this appendix is missing from your copy of HTMLDOC, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
This software is based in part on the work of the Independent JPEG Group.
% rpm -i htmldoc-1.8-linux-2.0.36-intel.rpm ENTER
% rpm -r htmldoc ENTER
% gunzip htmldoc-1.8-platform.tar.gz ENTER % tar xf htmldoc-1.8-platform.tar ENTER % ./setup ENTERSubstitute the correct platform string as needed.
% /etc/software/htmldoc.remove ENTER
CC
environment
variable to the name and path of your ANSI C compiler:
% setenv CC /path/to/compiler [C Shell] % CC=/path/to/compiler; export CC [Bourne/Korn Shell]Similarly, if your C++ compiler is not called CC, gcc , c++, or g++, set the
CXX
environment variable to the name and path of your C++ compiler:
% setenv CXX /path/to/compiler [C Shell] % CXX=/path/to/compiler; export CXX [Bourne/Korn Shell]Finally, if the FLTK library is not installed in a standard location for your compilers, set the
CFLAGS
, CXXFLAGS
,
and LDFLAGS
environment variables to point to the FLTK
library:
% setenv CFLAGS -I/path/to/fltk [C Shell] % setenv CXXFLAGS -I/path/to/fltk % setenv LDFLAGS -L/path/to/fltk/lib % CFLAGS=-I/path/to/fltk; export CFLAGS [Bourne/Korn Shell] % CXXFLAGS=-I/path/to/fltk; export CXXFLAGS % LDFLAGS=-L/path/to/fltk/lib; export LDFLAGSThen run the following command to configure HTMLDOC for installation in the default directories:
% ./configure ENTERThe default configuration will install HTMLDOC in the /usr/bin directory with the data files under /usr/share/htmldoc and the documentation and on-line help under /usr/share/doc/htmldoc. Use the
--prefix
option to
change the installation prefix to /usr/local:
% ./configure --prefix=/usr/local ENTER
% make ENTERIf you get any fatal errors please send a copy of the make/compiler output to " htmldoc-support@easysw.com" for assistance. Please note the version of HTMLDOC that you are using as well as any pertinent system information (operating system, OS version, compiler, etc.)
% make install ENTER
To install HTMLDOC without InstallShield, create an installation directory and copy the htmldoc.exe executable, the afm directory, the data directory, and the doc directory to it.
Then use the regedit program to create the following two string entries:
HKEY_LOCAL_MACHINE\Software\Easy Software
Products\HTMLDOC\data
HKEY_LOCAL_MACHINE\Software\Easy Software Products\HTMLDOC\doc
% htmldoc ENTERChoose HTMLDOC from the Start menu to start HTMLDOC under Windows.
Figure 2-1 - The HTMLDOC Window
Then choose a file for conversion by clicking on the Add Files... button (2). When the file chooser dialog appears (Figure 3), double-click on the HTML file (3) you wish to convert from the list of files.
Figure 2-2 - The File Chooser Dialog
Figure 2-3 - The Output Tab
HTMLDOC uses HTML heading elements to delineate chapters and
headings in a book. The H1
element is used for chapters:
<HTML> <HEAD> <TITLE>The Little Computer that Could</TITLE> </HEAD> <BODY> <H1>Chapter 1 - The Little Computer is Born</H1> ... <H1>Chapter 2 - Little Computer's First Task</H1> ... </BODY> </HTML>Sub-headings are marked using the
H2
through H6
elements.
Figure 3-1: The Input Tab
Then choose one or more files for conversion by clicking on the Add Files... button (2). When the file chooser dialog appears, pick the file(s) you wish to convert from the list of files and then click on the OK button.
META
information on it. Type the
title image filename into the Title Image field or click on
the Browse... button (3) to select a title image for your
book.
Figure 3-2: The Output Tab
.BOOK
file so you can
regenerate your book when you make changed to your HTML files.
Click on the Save button (7) to save the current book to a file.
% htmldoc --webpage -f output.pdf filename.html ENTER % htmldoc --webpage -f output.ps filename.html ENTERThe "--webpage" option tells HTMLDOC that you want to convert a web page or other unstructured document.
The "-f" option tells HTMLDOC what file to generate. If you don't specify an output file then a PDF file is send to the standard output.
% htmldoc --book -f output.html filename.html ENTER % htmldoc --book -f output.pdf filename.html ENTER % htmldoc --book -f output.ps filename.html ENTERThe "--book" option tells HTMLDOC that you want to generate a book from the HTML file(s) you specified.
--titleimage
sets the image to use on the title page:
% htmldoc --titleimage filename.gif ... ENTER % htmldoc --titleimage filename.jpg ... ENTER % htmldoc --titleimage filename.png ... ENTERHTMLDOC supports GIF, JPEG, and PNG images.
To make this work the CGI script or program must send the appropriate HTTP attributes, the required empty line to signify the beginning of the document, and then execute the HTMLDOC program to generate the HTML, PostScript, or PDF file as needed.
#!/bin/sh docroot=/insert/directory/here cd $docroot echo "Content-Type: application/pdf" echo "" htmldoc -t pdf --webpage $1Users of this CGI would reference the URL "http://www.domain.com/topdf.cgi?index.html" to generate a PDF file of the site's home page.
You can update the script to use the PATH_TRANSLATED
environment variable so that URLs like
"http://www.domain.com/cgi-bin/topdf/index.html" work as well:
#!/bin/sh docroot=`dirname $PATH_TRANSLATED` cd $docroot echo "Content-Type: application/pdf" echo "" htmldoc -t pdf --webpage $PATH_TRANSLATED
Here is a simple Perl subroutine that can be used to write a PDF report to the HTTP client:
sub topdf(filename); sub topdf { print "Content-Type: application/pdf\n\n" system htmldoc -t pdf --webpage $filename }
Here are some simple C functions that can be used to generate a PDF report to the HTTP client from a temporary file or pipe:
#include <stdio.h> #include <stdlib.h> /* topdf() - convert a HTML file to PDF */ FILE *topdf(const char *filename) /* HTML file to convert */ { char command[1024]; /* Command to execute */ puts("Content-Type: application/pdf\n"); sprintf(command, "htmldoc -t pdf --webpage %s", filename); return (popen(command, "w")); } /* topdf2() - pipe HTML output to HTMLDOC for conversion to PDF */ FILE *topdf2(void) { puts("Content-Type: application/pdf\n"); return (popen("htmldoc -t pdf --webpage -", "w")); }
Element | Version | Supported? | Notes |
---|---|---|---|
!DOCTYPE | 3.0 | Yes | DTD is ignored |
A | 1.0 | Yes | See Below |
ACRONYM | 2.0 | Yes | No font change |
ADDRESS | 2.0 | Yes | |
APPLET | 4.0 | No | |
AREA | 2.0 | No | |
B | 1.0 | Yes | |
BASE | 2.0 | No | |
BASEFONT | 1.0 | No | |
BIG | 2.0 | Yes | |
BLINK | 2.0 | No | |
BLOCKQUOTE | 2.0 | Yes | |
BODY | 1.0 | Yes | |
BR | 2.0 | Yes | |
CAPTION | 2.0 | Yes | See Below |
CENTER | 2.0 | Yes | |
CITE | 2.0 | Yes | Italic/Oblique |
CODE | 2.0 | Yes | Courier |
COL | 4.0 | No | |
COLGROUP | 4.0 | No | |
DD | 2.0 | Yes | |
DEL | 2.0 | Yes | Strikethrough |
DFN | 2.0 | Yes | Helvetica |
DIR | 2.0 | Yes | |
DIV | 3.2 | Yes | |
DL | 2.0 | Yes | |
DT | 2.0 | Yes | Italic/Oblique |
EM | 2.0 | Yes | Italic/Oblique |
EMBED | 2.0 | Yes | HTML Only |
FONT | 2.0 | Yes | See Below |
FORM | 2.0 | No | |
FRAME | 3.2 | No | |
FRAMESET | 3.2 | No | |
H1 | 1.0 | Yes | Boldface, See Below |
H2 | 1.0 | Yes | Boldface, See Below |
H3 | 1.0 | Yes | Boldface, See Below |
H4 | 1.0 | Yes | Boldface, See Below |
H5 | 1.0 | Yes | Boldface, See Below |
H6 | 1.0 | Yes | Boldface, See Below |
HEAD | 1.0 | Yes | |
HR | 1.0 | Yes | See Below |
HTML | 1.0 | Yes | |
I | 1.0 | Yes | |
IMG | 1.0 | Yes | GIF, JPEG, PNG |
INPUT | 2.0 | No | |
INS | 2.0 | Yes | Underline |
ISINDEX | 2.0 | No | |
KBD | 2.0 | Yes | Courier Bold |
LI | 2.0 | Yes | |
LINK | 2.0 | No | |
MAP | 2.0 | No | |
MENU | 2.0 | Yes | |
META | 2.0 | Yes | See Below |
MULTICOL | N3.0 | No | |
NOBR | 1.0 | No | |
NOFRAMES | 3.2 | No | |
OL | 2.0 | Yes | |
OPTION | 2.0 | No | |
P | 1.0 | Yes | |
PRE | 1.0 | Yes | |
S | 2.0 | Yes | Strikethrough |
SAMP | 2.0 | Yes | Courier |
SCRIPT | 2.0 | No | |
SELECT | 2.0 | No | |
SMALL | 2.0 | Yes | |
SPACER | N3.0 | Yes | |
STRIKE | 2.0 | Yes | |
STRONG | 2.0 | Yes | Boldface Italic/Oblique |
STYLE | 4.0 | No | |
SUB | 2.0 | Yes | Reduced Fontsize |
SUP | 2.0 | Yes | Reduced Fontsize |
TABLE | 2.0 | Yes | See Below |
TBODY | 4.0 | No | |
TD | 2.0 | Yes | |
TEXTAREA | 2.0 | No | |
TFOOT | 4.0 | No | |
TH | 2.0 | Yes | Boldface Center |
THEAD | 4.0 | No | |
TITLE | 2.0 | Yes | |
TR | 2.0 | Yes | |
TT | 2.0 | Yes | Courier |
U | 1.0 | Yes | |
UL | 2.0 | Yes | |
VAR | 2.0 | Yes | Helvetica Oblique |
WBR | 1.0 | No |
<!-- PAGE BREAK -->
<!-- NEW PAGE -->
<!-- NEW SHEET -->
Requested Font | Actual Font |
---|---|
Arial | Helvetica |
Courier | Courier |
Helvetica | Helvetica |
Monospace | Courier |
Sans-Serif | Helvetica |
Serif | Times |
Symbol | Symbol |
Times | Times |
All chapters start with a top-level heading (H1) markup. Any headings within a chapter must be of a lower level (H2 to H6). Each chapter starts a new page or the next odd-numbered page if duplexing is selected.
The headings you use within a chapter must start at level 2 (H2). If you skip levels the heading will be shown under the last level that was known. For example, if you use the following hierarchy of headings:
<H1>Chapter Heading</H1> ... <H2>Section Heading 1</H2> ... <H2>Section Heading 2</H2> ... <H3>Sub-Section Heading 1</H3> ... <H4>Sub-Sub-Section Heading 1</H4> ... <H4>Sub-Sub-Section Heading 2</H4> ... <H3>Sub-Section Heading 2</H3> ... <H2>Section Heading 3</H2> ... <H4>Sub-Sub-Section Heading 3</H4> ...the table-of-contents that is generated will show:
VALUE="#"
TYPE="1"
TYPE="a"
TYPE="A"
TYPE="i"
TYPE="I"
External URL links are fully supported for HTML and PDF output, and
internal links (#target
and filename.html
)
are supported in HTML and PDF output.
When generating PDF files, local PDF file links will be converted to external file links for the PDF viewer instead of URL links. That is, you can directly link to another local PDF file from your HTML document with:
<A HREF="filename.pdf">...</A>
META
attributes for
the title page and document information:
<META NAME="AUTHOR" CONTENT="..."
<META NAME="COPYRIGHT" CONTENT="..."
<META NAME="DOCNUMBER" CONTENT="..."
<META NAME="GENERATOR" CONTENT="..."
BREAK
attribute is still supported by the HR
element:
<HR BREAK>Support for the
BREAK
attribute is deprecated and will be
removed in a future release of HTMLDOC.
CAPTION
element is always shown at the top of the
table. ROWSPAN
attribute is ignored. VALIGN
attribute is ignored.
.BOOK
files. The buttons on the bottom of the HTMLDOC
window allow you manage these files and generate formatted documents.
Note: Saving a document is not the same as generating a document. The book files saved to disk by the Save and Save As... buttons are not the final HTML, PDF, or PostScript output files. You generate those files by clicking on the Generate button.
Note: Saving a document is not the same as generating a document. The book files saved to disk by the Save and Save As... buttons are not the final HTML, PDF, or PostScript output files. You generate those files by clicking on the Generate button.
Note: Generating a document is not the same as saving a document. To save the current HTML files and settings in the HTMLDOC GUI, click on the Save or Save As... buttons instead.
Figure 7-1 - The Input Tab
The Delete Files button only removes the files from the Input Files list. The files are not removed from disk.
Click on the Browse... button to select a logo image file using the file chooser dialog.
Click on the Browse... button to select a title image file using the file chooser dialog.
Figure 7-2 - The Output Tab
Directory output is not available when generating PDF files.
Figure 7-3 - The Page Tab
HTMLDOC supports the following standard page size names:
Figure 7-4 - The TOC Tab
Figure 7-5 - The Colors Tab
#RRGGBB
. Click on the Lookup...
button to pick the color graphically.
#RRGGBB
. Click on the Lookup... button to
pick the color graphically.
Figure 7-6 - The Fonts Tab
Figure 7-7 - The PS Tab
PostScript Level 2 is compatible with most PostScript printers and supports printer commands and JPEG image compression.
PostScript Level 3 is compatible with only the newest PostScript printers and supports Flate image compression in addition to the Level 2 features.
setpagedevice
commands
for the page size and duplex settings. Click in the check box to enable
or disable printer commands.
Printer commands are only available with Level 2 and 3 output and may not work with some printers.
Figure 7-8 - The PDF Tab
The Document page mode displays only the document pages. The Outline page mode displays the table-of-contents outline as well as the document pages. The Full-Screen page mode displays the document pages on the whole screen; this mode is used primarily for presentations.
The Single page layout displays a single page at a time. The One Column page layout displays a single column of pages at a time. The Two Column Left and Two Column Right page layouts display two columns of pages at a time; the first page is displayed in the left or right column as selected.
Figure 7-9 - The Options Tab
The %s
is added automatically to the end of the command
name to insert the name of the file to be edited. If you are using
Netscape Composer to edit your HTML files you should put "-edit" before
the %s
to tell Netscape to edit the file and not display
it.
Figure 7-10 - The File Chooser
% htmldoc options filename1.html ... filenameN.html ENTER % htmldoc options filename.book ENTERThe first form converts the named HTML files to the specified output format immediately. The second form loads the specified
.book
file and displays the HTMLDOC window, allowing a user to make
changes and/or generate the document interactively.
If no output file or directory is specified, then all output is sent to the standard output file.
-d
option specifies an output directory for the
document files.
This option is not compatible with the PDF output format.
-f
option specifies an output file for the document.
-t
option specifies the output format for the
document and can be one of the following:
Format | Description |
---|---|
html | Generate one or more indexed HTML files. |
Generate a PDF file (default version). | |
pdf11 | Generate a PDF 1.1 file for Acrobat Reader 2.0. |
pdf12 | Generate a PDF 1.2 file for Acrobat Reader 3.0. |
pdf13 | Generate a PDF 1.3 file for Acrobat Reader 4.0. |
ps | Generate one or more PostScript files (default level). |
ps1 | Generate one or more Level 1 PostScript files. |
ps2 | Generate one or more Level 2 PostScript files. |
ps3 | Generate one or more Level 3 PostScript files. |
-v
option specifies that progress information should
be sent/displayed to the standard error file.
--bodycolor
option specifies the background color for
all pages in the document. The color can be specified by name or as a
6-digit hexadecimal number of the form #RRGGBB
.
--bodyfont
option specifies the default text font
used for text in the document body. The typeface
parameter
can be one of the following:
typeface | Actual Font |
---|---|
Arial | Helvetica |
Courier | Courier |
Helvetica | Helvetica |
Monospace | Courier |
Sans-Serif | Helvetica |
Serif | Times |
Symbol | Symbol |
Times | Times |
--bodyimage
option specifies the background image for
all pages in the document. The supported formats are GIF, JPEG, and
PNG.
--book
option specifies that the input files comprise
a book with chapters and headings.
--bottom
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.
This option is only available when generating PostScript or PDF files.
--browserwidth
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.
The default browser width is 680 pixels which corresponds roughly to a 96 DPI display.
This option is only available when generating PostScript or PDF files.
--charset
option specifies the 8-bit character set
encoding to use for the entire document. HTMLDOC comes with the
following character set files:
charset | Character Set |
---|---|
8859-1 | ISO-8859-1 |
8859-2 | ISO-8859-2 |
8859-3 | ISO-8859-3 |
8859-4 | ISO-8859-4 |
8859-5 | ISO-8859-5 |
8859-6 | ISO-8859-6 |
8859-7 | ISO-8859-7 |
8859-8 | ISO-8859-8 |
8859-9 | ISO-8859-9 |
8859-14 | ISO-8859-14 |
8859-15 | ISO-8859-15 |
--color
option specifies that color output is
desired.
This option is only available when generating PostScript or PDF files.
--compression
option specifies that Flate compression
should be performed on the output file(s). The optional level
parameter is a number from 1 (fastest and least amount of compression)
to 9 (slowest and most amount of compression).
This option is only available when generating Level 3 PostScript or PDF files.
--datadir
option specifies the location of data files
used by HTMLDOC.
--duplex
option specifies that the output should be
formatted for two sided printing.
This option is only available when generating PostScript or PDF
files. Use the --pscommands
option to generate PostScript
duplex mode commands.
--effectduration
option specifies the duration of a
page transition effect in seconds.
This option is only available when generating PDF files.
--firstpage
option specifies the first page that will
be displayed in a PDF file. The page
parameter can be one
of the following:
page | Description |
---|---|
p1 | The first page of the document. |
toc | The first page of the table-of-contents. |
c1 | The first page of chapter 1. |
This option is only available when generating PDF files.
--fontsize
option specifies the base font size for
the entire document in points (1 point = 1/72nd inch).
--fontspacing
option specifies the line spacing for
the entire document as a multiplier of the base font size. A
spacing
value of 1 makes each line of text the same height as
the font.
--footer
option specifies the contents of the page
footer. The lcr
parameter is a three-character string
representing the left, center, and right footer fields. Each character
can be one of the following:
lcr | Description |
---|---|
. | A period indicates that the field should be blank. |
1 | The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...) |
c | An "c" indicates that the field should contain the current chapter. |
h | An "h" indicates that the field should contain the current heading. |
i | A lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...) |
I | An uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...) |
l | A lowercase L indicates that the field should contain the logo image. |
t | A "t" indicates that the field should contain the document title. |
Setting the footer to "...
" disables the footer
entirely.
This option is only available when generating PostScript or PDF files.
--format
option specifies the output format for the
document and can be one of the following:
Format | Description |
---|---|
html | Generate one or more indexed HTML files. |
Generate a PDF file (default version). | |
pdf11 | Generate a PDF 1.1 file for Acrobat Reader 2.0. |
pdf12 | Generate a PDF 1.2 file for Acrobat Reader 3.0. |
pdf13 | Generate a PDF 1.3 file for Acrobat Reader 4.0. |
ps | Generate one or more PostScript files (default level). |
ps1 | Generate one or more Level 1 PostScript files. |
ps2 | Generate one or more Level 2 PostScript files. |
ps3 | Generate one or more Level 3 PostScript files. |
--gray
option specifies that grayscale output is
desired.
This option is only available when generating PostScript or PDF files.
--header
option specifies the contents of the page
header. The lcr
parameter is a three-character string
representing the left, center, and right header fields. Each character
can be one of the following:
lcr | Description |
---|---|
. | A period indicates that the field should be blank. |
1 | The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...) |
c | An "c" indicates that the field should contain the current chapter. |
h | An "h" indicates that the field should contain the current heading. |
i | A lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...) |
I | An uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...) |
l | A lowercase L indicates that the field should contain the logo image. |
t | A "t" indicates that the field should contain the document title. |
Setting the header to "...
" disables the header
entirely.
This option is only available when generating PostScript or PDF files.
--headfootfont
option specifies the font that is used
for the header and footer text. The font
parameter can be
one of the following:
This option is only available when generating PostScript or PDF files.
--headfootsize
option sets the size of the header and
footer text in points (1 point = 1/72nd inch).
This option is only available when generating PostScript or PDF files.
--headingfont
options sets the typeface that is used
for headings in the document. The typeface
parameter can
be one of the following:
typeface | Actual Font |
---|---|
Arial | Helvetica |
Courier | Courier |
Helvetica | Helvetica |
Monospace | Courier |
Sans-Serif | Helvetica |
Serif | Times |
Symbol | Symbol |
Times | Times |
--help
option displays all of the available options
to the standard output file.
--helpdir
option specifies the location of the
on-line help files.
--jpeg
option enables JPEG compression of
continuous-tone images. The optional quality
parameter
specifies the output quality from 0 (worst) to 100 (best).
This option is only available when generating Level 2 and Level 3 PostScript or PDF files.
--landscape
option specifies that the output should
be in landscape orientation (long edge on top).
This option is only available when generating PostScript or PDF files.
--left
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.
This option is only available when generating PostScript or PDF files.
--logoimage
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.
--no-compression
option specifies that Flate
compresion should not be performed on the output files.
--no-pscommands
option specifies that PostScript
device commands should not be written to the output files.
--no-title
option specifies that the title page
should not be generated.
--no-toc
option specifies that the table-of-contents
pages should not be generated.
--numbered
option specifies that headings should be
numbered.
--outdir
option specifies an output directory for the
document files.
This option is not compatible with the PDF output format.
--outfile
option specifies an output file for the
document.
--pageduration
option specifies the number of seconds
that each page will be displayed in the document.
This option is only available when generating PDF files.
--pageeffect
option specifies the page effect to use
in PDF files. The effect
parameter can be one of the
following:
effect | Description |
---|---|
none | No effect is generated. |
bi | Box Inward |
bo | Box Outward |
d | Dissolve |
gd | Glitter Down |
gdr | Glitter Down and Right |
gr | Glitter Right |
hb | Horizontal Blinds |
hsi | Horizontal Sweet Inward |
hso | Horizontal Sweep Outward |
vb | Vertical Blinds |
vsi | Vertical Sweep Inward |
vso | Vertical Sweep Outward |
wd | Wipe Down |
wl | Wipe Left |
wr | Wipe Right |
wu | Wipe Up |
This option is only available when generating PDF files.
--pagelayout
option specifies the initial page layout
in the PDF viewer. The layout
parameter can be one of the
following:
layout | Description |
---|---|
single | A single page is displayed. |
one | A single column is displayed. |
twoleft | Two columns are displayed with the first page on the left. |
tworight | Two columns are displayed with the first page on the right. |
This option is only available when generating PDF files.
--pagemode
option specifies the initial viewing mode
in the PDF viewer. The mode
parameter can be one of the
following:
mode | Description |
---|---|
document | The document pages are displayed in a normal window. |
outline | The document outline and pages are displayed. |
fullscreen | The document pages are displayed on the entire screen in "slideshow" mode. |
This option is only available when generating PDF files.
--portrait
option specifies that the output should be
in portrait orientation (short edge on top).
This option is only available when generating PostScript or PDF files.
--pscommands
option specifies that PostScript device
commands should be written to the output files.
This option is only available when generating Level 2 and Level 3 PostScript files.
--right
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.
This option is only available when generating PostScript or PDF files.
--size
option specifies the page size. The size
parameter can be one of the following standard sizes:
size | Description |
---|---|
Letter | 8.5x11in (216x279mm) |
A4 | 8.27x11.69in (210x297mm) |
Universal | 8.27x11in (210x279mm) |
This option is only available when generating PostScript or PDF
files. Use the --pscommands
option to generate PostScript
page size commands.
--textcolor
option specifies the default text color
for all pages in the document. The color can be specified by name or as
a 6-digit hexadecimal number of the form #RRGGBB
.
--textfont
options sets the typeface that is used for
text in the document. The typeface
parameter can be one of
the following:
typeface | Actual Font |
---|---|
Arial | Helvetica |
Courier | Courier |
Helvetica | Helvetica |
Monospace | Courier |
Sans-Serif | Helvetica |
Serif | Times |
Symbol | Symbol |
Times | Times |
--title
option specifies that a title page should be
generated.
--titleimage
option specifies the title image for the
title page. The supported formats are GIF, JPEG, and PNG.
--tocfooter
option specifies the contents of the
table-of-contents footer. The lcr
parameter is a
three-character string representing the left, center, and right footer
fields. Each character can be one of the following:
lcr | Description |
---|---|
. | A period indicates that the field should be blank. |
1 | The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...) |
c | An "c" indicates that the field should contain the current chapter. |
h | An "h" indicates that the field should contain the current heading. |
i | A lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...) |
I | An uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...) |
l | A lowercase L indicates that the field should contain the logo image. |
t | A "t" indicates that the field should contain the document title. |
Setting the TOC footer to "...
" disables the TOC footer
entirely.
This option is only available when generating PostScript or PDF files.
--tocheader
option specifies the contents of the
table-of-contents header. The lcr
parameter is a
three-character string representing the left, center, and right header
fields. Each character can be one of the following:
lcr | Description |
---|---|
. | A period indicates that the field should be blank. |
1 | The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...) |
c | An "c" indicates that the field should contain the current chapter. |
h | An "h" indicates that the field should contain the current heading. |
i | A lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...) |
I | An uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...) |
l | A lowercase L indicates that the field should contain the logo image. |
t | A "t" indicates that the field should contain the document title. |
Setting the TOC header to "...
" disables the TOC header
entirely.
This option is only available when generating PostScript or PDF files.
--toclevels
options specifies the number of heading
levels to include in the table-of-contents pages. The levels
parameter is a number from 1 to 6.
--top
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.
This option is only available when generating PostScript or PDF files.
-v
option specifies that progress information should
be sent/displayed to the standard error file.
--webpage
option specifies that the input files
comprise a web page (or site) and that no title page or
table-of-contents should be generated.
This option is only available when generating PostScript or PDF files.
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation,
Inc.
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
Everyone is permitted to copy and distribute verbatim copies of
this license document, but changing it is not allowed.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a. Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS