<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>HTMLDOC 1.8.27 Software Users Manual</TITLE>
<META NAME="author" CONTENT="Easy Software Products">
<META NAME="copyright" CONTENT="Copyright 1997-2006, All Rights Reserved.">
<META NAME="docnumber" CONTENT="ESP-003-20060801">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
<STYLE TYPE="text/css"><!--
BODY { font-family: serif }
H1 { font-family: sans-serif }
H2 { font-family: sans-serif }
H3 { font-family: sans-serif }
H4 { font-family: sans-serif }
H5 { font-family: sans-serif }
H6 { font-family: sans-serif }
SUB { font-size: smaller }
SUP { font-size: smaller }
PRE { font-family: monospace }
--></STYLE>
</HEAD>
<BODY>
<CENTER><A HREF="#CONTENTS"><H1>HTMLDOC 1.8.27 Software Users Manual</H1></A><BR>
ESP-003-20060801<BR>
Easy Software Products<BR>
Copyright 1997-2006, All Rights Reserved.<BR>
</CENTER>
<HR NOSHADE>
<H1 ALIGN="CENTER"><A NAME="CONTENTS">Table of Contents</A></H1>
<BR>
<BR><B><A HREF="#INTRO">Introduction</A></B>
<UL>
<LI><A HREF="#1_1">History</A></LI>
<LI><A HREF="#1_2">Organization of This Manual</A></LI>
<LI><A HREF="#1_3">Support</A></LI>
<LI><A HREF="#1_4">Encryption Support</A></LI>
<LI><A HREF="#1_5">Copyright, Trademark, and License Information</A></LI>
</UL>
<B><A HREF="#INSTALL">Chapter 1 - Installing HTMLDOC</A></B>
<UL>
<LI><A HREF="#2_1">Requirements</A></LI>
<LI><A HREF="#2_2">Installing HTMLDOC</A>
<UL>
<LI><A HREF="#2_2_1">Installing HTMLDOC on Microsoft Windows</A></LI>
<LI><A HREF="#2_2_2">Installing HTMLDOC on MacOS X</A></LI>
<LI><A HREF="#2_2_3">Installing HTMLDOC on Linux</A></LI>
<LI><A HREF="#2_2_4">Installing HTMLDOC on Solaris</A></LI>
</UL>
</LI>
<LI><A HREF="#2_3">Licensing HTMLDOC</A></LI>
<LI><A HREF="#2_4">Uninstalling HTMLDOC</A>
<UL>
<LI><A HREF="#2_4_1">Uninstalling HTMLDOC on Microsoft Windows</A></LI>
<LI><A HREF="#2_4_2">Uninstalling HTMLDOC on MacOS X</A></LI>
<LI><A HREF="#2_4_3">Uninstalling HTMLDOC on Linux</A></LI>
<LI><A HREF="#2_4_4">Uninstalling HTMLDOC on Solaris</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#STARTING">Chapter 2 - Getting Started</A></B>
<UL>
<LI><A HREF="#3_1">Starting HTMLDOC</A></LI>
<LI><A HREF="#3_2">Choosing a HTML File</A></LI>
<LI><A HREF="#3_3">Setting the Output File</A></LI>
<LI><A HREF="#3_4">Generating the Document</A></LI>
</UL>
<B><A HREF="#BOOKS">Chapter 3 - Generating Books</A></B>
<UL>
<LI><A HREF="#4_1">Overview</A></LI>
<LI><A HREF="#4_2">Choosing HTML Files</A></LI>
<LI><A HREF="#4_3">Selecting a Title File</A></LI>
<LI><A HREF="#4_4">Setting the Output Format</A></LI>
<LI><A HREF="#4_5">Setting the Output File</A></LI>
<LI><A HREF="#4_6">Generating the Document</A></LI>
<LI><A HREF="#4_7">Saving Your Book</A></LI>
</UL>
<B><A HREF="#CMDLINE">Chapter 4 - HTMLDOC from the Command-Line</A></B>
<UL>
<LI><A HREF="#5_1">Getting to the Command-Line on Windows</A></LI>
<LI><A HREF="#5_2">The Basics of Command-Line Access</A>
<UL>
<LI><A HREF="#5_2_1">What Are All These Commands?</A></LI>
</UL>
</LI>
<LI><A HREF="#5_3">Converting Multiple HTML Files</A></LI>
<LI><A HREF="#5_4">Generating Books</A>
<UL>
<LI><A HREF="#5_4_1">What are all these commands?</A></LI>
</UL>
</LI>
<LI><A HREF="#5_5">Setting the Title File</A>
<UL>
<LI><A HREF="#5_5_1">Putting It All Together</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#CGI">Chapter 5 - Using HTMLDOC on a Web Server</A></B>
<UL>
<LI><A HREF="#6_1">The Basics</A></LI>
<LI><A HREF="#6_2">Using HTMLDOC as a CGI Program</A>
<UL>
<LI><A HREF="#6_2_1">Server-Side Preferences</A></LI>
<LI><A HREF="#6_2_2">Configuring HTMLDOC with Apache</A></LI>
<LI><A HREF="#6_2_3">Configuring HTMLDOC with Microsoft IIS</A></LI>
<LI><A HREF="#IIS6.0">Additional Configuration for IIS 6.0</A></LI>
</UL>
</LI>
<LI><A HREF="#6_3">Using HTMLDOC From Server-Side Scripts and Programs</A>
<UL>
<LI><A HREF="#6_3_1">Calling HTMLDOC from a Shell Script</A></LI>
<LI><A HREF="#6_3_2">Calling HTMLDOC from Perl</A></LI>
<LI><A HREF="#6_3_3">Calling HTMLDOC from PHP</A></LI>
<LI><A HREF="#6_3_4">Calling HTMLDOC from C</A></LI>
<LI><A HREF="#6_3_5">Calling HTMLDOC from Java</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#HTMLREF">Chapter 6 - HTML Reference</A></B>
<UL>
<LI><A HREF="#7_1">General Usage</A></LI>
<LI><A HREF="#7_2">Elements</A></LI>
<LI><A HREF="#COMMENTS">Comments</A>
<UL>
<LI><A HREF="#7_3_1">Header/Footer Strings</A></LI>
</UL>
</LI>
<LI><A HREF="#FONT">FONT Attributes</A></LI>
<LI><A HREF="#HEADING">Headings</A>
<UL>
<LI><A HREF="#7_5_1">Numbered Headings</A></LI>
</UL>
</LI>
<LI><A HREF="#IMAGES">Images</A></LI>
<LI><A HREF="#LINKS">Links</A></LI>
<LI><A HREF="#META">META Attributes</A></LI>
<LI><A HREF="#BREAKS">Page Breaks</A></LI>
<LI><A HREF="#TABLE">Tables</A></LI>
</UL>
<B><A HREF="#GUIREF">Chapter 7 - GUI Reference</A></B>
<UL>
<LI><A HREF="#8_1">The HTMLDOC GUI</A>
<UL>
<LI><A HREF="#8_1_1">Document File Operations</A></LI>
<LI><A HREF="#8_1_2">New</A></LI>
<LI><A HREF="#8_1_3">Open...</A></LI>
<LI><A HREF="#8_1_4">Save</A></LI>
<LI><A HREF="#8_1_5">Save As...</A></LI>
<LI><A HREF="#8_1_6">Generate</A></LI>
<LI><A HREF="#8_1_7">Close</A></LI>
</UL>
</LI>
<LI><A HREF="#8_2">The Input Tab</A>
<UL>
<LI><A HREF="#8_2_1">Document Type</A></LI>
<LI><A HREF="#8_2_2">Input Files</A></LI>
<LI><A HREF="#8_2_3">Add Files...</A></LI>
<LI><A HREF="#8_2_4">Edit Files...</A></LI>
<LI><A HREF="#8_2_5">Delete Files</A></LI>
<LI><A HREF="#8_2_6">Move Up</A></LI>
<LI><A HREF="#8_2_7">Move Down</A></LI>
<LI><A HREF="#8_2_8">Logo Image</A></LI>
<LI><A HREF="#8_2_9">Title File/Image</A></LI>
</UL>
</LI>
<LI><A HREF="#8_3">The Output Tab</A>
<UL>
<LI><A HREF="#8_3_1">Output To</A></LI>
<LI><A HREF="#8_3_2">Output Path</A></LI>
<LI><A HREF="#8_3_3">Output Format</A></LI>
<LI><A HREF="#8_3_4">Output Options</A></LI>
<LI><A HREF="#8_3_5">Compression</A></LI>
<LI><A HREF="#8_3_6">JPEG Quality</A></LI>
</UL>
</LI>
<LI><A HREF="#8_4">The Page Tab</A>
<UL>
<LI><A HREF="#8_4_1">Page Size</A></LI>
<LI><A HREF="#8_4_2">2-Sided</A></LI>
<LI><A HREF="#8_4_3">Landscape</A></LI>
<LI><A HREF="#8_4_4">Top, Left, Right, and Bottom</A></LI>
<LI><A HREF="#8_4_5">Header and Footer</A></LI>
</UL>
</LI>
<LI><A HREF="#8_5">The TOC Tab</A>
<UL>
<LI><A HREF="#8_5_1">Table of Contents</A></LI>
<LI><A HREF="#8_5_2">Numbered Headings</A></LI>
<LI><A HREF="#8_5_3">Header and Footer</A></LI>
<LI><A HREF="#8_5_4">Title</A></LI>
</UL>
</LI>
<LI><A HREF="#8_6">The Colors Tab</A>
<UL>
<LI><A HREF="#8_6_1">Body Color</A></LI>
<LI><A HREF="#8_6_2">Body Image</A></LI>
<LI><A HREF="#8_6_3">Text Color</A></LI>
<LI><A HREF="#8_6_4">Link Color</A></LI>
<LI><A HREF="#8_6_5">Link Style</A></LI>
</UL>
</LI>
<LI><A HREF="#8_7">The Fonts Tab</A>
<UL>
<LI><A HREF="#8_7_1">Base Font Size</A></LI>
<LI><A HREF="#8_7_2">Line Spacing</A></LI>
<LI><A HREF="#8_7_3">Body Typeface</A></LI>
<LI><A HREF="#8_7_4">Heading Typeface</A></LI>
<LI><A HREF="#8_7_5">Header/Footer Size</A></LI>
<LI><A HREF="#8_7_6">Header/Footer Font</A></LI>
<LI><A HREF="#8_7_7">Character Set</A></LI>
<LI><A HREF="#8_7_8">Options</A></LI>
</UL>
</LI>
<LI><A HREF="#8_8">The PS Tab</A>
<UL>
<LI><A HREF="#8_8_1">PostScript Level</A></LI>
<LI><A HREF="#8_8_2">Send Printer Commands</A></LI>
<LI><A HREF="#8_8_3">Include Xerox Job Comments</A></LI>
</UL>
</LI>
<LI><A HREF="#8_9">The PDF Tab</A>
<UL>
<LI><A HREF="#8_9_1">PDF Version</A></LI>
<LI><A HREF="#8_9_2">Page Mode</A></LI>
<LI><A HREF="#8_9_3">Page Layout</A></LI>
<LI><A HREF="#8_9_4">First Page</A></LI>
<LI><A HREF="#8_9_5">Page Effect</A></LI>
<LI><A HREF="#8_9_6">Page Duration</A></LI>
<LI><A HREF="#8_9_7">Effect Duration</A></LI>
</UL>
</LI>
<LI><A HREF="#8_10">The Security Tab</A>
<UL>
<LI><A HREF="#8_10_1">Encryption</A></LI>
<LI><A HREF="#8_10_2">Permissions</A></LI>
<LI><A HREF="#8_10_3">Owner Password</A></LI>
<LI><A HREF="#8_10_4">Options</A></LI>
<LI><A HREF="#8_10_5">User Password</A></LI>
</UL>
</LI>
<LI><A HREF="#8_11">The Options Tab</A>
<UL>
<LI><A HREF="#8_11_1">HTML Editor</A></LI>
<LI><A HREF="#8_11_2">Browser Width</A></LI>
<LI><A HREF="#8_11_3">Search Path</A></LI>
<LI><A HREF="#8_11_4">Proxy URL</A></LI>
<LI><A HREF="#8_11_5">Tooltips</A></LI>
<LI><A HREF="#8_11_6">Modern Look</A></LI>
<LI><A HREF="#8_11_7">Strict HTML</A></LI>
<LI><A HREF="#8_11_8">Save Options and Defaults</A></LI>
</UL>
</LI>
<LI><A HREF="#FILECHOOSER">The File Chooser</A>
<UL>
<LI><A HREF="#8_12_1">Show</A></LI>
<LI><A HREF="#8_12_2">Favorites</A></LI>
<LI><A HREF="#8_12_3">File List</A></LI>
<LI><A HREF="#8_12_4">Filename</A></LI>
<LI><A HREF="#8_12_5">Dialog Buttons</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#CMDREF">Chapter 8 - Command-Line Reference</A></B>
<UL>
<LI><A HREF="#9_1">Basic Usage</A></LI>
<LI><A HREF="#9_2">Options</A>
<UL>
<LI><A HREF="#9_2_1">-d directory</A></LI>
<LI><A HREF="#9_2_2">-f filename</A></LI>
<LI><A HREF="#9_2_3">-t format</A></LI>
<LI><A HREF="#9_2_4">-v</A></LI>
<LI><A HREF="#9_2_5">--batch filename.book</A></LI>
<LI><A HREF="#9_2_6">--bodycolor color</A></LI>
<LI><A HREF="#9_2_7">--bodyfont typeface</A></LI>
<LI><A HREF="#9_2_8">--bodyimage filename</A></LI>
<LI><A HREF="#9_2_9">--book</A></LI>
<LI><A HREF="#9_2_10">--bottom margin</A></LI>
<LI><A HREF="#9_2_11">--browserwidth pixels</A></LI>
<LI><A HREF="#9_2_12">--charset charset</A></LI>
<LI><A HREF="#9_2_13">--color</A></LI>
<LI><A HREF="#9_2_14">--compression[=level]</A></LI>
<LI><A HREF="#9_2_15">--continuous</A></LI>
<LI><A HREF="#9_2_16">--cookies 'name=\"value with space\"; name=value'</A>
</LI>
<LI><A HREF="#9_2_17">--datadir directory</A></LI>
<LI><A HREF="#9_2_18">--duplex</A></LI>
<LI><A HREF="#9_2_19">--effectduration seconds</A></LI>
<LI><A HREF="#9_2_20">--embedfonts</A></LI>
<LI><A HREF="#9_2_21">--encryption</A></LI>
<LI><A HREF="#9_2_22">--firstpage page</A></LI>
<LI><A HREF="#9_2_23">--fontsize size</A></LI>
<LI><A HREF="#9_2_24">--fontspacing spacing</A></LI>
<LI><A HREF="#footer">--footer lcr</A></LI>
<LI><A HREF="#9_2_26">--format format</A></LI>
<LI><A HREF="#9_2_27">--gray</A></LI>
<LI><A HREF="#9_2_28">--header lcr</A></LI>
<LI><A HREF="#9_2_29">--headfootfont font</A></LI>
<LI><A HREF="#9_2_30">--headfootsize size</A></LI>
<LI><A HREF="#9_2_31">--headingfont typeface</A></LI>
<LI><A HREF="#9_2_32">--help</A></LI>
<LI><A HREF="#9_2_33">--helpdir directory</A></LI>
<LI><A HREF="#9_2_34">--jpeg[=quality]</A></LI>
<LI><A HREF="#9_2_35">--landscape</A></LI>
<LI><A HREF="#9_2_36">--left margin</A></LI>
<LI><A HREF="#9_2_37">--linkcolor color</A></LI>
<LI><A HREF="#9_2_38">--links</A></LI>
<LI><A HREF="#9_2_39">--linkstyle style</A></LI>
<LI><A HREF="#9_2_40">--logoimage filename</A></LI>
<LI><A HREF="#9_2_41">--no-compression</A></LI>
<LI><A HREF="#9_2_42">--no-duplex</A></LI>
<LI><A HREF="#9_2_43">--no-embedfonts</A></LI>
<LI><A HREF="#9_2_44">--no-encryption</A></LI>
<LI><A HREF="#9_2_45">--no-jpeg</A></LI>
<LI><A HREF="#9_2_46">--no-links</A></LI>
<LI><A HREF="#9_2_47">--no-localfiles</A></LI>
<LI><A HREF="#9_2_48">--no-numbered</A></LI>
<LI><A HREF="#9_2_49">--no-pscommands</A></LI>
<LI><A HREF="#9_2_50">--no-strict</A></LI>
<LI><A HREF="#9_2_51">--no-title</A></LI>
<LI><A HREF="#9_2_52">--no-toc</A></LI>
<LI><A HREF="#9_2_53">--no-xrxcomments</A></LI>
<LI><A HREF="#9_2_54">--numbered</A></LI>
<LI><A HREF="#9_2_55">--nup pages</A></LI>
<LI><A HREF="#9_2_56">--outdir directory</A></LI>
<LI><A HREF="#9_2_57">--outfile filename</A></LI>
<LI><A HREF="#9_2_58">--owner-password password</A></LI>
<LI><A HREF="#9_2_59">--pageduration seconds</A></LI>
<LI><A HREF="#9_2_60">--pageeffect effect</A></LI>
<LI><A HREF="#9_2_61">--pagelayout layout</A></LI>
<LI><A HREF="#9_2_62">--pagemode mode</A></LI>
<LI><A HREF="#9_2_63">--path dir1;dir2;dir3;...;dirN</A></LI>
<LI><A HREF="#9_2_64">--permissions permission[,permission,...]</A></LI>
<LI><A HREF="#9_2_65">--portrait</A></LI>
<LI><A HREF="#9_2_66">--pscommands</A></LI>
<LI><A HREF="#9_2_67">--quiet</A></LI>
<LI><A HREF="#9_2_68">--referer url</A></LI>
<LI><A HREF="#9_2_69">--right margin</A></LI>
<LI><A HREF="#9_2_70">--size size</A></LI>
<LI><A HREF="#9_2_71">--strict</A></LI>
<LI><A HREF="#9_2_72">--textcolor color</A></LI>
<LI><A HREF="#9_2_73">--textfont typeface</A></LI>
<LI><A HREF="#9_2_74">--title</A></LI>
<LI><A HREF="#9_2_75">--titlefile filename</A></LI>
<LI><A HREF="#9_2_76">--titleimage filename</A></LI>
<LI><A HREF="#9_2_77">--tocfooter lcr</A></LI>
<LI><A HREF="#9_2_78">--tocheader lcr</A></LI>
<LI><A HREF="#9_2_79">--toclevels levels</A></LI>
<LI><A HREF="#9_2_80">--toctitle string</A></LI>
<LI><A HREF="#9_2_81">--top margin</A></LI>
<LI><A HREF="#9_2_82">--user-password password</A></LI>
<LI><A HREF="#9_2_83">--verbose</A></LI>
<LI><A HREF="#9_2_84">--version</A></LI>
<LI><A HREF="#9_2_85">--webpage</A></LI>
<LI><A HREF="#9_2_86">--xrxcomments</A></LI>
</UL>
</LI>
<LI><A HREF="#9_3">Environment Variables</A>
<UL>
<LI><A HREF="#9_3_1">HTMLDOC_DATA</A></LI>
<LI><A HREF="#9_3_2">HTMLDOC_DEBUG</A></LI>
<LI><A HREF="#9_3_3">HTMLDOC_HELP</A></LI>
<LI><A HREF="#9_3_4">HTMLDOC_NOCGI</A></LI>
</UL>
</LI>
<LI><A HREF="#9_4">Messages</A>
<UL>
<LI><A HREF="#9_4_1">BYTES: Message</A></LI>
<LI><A HREF="#9_4_2">DEBUG: Messages</A></LI>
<LI><A HREF="#9_4_3">ERRnnn: Messages</A></LI>
<LI><A HREF="#9_4_4">INFO: Messages</A></LI>
<LI><A HREF="#9_4_5">PAGES: Message</A></LI>
<LI><A HREF="#9_4_6">REMOTEBYTES: Message</A></LI>
<LI><A HREF="#9_4_7">TIMING: Message</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#LICENSE">Appendix A - License Agreement</A></B>
<UL>
<LI><A HREF="#10_1">Introduction</A>
<UL>
<LI><A HREF="#10_1_1">Source Code and the GNU GPL</A></LI>
<LI><A HREF="#10_1_2">Trademarks</A></LI>
<LI><A HREF="#10_1_3">Binary Distribution Rights</A></LI>
<LI><A HREF="#10_1_4">Binaries and Support</A></LI>
</UL>
</LI>
<LI><A HREF="#10_2">End-User License Agreement</A>
<UL>
<LI><A HREF="#10_2_1">TERMS AND CONDITIONS OF SOFTWARE LICENSE</A></LI>
<LI><A HREF="#10_2_2">LIMITED WARRANTY AND DISCLAIMER OF WARRANTY;
LIMITATION OF LIABILITY</A></LI>
</UL>
</LI>
</UL>
<B><A HREF="#BOOKFORMAT">Appendix B - Book File Format</A></B>
<UL>
<LI><A HREF="#11_1">Introduction</A></LI>
<LI><A HREF="#11_2">The Header</A></LI>
<LI><A HREF="#11_3">The Options</A></LI>
<LI><A HREF="#11_4">The Files</A></LI>
<LI><A HREF="#11_5">Putting It All Together</A></LI>
<LI><A HREF="#11_6">Older Book Files</A></LI>
</UL>
<B><A HREF="#RELNOTES">Appendix C - Release Notes</A></B>
<UL>
<LI><A HREF="#12_1">Changes in HTMLDOC v1.8.27</A>
<UL></UL>
</LI>
<LI><A HREF="#12_2">Changes in HTMLDOC v1.8.26</A>
<UL></UL>
</LI>
<LI><A HREF="#12_3">Changes in HTMLDOC v1.8.25</A>
<UL></UL>
</LI>
<LI><A HREF="#12_4">Changes in HTMLDOC v1.8.24</A>
<UL></UL>
</LI>
<LI><A HREF="#12_5">Changes in HTMLDOC v1.8.23</A>
<UL></UL>
</LI>
<LI><A HREF="#12_6">Changes in HTMLDOC v1.8.22</A>
<UL></UL>
</LI>
<LI><A HREF="#12_7">Changes in HTMLDOC v1.8.21</A>
<UL></UL>
</LI>
<LI><A HREF="#12_8">Changes in HTMLDOC v1.8.20</A>
<UL></UL>
</LI>
<LI><A HREF="#12_9">Changes in HTMLDOC v1.8.19</A>
<UL></UL>
</LI>
<LI><A HREF="#12_10">Changes in HTMLDOC v1.8.18</A>
<UL></UL>
</LI>
<LI><A HREF="#12_11">Changes in HTMLDOC v1.8.17</A>
<UL></UL>
</LI>
<LI><A HREF="#12_12">Changes in HTMLDOC v1.8.16</A>
<UL></UL>
</LI>
<LI><A HREF="#12_13">Changes in HTMLDOC v1.8.15</A>
<UL></UL>
</LI>
<LI><A HREF="#12_14">Changes in HTMLDOC v1.8.14</A>
<UL></UL>
</LI>
<LI><A HREF="#12_15">Changes in HTMLDOC v1.8.13</A>
<UL></UL>
</LI>
<LI><A HREF="#12_16">Changes in HTMLDOC v1.8.12</A>
<UL></UL>
</LI>
<LI><A HREF="#12_17">Changes in HTMLDOC v1.8.8</A>
<UL></UL>
</LI>
<LI><A HREF="#12_18">Changes in HTMLDOC v1.8.7</A>
<UL></UL>
</LI>
<LI><A HREF="#12_19">Changes in HTMLDOC v1.8.6</A>
<UL></UL>
</LI>
<LI><A HREF="#12_20">Changes in HTMLDOC v1.8.5</A>
<UL></UL>
</LI>
<LI><A HREF="#12_21">Changes in HTMLDOC v1.8.4</A>
<UL></UL>
</LI>
<LI><A HREF="#12_22">Changes in HTMLDOC v1.8.3</A>
<UL></UL>
</LI>
<LI><A HREF="#12_23">Changes in HTMLDOC v1.8.2</A>
<UL></UL>
</LI>
<LI><A HREF="#12_24">Changes in HTMLDOC v1.8.1</A>
<UL></UL>
</LI>
<LI><A HREF="#12_25">Changes in HTMLDOC v1.8</A>
<UL></UL>
</LI>
</UL>
<B><A HREF="#COMPILE">Appendix D - Compiling HTMLDOC from Source</A></B>
<UL>
<LI><A HREF="#13_1">Requirements</A></LI>
<LI><A HREF="#13_2">Compiling under UNIX/Linux</A></LI>
<LI><A HREF="#13_3">Compiling on Windows Using Visual C++</A></LI>
<LI><A HREF="#13_4">Installing with Visual C++</A></LI>
</UL>
<HR NOSHADE>
<!-- FOOTER RIGHT "IN-$CHAPTERPAGE" -->
<DIV align="justify">
<H1 align="right"><A name="INTRO">Introduction</A></H1>
<P>This document describes how to use the HTMLDOC software, version
1.8.27. HTMLDOC converts Hyper-Text Markup Language ("HTML") input
files into indexed HTML, Adobe® PostScript®, or Adobe Portable Document
Format ("PDF") files.</P>
<P>HTMLDOC supports most HTML 3.2 elements, some HTML 4.0 elements, and
can generate title and table of contents pages. It does not currently
support stylesheets.</P>
<P>HTMLDOC can be used as a standalone application, in a batch document
processing environment, or as a web-based report generation
application.</P>
<P>No restrictions are placed upon the output produced by HTMLDOC.</P>
<P>HTMLDOC is available both as open source software under the terms of
the GNU General Public License and as commercial software under the
terms of a traditional commercial End-User License Agreement.</P>
<H2><A NAME="1_1">History</A></H2>
<P>Like many programs HTMLDOC was developed in response to a need our
company had for generating high-quality documentation in printed and
electronic forms. For a while we used FrameMaker® and a package from <CODE>
sgi</CODE> that generated "compiled" Standard Generalized Markup
Language ("SGML") files that could be used by the Electronic Book
Technologies ("EBT") documentation products; EBT was bought by INSO who
was bought by Stellent<SUP>TM</SUP> who apparently has dropped the
whole product line. When <CODE>sgi</CODE> stopped supporting these
tools we turned to INSO, but the cost of their tools is prohibitive to
small businesses.</P>
<P>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.</P>
<P>The result of our efforts is the HTMLDOC software which is available
for Linux®/UNIX®, MacOS® X, and Microsoft® Windows®. Among other
things, this software users manual is produced using HTMLDOC.</P>
<H2><A NAME="1_2">Organization of This Manual</A></H2>
<P>This manual is organized into tutorial and reference chapters and
appendices:</P>
<UL>
<LI><A href="#INSTALL">Chapter 1</A> - Installing HTMLDOC</LI>
<LI><A href="#STARTING">Chapter 2</A> - Getting Started</LI>
<LI><A href="#BOOKS">Chapter 3</A> - Generating Books</LI>
<LI><A href="#CMDLINE">Chapter 4</A> - HTMLDOC from the Command-Line</LI>
<LI><A href="#CGI">Chapter 5</A> - HTMLDOC from a Web Server</LI>
<LI><A href="#HTMLREF">Chapter 6</A> - HTML Reference</LI>
<LI><A href="#GUIREF">Chapter 7</A> - GUI Reference</LI>
<LI><A href="#CMDREF">Chapter 8</A> - Command-Line Reference</LI>
<LI><A href="#LICENSE">Appendix A</A> - License Agreement</LI>
<LI><A href="#BOOKFORMAT">Appendix B</A> - Book File Format</LI>
<LI><A href="#RELNOTES">Appendix C</A> - Release Notes</LI>
<LI><A href="#COMPILE">Appendix D</A> - Compiling HTMLDOC from Source</LI>
</UL>
<H2><A NAME="1_3">Support</A></H2>
<P>Commercial support is available from Easy Software Products when you
purchase the HTMLDOC Professional Membership. More information is
available at the HTMLDOC web page at the following URL:</P>
<PRE>
<A href="http://www.easysw.com/htmldoc/">http://www.easysw.com/htmldoc/</A>
</PRE>
<H2><A NAME="1_4">Encryption Support</A></H2>
<P>HTMLDOC includes code to encrypt PDF document files using the RC4
algorithm with up to a 128-bit key. While this software and code may be
freely used and exported under current US laws, other countries may
restrict your use and possession of this code and software.</P>
<H2><A NAME="1_5">Copyright, Trademark, and License Information</A></H2>
<P>The Adobe Portable Document Format is Copyright 1985-2005 by Adobe
Systems Incorporated. Adobe, FrameMaker, and PostScript are registered
trademarks of Adobe Systems, Incorporated.</P>
<P>The Graphics Interchange Format is the copyright and GIF<SUP>SM</SUP>
is the service mark property of CompuServe Incorporated.</P>
<P>Intel is a registered trademark of Intel Corporation.</P>
<P>Linux is a registered trademark of Linus Torvalds.</P>
<P>MacOS is a registered trademark of Apple Computer, Inc.</P>
<P>Microsoft and Windows are registered trademarks of Microsoft
Corporation.</P>
<P>Red Hat and RPM are registered trademarks of Red Hat, Inc.</P>
<P>Solaris is a registered trademark of Sun Microsystems, Inc.</P>
<P>SPARC is a registered trademark of SPARC International, Inc.</P>
<P>UNIX is a registered trademark of the X/Open Company, Ltd.</P>
<P>HTMLDOC is the trademark property of Easy Software Products.</P>
<P>HTMLDOC is copyright 1997-2006 by Easy Software Products. See <A href="#LICENSE">
Appendix A - License Agreement</A> for the terms of use.</P>
<P>This software is based in part on the work of the Independent JPEG
Group and FLTK project.</P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "1-$CHAPTERPAGE" -->
<DIV align="justify">
<H1 align="right"><A name="INSTALL">Chapter 1 - Installing HTMLDOC</A></H1>
<P>This chapter describes the steps needed to install the commercial
version of HTMLDOC on your system. If you are installing HTMLDOC from
source code, please see <A href="#COMPILE">Appendix D, Compiling
HTMLDOC from Source</A>.</P>
<H2><A NAME="2_1">Requirements</A></H2>
<P>HTMLDOC requires approximately 4MB of disk space and one of the
following environments:</P>
<UL>
<LI>Microsoft Windows<SUP>®</SUP> 2000 or higher</LI>
<LI>MacOS<SUP>®</SUP> X 10.2 or higher</LI>
<LI>Linux<SUP>®</SUP> 2.4 or higher</LI>
<LI>Solaris<SUP>®</SUP> 7 or higher</LI>
</UL>
<P>HTMLDOC may run on other platforms, however we do not provide
packages for platforms other than those listed.</P>
<H2><A NAME="2_2">Installing HTMLDOC</A></H2>
<P>The following instructions describe how to install the HTMLDOC
software on your system.</P>
<H3><A NAME="2_2_1">Installing HTMLDOC on Microsoft Windows</A></H3>
<P>HTMLDOC is provided as a Microsoft installer file under Windows.
Insert the CD or double-click on the<VAR> htmldoc</VAR> icon in the<VAR>
Explorer</VAR> window to install HTMLDOC under Windows using the
Microsoft software installation wizard (Figure 1-1).</P>
<P align="center"><IMG alt="The software installation wizard" HEIGHT="407"
src="htmldoc-fig11.png" WIDTH="503">
<BR><I> Figure 1-1: The Microsoft software installation wizard</I></P>
<H3><A NAME="2_2_2">Installing HTMLDOC on MacOS X</A></H3>
<P>Double-click on the<VAR> Install</VAR> icon in the<VAR> Finder</VAR>
window to start the software installation wizard (Figure 1-2) and
follow the installer prompts.</P>
<P align="center"><IMG alt="The software installation wizard" HEIGHT="367"
src="htmldoc-fig12.png" WIDTH="580">
<BR><I> Figure 1-2: The software installation wizard</I></P>
<H3><A NAME="2_2_3">Installing HTMLDOC on Linux</A></H3>
<P>Double-click on the<VAR> htmldoc-linux-intel.rpm</VAR> icon or run
the following command to install HTMLDOC on Linux:</P>
<PRE>
<KBD>rpm -i htmldoc-linux-intel.rpm ENTER</KBD>
</PRE>
<H3><A NAME="2_2_4">Installing HTMLDOC on Solaris</A></H3>
<P>Run the following command to install HTMLDOC on Solaris SPARC:</P>
<PRE>
<KBD>pkgadd -d htmldoc-solaris-sparc.pkg ENTER</KBD>
</PRE>
<P>Run the following command to install HTMLDOC on Solaris Intel:</P>
<PRE>
<KBD>pkgadd -d htmldoc-solaris-intel.pkg ENTER</KBD>
</PRE>
<H2><A NAME="2_3">Licensing HTMLDOC</A></H2>
<P>Before you can use HTMLDOC, you must license it. When you first run
HTMLDOC, the license dialog (Figure 1-3) will appear.</P>
<P align="center"><IMG HEIGHT="505" src="htmldoc-fig13.png" WIDTH="486">
<BR><I> Figure 1-3 - The HTMLDOC License Dialog</I></P>
<P>Click on the<VAR> Update License</VAR> button to show the license
manager window (Figure 1-4).</P>
<P align="center"><IMG HEIGHT="290" src="htmldoc-fig14.png" WIDTH="471">
<BR><I> Figure 1-4 - The HTMLDOC License Dialog</I></P>
<P>Enter the license key that was emailed to you or came on the inside
of the HTMLDOC CD-ROM case and click on the<VAR> OK</VAR> button. Click
on the<VAR> Close</VAR> button to start using the software.</P>
<H2><A NAME="2_4">Uninstalling HTMLDOC</A></H2>
<P>The following instructions describe how to remove the HTMLDOC
software from your system.</P>
<H3><A NAME="2_4_1">Uninstalling HTMLDOC on Microsoft Windows</A></H3>
<P>Open the Control Panel window and double-click on the<VAR> Add/Remove
Software</VAR> icon. When the available software list is displayed,
select HTMLDOC and click on the<VAR> Remove</VAR> button.</P>
<H3><A NAME="2_4_2">Uninstalling HTMLDOC on MacOS X</A></H3>
<P>Double-click on the<VAR> Uninstall</VAR> icon in the<VAR> Finder</VAR>
and follow the prompts.</P>
<H3><A NAME="2_4_3">Uninstalling HTMLDOC on Linux</A></H3>
<P>Run the following command to remove HTMLDOC from your Linux system:</P>
<PRE>
% <KBD>rpm -e htmldoc ENTER</KBD>
</PRE>
<H3><A NAME="2_4_4">Uninstalling HTMLDOC on Solaris</A></H3>
<P>Run the following command to remove HTMLDOC from Solaris:</P>
<PRE>
% <KBD>pkgrm htmldoc ENTER</KBD>
</PRE>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "2-$CHAPTERPAGE" -->
<DIV align="justify">
<H1 align="right"><A name="STARTING">Chapter 2 - Getting Started</A></H1>
<P>This chapter describes how to start HTMLDOC and convert HTML files
into PostScript and PDF files.</P>
<CENTER>
<TABLE bgcolor="#cccccc" border="1" cellpadding="5" cellspacing="0" width="80%">
<TR><TD><B>Note:</B>
<P>HTMLDOC currently does not support HTML 4.0 features such as
stylesheets or the <CODE>STYLE</CODE>, <CODE>TBODY</CODE>, <CODE>THEAD</CODE>
, or <CODE>TFOOT</CODE> elements. For more information, please consult <A
href="#HTMLREF">Chapter 6 - HTML Reference</A>.</P>
</TD></TR>
</TABLE>
</CENTER>
<H2><A NAME="3_1">Starting HTMLDOC</A></H2>
<P>For Windows click:</P>
<PRE>
Start Menu->All Programs->HTMLDOC->HTMLDOC
</PRE>
<P>For MacOS X click:</P>
<PRE>
Applications Folder->HTMLDOC
</PRE>
<P>For Linux click:</P>
<PRE>
Applications Menu->Office->HTMLDOC
</PRE>
<P>or type:</P>
<PRE>
<KBD>htmldoc ENTER</KBD>
</PRE>
<P>For Solaris click:</P>
<PRE>
Applications Window->ESP->HTMLDOC
</PRE>
<P>or type:</P>
<PRE>
<KBD>htmldoc ENTER</KBD>
</PRE>
<H2><A NAME="3_2">Choosing a HTML File</A></H2>
<P>The HTMLDOC window (Figure 2-1) shows the list of input files that
will be converted. Start by clicking on the<VAR> Web Page</VAR> radio
button (1) to specify that you will be converting a HTML web page file.</P>
<P align="center"><IMG HEIGHT="397" src="htmldoc-fig21.png" WIDTH="513">
<BR> Figure 2-1 - The HTMLDOC Window</P>
<P>Then choose a file for conversion by clicking on the<VAR> Add
Files...</VAR> button (2). When the file chooser dialog appears (Figure
2-2), double-click on the HTML file (3) you wish to convert from the
list of files. If you don't see the file you wish to add, then double
click on the folder with ../ (4) to see more file options.</P>
<P align="center"><IMG HEIGHT="407" src="htmldoc-fig22.png" WIDTH="497">
<BR> Figure 2-2 - The File Chooser Dialog</P>
<H2><A NAME="3_3">Setting the Output File</A></H2>
<P>You've chosen your HTML files to be converted, now you need to save
your file(s) somewhere. The output file is where you would do that.
Click on the<VAR> Output</VAR> tab (5) to set the output file (Figure
2-3). You can either type the name of the output file into the<VAR>
Output Path</VAR> field or click on the<VAR> Browse...</VAR> button (6)
to find an acceptable output location. Clicking on browse allows you to
put the new file in a specific folder for easy retrieval. When you
click on a folder you will notice that the filename area and text is
highlighted. Click a few times at the end of the file name path and add
a slash (<KBD>/</KBD>) and the name of the new file. If you don't see
the folder you want to put your document in, double click on the folder
with<VAR> ../</VAR> after it.</P>
<P align="center"><IMG HEIGHT="423" src="htmldoc-fig23.png" WIDTH="513">
<BR> Figure 2-3 - The Output Tab</P>
<H2><A NAME="3_4">Generating the Document</A></H2>
<P>You can generate the document by clicking on the<VAR> Generate</VAR>
button (7) at the bottom of the HTMLDOC window. When the conversion is
completed you can open the PDF file that is produced using Adobe
Acrobat Reader or any other PDF viewing application.</P>
<CENTER>
<TABLE bgcolor="#cccccc" border="1" cellpadding="5" cellspacing="0" width="80%">
<TR><TD><B>Note:</B>
<P>The<VAR> Open</VAR> button at the bottom of the HTMLDOC GUI Open
Window will not open the generated document for viewing. You will learn
about the<VAR> Open</VAR> button in later chapters.</P>
</TD></TR>
</TABLE>
</CENTER>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "3-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="BOOKS">Chapter 3 - Generating Books</A></H1>
<P>This chapter describes how to create a book using HTML files.</P>
<H2><A NAME="4_1">Overview</A></H2>
<P>While HTMLDOC can convert web pages into PostScript and PDF files,
its real strength is generating indexed HTML, PostScript, or PDF books.</P>
<P>HTMLDOC uses HTML heading elements to delineate chapters and headings
in a book. The <CODE>H1</CODE> element is used for chapters:</P>
<PRE>
<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>
</PRE>
<P>Sub-headings are marked using the <CODE>H2</CODE> through <CODE>H6</CODE>
elements.</P>
<!-- NEED 2in -->
<CENTER>
<TABLE BGCOLOR="#cccccc" BORDER="1" CELLPADDING="5" CELLSPACING="0" WIDTH="80%">
<TR><TD><B>Note:</B>
<P>When using book mode, HTMLDOC starts rendering with the first <CODE>
H1</CODE> element. Any text, images, tables, and other viewable elements
that precede the first <CODE>H1</CODE> element are silently ignored.
Because of this, make sure you have an <CODE>H1</CODE> element in your
HTML file, otherwise HTMLDOC will not convert anything.</P>
</TD></TR>
</TABLE>
</CENTER>
<H2><A NAME="4_2">Choosing HTML Files</A></H2>
<P>Start by clicking on the<VAR> Book</VAR> radio button (1) to specify
you'll be converting one or more HTML files into a book.</P>
<P>Your next step is to choose one or more files for conversion by
clicking on the<VAR> Add Files...</VAR> button (2). When the file
chooser dialog appears, pick the file(s) you wish to convert and then
click on the<VAR> OK</VAR> button. As discussed in Chapter 2, if you
don't see the file that you want, double click on the folder with<VAR>
../</VAR> after it.</P>
<P>Also, having all files and images in one folder will make file
retrieval much easier.</P>
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig31.png" WIDTH="513">
<BR> Figure 3-1: The Input Tab</P>
<H2><A NAME="4_3">Selecting a Title File</A></H2>
<P>HTMLDOC can automatically create a title page for you. Fill in the<VAR>
Title File/Image</VAR> field or click the<VAR> Browse...</VAR> button
(3) to locate the file you want to use. If you don't see the file you
want, double click on the folder with<VAR> ../</VAR> after it.</P>
<P ALIGN="CENTER"><IMG HEIGHT="423" SRC="htmldoc-fig32.png" WIDTH="513">
<BR> Figure 3-2: The Output Tab</P>
<H2><A NAME="4_4">Setting the Output Format</A></H2>
<P>The output format is set in the<VAR> Output</VAR> tab (4). Click on
the<VAR> Output</VAR> tab and then click on the<VAR> HTML</VAR>,<VAR>
PS</VAR>, or<VAR> PDF</VAR> radio buttons to set the output format.</P>
<H2><A NAME="4_5">Setting the Output File</A></H2>
<P>Now that you've chosen an output format, type the name of the output
file into the<VAR> Output Path</VAR> field or click on the<VAR>
Browse...</VAR> button (5) to select the output file using the file
chooser.</P>
<H2><A NAME="4_6">Generating the Document</A></H2>
<P>Once you have chosen the output file you can generate it by clicking
on the<VAR> Generate</VAR> button (6) at the bottom of the HTMLDOC
window.</P>
<H2><A NAME="4_7">Saving Your Book</A></H2>
<P>HTMLDOC can save the list of HTML files, the title file, and all
other options to a special <CODE>.BOOK</CODE> file so you can
regenerate your book when you make changes to your HTML files.</P>
<P>Click on the<VAR> Save</VAR> button (7) to save the current book to a
file.</P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "4-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="CMDLINE">Chapter 4 - HTMLDOC from the
Command-Line</A></H1>
<P>This chapter describes how to use HTMLDOC from the command-line to
convert web pages and generate books.</P>
<H2><A NAME="5_1">Getting to the Command-Line on Windows</A></H2>
<P>Do the following steps to access the command-line on Windows:</P>
<OL>
<LI>Click on<VAR> Start</VAR> at the bottom left corner of your screen</LI>
<LI>Click on<VAR> All Programs</VAR></LI>
<LI>Click on<VAR> Accessories</VAR></LI>
<LI>Click on<VAR> Command Prompt</VAR></LI>
</OL>
<P> After you have clicked command prompt, your screen should look
something like Figure 4-1.</P>
<P align="center"><IMG alt="Command prompt window" HEIGHT="331" src="htmldoc-fig41.png"
WIDTH="668">
<BR><I> Figure 4-1: Command prompt window</I></P>
<P>To see what's in this directory, type the following command:</P>
<PRE>
<KBD>dir ENTER <KBD></KBD></KBD></PRE>
<P>You now have a list of available files and directories that you can
use. To access a different directory simply type <KBD>cd</KBD> and the
name of the new directory. For example, type the following if you want
to access a directory called<VAR> Steve</VAR>:</P>
<PRE>
<KBD>cd Steve ENTER</KBD>
</PRE>
<H2><A NAME="5_2">The Basics of Command-Line Access</A></H2>
<P>To convert a single web page type:</P>
<PRE>
<KBD>htmldoc --webpage -f output.pdf filename.html ENTER</KBD>
</PRE>
<H3><A NAME="5_2_1">What Are All These Commands?</A></H3>
<P><TT>htmldoc</TT> is the name of the software.</P>
<P><TT>--webpage</TT> is the document type that specifies unstructured
files with page breaks between each file.</P>
<P><TT>-f output.pdf</TT> is the file name that you will save all the
documents into and also the type of file it is. In this example it is a
PDF file.</P>
<P><TT>filename.html</TT> is the name of the file that you want to be
converted and the type of file it is. In this example it is a HTML
file.</P>
<P>Try the following exercise: You want to convert the file<VAR>
myhtml.html</VAR> into a PDF file. The new file will be called<VAR>
mypdf.pdf</VAR>. How would you do this? (Don't worry, it's answered for
you on the next line. But try first.)</P>
<P>To accomplish this type:</P>
<PRE>
<KBD>htmldoc --webpage -f mypdf.pdf myhtml.html ENTER</KBD>
</PRE>
<H2><A NAME="5_3">Converting Multiple HTML Files</A></H2>
<P>To convert more than one web page with page breaks between each HTML
file, type:</P>
<PRE>
<KBD>htmldoc --webpage -f output.pdf file1.html file2.html ENTER</KBD>
</PRE>
<P>All we are doing is adding another file. In this example we are
converting two files:<VAR> file1.html</VAR> and<VAR> file2.html</VAR>.</P>
<P>Try this example: Convert<VAR> one.html</VAR> and<VAR> two.html</VAR>
into a PDF file named<VAR> 12pdf.pdf</VAR>. Again, the answer is on the
next line.</P>
<P>Your line command should look like this:</P>
<PRE>
<KBD>htmldoc --webpage -f 12pdf.pdf one.html two.html ENTER</KBD>
</PRE>
<P>We've been using HTML files, but you can also use URLs. For example:</P>
<PRE>
<KBD>htmldoc --webpage -f output.pdf http://slashdot.org/ ENTER</KBD>
</PRE>
<!-- NEED 4in -->
<H2><A NAME="5_4">Generating Books</A></H2>
<P>Type one of the following commands to generate a book from one or
more HTML files:</P>
<PRE>
<KBD>htmldoc --book -f output.html file1.html file2.html ENTER</KBD>
<KBD>htmldoc --book -f output.pdf file1.html file2.html ENTER</KBD>
<KBD>htmldoc --book -f output.ps file1.html file2.html ENTER</KBD>
</PRE>
<H3><A NAME="5_4_1">What are all these commands?</A></H3>
<P><TT>htmldoc</TT> is the name of the sofware.</P>
<P><TT>--book</TT> is a type of document that specifies that the input
files are structured with headings.</P>
<P><TT>-f output.html</TT> is where you want the converted files to go
to. In this case, we requested the file be a HTML file. We could have
made it a PDF (<TT>-f output.pdf</TT>) or Postscript (<TT>-f ouput.ps</TT>
), too.</P>
<P><TT>file1.html</TT> and <TT>file2.html</TT> are the files you want to
convert.</P>
<P>HTMLDOC will build a table of contents for the book using the heading
elements (<CODE>H1</CODE>, <CODE>H2</CODE>, etc.) in your HTML files.
It will also add a title page using the document <CODE>TITLE</CODE>
text (you're going to learn about title files shortly) and other <CODE>
META</CODE> information you supply in your HTML files. See <A HREF="#HTMLREF">
Chapter 6 - HTML Reference</A> for more information on the <CODE>META</CODE>
variables that are supported.</P>
<CENTER>
<TABLE bgcolor="#cccccc" border="1" cellpadding="5" cellspacing="0" width="80%">
<TR><TD><B>Note:</B>
<P>When using book mode, HTMLDOC starts rendering with the first <CODE>
H1</CODE> element. Any text, images, tables, and other viewable elements
that precede the first <CODE>H1</CODE> element are silently ignored.
Because of this, make sure you have an <CODE>H1</CODE> element in your
HTML file, otherwise HTMLDOC will not convert anything!</P>
</TD></TR>
</TABLE>
</CENTER>
<!-- NEED 2in -->
<H2><A NAME="5_5">Setting the Title File</A></H2>
<P>The <CODE>--titlefile</CODE> option sets the HTML file or image to
use on the title page:</P>
<PRE>
<KBD>htmldoc --titlefile filename.bmp ... ENTER</KBD>
<KBD>htmldoc --titlefile filename.gif ... ENTER</KBD>
<KBD>htmldoc --titlefile filename.jpg ... ENTER</KBD>
<KBD>htmldoc --titlefile filename.png ... ENTER</KBD>
<KBD>htmldoc --titlefile filename.html ... ENTER</KBD>
</PRE>
<P>HTMLDOC supports BMP, GIF, JPEG, and PNG images, as well as generic
HTML text you supply for the title page(s).</P>
<H3><A NAME="5_5_1">Putting It All Together</A></H3>
<PRE>
<KBD>htmldoc --book -f 12book.pdf 1book.html 2book.html --titlefile bookcover.jpg ENTER</KBD>
</PRE>
<P>Take a look at the entire command line. Dissect the information. Can
you see what the new filename is? What are the names of the files being
converted? Do you see the titlepage file? What kind of file is your
titlefile?</P>
<P>Figure it out? The new file is<VAR> 12book.pdf</VAR>. The files
converted were<VAR> 1book.html</VAR> and<VAR> 2book.html</VAR>. A title
page was created using the JPEG image file<VAR> bookcover.jpg</VAR>.</P>
<P><A href="#HTMLREF">Chapter 8 - Command Line Reference</A> digs deeper
into what you can do with the the command line prompt.</P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "5-$CHAPTERPAGE" -->
<DIV align="justify">
<H1 align="right"><A name="CGI">Chapter 5 - Using HTMLDOC on a Web
Server</A></H1>
<P>This chapter describes how to interface HTMLDOC to your web server
using CGI and your own server-side scripts and programs.</P>
<H2><A NAME="6_1">The Basics</A></H2>
<P>HTMLDOC can be used in a variety of ways to generate formatted
reports on a web server. The most common way is to use HTMLDOC as a CGI
program with your web server to provide PDF-formatted output of a web
page. Examples are provided for Microsoft IIS and the Apache web
servers.</P>
<P>HTMLDOC can also be called from your own server-side scripts and
programs. Examples are provided for PHP and Java.</P>
<!-- NEED 2in -->
<CENTER>
<TABLE bgcolor="#cccccc" border="1" cellpadding="5" width="80%">
<TR><TD><B> WARNING:</B>
<P>Passing information directly from the web browser to HTMLDOC can
potentially expose your system to security risks. Always be sure to
"sanitize" any input from the web browser so that filenames, URLs, and
options passed to HTMLDOC are not acted on by the shell program or
other processes.</P>
</TD></TR>
</TABLE>
</CENTER>
<H2><A NAME="6_2">Using HTMLDOC as a CGI Program</A></H2>
<P>HTMLDOC 1.8.24 and higher supports operation as a CGI program. You
can copy or symlink the<VAR> htmldoc</VAR> (all but Windows) or<VAR>
htmldoc.exe</VAR> (Windows) executable to your web server's<VAR>
cgi-bin</VAR> directory and then use it to produce PDF versions of your
web pages.</P>
<P>The CGI converts a page on your local server to PDF and sends it to
the client's web browser. For example, to convert a page called<VAR>
superproducts.html</VAR> at the following URL:</P>
<PRE>
http://servername/superproducts.html
</PRE>
<P>and if you installed HTMLDOC in your server's<VAR> cgi-bin</VAR>
directory, you would direct your clients to the following URL:</P>
<PRE>
http://servername<B>/cgi-bin/htmldoc</B>/superproducts.html
</PRE>
<P>The boldface portion represents the location of the HTMLDOC
executable on the web server. You simply place that path before the
page you want to convert.</P>
<P>Form data using the <CODE>GET</CODE> method can be passed at the end
of the URL, for example:</P>
<PRE>
http://servername/cgi-bin/htmldoc/superproducts.html<B>?name=value</B>
</PRE>
<H3><A NAME="6_2_1">Server-Side Preferences</A></H3>
<P>When run as a CGI program, HTMLDOC will try to read a book file to
set any preferences for the conversion to PDF. For the<VAR>
superproducts.html</VAR> file described previously, HTMLDOC will look
at the following URLs for a book file:</P>
<PRE>
http://servername/superproducts.html.book
http://servername/.book
http://servername/cgi-bin/.book
</PRE>
<P>The first book file that is found will be used.</P>
<H3><A NAME="6_2_2">Configuring HTMLDOC with Apache</A></H3>
<P>The Apache web server is easily configured to use HTMLDOC. The
simplest way is to copy or symlink the<VAR> htmldoc</VAR> executable to
the configured<VAR> cgi-bin</VAR> directory. For example, if your
Apache installation is configured to look for CGI programs in the<VAR>
/var/www/cgi-bin</VAR> directory, the default for Apache on Red Hat
Linux, then the command to install HTMLDOC on your web server would be:</P>
<PRE>
<KBD>ln -s /usr/bin/htmldoc /var/www/cgi-bin ENTER</KBD>
</PRE>
<P>If you are using Apache 2.0.30 or higher, you will also need to
enable <TT>PATH_INFO</TT> support by adding the following line to your<VAR>
httpd.conf</VAR> file:</P>
<PRE>
AcceptPathInfo On
</PRE>
<P>Apache also allows you to associate CGI programs with a specific
extension. If you add the following line to your<VAR> httpd.conf</VAR>
file:</P>
<PRE>
AddHandler cgi-script .cgi
</PRE>
<P>and enable CGI execution with the <TT>Options</TT> directive for a
directory:</P>
<PRE>
Options +ExecCGI
</PRE>
<P>then you can copy or symlink the<VAR> htmldoc</VAR> executable to an
alternate location. For example, if you have a web directory called<VAR>
/var/www/htdocs/products</VAR>, you can install HTMLDOC in this
directory with the following command:</P>
<PRE>
<KBD>ln -s /usr/bin/htmldoc /var/www/htdocs/products/htmldoc.cgi ENTER</KBD>
</PRE>
<H3><A NAME="6_2_3">Configuring HTMLDOC with Microsoft IIS</A></H3>
<P>The IIS web server is configured to run CGI programs by either
modifying the permissions of an existing directory or by creating a new
virtual directory that allows for execution of programs. Start by
running the<VAR> Internet Services Manager</VAR> program (Figure 5-1):</P>
<OL>
<LI>Click on<VAR> Start</VAR></LI>
<LI>Click on<VAR> Settings</VAR></LI>
<LI>Click on<VAR> Control Panel</VAR></LI>
<LI>Double-click on<VAR> Administrative Tools</VAR></LI>
<LI>Double-click on<VAR> Internet Services Manager</VAR></LI>
</OL>
<P>After the<VAR> Internet Services Manager</VAR> window (Figure 5-1)
appears, perform the following steps to add a virtual folder for
HTMLDOC:</P>
<OL>
<LI>Click on your server in the list to show the default web site
service in the list (Figure 5-2)</LI>
<LI>Choose<VAR> New->Virtual Directory</VAR> from the<VAR> Action</VAR>
menu (Figure 5-3)</LI>
<LI>Click<VAR> Next</VAR> when the<VAR> Virtual Directory Creation
Wizard</VAR> window appears (Figure 5-4)</LI>
<LI>Enter the name <TT>htmldoc</TT> in the<VAR> Alias</VAR> field and
click<VAR> Next</VAR> (Figure 5-5)</LI>
<LI>Enter the HTMLDOC program folder in the<VAR> Directory</VAR> field
and click<VAR> Next</VAR> (Figure 5-6)</LI>
<LI>Check the<VAR> Execute (such as ISAPI applications or CGI)</VAR> box
and click<VAR> Next</VAR> (Figure 5-7)</LI>
<LI>Click<VAR> Finish</VAR> to dismiss the wizard (Figure 5-8)</LI>
</OL>
<P>If you are using IIS 6.0, proceed to the next section titled, <A href="#IIS6.0">
"Additional Configuration for IIS 6.0"</A>.</P>
<P align="center"><IMG alt="The Internet Services Manager Window" HEIGHT="423"
src="htmldoc-fig51.png" width="600">
<BR><I> Figure 5-1: The Internet Services Manager Window</I></P>
<P align="center"><IMG alt="The Default Web Site Service" HEIGHT="423" src="htmldoc-fig52.png"
width="600">
<BR><I> Figure 5-2: The Default Web Site Service</I></P>
<P align="center"><IMG alt="Adding a New Virtual Directory" HEIGHT="423" src="htmldoc-fig53.png"
width="600">
<BR><I> Figure 5-3: Adding a New Virtual Directory</I></P>
<P align="center"><IMG alt="The Virtual Directory Creation Wizard Window"
HEIGHT="374" src="htmldoc-fig54.png" width="482">
<BR><I> Figure 5-4: The Virtual Directory Creation Wizard Window</I></P>
<P align="center"><IMG alt="Entering the Alias Name" HEIGHT="374" src="htmldoc-fig55.png"
width="482">
<BR><I> Figure 5-5: Entering the Alias Name</I></P>
<P align="center"><IMG alt="Entering the HTMLDOC Program Folder" HEIGHT="374"
src="htmldoc-fig56.png" width="482">
<BR><I> Figure 5-6: Entering the HTMLDOC Program Folder</I></P>
<P align="center"><IMG alt="Enabling CGI Mode" HEIGHT="374" src="htmldoc-fig57.png"
width="482">
<BR><I> Figure 5-7: Enabling CGI Mode</I></P>
<P align="center"><IMG alt="Completion of IIS Configuration" HEIGHT="374"
src="htmldoc-fig58.png" width="482">
<BR><I> Figure 5-8: Completion of IIS Configuration</I></P>
<P>Once configured, the<VAR> htmldoc.exe</VAR> program will be available
in the web server directory. For example, for a virtual directory
called<VAR> cgi-bin</VAR>, the PDF converted URL for the<VAR>
superproducts.html</VAR> page would be as follows:</P>
<PRE>
http://servername<B>/cgi-bin/htmldoc.exe</B>/superproducts.html
</PRE>
<P>The boldface portion represents the location of the HTMLDOC program
on the web server.</P>
<H3><A name="IIS6.0">Additional Configuration for IIS 6.0</A></H3>
<P>IIS 6.0 requires additional configuration steps due to its increased
focus on security. Start by running the<VAR> Internet Services Manager</VAR>
program (Figure 5-1):</P>
<OL>
<LI>Click on<VAR> Start</VAR></LI>
<LI>Click on<VAR> Settings</VAR></LI>
<LI>Click on<VAR> Control Panel</VAR></LI>
<LI>Double-click on<VAR> Administrative Tools</VAR></LI>
<LI>Double-click on<VAR> Internet Services Manager</VAR></LI>
</OL>
<P>After the<VAR> Internet Services Manager</VAR> window (Figure 5-1)
appears, perform the following steps to add a new Wed Service Extension
for HTMLDOC:</P>
<OL>
<LI>Click on<VAR> Web Service Extensions</VAR></LI>
<LI>Click<VAR> Add a new Web Service Extension</VAR></LI>
<LI>Enter the name "HTMLDOC" when the<VAR> Web Service Extension</VAR>
window appears</LI>
<LI>Click<VAR> Add...</VAR> and choose the<VAR> htmldoc.exe</VAR> file
from the program folder, typically<VAR>
C:\Program Files\Easy Software Products\HTMLDOC</VAR></LI>
<LI>Check the<VAR> Set extension status to Allowed</VAR> box</LI>
<LI>Click<VAR> OK</VAR> to add the extension and dismiss the window</LI>
</OL>
<P>Finally, double-click the<VAR> My Computer</VAR> icon on the desktop
or start the<VAR> Windows Explorer</VAR>. When the explorer window
appears, perform the following steps to provide write access to the
Windows temporary folder:</P>
<OL>
<LI>Open the windows temporary file folder, typically<VAR>
C:\WINDOWS\TEMP</VAR></LI>
<LI>Choose<VAR> Properties</VAR> from the<VAR> File</VAR> menu</LI>
<LI>Click on the<VAR> Security</VAR> tab</LI>
<LI>Click<VAR> Add...</VAR>, enter the username for the web server,
typically "SERVER\IUSR_SERVER" where "SERVER" is the name you gave your
server, and click<VAR> OK</VAR></LI>
<LI>Click on the username you just added in the list</LI>
<LI>Check the<VAR> Read</VAR> and<VAR> Write</VAR> permissions</LI>
<LI>Click<VAR> OK</VAR> to save the changes</LI>
</OL>
<H2><A NAME="6_3">Using HTMLDOC From Server-Side Scripts and Programs</A>
</H2>
<P>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. Since HTMLDOC looks for CGI
environment variables when it is run, you must also set the <TT>
HTMLDOC_NOCGI</TT> environment variable to a value of 1 before running
HTMLDOC from your CGI script or program.</P>
<P>Another way to generate PDF files from your reports is to use HTMLDOC
as a "portal" application. When used as a portal, HTMLDOC automatically
retrieves the named document or report from your server and passes a
PDF version to the web browser. See the next sections for more
information.</P>
<!-- NEED 6in -->
<H3><A NAME="6_3_1">Calling HTMLDOC from a Shell Script</A></H3>
<P>Shell scripts are probably the easiest to work with, but are normally
limited to GET type requests. Here is a script called<VAR> topdf</VAR>
that acts as a portal, converting the named file to PDF:</P>
<PRE>
#!/bin/sh
#
# Sample "portal" script to convert the named HTML file to PDF on-the-fly.
#
# Usage: http://www.domain.com/path/topdf/path/filename.html
#
#
# Tell HTMLDOC not to run in CGI mode...
#
HTMLDOC_NOCGI=1; export HTMLDOC_NOCGI
#
# The "options" variable contains any options you want to pass to HTMLDOC.
#
options='-t pdf --webpage --header ... --footer ..."
#
# Tell the browser to expect a PDF file...
#
echo "Content-Type: application/pdf"
echo ""
#
# Run HTMLDOC to generate the PDF file...
#
htmldoc $options http://${SERVER_NAME}:${SERVER_PORT}$PATH_INFO
</PRE>
<P>Users 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.</P>
<P>The<VAR> options</VAR> variable in the script can be set to use any
supported command-line option for HTMLDOC; for a complete list see <A href="#CMDREF">
Chapter 8 - Command-Line Reference</A>.</P>
<!-- NEED 5in -->
<H3><A NAME="6_3_2">Calling HTMLDOC from Perl</A></H3>
<P>Perl scripts offer the ability to generate more complex reports, pull
data from databases, etc. The easiest way to interface Perl scripts
with HTMLDOC is to write a report to a temporary file and then execute
HTMLDOC to generate the PDF file.</P>
<P>Here is a simple Perl subroutine that can be used to write a PDF
report to the HTTP client:</P>
<PRE>
sub topdf {
# Get the filename argument...
my $filename = shift;
# Make stdout unbuffered...
select(STDOUT); $| = 1;
# Tell HTMLDOC not to run in CGI mode...
$ENV{HTMLDOC_NOCGI} = 1;
# Write the content type to the client...
print "Content-Type: application/pdf\n\n";
# Run HTMLDOC to provide the PDF file to the user...
system "htmldoc -t pdf --quiet --webpage $filename";
}
</PRE>
<H3><A NAME="6_3_3">Calling HTMLDOC from PHP</A></H3>
<P>PHP is quickly becoming the most popular server-side scripting
language available. PHP provides a <CODE>passthru()</CODE> function
that can be used to run HTMLDOC. This combined with the <CODE>header()</CODE>
function can be used to provide on-the-fly reports in PDF format.</P>
<P>Here is a simple PHP function that can be used to convert a HTML
report to PDF and send it to the HTTP client:</P>
<PRE>
function topdf($filename, $options = "") {
# Tell HTMLDOC not to run in CGI mode...
putenv("HTMLDOC_NOCGI=1");
# Write the content type to the client...
header("Content-Type: application/pdf");
flush();
# Run HTMLDOC to provide the PDF file to the user...
passthru("htmldoc -t pdf --quiet --jpeg --webpage $options '$filename'");
}
</PRE>
<P>The function accepts a filename and an optional "options" string for
specifying the header, footer, fonts, etc.</P>
<P>To prevent malicious users from passing in unauthorized characters
into this function, the following function can be used to verify that
the URL/filename does not contain any characters that might be
interpreted by the shell:</P>
<!-- NEED 5in -->
<PRE>
function bad_url($url) {
// See if the URL starts with http: or https:...
if (strncmp($url, "http://", 7) != 0 &&
strncmp($url, "https://", 8) != 0) {
return 1;
}
// Check for bad characters in the URL...
$len = strlen($url);
for ($i = 0; $i < $len; $i ++) {
if (!strchr("~_*()/:%?+-&@;=,$.", $url[$i]) &&
!ctype_alnum($url[$i])) {
return 1;
}
}
return 0;
}
</PRE>
<P>Another method is to use the <CODE>escapeshellarg()</CODE> function
provided with PHP 4.0.3 and higher to generate a quoted shell argument
for HTMLDOC.</P>
<P>To make a "portal" script, add the following code to complete the
example:</P>
<PRE>
global $SERVER_NAME;
global $SERVER_PORT;
global $PATH_INFO;
global $QUERY_STRING;
if ($QUERY_STRING != "") {
$url = "http://${SERVER_NAME}:${SERVER_PORT}${PATH_INFO}?${QUERY_STRING}";
} else {
$url = "http://${SERVER_NAME}:${SERVER_PORT}$PATH_INFO";
}
if (bad_url($url)) {
print("<html><head><title>Bad URL</title></head>\n"
."<body><h1>Bad URL</h1>\n"
."<p>The URL <b><tt>$url</tt></b> is bad.</p>\n"
."</body></html>\n");
} else {
topdf($url);
}
</PRE>
<!-- NEED 5in -->
<H3><A NAME="6_3_4">Calling HTMLDOC from C</A></H3>
<P>C programs offer the best flexibility and easily supports on-the-fly
report generation without the need for temporary files.</P>
<P>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:</P>
<PRE>
#include <stdio.h>
#include <stdlib.h>
/* topdf() - convert a HTML file to PDF */
FILE *topdf(const char *filename) /* I - HTML file to convert */
{
char command[1024]; /* Command to execute */
/*
* Tell HTMLDOC not to run in CGI mode...
*/
putenv("HTMLDOC_NOCGI=1");
/*
* Write the content type to the client...
*/
puts("Content-Type: application/pdf\n");
/*
* Run HTMLDOC to provide the PDF file to the user...
*/
sprintf(command, "htmldoc --quiet -t pdf --webpage %s", filename);
return (popen(command, "w"));
}
/* topdf2() - pipe HTML output to HTMLDOC for conversion to PDF */
FILE *topdf2(void)
{
/*
* Tell HTMLDOC not to run in CGI mode...
*/
putenv("HTMLDOC_NOCGI=1");
/*
* Write the content type to the client...
*/
puts("Content-Type: application/pdf\n");
/*
* Open a pipe to HTMLDOC...
*/
return (popen("htmldoc --quiet -t pdf --webpage -", "w"));
}
</PRE>
<!-- NEED 5in -->
<H3><A NAME="6_3_5">Calling HTMLDOC from Java</A></H3>
<P>Java programs are a portable way to add PDF support to your web
server. Here is a class called<VAR> htmldoc</VAR> that acts as a
portal, converting the named file to PDF. It can also be called by your
Java servlets to process an HTML file and send the result to the client
in PDF format:</P>
<PRE>
class htmldoc
{
// Convert named file to PDF on stdout...
public static int topdf(String filename)// I - Name of file to convert
{
String command; // Command string
Process process; // Process for HTMLDOC
Runtime runtime; // Local runtime object
java.io.InputStream input; // Output from HTMLDOC
byte buffer []; // Buffer for output data
int bytes; // Number of bytes
// First tell the client that we will be sending PDF...
System.out.print("Content-type: application/pdf\n\n");
// Construct the command string
command = "htmldoc --quiet --jpeg --webpage -t pdf --left 36 " +
"--header .t. --footer .1. " + filename;
// Run the process and wait for it to complete...
runtime = Runtime.getRuntime();
try
{
// Create a new HTMLDOC process...
process = runtime.exec(command);
// Get stdout from the process and a buffer for the data...
input = process.getInputStream();
buffer = new byte[8192];
// Read output from HTMLDOC until we have it all...
while ((bytes = input.read(buffer)) > 0)
System.out.write(buffer, 0, bytes);
// Return the exit status from HTMLDOC...
return (process.waitFor());
}
catch (Exception e)
{
// An error occurred - send it to stderr for the web server...
System.err.print(e.toString() + " caught while running:\n\n");
System.err.print(" " + command + "\n");
return (1);
}
}
// Main entry for htmldoc class
public static void main(String[] args)// I - Command-line args
{
String server_name, // SERVER_NAME env var
server_port, // SERVER_PORT env var
path_info, // PATH_INFO env var
query_string, // QUERY_STRING env var
filename; // File to convert
if ((server_name = System.getProperty("SERVER_NAME")) != null &&
(server_port = System.getProperty("SERVER_PORT")) != null &&
(path_info = System.getProperty("PATH_INFO")) != null)
{
// Construct a URL for the resource specified...
filename = "http://" + server_name + ":" + server_port + path_info;
if ((query_string = System.getProperty("QUERY_STRING")) != null)
{
filename = filename + "?" + query_string;
}
}
else if (args.length == 1)
{
// Pull the filename from the command-line...
filename = args[0];
}
else
{
// Error - no args or env variables!
System.err.print("Usage: htmldoc.class filename\n");
return;
}
// Convert the file to PDF and send to the web client...
topdf(filename);
}
}
</PRE>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "6-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="HTMLREF">Chapter 6 - HTML Reference</A></H1>
This chapter defines all of the HTML elements and attributes that are
recognized and supported by HTMLDOC.
<H2><A NAME="7_1">General Usage</A></H2>
<P>There are two types of HTML files - structured documents using
headings (H1, H2, etc.) which HTMLDOC calls "books", and unstructured
documents that do not use headings which HTMLDOC calls "web pages".</P>
<P>A very common mistake is to try converting a web page using:</P>
<UL>
<PRE>
htmldoc -f filename.pdf filename.html
</PRE>
</UL>
<P>which will likely produce a PDF file with no pages. To convert web
page files you<B> must</B> use the <CODE>--webpage</CODE> option at the
command-line or choose<VAR> Web Page</VAR> in the input tab of the GUI.
<CENTER>
<TABLE bgcolor="#cccccc" border="1" cellpadding="5" width="80%">
<TR><TD><B>Note:</B>
<P>HTMLDOC does not support HTML 4.0 elements, attributes, stylesheets,
or scripting.</P>
</TD></TR>
</TABLE>
</CENTER>
<!-- NEED 5in -->
</P>
<H2><A NAME="7_2">Elements</A></H2>
<P>The following HTML elements are recognized by HTMLDOC:</P>
<CENTER>
<TABLE BORDER="1" CELLPADDING="5">
<TR><TH>Element</TH><TH>Version</TH><TH>Supported?</TH><TH>Notes</TH></TR>
<TR><TD>!DOCTYPE</TD><TD ALIGN="CENTER">3.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
DTD is ignored</TD></TR>
<TR><TD>A</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD><A
HREF="#LINKS">See Below</A></TD></TR>
<TR><TD>ACRONYM</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
No font change</TD></TR>
<TR><TD>ADDRESS</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>AREA</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>B</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>BASE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>BASEFONT</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>BIG</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>BLINK</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>BLOCKQUOTE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>BODY</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>BR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>CAPTION</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>CENTER</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>CITE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Italic/Oblique</TD></TR>
<TR><TD>CODE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Courier</TD></TR>
<TR><TD>DD</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>DEL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Strikethrough</TD></TR>
<TR><TD>DFN</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Helvetica</TD></TR>
<TR><TD>DIR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>DIV</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>DL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>DT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Italic/Oblique</TD></TR>
<TR><TD>EM</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Italic/Oblique</TD></TR>
<TR><TD>EMBED</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
HTML Only</TD></TR>
<TR><TD>FONT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
<A HREF="#FONT">See Below</A></TD></TR>
<TR><TD>FORM</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>FRAME</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TH>Element</TH><TH>Version</TH><TH>Supported?</TH><TH>Notes</TH></TR>
<TR><TD>FRAMESET</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>H1</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
<TR><TD>H2</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
<TR><TD>H3</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
<TR><TD>H4</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
<TR><TD>H5</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
<TR><TD>H6</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
<TR><TD>HEAD</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>HR</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
<A HREF="#BREAKS">See Below</A></TD></TR>
<TR><TD>HTML</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>I</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>IMG</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
<A HREF="#IMAGES">See Below</A></TD></TR>
<TR><TD>INPUT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>INS</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Underline</TD></TR>
<TR><TD>ISINDEX</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>KBD</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Courier Bold</TD></TR>
<TR><TD>LI</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>LINK</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>MAP</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>MENU</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>META</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
<A HREF="#META">See Below</A></TD></TR>
<TR><TD>MULTICOL</TD><TD ALIGN="CENTER">N3.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>NOBR</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>NOFRAMES</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>OL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>OPTION</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>P</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>PRE</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>S</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Strikethrough</TD></TR>
<TR><TD>SAMP</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Courier</TD></TR>
<TR><TD>SCRIPT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TH>Element</TH><TH>Version</TH><TH>Supported?</TH><TH>Notes</TH></TR>
<TR><TD>SELECT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>SMALL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>SPACER</TD><TD ALIGN="CENTER">N3.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>STRIKE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>STRONG</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface Italic/Oblique</TD></TR>
<TR><TD>SUB</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Reduced Fontsize</TD></TR>
<TR><TD>SUP</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Reduced Fontsize</TD></TR>
<TR><TD>TABLE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
<A HREF="#TABLE">See Below</A></TD></TR>
<TR><TD>TD</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>TEXTAREA</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
<TR><TD>TH</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Boldface Center</TD></TR>
<TR><TD>TITLE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>TR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>TT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Courier</TD></TR>
<TR><TD>U</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>UL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
</TD></TR>
<TR><TD>VAR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>
Helvetica Oblique</TD></TR>
<TR><TD>WBR</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">No</TD><TD>
</TD></TR>
</TABLE>
</CENTER>
<H2><A NAME="COMMENTS">Comments</A></H2>
<P>HTMLDOC supports many special HTML comments to initiate page breaks,
set the header and footer text, and control the current media options:</P>
<DL>
<!-- NEED 1in -->
<DT><CODE><!-- FOOTER LEFT "foo" --></CODE></DT>
<DD>Sets the left footer text; the test is applied to the current page
if empty, or the next page otherwise.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- FOOTER CENTER "foo" --></CODE></DT>
<DD>Sets the center footer text; the test is applied to the current page
if empty, or the next page otherwise.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- FOOTER RIGHT "foo" --></CODE></DT>
<DD>Sets the right footer text; the test is applied to the current page
if empty, or the next page otherwise.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- HALF PAGE --></CODE></DT>
<DD>Break to the next half page.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- HEADER LEFT "foo" --></CODE></DT>
<DD>Sets the left header text; the test is applied to the current page
if empty, or the next page otherwise.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- HEADER CENTER "foo" --></CODE></DT>
<DD>Sets the center header text; the test is applied to the current page
if empty, or the next page otherwise.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- HEADER RIGHT "foo" --></CODE></DT>
<DD>Sets the right header text; the test is applied to the current page
if empty, or the next page otherwise.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA BOTTOM nnn --></CODE></DT>
<DD>Sets the bottom margin of the page. The "nnn" string can be any
standard measurement value, e.g. 0.5in, 36, 12mm, etc. Breaks to a new
page if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA COLOR "foo" --></CODE></DT>
<DD>Sets the media color attribute for the page. The "foo" string is any
color name that is supported by the printer, e.g. "Blue", "White", etc.
Breaks to a new page or sheet if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA DUPLEX NO --></CODE></DT>
<DD>Chooses single-sided printing for the page; breaks to a new page or
sheet if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA DUPLEX YES --></CODE></DT>
<DD>Chooses double-sided printing for the page; breaks to a new sheet if
the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA LANDSCAPE NO --></CODE></DT>
<DD>Chooses portrait orientation for the page; breaks to a new page if
the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA LANDSCAPE YES --></CODE></DT>
<DD>Chooses landscape orientation for the page; breaks to a new page if
the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA LEFT nnn --></CODE></DT>
<DD>Sets the left margin of the page. The "nnn" string can be any
standard measurement value, e.g. 0.5in, 36, 12mm, etc. Breaks to a new
page if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA POSITION nnn --></CODE></DT>
<DD>Sets the media position attribute (input tray) for the page. The
"nnn" string is an integer that usually specifies the tray number.
Breaks to a new page or sheet if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA RIGHT nnn --></CODE></DT>
<DD>Sets the right margin of the page. The "nnn" string can be any
standard measurement value, e.g. 0.5in, 36, 12mm, etc. Breaks to a new
page if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA SIZE foo --></CODE></DT>
<DD>Sets the media size to the specified size. The "foo" string can be
"Letter", "Legal", "Universal", or "A4" for standard sizes or
"WIDTHxHEIGHTunits" for custom sizes, e.g. "8.5x11in"; breaks to a new
page or sheet if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA TOP nnn --></CODE></DT>
<DD>Sets the top margin of the page. The "nnn" string can be any
standard measurement value, e.g. 0.5in, 36, 12mm, etc. Breaks to a new
page if the current page is already marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- MEDIA TYPE "foo" --></CODE></DT>
<DD>Sets the media type attribute for the page. The "foo" string is any
type name that is supported by the printer, e.g. "Plain", "Glossy",
etc. Breaks to a new page or sheet if the current page is already
marked.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- NEED length --></CODE></DT>
<DD>Break if there is less than <CODE>length</CODE> units left on the
current page. The <CODE>length</CODE> value defaults to lines of text
but can be suffixed by <CODE>in</CODE>, <CODE>mm</CODE>, or <CODE>cm</CODE>
to convert from the corresponding units.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- NEW PAGE --></CODE></DT>
<DD>Break to the next page.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- NEW SHEET --></CODE></DT>
<DD>Break to the next sheet.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- NUMBER-UP nn --></CODE></DT>
<DD>Sets the number of pages that are placed on each output page. Valid
values are 1, 2, 4, 6, 9, and 16.
<!-- NEED 1in -->
</DD>
<DT><CODE><!-- PAGE BREAK --></CODE></DT>
<DD>Break to the next page.</DD>
</DL>
<!-- NEED 2in -->
<H3><A NAME="7_3_1">Header/Footer Strings</A></H3>
<P>The <CODE>HEADER</CODE> and <CODE>FOOTER</CODE> comments allow you to
set an arbitrary string of text for the left, center, and right headers
and footers. Each string consists of plain text; special values or
strings can be inserted using the dollar sign (<CODE>$</CODE>):</P>
<DL>
<!-- NEED 1in -->
<DT><CODE>$$</CODE></DT>
<DD>Inserts a single dollar sign in the header.
<!-- NEED 1in -->
</DD>
<DT><CODE>$CHAPTER</CODE></DT>
<DD>Inserts the current chapter heading.
<!-- NEED 1.5in -->
</DD>
<DT><CODE>$CHAPTERPAGE</CODE></DT>
<DT><CODE>$CHAPTERPAGE(format)</CODE></DT>
<DD>Inserts the current page number within a chapter or file. When a
format is specified, uses that numeric format (1 = decimal, i =
lowercase roman numerals, I = uppercase roman numerals, a = lowercase
ascii, A = uppercase ascii) for the page numbers.
<!-- NEED 1.5in -->
</DD>
<DT><CODE>$CHAPTERPAGES</CODE></DT>
<DT><CODE>$CHAPTERPAGES(format)</CODE></DT>
<DD>Inserts the total page count within a chapter or file. When a format
is specified, uses that numeric format (1 = decimal, i = lowercase
roman numerals, I = uppercase roman numerals, a = lowercase ascii, A =
uppercase ascii) for the page count.
<!-- NEED 1in -->
</DD>
<DT><CODE>$DATE</CODE></DT>
<DD>Inserts the current date.
<!-- NEED 1in -->
</DD>
<DT><CODE>$HEADING</CODE></DT>
<DD>Inserts the current heading.
<!-- NEED 1in -->
</DD>
<DT><CODE>$LOGOIMAGE</CODE></DT>
<DD>Inserts the logo image; all other text in the string will be
ignored.
<!-- NEED 1in -->
</DD>
<DT><CODE>$PAGE</CODE></DT>
<DT><CODE>$PAGE(format)</CODE></DT>
<DD>Inserts the current page number. When a format is specified, uses
that numeric format (1 = decimal, i = lowercase roman numerals, I =
uppercase roman numerals, a = lowercase ascii, A = uppercase ascii) for
the page numbers.
<!-- NEED 1.5in -->
</DD>
<DT><CODE>$PAGES</CODE></DT>
<DT><CODE>$PAGES(format)</CODE></DT>
<DD>Inserts the total page count. When a format is specified, uses that
numeric format (1 = decimal, i = lowercase roman numerals, I =
uppercase roman numerals, a = lowercase ascii, A = uppercase ascii) for
the page count.
<!-- NEED 1in -->
</DD>
<DT><CODE>$TIME</CODE></DT>
<DD>Inserts the current time.
<!-- NEED 1in -->
</DD>
<DT><CODE>$TITLE</CODE></DT>
<DD>Inserts the document title.</DD>
</DL>
<!-- NEED 5in -->
<H2><A NAME="FONT">FONT Attributes</A></H2>
<P>Limited typeface specification is currently supported to ensure
portability across platforms and for older PostScript printers:</P>
<CENTER>
<TABLE BORDER="1" CELLPADDING="5">
<TR><TH>Requested Font</TH><TH>Actual Font</TH></TR>
<TR><TD>Arial</TD><TD>Helvetica</TD></TR>
<TR><TD>Courier</TD><TD>Courier</TD></TR>
<TR><TD>Dingbats</TD><TD>Dingbats</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>DejaVu Sans</TD></TR>
<TR><TD>Serif</TD><TD>DejaVu Serif</TD></TR>
<TR><TD>Symbol</TD><TD>Symbol</TD></TR>
<TR><TD>Times</TD><TD>Times</TD></TR>
</TABLE>
</CENTER>
<P>All other unrecognized typefaces are silently ignored.</P>
<H2><A NAME="HEADING">Headings</A></H2>
<P>Currently HTMLDOC supports a maximum of 1000 chapters (H1 headings).
This limit can be increased by changing the <CODE>MAX_CHAPTERS</CODE>
constant in the<VAR> config.h</VAR> file included with the source code.</P>
<P>All chapters start with a top-level heading (H1) markup. Any headings
within a chapter must be of a lower level (H2 to H15). Each chapter
starts a new page or the next odd-numbered page if duplexing is
selected.
<CENTER>
<TABLE BGCOLOR="#cccccc" BORDER="1" CELLPADDING="5" WIDTH="80%">
<TR><TD><B>Note:</B>
<P>Heading levels 7 to 15 are not standard HTML and will not likely be
recognized by most web browsers.</P>
</TD></TR>
</TABLE>
</CENTER>
</P>
<P>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:</P>
<UL>
<PRE>
<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>
...
</PRE>
</UL>
the table-of-contents that is generated will show:
<UL><B> Chapter Heading</B>
<UL>
<LI>Section Heading 1</LI>
<LI>Section Heading 2</LI>
<UL>
<LI>Sub-Section Heading 1</LI>
<UL>
<LI>Sub-Sub-Section Heading 1</LI>
<LI>Sub-Sub-Section Heading 2</LI>
</UL>
<LI>Sub-Section Heading 2</LI>
<UL>
<LI>Sub-Sub-Section Heading 3</LI>
</UL>
</UL>
<LI>Section Heading 3</LI>
</UL>
</UL>
<!-- NEED 4in -->
<H3><A NAME="7_5_1">Numbered Headings</A></H3>
When the numbered headings option is enabled, HTMLDOC recognizes the
following additional attributes for all heading elements:
<DL>
<DT><CODE>VALUE="#"</CODE></DT>
<DD>Specifies the starting value for this heading level (default is "1"
for all new levels).</DD>
<DT><CODE>TYPE="1"</CODE></DT>
<DD>Specifies that decimal numbers should be generated for this heading
level.</DD>
<DT><CODE>TYPE="a"</CODE></DT>
<DD>Specifies that lowercase letters should be generated for this
heading level.</DD>
<DT><CODE>TYPE="A"</CODE></DT>
<DD>Specifies that uppercase letters should be generated for this
heading level.</DD>
<DT><CODE>TYPE="i"</CODE></DT>
<DD>Specifies that lowercase roman numerals should be generated for this
heading level.</DD>
<DT><CODE>TYPE="I"</CODE></DT>
<DD>Specifies that uppercase roman numerals should be generated for this
heading level.</DD>
</DL>
<!-- NEED 2in -->
<H2><A NAME="IMAGES">Images</A></H2>
HTMLDOC supports loading of BMP, GIF, JPEG, and PNG image files. EPS
and other types of image files are not supported at this time.
<!-- NEED 2in -->
<H2><A NAME="LINKS">Links</A></H2>
<P>External URL and internal (<CODE>#target</CODE> and <CODE>
filename.html</CODE>) links are fully supported for HTML and PDF output.</P>
<P>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:</P>
<UL>
<PRE>
<A HREF="filename.pdf">...</A>
</PRE>
</UL>
<!-- NEED 5in -->
<H2><A NAME="META">META Attributes</A></H2>
<P>HTMLDOC supports the following <CODE>META</CODE> attributes for the
title page and document information:</P>
<DL>
<DT><CODE><META NAME="AUTHOR" CONTENT="..."</CODE></DT>
<DD>Specifies the document author.</DD>
<DT><CODE><META NAME="COPYRIGHT" CONTENT="..."</CODE></DT>
<DD>Specifies the document copyright.</DD>
<DT><CODE><META NAME="DOCNUMBER" CONTENT="..."</CODE></DT>
<DD>Specifies the document number.</DD>
<DT><CODE><META NAME="GENERATOR" CONTENT="..."</CODE></DT>
<DD>Specifies the application that generated the HTML file.</DD>
<DT><CODE><META NAME="KEYWORDS" CONTENT="..."</CODE></DT>
<DD>Specifies document search keywords.</DD>
<DT><CODE><META NAME="SUBJECT" CONTENT="..."</CODE></DT>
<DD>Specifies document subject.</DD>
</DL>
<H2><A NAME="BREAKS">Page Breaks</A></H2>
HTMLDOC supports four new <A HREF="#COMMENTS">page comments</A> to
specify page breaks. In addition, the older <CODE>BREAK</CODE>
attribute is still supported by the <CODE>HR</CODE> element:
<UL>
<PRE>
<HR BREAK>
</PRE>
</UL>
Support for the <CODE>BREAK</CODE> attribute is deprecated and will be
removed in a future release of HTMLDOC.
<H2><A NAME="TABLE">Tables</A></H2>
Currently HTMLDOC supports a maximum of 200 columns within a single
table. This limit can be increased by changing the <CODE>MAX_COLUMNS</CODE>
constant in the<VAR> config.h</VAR> file included with the source code.
<P><B>HTMLDOC does not support HTML 4.0 table elements or attributes,
such as <CODE>TBODY</CODE>, <CODE>THEAD</CODE>, <CODE>TFOOT</CODE>, or <CODE>
RULES</CODE>.</B></P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "7-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="GUIREF">Chapter 7 - GUI Reference</A></H1>
This chapter describes all of the GUI controls in HTMLDOC.
<H2><A NAME="8_1">The HTMLDOC GUI</A></H2>
The HTMLDOC GUI (Figures 7-1 through 7-11) is contained in a single
window showing the input, output, and generation options. At the bottom
are buttons to load, save, and generate documents.
<H3><A NAME="8_1_1">Document File Operations</A></H3>
HTMLDOC stores the HTML files, settings, and options in <CODE>.BOOK</CODE>
files. The buttons on the bottom of the HTMLDOC window allow you to
manage these files and generate formatted documents.
<H3><A NAME="8_1_2">New</A></H3>
The<VAR> New</VAR> button starts a new document. A confirmation dialog
will appear if you have not saved the changes to the existing document.
<H3><A NAME="8_1_3">Open...</A></H3>
The<VAR> Open...</VAR> button retrieves a document that you have saved
previously. A <A HREF="#FILECHOOSER">file chooser</A> dialog is
displayed that allows you to pick an existing book file.
<H3><A NAME="8_1_4">Save</A></H3>
The<VAR> Save</VAR> button saves the current document. A <A HREF="#FILECHOOSER">
file chooser</A> dialog is displayed if there is no filename assigned to
the current document.
<P><B>Note:</B> Saving a document is not the same as<I> generating</I> a
document. The book files saved to disk by the<VAR> Save</VAR> and<VAR>
Save As...</VAR> buttons are<STRONG> not</STRONG> the final HTML, PDF,
or PostScript output files. You generate those files by clicking on the<VAR>
Generate</VAR> button.</P>
<H3><A NAME="8_1_5">Save As...</A></H3>
The<VAR> Save As...</VAR> button saves the current document to a new
file. A <A HREF="#FILECHOOSER">file chooser</A> dialog is displayed to
allow you to specify the new document filename.
<P><B>Note:</B> Saving a document is not the same as<I> generating</I> a
document. The book files saved to disk by the<VAR> Save</VAR> and<VAR>
Save As...</VAR> buttons are<STRONG> not</STRONG> the final HTML, PDF,
or PostScript output files. You generate those files by clicking on the<VAR>
Generate</VAR> button.</P>
<H3><A NAME="8_1_6">Generate</A></H3>
The<VAR> Generate</VAR> button generates the current document, creating
the specified HTML, PDF, or PostScript file(s) as needed. The progress
meter at the bottom of the window will show the progress as each page
or file is formatted and written.
<P><B>Note:</B> Generating a document is not the same as<STRONG> saving</STRONG>
a document. To save the current HTML files and settings in the HTMLDOC
GUI, click on the<VAR> Save</VAR> or<VAR> Save As...</VAR> buttons
instead.</P>
<H3><A NAME="8_1_7">Close</A></H3>
The<VAR> Close</VAR> button closes the HTMLDOC window.
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig71.png" WIDTH="513">
<BR> Figure 7-1 - The Input Tab</P>
<H2><A NAME="8_2">The Input Tab</A></H2>
The input tab (Figure 7-1) lists all of the HTML source files that are
used to generate the document. You also specify the type of document
(book or web page) and the title and logo images in this tab.
<H3><A NAME="8_2_1">Document Type</A></H3>
The<VAR> Book</VAR> radio button specifies that the input files are
structured with headings. The<VAR> Continuous</VAR> radio button
specifies unstructured files without page breaks between each file. The<VAR>
Web Page</VAR> radio button specifies unstructured files with page
breaks between each file.
<H3><A NAME="8_2_2">Input Files</A></H3>
The<VAR> Input Files</VAR> list shows all of the HTML input files that
will be used to produce the document. Double-click on files to edit
them.
<H3><A NAME="8_2_3">Add Files...</A></H3>
The<VAR> Add Files...</VAR> button displays the <A HREF="#FILECHOOSER">
file chooser</A> dialog, allowing you to select one or more HTML files
to include in the document.
<H3><A NAME="8_2_4">Edit Files...</A></H3>
The<VAR> Edit Files...</VAR> button starts the specified editor program
to edit the files selected in the<VAR> Input Files</VAR> list. Select
one or more files in the<VAR> Input Files</VAR> list to enable the<VAR>
Edit Files...</VAR> button.
<H3><A NAME="8_2_5">Delete Files</A></H3>
The<VAR> Delete Files</VAR> button removes the selected files from the<VAR>
Input Files</VAR> list. Select one or more files in the<VAR> Input
Files</VAR> list to enable the<VAR> Delete Files</VAR> button.
<P>The<VAR> Delete Files</VAR> button only removes the files from the<VAR>
Input Files</VAR> list. The files are<STRONG> not</STRONG> removed from
disk.</P>
<H3><A NAME="8_2_6">Move Up</A></H3>
The<VAR> Move Up</VAR> button moves the selected files in the<VAR>
Input Files</VAR> list up one line in the list. To enable the<VAR> Move
Up</VAR> button select one or more files in the<VAR> Input Files</VAR>
list.
<H3><A NAME="8_2_7">Move Down</A></H3>
The<VAR> Move Down</VAR> button moves the selected files in the<VAR>
Input Files</VAR> list down one line in the list. To enable the<VAR>
Move Down</VAR> button select one or more files in the<VAR> Input Files</VAR>
list.
<H3><A NAME="8_2_8">Logo Image</A></H3>
The<VAR> Logo Image</VAR> field contains the filename for an image to
be shown in the header or footer of pages, and in the navigation bar of
HTML files.
<P>Click on the<VAR> Browse...</VAR> button to select a logo image file
using the <A HREF="#FILECHOOSER">file chooser</A> dialog.</P>
<H3><A NAME="8_2_9">Title File/Image</A></H3>
The<VAR> Title File/Image</VAR> field contains the filename for an
image to be shown on the title page, or for a HTML file to be used for
the title page(s).
<P>Click on the<VAR> Browse...</VAR> button to select a title file using
the <A HREF="#FILECHOOSER">file chooser</A> dialog.</P>
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig72.png" WIDTH="513">
<BR> Figure 7-2 - The Output Tab</P>
<H2><A NAME="8_3">The Output Tab</A></H2>
The output tab (Figure 7-2) specifies where your document will be
generated, the output format, and some of the generic output options.
<H3><A NAME="8_3_1">Output To</A></H3>
The<VAR> File</VAR> radio button selects output to a single file. The<VAR>
Directory</VAR> radio button selects output to multiple files in the
named directory.
<P><VAR>Directory</VAR> output is not available when generating PDF
files.</P>
<H3><A NAME="8_3_2">Output Path</A></H3>
The<VAR> Output Path</VAR> field contains the output directory or
filename. Click on the<VAR> Browse...</VAR> button to choose an output
file using the <A HREF="#FILECHOOSER">file chooser</A> dialog.
<H3><A NAME="8_3_3">Output Format</A></H3>
The<VAR> HTML</VAR> radio button selects HTML output, the<VAR>
Separated HTML</VAR> radio button selects HTML output that is separated
into a separate file for each heading in the table-of-contents, the<VAR>
PS</VAR> radio button selects PostScript output, and the<VAR> PDF</VAR>
radio button selects PDF output.
<H3><A NAME="8_3_4">Output Options</A></H3>
The<VAR> Grayscale</VAR> check box selects grayscale output for
PostScript and PDF files. The<VAR> Title Page</VAR> check box specifies
that a title page should be generated for the document. The<VAR> JPEG
Big Images</VAR> check box specifies that JPEG compression should be
applied to continuous-tone images.
<H3><A NAME="8_3_5">Compression</A></H3>
The<VAR> Compression</VAR> slider controls the amount of compression
that is used when writing PDF or Level 3 PostScript output.
<P><B>Note:</B> HTMLDOC uses Flate compression, which is not encumbered
by patents and is also used by the popular PKZIP and gzip programs.
Flate is a lossless compression algorithm (that is, you get back
exactly what you put in) that performs very well on indexed images and
text.</P>
<H3><A NAME="8_3_6">JPEG Quality</A></H3>
The<VAR> JPEG Quality</VAR> slider controls the quality level used when
writing continuous-tone images with JPEG compression.
<!-- NEW PAGE -->
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig73.png" WIDTH="513">
<BR> Figure 7-3 - The Page Tab</P>
<H2><A NAME="8_4">The Page Tab</A></H2>
The page tab (Figure 7-3) defines the page header, footer, size, and
margins for PostScript and PDF output.
<!-- NEED 3in -->
<H3><A NAME="8_4_1">Page Size</A></H3>
The<VAR> Page Size</VAR> field contains the current page size. Click on
the arrow button to choose a standard page size.
<P>HTMLDOC supports the following standard page size names:</P>
<UL>
<LI>Letter - 8.5x11in (216x279mm)</LI>
<LI>A4 - 8.27x11.69in (210x297mm)</LI>
<LI>Universal - 8.27x11in (210x279mm)</LI>
</UL>
<P>Click in the<VAR> Page Size</VAR> field and enter 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>
<H3><A NAME="8_4_2">2-Sided</A></H3>
Click in the<VAR> 2-Sided</VAR> check box to select 2-sided (duplexed)
output.
<H3><A NAME="8_4_3">Landscape</A></H3>
Click in the<VAR> Landscape</VAR> check box to select landscape output.
<H3><A NAME="8_4_4">Top, Left, Right, and Bottom</A></H3>
Click in the<VAR> Top</VAR>,<VAR> Left</VAR>,<VAR> Right</VAR>, and<VAR>
Bottom</VAR> fields and enter the new margin values to change them.
Append the letters "in" for inches, "mm" for millimeters, or "cm" for
centimeters.
<H3><A NAME="8_4_5">Header and Footer</A></H3>
<P>Select the desired text in each of the option buttons to customize
the header and footer for the document/body pages. The left-most option
buttons set the text that is left-justified, while the middle buttons
set the text that is centered and the right buttons set the text that
is right-justified. Each choice corresponds to the following text:</P>
<CENTER>
<TABLE BORDER="1" CELLPADDING="5" WIDTH="90%">
<TR><TH>Choice</TH><TH>Description</TH></TR>
<TR><TD ALIGN="CENTER">Blank</TD><TD>The field should be blank.</TD></TR>
<TR><TD ALIGN="CENTER">Title</TD><TD>The field should contain the
document title.</TD></TR>
<TR><TD ALIGN="CENTER">Chapter Title</TD><TD>The field should contain
the current chapter title.</TD></TR>
<TR><TD ALIGN="CENTER">Heading</TD><TD>The field should contain the
current heading.</TD></TR>
<TR><TD ALIGN="CENTER">Logo</TD><TD>The field should contain the logo
image.</TD></TR>
<TR><TD ALIGN="CENTER">1,2,3,...</TD><TD>The field should contain the
current page number in decimal format (1, 2, 3, ...)</TD></TR>
<TR><TD ALIGN="CENTER">i,ii,iii,...</TD><TD>The field should contain the
current page number in lowercase roman numerals (i, ii, iii, ...)</TD></TR>
<TR><TD ALIGN="CENTER">I,II,III,...</TD><TD>The field should contain the
current page number in uppercase roman numerals (I, II, III, ...)</TD></TR>
<TR><TD ALIGN="CENTER">a,b,c,...</TD><TD>The field should contain the
current page number using lowercase letters.</TD></TR>
<TR><TD ALIGN="CENTER">A,B,C,...</TD><TD>The field should contain the
current page number using UPPERCASE letters.</TD></TR>
<TR><TD ALIGN="CENTER">Chapter Page</TD><TD>The field should contain the
current chapter page number.</TD></TR>
<TR><TD ALIGN="CENTER">1/N,2/N,...</TD><TD>The field should contain the
current and total number of pages (n/N).</TD></TR>
<TR><TD ALIGN="CENTER">1/C,2/C,...</TD><TD>The field should contain the
current and total number of pages in the chapter (n/N).</TD></TR>
<TR><TD ALIGN="CENTER">Date</TD><TD>The field should contain the current
date (formatted for the current locale).</TD></TR>
<TR><TD ALIGN="CENTER">Time</TD><TD>The field should contain the current
time (formatted for the current locale).</TD></TR>
<TR><TD ALIGN="CENTER">Date + Time</TD><TD>The field should contain the
current date and time (formatted for the current locale).</TD></TR>
</TABLE>
</CENTER>
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig74.png" WIDTH="513">
<BR> Figure 7-4 - The TOC Tab</P>
<H2><A NAME="8_5">The TOC Tab</A></H2>
The TOC tab (Figure 7-4) defines the table-of-contents options.
<H3><A NAME="8_5_1">Table of Contents</A></H3>
Select the desired number of levels from the<VAR> Table of Contents</VAR>
option button.
<H3><A NAME="8_5_2">Numbered Headings</A></H3>
Click in the<VAR> Numbered Headings</VAR> check box to automatically
number the headings in the document.
<H3><A NAME="8_5_3">Header and Footer</A></H3>
Select the desired text in each of the option buttons to customize the
header and footer for the tables-of-contents pages. The left-most
option buttons set the text that is left-justified, while the middle
buttons set the text that is centered and the right buttons set the
text that is right-justified.
<H3><A NAME="8_5_4">Title</A></H3>
Enter the desired title for the table-of-contents in the<VAR> Title</VAR>
field.
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig75.png" WIDTH="513">
<BR> Figure 7-5 - The Colors Tab</P>
<H2><A NAME="8_6">The Colors Tab</A></H2>
The colors tab (Figure 7-5) defines the color and image information
that is used for the entire document.
<H3><A NAME="8_6_1">Body Color</A></H3>
The<VAR> Body Color</VAR> field specifies the default background color.
It can be a standard HTML color name or a hexadecimal RGB color of the
form <CODE>#RRGGBB</CODE>. Click on the<VAR> Lookup...</VAR> button to
pick the color graphically.
<H3><A NAME="8_6_2">Body Image</A></H3>
The<VAR> Body Image</VAR> field specifies the default background image.
Click on the<VAR> Browse...</VAR> button to pick the background image
using the <A HREF="#FILECHOOSER">file chooser</A>.
<H3><A NAME="8_6_3">Text Color</A></H3>
The<VAR> Text Color</VAR> field specifies the default text color. It
can be a standard HTML color name or a hexadecimal RGB color of the
form <CODE>#RRGGBB</CODE>. Click on the<VAR> Lookup...</VAR> button to
pick the color graphically.
<H3><A NAME="8_6_4">Link Color</A></H3>
The<VAR> Link Color</VAR> field specifies the default link color. It
can be a standard HTML color name or a hexadecimal RGB color of the
form <CODE>#RRGGBB</CODE>. Click on the<VAR> Lookup...</VAR> button to
pick the color graphically.
<H3><A NAME="8_6_5">Link Style</A></H3>
The<VAR> Link Style</VAR> chooser specifies the default link
decoration.
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig76.png" WIDTH="513">
<BR> Figure 7-6 - The Fonts Tab</P>
<H2><A NAME="8_7">The Fonts Tab</A></H2>
The fonts tab (Figure 7-6) defines the fonts and character set used by
the document.
<H3><A NAME="8_7_1">Base Font Size</A></H3>
The<VAR> Base Font Size</VAR> field specifies the size of normal text
in the document in points (1 point = 1/72nd inch). Click on the single
arrow buttons to decrease or increase the size by 1/10th point or on
the double arrow buttons to decrease or increase the size by whole
points.
<H3><A NAME="8_7_2">Line Spacing</A></H3>
The<VAR> Line Spacing</VAR> field specifies the spacing between lines
as a multiple of the base font size. Click on the single arrow buttons
to decrease or increase the size by 10ths or on the double arrow
buttons to decrease or increase the size by whole numbers.
<H3><A NAME="8_7_3">Body Typeface</A></H3>
The<VAR> Body Typeface</VAR> option button specifies the typeface to
use for normal text. Click on the option button to select a typeface.
<H3><A NAME="8_7_4">Heading Typeface</A></H3>
The<VAR> Heading Typeface</VAR> option button specifies the typeface to
use for headings. Click on the option button to select a typeface.
<H3><A NAME="8_7_5">Header/Footer Size</A></H3>
The<VAR> Header/Footer Size</VAR> field specifies the size of header
and footer text in the document in points (1 point = 1/72nd inch).
Click on the single arrow buttons to decrease or increase the size by
1/10th point or on the double arrow buttons to decrease or increase the
size by whole points.
<H3><A NAME="8_7_6">Header/Footer Font</A></H3>
The<VAR> Header/Footer Font</VAR> option button specifies the typeface
and style to use for header and footer text. Click on the option button
to select a typeface and style.
<H3><A NAME="8_7_7">Character Set</A></H3>
The<VAR> Character Set</VAR> option button specifies the encoding of
characters in the document. Click on the option button to select a
character set.
<H3><A NAME="8_7_8">Options</A></H3>
<P>The<VAR> Embed Fonts</VAR> check box controls whether or not fonts
are embedded in PostScript and PDF output.</P>
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig77.png" WIDTH="513">
<BR> Figure 7-7 - The PS Tab</P>
<H2><A NAME="8_8">The PS Tab</A></H2>
The PS tab (Figure 7-7) contains options specific to PostScript output.
<H3><A NAME="8_8_1">PostScript Level</A></H3>
Click on one of the<VAR> Level</VAR> radio buttons to select the
language level to generate. PostScript Level 1 is compatible with all
PostScript printers and will produce the largest output files.
<P>PostScript Level 2 is compatible with most PostScript printers and
supports printer commands and JPEG image compression.</P>
<P>PostScript Level 3 is compatible with only the newest PostScript
printers and supports Flate image compression in addition to the Level
2 features.</P>
<H3><A NAME="8_8_2">Send Printer Commands</A></H3>
The<VAR> Send Printer Commands</VAR> check box controls whether or not
the output files contain PostScript <CODE>setpagedevice</CODE> commands
for the page size and duplex settings. Click in the check box to enable
or disable printer commands.
<P>Printer commands are only available with Level 2 and 3 output and may
not work with some printers.</P>
<H3><A NAME="8_8_3">Include Xerox Job Comments</A></H3>
<P>The<VAR> Include Xerox Job Comments</VAR> check box controls whether
or not the output files contain Xerox job comments. Click in the check
box to enable or disable the job comments.</P>
<P>Job comments are available with all levels of PostScript output.</P>
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig78.png" WIDTH="513">
<BR> Figure 7-8 - The PDF Tab</P>
<H2><A NAME="8_9">The PDF Tab</A></H2>
The PDF tab (Figure 7-8) contains settings specific to PDF output.
<H3><A NAME="8_9_1">PDF Version</A></H3>
The<VAR> PDF Version</VAR> radio buttons control what version of PDF is
generated. PDF 1.3 is the most commonly supported version. Click on the
corresponding radio button to set the version.
<H3><A NAME="8_9_2">Page Mode</A></H3>
The<VAR> Page Mode</VAR> option button controls the initial viewing
mode for the document. Click on the option button to set the page mode.
<P>The<VAR> Document</VAR> page mode displays only the document pages.
The<VAR> Outline</VAR> page mode displays the table-of-contents outline
as well as the document pages. The<VAR> Full-Screen</VAR> page mode
displays the document pages on the whole screen; this mode is used
primarily for presentations.</P>
<H3><A NAME="8_9_3">Page Layout</A></H3>
The<VAR> Page Layout</VAR> option button controls the initial layout of
document pages on the screen. Click on the option button to set the
page layout.
<P>The<VAR> Single</VAR> page layout displays a single page at a time.
The<VAR> One Column</VAR> page layout displays a single column of pages
at a time. The<VAR> Two Column Left</VAR> and<VAR> Two Column Right</VAR>
page layouts display two columns of pages at a time; the first page is
displayed in the left or right column as selected.</P>
<H3><A NAME="8_9_4">First Page</A></H3>
The<VAR> First Page</VAR> option button controls the initial page that
is displayed. Click on the option button to choose the first page.
<H3><A NAME="8_9_5">Page Effect</A></H3>
The<VAR> Page Effect</VAR> option button controls the page effect that
is displayed in<VAR> Full-Screen</VAR> mode. Click on the option button
to select a page effect.
<H3><A NAME="8_9_6">Page Duration</A></H3>
The<VAR> Page Duration</VAR> slider controls the number of seconds that
each page will be visible in<VAR> Full-Screen</VAR> mode. Drag the
slider to adjust the number of seconds.
<H3><A NAME="8_9_7">Effect Duration</A></H3>
The<VAR> Effect Duration</VAR> slider controls the number of seconds
that the page effect will last when changing pages. Drag the slider to
adjust the number of seconds.
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig79.png" WIDTH="513">
<BR> Figure 7-9 - The Security Tab</P>
<H2><A NAME="8_10">The Security Tab</A></H2>
<P>The security tab (Figure 7-9) allows you to enable PDF document
encryption and security features.</P>
<H3><A NAME="8_10_1">Encryption</A></H3>
<P>The<VAR> Encryption</VAR> buttons control whether or not encryption
is performed on the PDF file. Encrypted documents can be password
protected and also provide user permissions.</P>
<H3><A NAME="8_10_2">Permissions</A></H3>
<P>The<VAR> Permissions</VAR> buttons control what operations are
allowed by the PDF viewer.</P>
<H3><A NAME="8_10_3">Owner Password</A></H3>
<P>The<VAR> Owner Password</VAR> field contains the document owner
password, a string that is used by Adobe Acrobat to control who can
change document permissions, etc.</P>
<P>If this field is left blank, a random 32-character password is
generated so that no one can change the document using the Adobe tools.</P>
<H3><A NAME="8_10_4">Options</A></H3>
<P>The<VAR> Include Links</VAR> option controls whether or not the
internal links in a document are included in the PDF output. The
document outline (shown to the left of the document in Acrobat Reader)
is unaffected by this setting.
<!-- NEED 2i -->
</P>
<H3><A NAME="8_10_5">User Password</A></H3>
<P>The<VAR> User Password</VAR> field contains the document user
password, a string that is used by Adobe Acrobat to restrict viewing
permissions on the file.</P>
<P>If this field is left blank, any user may view the document without
entering a password.</P>
<P ALIGN="CENTER"><IMG HEIGHT="397" SRC="htmldoc-fig7a.png" WIDTH="513">
<BR> Figure 7-10 - The Options Tab</P>
<H2><A NAME="8_11">The Options Tab</A></H2>
<P>The options tab (Figure 7-10) contains the HTML file editor of your
choice and allows you to save the settings and options that will be
used in new documents.</P>
<H3><A NAME="8_11_1">HTML Editor</A></H3>
<P>The<VAR> HTML Editor</VAR> field contains the name of the HTML editor
to run when you double-click on an input file or click on the<VAR> Edit
Files...</VAR> button. Enter the program name in the field or click on
the<VAR> Browse...</VAR> button to select the editor using the <A HREF="#FILECHOOSER">
file chooser</A>.</P>
<P>The <CODE>%s</CODE> 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 <CODE>%s</CODE> to tell Netscape to edit the file and not display
it.</P>
<H3><A NAME="8_11_2">Browser Width</A></H3>
<P>The<VAR> Browser Width</VAR> slider specifies the width of the
browser in pixels that is used to scale images and other pixel
measurements to the printable page width. You can adjust this value to
more closely match the formatting on the screen.</P>
<P>The default browser width is 680 pixels which corresponds roughly to
a 96 DPI display. The browser width is only used when generating
PostScript or PDF files.</P>
<H3><A NAME="8_11_3">Search Path</A></H3>
<P>The<VAR> Search Path</VAR> field 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>
<P>Directories are separated by the semicolon (;) so that drive letters
(and eventually URLs) can be specified.</P>
<H3><A NAME="8_11_4">Proxy URL</A></H3>
<P>The<VAR> Proxy URL</VAR> field specifies a URL for a HTTP proxy
server.</P>
<H3><A NAME="8_11_5">Tooltips</A></H3>
<P>The<VAR> Tooltips</VAR> check button controls the appearance of
tooltip windows over GUI controls.</P>
<H3><A NAME="8_11_6">Modern Look</A></H3>
<P>The<VAR> Modern Look</VAR> check button controls the appearance of
the GUI controls.</P>
<H3><A NAME="8_11_7">Strict HTML</A></H3>
<P>The<VAR> Strict HTML</VAR> check button controls strict HTML
conformance checking. When checked, HTML elements that are improperly
nested and dangling close elements will produce error messages.</P>
<H3><A NAME="8_11_8">Save Options and Defaults</A></H3>
<P>The<VAR> Save Options and Defaults</VAR> button saves the HTML editor
and all of the document settings on the other tabs for use in new
documents. These settings are also used by the command-line version of
HTMLDOC.</P>
<P ALIGN="CENTER"><IMG HEIGHT="460" SRC="htmldoc-fig7b.png" WIDTH="497">
<BR> Figure 7-11 - The File Chooser</P>
<H2><A NAME="FILECHOOSER">The File Chooser</A></H2>
<P>The file chooser (Figure 7-11) allows you to select one or more files
and create files and directories.</P>
<H3><A NAME="8_12_1">Show</A></H3>
<P>The<VAR> Show</VAR> option button (1) selects which files are
displayed in the file list (3). Click on the option button to choose a
different type of file.</P>
<H3><A NAME="8_12_2">Favorites</A></H3>
<P>The<VAR> Favorites</VAR> button (2) allow you to view a specific
directory or add the current directory to your list of favorites.</P>
<H3><A NAME="8_12_3">File List</A></H3>
<P>The file list (3) lists the files and directories in the current
directory or folder. Double-click on a file or directory to select that
file or directory. Drag the mouse or hold the <KBD>CTRL</KBD> key down
while clicking to select multiple files.</P>
<H3><A NAME="8_12_4">Filename</A></H3>
<P>The<VAR> Filename</VAR> field contains the currently selected
filename. Type a name in the field to select a file or directory. As
you type, any matching filenames will be highlighted; press the <KBD>
TAB</KBD> key to accept the matches.</P>
<P>The button bar along the top of the filename allows you to view each
directory in the filename. Click on any of the segments to display the
corresponding directory.</P>
<H3><A NAME="8_12_5">Dialog Buttons</A></H3>
<P>The dialog buttons (5) close the file chooser dialog window. Click on
the<VAR> OK</VAR> button to accept your selections or the<VAR> Cancel</VAR>
button to reject your selections and cancel the file operation.</P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "8-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="CMDREF">Chapter 8 - Command-Line Reference</A>
</H1>
<P>This chapter describes all of the command-line options supported by
HTMLDOC.</P>
<H2><A NAME="9_1">Basic Usage</A></H2>
<P>The basic command-line usage for HTMLDOC is:</P>
<UL>
<PRE>
% <KBD>htmldoc <I>options</I> filename1.html ... filenameN.html <I>ENTER</I></KBD>
% <KBD>htmldoc <I>options</I> filename.book <I>ENTER</I></KBD>
</PRE>
</UL>
<P>The first form converts the named HTML 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>
<P>If no output file or directory is specified, then all output is sent
to the standard output file.</P>
<P>On return, HTMLDOC returns and exit code of 0 if it was successful
and non-zero if there were errors.</P>
<H2><A NAME="9_2">Options</A></H2>
<P>The following command-line options are recognized by HTMLDOC.</P>
<H3><A NAME="9_2_1">-d directory</A></H3>
<P>The <CODE>-d</CODE> option specifies an output directory for the
document files.</P>
<P>This option is not compatible with the PDF output format.</P>
<H3><A NAME="9_2_2">-f filename</A></H3>
<P>The <CODE>-f</CODE> option specifies an output file for the document.</P>
<H3><A NAME="9_2_3">-t format</A></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>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.3).</TD></TR>
<TR><TD>pdf11</TD><TD>Generate a PDF 1.1 file for Acrobat Reader 2.0.</TD>
</TR>
<TR><TD>pdf12</TD><TD>Generate a PDF 1.2 file for Acrobat Reader 3.0.</TD>
</TR>
<TR><TD>pdf13</TD><TD>Generate a PDF 1.3 file for Acrobat Reader 4.0.</TD>
</TR>
<TR><TD>pdf14</TD><TD>Generate a PDF 1.4 file for Acrobat Reader 5.0.</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><A NAME="9_2_4">-v</A></H3>
<P>The <CODE>-v</CODE> option specifies that progress information should
be sent/displayed to the standard error file.</P>
<H3><A NAME="9_2_5">--batch filename.book</A></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:</P>
<UL>
<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>
</UL>
<H3><A NAME="9_2_6">--bodycolor color</A></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 -->
</P>
<H3><A NAME="9_2_7">--bodyfont typeface</A></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><A NAME="9_2_8">--bodyimage filename</A></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.</P>
<H3><A NAME="9_2_9">--book</A></H3>
<P>The <CODE>--book</CODE> option specifies that the input files
comprise a book with chapters and headings.</P>
<H3><A NAME="9_2_10">--bottom margin</A></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>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_11">--browserwidth pixels</A></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>
<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 -->
</P>
<H3><A NAME="9_2_12">--charset charset</A></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>
</TABLE>
</CENTER>
<H3><A NAME="9_2_13">--color</A></H3>
<P>The <CODE>--color</CODE> option specifies that color output is
desired.</P>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_14">--compression[=level]</A></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>
<P>This option is only available when generating PDF or Level 3
PostScript files.</P>
<H3><A NAME="9_2_15">--continuous</A></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>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_16">--cookies 'name=\"value with space\"; name=value'</A>
</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><A NAME="9_2_17">--datadir directory</A></H3>
<P>The <CODE>--datadir</CODE> option specifies the location of data
files used by HTMLDOC.</P>
<H3><A NAME="9_2_18">--duplex</A></H3>
<P>The <CODE>--duplex</CODE> option specifies that the output should be
formatted for two sided printing.</P>
<P>This option is only available when generating PostScript or PDF
files. Use the <CODE>--pscommands</CODE> option to generate PostScript
duplex mode commands.</P>
<H3><A NAME="9_2_19">--effectduration seconds</A></H3>
<P>The <CODE>--effectduration</CODE> option specifies the duration of a
page transition effect in seconds.</P>
<P>This option is only available when generating PDF files.</P>
<H3><A NAME="9_2_20">--embedfonts</A></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.</P>
<H3><A NAME="9_2_21">--encryption</A></H3>
<P>The <CODE>--encryption</CODE> option enables encryption and security
features for PDF output.</P>
<P>This option is only available when generating PDF files.
<!-- NEED 4in -->
</P>
<H3><A NAME="9_2_22">--firstpage page</A></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.</P>
<H3><A NAME="9_2_23">--fontsize size</A></H3>
<P>The <CODE>--fontsize</CODE> option specifies the base font size for
the entire document in points (1 point = 1/72nd inch).</P>
<H3><A NAME="9_2_24">--fontspacing spacing</A></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 -->
</P>
<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" CELLPADDING="5" WIDTH="80%">
<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">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>
</TABLE>
</CENTER>
<P>Setting the footer to "<CODE>...</CODE>" disables the footer
entirely.
<!-- NEED 4in -->
</P>
<H3><A NAME="9_2_26">--format format</A></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>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.3).</TD></TR>
<TR><TD>pdf11</TD><TD>Generate a PDF 1.1 file for Acrobat Reader 2.0.</TD>
</TR>
<TR><TD>pdf12</TD><TD>Generate a PDF 1.2 file for Acrobat Reader 3.0.</TD>
</TR>
<TR><TD>pdf13</TD><TD>Generate a PDF 1.3 file for Acrobat Reader 4.0.</TD>
</TR>
<TR><TD>pdf14</TD><TD>Generate a PDF 1.4 file for Acrobat Reader 5.0.</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><A NAME="9_2_27">--gray</A></H3>
<P>The <CODE>--gray</CODE> option specifies that grayscale output is
desired.</P>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_28">--header lcr</A></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>
<P>Setting the header to "<CODE>...</CODE>" disables the header
entirely.
<!-- NEED 4in -->
</P>
<H3><A NAME="9_2_29">--headfootfont font</A></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:</P>
<UL>
<LI>Courier</LI>
<LI>Courier-Bold</LI>
<LI>Courier-Oblique</LI>
<LI>Courier-BoldOblique</LI>
<LI>Helvetica</LI>
<LI>Helvetica-Bold</LI>
<LI>Helvetica-Oblique</LI>
<LI>Helvetica-BoldOblique</LI>
<LI>Monospace</LI>
<LI>Monospace-Bold</LI>
<LI>Monospace-Oblique</LI>
<LI>Monospace-BoldOblique</LI>
<LI>Sans</LI>
<LI>Sans-Bold</LI>
<LI>Sans-Oblique</LI>
<LI>Sans-BoldOblique</LI>
<LI>Serif</LI>
<LI>Serif-Roman</LI>
<LI>Serif-Bold</LI>
<LI>Serif-Italic</LI>
<LI>Serif-BoldItalic</LI>
<LI>Times</LI>
<LI>Times-Roman</LI>
<LI>Times-Bold</LI>
<LI>Times-Italic</LI>
<LI>Times-BoldItalic</LI>
</UL>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_30">--headfootsize size</A></H3>
<P>The <CODE>--headfootsize</CODE> option sets the size of the header
and footer text in points (1 point = 1/72nd inch).</P>
<P>This option is only available when generating PostScript or PDF
files.
<!-- NEED 4in -->
</P>
<H3><A NAME="9_2_31">--headingfont typeface</A></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><A NAME="9_2_32">--help</A></H3>
<P>The <CODE>--help</CODE> option displays all of the available options
to the standard output file.</P>
<H3><A NAME="9_2_33">--helpdir directory</A></H3>
<P>The <CODE>--helpdir</CODE> option specifies the location of the
on-line help files.</P>
<H3><A NAME="9_2_34">--jpeg[=quality]</A></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>
<P>This option is only available when generating PDF or Level 2 and
Level 3 PostScript files.</P>
<H3><A NAME="9_2_35">--landscape</A></H3>
<P>The <CODE>--landscape</CODE> option specifies that the output should
be in landscape orientation (long edge on top).</P>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_36">--left margin</A></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>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_37">--linkcolor color</A></H3>
<P>The <CODE>--linkcolor</CODE> option specifies the color of links in
HTML and PDF output. The color can be specified by name or as a 6-digit
hexadecimal number of the form <CODE>#RRGGBB</CODE>.</P>
<H3><A NAME="9_2_38">--links</A></H3>
<P>The <CODE>--links</CODE> option specifies that PDF output should
contain hyperlinks.</P>
<H3><A NAME="9_2_39">--linkstyle style</A></H3>
<P>The <CODE>--linkstyle</CODE> option specifies the style of links in
HTML and PDF output. The style can be "plain" for no decoration or
"underline" to underline links.
<!-- NEED 5in -->
</P>
<H3><A NAME="9_2_40">--logoimage filename</A></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.
<CENTER>
<TABLE BGCOLOR="#cccccc" BORDER="1" CELLPADDING="5" CELLSPACING="0" WIDTH="80%">
<TR><TD><B>Note:</B>
<P>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.</P>
<P>The following example uses the <CODE>--header</CODE> option:</P>
<PRE>
htmldoc --logoimage image.png --header lt. -f file.pdf file.html
</PRE>
</TD></TR>
</TABLE>
</CENTER>
</P>
<H3><A NAME="9_2_41">--no-compression</A></H3>
<P>The <CODE>--no-compression</CODE> option specifies that Flate
compression should not be performed on the output files.</P>
<H3><A NAME="9_2_42">--no-duplex</A></H3>
<P>The <CODE>--no-duplex</CODE> option specifies that the output should
be formatted for one sided printing.</P>
<P>This option is only available when generating PostScript or PDF
files. Use the <CODE>--pscommands</CODE> option to generate PostScript
duplex mode commands.</P>
<H3><A NAME="9_2_43">--no-embedfonts</A></H3>
<P>The <CODE>--no-embedfonts</CODE> option specifies that fonts should
not be embedded in PostScript and PDF output.</P>
<H3><A NAME="9_2_44">--no-encryption</A></H3>
<P>The <CODE>--no-encryption</CODE> option specifies that no
encryption/security features should be enabled in PDF output.</P>
<P>This option is only available when generating PDF files.</P>
<H3><A NAME="9_2_45">--no-jpeg</A></H3>
<P>The <CODE>--no-jpeg</CODE> option specifies that JPEG compression
should not be performed on large images.</P>
<H3><A NAME="9_2_46">--no-links</A></H3>
<P>The <CODE>--no-links</CODE> option specifies that PDF output should
not contain hyperlinks.</P>
<H3><A NAME="9_2_47">--no-localfiles</A></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.</P>
<H3><A NAME="9_2_48">--no-numbered</A></H3>
<P>The <CODE>--no-numbered</CODE> option specifies that headings should
not be numbered.</P>
<H3><A NAME="9_2_49">--no-pscommands</A></H3>
<P>The <CODE>--no-pscommands</CODE> option specifies that PostScript
device commands should not be written to the output files.</P>
<H3><A NAME="9_2_50">--no-strict</A></H3>
<P>The <CODE>--no-strict</CODE> option turns off strict HTML conformance
checking.</P>
<H3><A NAME="9_2_51">--no-title</A></H3>
<P>The <CODE>--no-title</CODE> option specifies that the title page
should not be generated.</P>
<H3><A NAME="9_2_52">--no-toc</A></H3>
<P>The <CODE>--no-toc</CODE> option specifies that the table-of-contents
pages should not be generated.</P>
<H3><A NAME="9_2_53">--no-xrxcomments</A></H3>
<P>The <CODE>--no-xrxcomments</CODE> option specifies that Xerox
PostScript job comments should not be written to the output files.</P>
<P>This option is only available when generating PostScript files.</P>
<H3><A NAME="9_2_54">--numbered</A></H3>
<P>The <CODE>--numbered</CODE> option specifies that headings should be
numbered.</P>
<H3><A NAME="9_2_55">--nup pages</A></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.</P>
<H3><A NAME="9_2_56">--outdir directory</A></H3>
<P>The <CODE>--outdir</CODE> option specifies an output directory for
the document files.</P>
<P>This option is not compatible with the PDF output format.</P>
<H3><A NAME="9_2_57">--outfile filename</A></H3>
<P>The <CODE>--outfile</CODE> option specifies an output file for the
document.</P>
<H3><A NAME="9_2_58">--owner-password password</A></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>
<P>This option is only available when generating PDF files.</P>
<H3><A NAME="9_2_59">--pageduration seconds</A></H3>
<P>The <CODE>--pageduration</CODE> option specifies the number of
seconds that each page will be displayed in the document.</P>
<P>This option is only available when generating PDF files.
<!-- NEED 8in -->
</P>
<H3><A NAME="9_2_60">--pageeffect effect</A></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 -->
</P>
<H3><A NAME="9_2_61">--pagelayout layout</A></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 -->
</P>
<H3><A NAME="9_2_62">--pagemode mode</A></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.</P>
<H3><A NAME="9_2_63">--path dir1;dir2;dir3;...;dirN</A></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>
<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.</P>
<UL>
<PRE>
<KBD>--path "dir1;dir2;dir3;...;dirN"</KBD>
</PRE>
</UL>
<!-- NEED 5in -->
<H3><A NAME="9_2_64">--permissions permission[,permission,...]</A></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.</P>
<UL>
<PRE>
<KBD>--permissions no-print --encryption</KBD>
</PRE>
</UL>
<P>Multiple options can be specified by separating them with commas:</P>
<UL>
<PRE>
<KBD>--permissions no-print,no-copy --encryption</KBD>
</PRE>
</UL>
<P>This option is only available when generating PDF files.</P>
<H3><A NAME="9_2_65">--portrait</A></H3>
<P>The <CODE>--portrait</CODE> option specifies that the output should
be in portrait orientation (short edge on top).</P>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_66">--pscommands</A></H3>
<P>The <CODE>--pscommands</CODE> option specifies that PostScript device
commands should be written to the output files.</P>
<P>This option is only available when generating Level 2 and Level 3
PostScript files.</P>
<H3><A NAME="9_2_67">--quiet</A></H3>
<P>The <CODE>--quiet</CODE> option prevents error messages from being
sent to stderr.</P>
<H3><A NAME="9_2_68">--referer url</A></H3>
<P>The <CODE>--referer</CODE> option sets the URL that is passed in the <CODE>
Referer:</CODE> field of HTTP requests.</P>
<H3><A NAME="9_2_69">--right margin</A></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>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_70">--size size</A></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>
<P>This option is only available when generating PostScript or PDF
files. Use the <CODE>--pscommands</CODE> option to generate PostScript
page size commands.</P>
<H3><A NAME="9_2_71">--strict</A></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.</P>
<H3><A NAME="9_2_72">--textcolor color</A></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 -->
</P>
<H3><A NAME="9_2_73">--textfont typeface</A></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><A NAME="9_2_74">--title</A></H3>
<P>The <CODE>--title</CODE> option specifies that a title page should be
generated.</P>
<H3><A NAME="9_2_75">--titlefile filename</A></H3>
<P>The <CODE>--titlefile</CODE> option specifies a HTML file to use for
the title page.</P>
<H3><A NAME="9_2_76">--titleimage filename</A></H3>
<P>The <CODE>--titleimage</CODE> option specifies the title image for
the title page. The supported formats are BMP, GIF, JPEG, and PNG.</P>
<H3><A NAME="9_2_77">--tocfooter lcr</A></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>
<P>Setting the TOC footer to "<CODE>...</CODE>" disables the TOC footer
entirely.</P>
<H3><A NAME="9_2_78">--tocheader lcr</A></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>
<P>Setting the TOC header to "<CODE>...</CODE>" disables the TOC header
entirely.</P>
<H3><A NAME="9_2_79">--toclevels levels</A></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.</P>
<H3><A NAME="9_2_80">--toctitle string</A></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".</P>
<H3><A NAME="9_2_81">--top margin</A></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>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_82">--user-password password</A></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>
<P>This option is only available when generating PDF files.</P>
<H3><A NAME="9_2_83">--verbose</A></H3>
<P>The <CODE>--verbose</CODE> option specifies that progress information
should be sent/displayed to the standard error file.</P>
<H3><A NAME="9_2_84">--version</A></H3>
<P>The <CODE>--version</CODE> option displays the HTMLDOC version
number.</P>
<H3><A NAME="9_2_85">--webpage</A></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>
<P>This option is only available when generating PostScript or PDF
files.</P>
<H3><A NAME="9_2_86">--xrxcomments</A></H3>
<P>The <CODE>--xrxcomments</CODE> option specifies that Xerox PostScript
job comments should be written to the output files.</P>
<P>This option is only available when generating PostScript files.
<!-- NEW PAGE -->
</P>
<H2><A NAME="9_3">Environment Variables</A></H2>
<P>HTMLDOC looks for several environment variables which can override
the default directories, display additional debugging information, and
disable CGI mode.</P>
<H3><A NAME="9_3_1">HTMLDOC_DATA</A></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\Easy Software
Products\HTMLDOC</VAR>.</P>
<H3><A NAME="9_3_2">HTMLDOC_DEBUG</A></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><A NAME="9_3_3">HTMLDOC_HELP</A></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\Easy Software Products\HTMLDOC\doc</VAR>.</P>
<H3><A NAME="9_3_4">HTMLDOC_NOCGI</A></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><A NAME="9_4">Messages</A></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.</P>
<H3><A NAME="9_4_1">BYTES: Message</A></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.</P>
<H3><A NAME="9_4_2">DEBUG: Messages</A></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><A NAME="9_4_3">ERRnnn: Messages</A></H3>
<P>The <CODE>ERRnnn:</CODE> messages specify an error condition. Error
numbers 1 to 14 map to the following errors:</P>
<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.</P>
<H3><A NAME="9_4_4">INFO: Messages</A></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><A NAME="9_4_5">PAGES: Message</A></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 output.</P>
<H3><A NAME="9_4_6">REMOTEBYTES: Message</A></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><A NAME="9_4_7">TIMING: Message</A></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><HR NOSHADE>
<!-- FOOTER RIGHT "A-$CHAPTERPAGE" -->
<DIV align="justify">
<H1 align="right"><A name="LICENSE">Appendix A - License Agreement</A></H1>
<H2><A NAME="10_1">Introduction</A></H2>
<P>HTMLDOC is distributed in both source code and binary (executable)
forms. The source code is provided under the terms of the GNU General
Public License ("GPL") with a license exception for the OpenSSL
toolkit. A copy of the source code license can be found in the file<VAR>
COPYING.txt</VAR> in the source code distribution.</P>
<P>The binaries are provided under a typical commercial software
end-user license agreement which is more restrictive than the GNU GPL.</P>
<H3><A NAME="10_1_1">Source Code and the GNU GPL</A></H3>
<P>For those not familiar with the GNU GPL, the license basically allows
you to:</P>
<UL>
<LI>Use the HTMLDOC software and source code at no charge.</LI>
<LI>Distribute verbatim copies of the software in source form or as
binaries you create.</LI>
<LI>Sell verbatim copies of the software for a media fee, or sell
support for the software.</LI>
<LI>Distribute or sell your own modified version of HTMLDOC so long as
the source code is made available under the GPL.</LI>
</UL>
<P>What this license<B> does not</B> allow you to do is make changes or
add features to HTMLDOC and then sell a binary distribution without
source code. You must provide source for any changes or additions to
the software, and all code must be provided under the GPL.</P>
<H3><A NAME="10_1_2">Trademarks</A></H3>
<P>Easy Software Products has trademarked the HTMLDOC name. You may use
the name in any direct port or binary distribution of HTMLDOC. Please
contact Easy Software Products for written permission to use the name
in derivative products. Our intention is to protect the value of this
trademark and ensure that any derivative product meets the same
high-quality standards as the original.</P>
<H3><A NAME="10_1_3">Binary Distribution Rights</A></H3>
<P>Easy Software Products also sells rights to the HTMLDOC source code
under a binary distribution license for vendors that are unable to
release source code for their additions and modifications to HTMLDOC
under the GNU GPL. For information please contact us at the address
shown above.</P>
<H3><A NAME="10_1_4">Binaries and Support</A></H3>
<P>Easy Software Products sells commercial HTMLDOC binaries and support.
You can find out more at the HTMLDOC commercial home page:</P>
<PRE>
<A href="http://www.easysw.com/">http://www.easysw.com/htmldoc/</A>
</PRE>
<!-- NEW PAGE -->
<H2><A NAME="10_2">End-User License Agreement</A></H2>
<P>PLEASE READ THIS DOCUMENT CAREFULLY. THIS IS A LEGAL AGREEMENT
BETWEEN YOU AND EASY SOFTWARE PRODUCTS ("ESP"). BY INSTALLING THIS
PACKAGE, AND USING THE HTMLDOC SOFTWARE AND DOCUMENTATION ("SOFTWARE")
CONTAINED IN THIS PACKAGE, YOU ARE AGREEING TO BECOME BOUND BY THE
TERMS AND CONDITIONS OF THIS AGREEMENT. THIS AGREEMENT REPRESENTS THE
ENTIRE AND SOLE AGREEMENT CONCERNING THE ESP SOFTWARE, AND IT
SUPERSEDES ANY PRIOR PROPOSAL, REPRESENTATION OR UNDERSTANDING
REGARDING THE SOFTWARE BETWEEN YOU AND ESP OR ANY OTHER PARTY. IF YOU
(hereafter in this document referred to as "LICENSEE") ARE NOT WILLING
TO BE BOUND BY THE TERMS OF THIS LICENSE AGREEMENT, PLEASE DO NOT
INSTALL OR USE THIS SOFTWARE.</P>
<H3><A NAME="10_2_1">TERMS AND CONDITIONS OF SOFTWARE LICENSE</A></H3>
<OL>
<LI><B>GRANT OF LICENSE; USE RESTRICTIONS</B>. In consideration for the
payment of a license fee, ESP grants to LICENSEE a personal,
nontransferable (except as provided below) and nonexclusive right to
use the SOFTWARE on one (1) computer system, solely for LICENSEE's
internal business purposes. LICENSEE agrees that it shall not reverse
compile or disassemble any portion of the SOFTWARE not already provided
by ESP in source code form.</LI>
<LI><B>OWNERSHIP OF SOFTWARE</B>. LICENSEE agrees that no title to the
SOFTWARE, or the intellectual property in any of the SOFTWARE, or in
any SOFTWARE copy, is transferred to LICENSEE, and that all rights not
expressly granted to LICENSEE hereunder are reserved by ESP. This
license is not a sale of the original SOFTWARE or any copy thereof.</LI>
<LI><B>TRANSFER RESTRICTIONS</B>. If LICENSEE transfers ownership, or
otherwise disposes, of a computer system for which a license for the
SOFTWARE was purchased, provided that the transferee agrees to accept
the terms and conditions of this AGREEMENT, LICENSEE may transfer the
SOFTWARE and all licenses and rights in SOFTWARE granted under this
AGREEMENT to such transferee, provided that all SOFTWARE copies are
also transferred.</LI>
<LI><B>DISCLOSURE RESTRICTIONS</B>. LICENSEE agrees to not disclose or
otherwise disseminate software licensing information, including the
so-called "license key" provided to LICENSEE by ESP, to third parties
other than ESP or its official distributors. Should LICENSEE violate
this restriction, LICENSEE shall comply with the termination clause of
this license and pay a penalty fee of $1000 US per offense or $100,000
US, whichever is greater. This restriction does not apply if the
license is being transferred according to the rules in paragraph 3.</LI>
<LI><B>TERMINATION</B>. If licensee fails to fulfill any of LICENSEE's
material obligations under this AGREEMENT, ESP may, at any time
thereafter, and in addition to any other available remedies, terminate
this AGREEMENT and all licenses and rights granted to LICENSEE under
this AGREEMENT. Upon termination of this AGREEMENT, LICENSEE shall,
within thirty (30) days after termination, deliver to ESP all removable
media and documentation containing the SOFTWARE, and shall render
unusable all copies of the SOFTWARE placed in any storage apparatus.</LI>
<LI><B>GOVERNING LAW</B>. This License is governed by the laws of the
State of Maryland, U.S.A., excluding choice of law rules. If any part
of this License is found to be in conflict with the law, that part
shall be interpreted in its broadest meaning consistent with the law,
and no other parts of the License shall be affected.</LI>
<LI><B>U.S. GOVERNMENT USERS</B>. This SOFTWARE is provided with
RESTRICTED RIGHTS. If you are a unit or agency of the United States
Government or are acquiring the Software for any such unit or agency,
the following applies:<BLOCKQUOTE>If the unit or agency is the
Department of Defense ("DOD"), the SOFTWARE and its documentation are
classified as "commercial computer software" and "commercial computer
software documentation" respectively and, pursuant to DFAR Section
227.7202, the Government is acquiring the SOFTWARE and its
documentation in accordance with the terms of this License. If the unit
or agency is other than DOD, the SOFTWARE and its documentation are
classified as "commercial computer software" and "commercial computer
software documentation" respectively and, pursuant to FAR Section
12.212, the Government is acquiring the SOFTWARE and its documentation
in accordance with the terms of this License.</BLOCKQUOTE></LI>
</OL>
<H3><A NAME="10_2_2">LIMITED WARRANTY AND DISCLAIMER OF WARRANTY;
LIMITATION OF LIABILITY</A></H3>
<P>ESP warrants that it has the authority and right to license the
SOFTWARE, and that the SOFTWARE will conform to the material printed
specifications therefore which are in effect on the date of original
delivery of such SOFTWARE. ESP's warranty and obligation shall extend
for a period of ninety (90) days after the date of the original
delivery of SOFTWARE to LICENSEE by ESP, and is solely for the benefit
of LICENSEE, who has no authority to assign or pass through this
warranty to any other person or entity.</P>
<P>Except as provided in this Section, the SOFTWARE is provided to
LICENSEE on an "AS IS" basis, and ESP makes no other warranty of any
kind, express or implied, with regard to the SOFTWARE licensed
hereunder. ESP warrants that the SOFTWARE properly processes date and
time information between the years 1970 and 2038. ESP does not warrant
or represent that the SOFTWARE will operate uninterrupted or error free
or that all defects in the SOFTWARE are correctable or will be
corrected. This warranty shall not apply if SOFTWARE is used other than
in accordance with ESP's written instructions, or if any of LICENSEE's
hardware equipment or other software malfunctions. ESP's entire
liability and LICENSEE's exclusive remedy for any defects in the
SOFTWARE shall be to obtain ESP's SOFTWARE updates via the Internet or
pay a media update fee for each copy of the SOFTWARE.</P>
<P>THE FORGOING WARRANTIES ARE IN LIEU OF, AND ESP DISCLAIMS, ALL OTHER
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some
states do not allow the exclusion of implied warranties, so the
exclusion above may not apply to LICENSEE. This warranty gives LICENSEE
specific legal rights, and LICENSEE may have other rights which vary
from state to state.</P>
<P>IN NO EVENT SHALL ESP OR ESP'S LICENSORS BE LIABLE TO LICENSEE FOR
ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL OR INDIRECT DAMAGES OF ANY KIND
(INCLUDING WITHOUT LIMITATION LOSS OF PROFITS OR DATA AND PERSONAL
INJURY), WHETHER OR NOT ESP HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
LOSS, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF
THIS AGREEMENT. THESE LIMITATIONS SHALL APPLY NOTWITHSTANDING THE
FAILURE OF THE ESSENTIAL PURPOSE OF ANY LIMITED REMEDY. In no event
will ESP be liable for any claim against LICENSEE by a third party, and
LICENSEE hereby agrees to indemnify and hold ESP harmless for any
claims for cost, damage, expense or liability arising out of or in
connection with the installation, use and performance of the SOFTWARE
licensed hereunder, whether alone or in combination with any other
product or service. Some states do not allow the limitation or
exclusion of liability for incidental or consequential damages, so the
limitation above may not apply to LICENSEE.</P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "B-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="BOOKFORMAT">Appendix B - Book File Format</A></H1>
<P>This appendix describes the HTMLDOC<VAR> .book</VAR> file format.</P>
<H2><A NAME="11_1">Introduction</A></H2>
<P>The HTMLDOC<VAR> .book</VAR> file format is a simple text format that
provides the command-line options and files that are part of the
document. These files can be used from the GUI interface or from the
command-line using the <CODE>--batch</CODE> option:</P>
<UL>
<PRE>
htmldoc filename.book
htmldoc --batch filename.book
</PRE>
</UL>
<P>The first form will load the book and display the GUI interface, if
configured. Windows users should use<VAR> ghtmldoc.exe</VAR> executable
to show the GUI and<VAR> htmldoc.exe</VAR> for the batch mode:</P>
<UL>
<PRE>
ghtmldoc.exe filename.book
htmldoc.exe --batch filename.book
</PRE>
</UL>
<H2><A NAME="11_2">The Header</A></H2>
<P>Each<VAR> .book</VAR> file starts with a line reading:</P>
<UL>
<PRE>
#HTMLDOC 1.8.17
</PRE>
</UL>
<P>The version number (1.8.17) is optional.</P>
<H2><A NAME="11_3">The Options</A></H2>
<P>Following the header is a line containing the options for the book.
You can use any valid command-line option on this line:</P>
<UL>
<PRE>
-f htmldoc.pdf --titleimage htmldoc.png --duplex --compression=9 --jpeg=90
</PRE>
</UL>
<P>Long option lines can be broken using a trailing backslash (<TT>\</TT>
) on the end of each continuation line:</P>
<UL>
<PRE>
-f htmldoc.pdf --titleimage htmldoc.png --duplex \
--compression=9 --jpeg=90
</PRE>
</UL>
<H2><A NAME="11_4">The Files</A></H2>
<P>Following the options are a list of files or URLs to include in the
document:</P>
<UL>
<PRE>
intro.html
1-install.html
2-starting.html
3-books.html
4-cmdline.html
5-cgi.html
6-htmlref.html
7-guiref.html
8-cmdref.html
a-license.html
b-book.html
c-relnotes.html
</PRE>
</UL>
<H2><A NAME="11_5">Putting It All Together</A></H2>
<P>The following is the complete book file needed to generate this
documentation:</P>
<UL>
<PRE>
#HTMLDOC 1.8.13
-f htmldoc.pdf --titleimage htmldoc.png --duplex --compression=9 --jpeg=90
intro.html
1-install.html
2-starting.html
3-books.html
4-cmdline.html
5-cgi.html
6-htmlref.html
7-guiref.html
8-cmdref.html
a-license.html
b-book.html
c-relnotes.html
</PRE>
</UL>
<!-- NEED 3in -->
<H2><A NAME="11_6">Older Book Files</A></H2>
<P>Prior to HTMLDOC version 1.8.12, the book file format was slightly
different:</P>
<UL>
<PRE>
#HTMLDOC version
file count
file(s)
options
</PRE>
</UL>
<P>While HTMLDOC still supports reading this format, we do not recommend
using it for new books. In particular, when generating a document using
the <CODE>--batch</CODE> option, some options may not be applied
correctly since the files are loaded prior to setting the output
options in the old format.</P>
</DIV><HR NOSHADE>
<!-- FOOTER RIGHT "C-$CHAPTERPAGE" -->
<H1 ALIGN="RIGHT"><A NAME="RELNOTES">Appendix C - Release Notes</A></H1>
<P>This appendix provides the release notes for each version of HTMLDOC.</P>
<H2><A NAME="12_1">Changes in HTMLDOC v1.8.27</A></H2>
<UL>
<H3><A NAME="12_1_1">Bug Fixes</A></H3>
<LI>Fixed a crash bug that appeared when more than 10 blank pages were
present in a document (PR #6223)</LI>
<LI>Color changes were not reflected in PRE text (STR #129)</LI>
<LI>Remote URLs did not always work on older operating systems (PR
#6179)</LI>
<LI>Image filenames using % escapes were not decoded properly.</LI>
<LI>Rows using BGCOLOR that spanned across multiple pages did not render
properly (PR #6149)</LI>
<LI>Rows no longer start on a new page due to a cell with both HEIGHT
and ROWSPAN specified (PR #6086)</LI>
<LI>CMYK JPEG images caused HTMLDOC to crash (PR #6106)</LI>
<LI>Table cell width calculations didn't always account for the proper
minimum width (STR #121)</LI>
<LI>Images were not copied when generating indexed HTML output to a
directory (STR #117)</LI>
<LI>Changing the bottom margin resulted in text that was formatted below
the bottom margin.</LI>
<LI>The Monospace-Oblique font was not embedded properly in PDF files.</LI>
</UL>
<H2><A NAME="12_2">Changes in HTMLDOC v1.8.26</A></H2>
<UL>
<H3><A NAME="12_2_1">Bug Fixes</A></H3>
<LI>Outline and keyword strings in PDF files are now stored as Unicode
(STR #113)</LI>
<LI>The Flate compression code could get in an infinite loop if it ran
out of memory (STR #101)</LI>
<LI>Book files saved from the GUI did not handle filenames with spaces
(STR #105)</LI>
<LI>Fixed and re-enabled the ASCII85Device filter support in PostScript
Level 2/3 output (STR #116)</LI>
<LI>Character entities in the first word of a file were not rendered
properly (STR #111)</LI>
<LI>Fixed-size table columns were incorrectly resized when a table width
was also specified and there was extra space to distribute (PR #6062)</LI>
<LI>Text could "walk" up or down when in-line images were used (PR
#6034)</LI>
<LI>Row backgrounds incorrectly replaced cell backgrounds when the first
cell in a row used ROWSPAN (PR #6033, PR #6036)</LI>
<LI>HTMLDOC did not correctly parse FONT FACE attributes (PR #6006)</LI>
<LI>Images in Level 2/3 PostScript output did not work on some printers
(PR #6000)</LI>
<LI>The GUI did not use the first page header (PR #5978)</LI>
</UL>
<H2><A NAME="12_3">Changes in HTMLDOC v1.8.25</A></H2>
<UL>
<H3><A NAME="12_3_1">New Features</A></H3>
<LI>Added "--overflow" and "--no-overflow" command-line options to show
or hide the content-too-large errors; the default is "--no-overflow".</LI>
<LI>Added "--header1" command-line option and "HEADER1" page comments to
set the page header for the first page of each chapter.</LI>
<LI>Added "timing" and "remotebytes" debug data generation.</LI>
<LI>Added DejaVu font collection to better support Cyrillic and Greek
text; the new fonts are available under the generic names "monospace",
"sans", and "serif".</LI>
<LI>Added "--referer" command-line option and corresponding CGI-mode
support to pass Referer: information in HTTP requests (STR #91)</LI>
<H3><A NAME="12_3_2">Changes</A></H3>
<LI>On Windows, HTMLDOC now logs CGI mode errors to a file called
"htmldoc.log" in the Windows temporary directory.</LI>
<LI>HTMLDOC no longer uses Base-85 encoding for image data when
producing Level 2 and 3 PostScript output. It appears that many
printers and PostScript interpreters cannot properly decode this data
when the original image data is not a multiple of 8 bits.</LI>
<LI>HTMLDOC now renders STRONG elements in boldface instead of
bold-italic to match the W3C recommendations.</LI>
<LI>HTMLDOC now automatically inserts a TR element before a TD or TH
element as needed to improve web site compatibility; this also triggers
a HTML error in --strict mode.</LI>
<H3><A NAME="12_3_3">Bug Fixes</A></H3>
<LI>"$HFIMAGEn" didn't work in a header/footer string.</LI>
<LI>HTMLDOC could crash when rendering a table.</LI>
<LI>Book files were not used in CGI mode (STR #69)</LI>
<LI>Cookies were not sent in HTTP requests (STR #71)</LI>
<LI>Table cells were not aligned properly when the ROWSPAN attribute was
set to 1 (STR #73)</LI>
<LI>HTMLDOC crashed when rendering unresolved hyperlinks in aligned
images (STR #62)</LI>
<LI>Documented the HTMLDOC_NOCGI environment variable (STR #63)</LI>
<LI>HTMLDOC sometimes crashed when rendering tables with background
colors (STR #65)</LI>
<LI>HTMLDOC would crash when writing encrypted strings longer than 1024
bytes (STR #66)</LI>
<LI>HTMLDOC didn't set the data directory when running in CGI mode on
Windows.</LI>
<LI>HTMLDOC could crash when loading the Symbol.afm file (STR #93)</LI>
<LI>HTMLDOC did not always honor HEIGHT attributes in table rows.</LI>
<LI>Tables with a mix of colspan and rowspan sometimes caused cells to
be moved vertically outside the cell.</LI>
</UL>
<H2><A NAME="12_4">Changes in HTMLDOC v1.8.24</A></H2>
<UL>
<H3><A NAME="12_4_1">New Features</A></H3>
<LI>HTMLDOC now provides limited cookie support via the "--cookies"
command-line option and via the cookies passed by a browser in CGI
mode.</LI>
<LI>HTMLDOC now features a CGI mode which provides PDF conversion
functionality for web servers.</LI>
<LI>HTMLDOC now generates a document outline for each input file or URL
in webpage mode; the outline shows the title for the file and links to
the first page containing that file.</LI>
<LI>HTMLDOC now offers an "htmlsep" output type which generates HTML
output with a separate file for each heading in the table of contents.</LI>
<LI>HTMLDOC now includes LINK elements in generated HTML so that
intelligent browsers like Mozilla can show next/prev/contents/top
buttons.</LI>
<LI>HTMLDOC now supports the BORDERCOLOR attribute for tables, a MSIE
extension.</LI>
<LI>The "strict HTML" mode now reports unresolved local links.</LI>
<LI>Added support for HP LaserJet 5000 and Xerox DocuPrint 2000/100
printer commands.</LI>
<LI>Added multiple header/footer image support.</LI>
<LI>Links to external URLs are now resolved so that the output file can
be moved without affecting them.</LI>
<H3><A NAME="12_4_2">Changes</A></H3>
<LI>The command-line now allows --fontsize values from 4 to 26 to match
the GUI.</LI>
<LI>Now use a 0.001 point tolerance when checking for content that
overflows the page/cell.</LI>
<LI>HTMLDOC no longer enables interpolation of 2-color images.</LI>
<LI>The default vertical alignment of images is "BOTTOM" to match the
HTML specification.</LI>
<LI>Paragraph spacing is only applied to the first table after a
paragraph.</LI>
<LI>The tabloid media size was 10 points too short in length.</LI>
<LI>The table formatter now subtracts the outside border and padding
widths for percentage-based widths. This helps to eliminate "truncation
or overlapping" errors.</LI>
<LI>Dropped support for FLTK 1.0.x when building the GUI.</LI>
<LI>The default vertical alignment is now "bottom" inside paragraphs to
correctly align different sized text and images to the baseline.</LI>
<LI>Indexed images are now written as PDF image objects when encryption
is enabled; this works around a serious bug in Acrobat 6 which tries to
decrypt the colormap of in-line images twice, causing some very strange
colors!</LI>
<LI>Table captions can now be bottom aligned.</LI>
<LI>Blocks now break at the bottom of a page if the current line height
+ standard line height goes below the bottom of the page; this prevents
images with captions from getting erroneously moved to the top of the
next page.</LI>
<LI>Character entities are now supported in HTML attributes and unknown
or invalid character entities are left as plain text.</LI>
<LI>Changed handling of NOWRAP for some tables.</LI>
<LI>The --permissions option now supports multiple permission keywords
in a single invocation.</LI>
<LI>Dropped support for MacOS 9 and earlier.</LI>
<LI>HTMLDOC now breaks between images that are too large to fit on a
single line, to match the behavior of Mozilla/Netscape (STR #7).</LI>
<LI>HTMLDOC now handles XHTML input more cleanly.</LI>
<LI>HTMLDOC no longer specifies an interpolation preference for images
in PostScript or PDF output (STR #8)</LI>
<LI>The DT element no longer applies an italic style (PR #5178)</LI>
<LI>HTMLDOC now ignores content inside a STYLE element (PR #5183)</LI>
<H3><A NAME="12_4_3">Bug Fixes</A></H3>
<LI>Switching between landscape and portrait orientations would cause
margin creepage.</LI>
<LI>Images did not default to align=bottom, and the align=bottom line
spacing calculation was incorrect.</LI>
<LI>Whitespace before a link was underlined.</LI>
<LI>Fixed a table column sizing bug.</LI>
<LI>HTMLDOC didn't read back the HTTP response properly in all
situations.</LI>
<LI>Fixed some more PNG transparency cases.</LI>
<LI>The PageBoundingBox comments in PostScript output did not account
for the back page when duplexing was enabled.</LI>
<LI>HTMLDOC generated an incorrect image mask for some images.</LI>
<LI>The first page of each chapter did not use the custom page number if
it was placed inside the heading.</LI>
<LI>HTMLDOC did not reset the rendering cache before each page when
producing N-up output; this caused font errors in some cases that
prevented the document from printing or displaying properly.</LI>
<LI>Eliminated a common cause of "table too wide" formatting errors,</LI>
<LI>Fixed a bug when applying a table background color to a cell without
a border that cross a page boundary.</LI>
<LI>Fixed some calls to strcpy with overlapping arguments.</LI>
<LI>The names object was never set when the name objects were written.</LI>
<LI>Character entities were not decoded/encoded inside HTML comments.</LI>
<LI>The current heading was not always correctly substituted when used
in the page header or footer.</LI>
<LI>When converting web pages from the GUI, the table-of-contents page
number preferences were incorrectly used.</LI>
<LI>PDF page effects/transitions were not put in the right part of the
page dictionary, causing them not to be used by the PDF reader
application.</LI>
<LI>The _HD_OMIT_TOC attribute was not being honored for HTML output.</LI>
<LI>HTMLDOC now handles "open" messages from the MacOS X Finder (STR #3)</LI>
<LI>The GUI did not load or save the "strict HTML" setting (STR #6)</LI>
<LI>The HTML version of the title page did not set the ALT attribute for
the title image (STR #10)</LI>
<LI>The HTML version of the table of contents did not correctly nest the
lists in the parent items (STR #10)</LI>
<LI>Borders around left and right-aligned images were not drawn properly
(PR #5112)</LI>
<LI>Grayscale PDF output was not truly grayscale (STR #32)</LI>
<LI>Fixed a table-of-contents bug introduced in 1.8.24rc1 which caused
the PDF document outline and actual TOC pages were not rendered
properly (STR #37)</LI>
<LI>Links were not rendered due to a bug that was introduced in
1.8.24rc2 (STR #41)</LI>
</UL>
<H2><A NAME="12_5">Changes in HTMLDOC v1.8.23</A></H2>
<UL>
<H3><A NAME="12_5_1">New Features</A></H3>
<LI>HTMLDOC now supports a full alpha channel in PNG files.</LI>
<LI>HTMLDOC now reports an error when a table, image, or section of text
overflows into an adjacent table cell or off the right edge of the
page.
<H3><A NAME="12_5_2">Changes</A></H3>
</LI>
<LI>The NEW SHEET page comment now breaks on N-up boundaries when N is
greater than 1.
<H3><A NAME="12_5_3">Bug Fixes</A></H3>
</LI>
<LI>HTMLDOC tried to format tables with no rows or columns. While the
HTML in technically not in error, it is not exactly something you'd
expect someone to do.</LI>
<LI>HTMLDOC didn't report an error when it could not find the specified
title page file.</LI>
<LI>HTMLDOC could crash if it was unable to create its output files.</LI>
<LI>HTMLDOC could crash when writing HTML output containing unknown HTML
elements.</LI>
<LI>HTMLDOC could crash when writing HTML output if the output document
had no title.</LI>
<LI>The htmlGetText() function used a fixed-size (10k) buffer which
allowed for a buffer overflow. The new code (from HTMLDOC 1.9)
allocates its buffer instead.</LI>
<LI>The header/footer text was not centered properly if the
header/footer font size was different than the default body font size.</LI>
<LI>The GUI interface incorrectly localized URLs when doing a "save as"
operation.</LI>
<LI>The PNG background color was not correct for PNG files using <= 8
bits per pixel.</LI>
</UL>
<H2><A NAME="12_6">Changes in HTMLDOC v1.8.22</A></H2>
<UL>
<H3><A NAME="12_6_1">New Features</A></H3>
<LI>Now support many Windows code pages in addition to ISO charsets.
<H3><A NAME="12_6_2">Bug Fixes</A></H3>
</LI>
<LI>HTMLDOC could crash when checking if a URL is already cached.</LI>
<LI>HTMLDOC didn't adjust the top margin when changing the page header
if the comment didn't appear at the top of a page.</LI>
<LI>HTMLDOC didn't initialize the right number of TOC headings.</LI>
<LI>When using a logo image in the header, the header was placed too low
on the page.</LI>
</UL>
<H2><A NAME="12_7">Changes in HTMLDOC v1.8.21</A></H2>
<UL>
<H3><A NAME="12_7_1">New Features</A></H3>
<LI>HTMLDOC now supports heading levels 1 to 15.</LI>
<LI>HTMLDOC now allows the author to omit headings from the TOC using
the _HD_OMIT_TOC attribute.</LI>
<LI>HTMLDOC now supports remote book files when running from the
command-line.</LI>
<LI>HTMLDOC now supports hexadecimal character constants (&#xFF)
<H3><A NAME="12_7_2">Changes</A></H3>
</LI>
<LI>HTMLDOC now calculates the resolution of the body image using the
printable width instead of the page width.</LI>
<LI>HTMLDOC should now compile out-of-the-box using the Cygwin tools.</LI>
<LI>HTMLDOC no longer inserts whitespace between text inside DIV
elements.</LI>
<LI>HTMLDOC now supports quoted usernames and passwords in URLs.</LI>
<LI>HTMLDOC now defaults unknown colors to white for background colors
and black for foreground colors. This should make documents that use
non-standard color names still appear readable.
<H3><A NAME="12_7_3">Bug Fixes</A></H3>
</LI>
<LI>"make install" didn't work in the fonts directory.</LI>
<LI>"&euro;" didn't work, while "&#128;" did: the character name table
was not sorted properly...</LI>
<LI>Links didn't always point to the right page in PDF output.</LI>
<LI>XRX comment output could crash HTMLDOC.</LI>
<LI>Fixed-width columns in tables could be resized by HTMLDOC.</LI>
<LI>When writing PostScript commands, some printers reset their
duplexing state when a new setpagedevice command is received; we now
cache the current duplex state and change it only as needed.</LI>
<LI>The MEDIA SIZE comment didn't adjust the printable size for the
current landscape setting.</LI>
<LI>HTMLDOC placed the header one line too high.</LI>
<LI>When continuing a chapter onto the next page, H3 and higher headings
would be indented the wrong amount.</LI>
</UL>
<H2><A NAME="12_8">Changes in HTMLDOC v1.8.20</A></H2>
<UL>
<H3><A NAME="12_8_1">New Features</A></H3>
<LI>New --nup and NUMBER-UP options for PostScript and PDF output.</LI>
<LI>HTMLDOC now logs HTML errors.</LI>
<LI>HTMLDOC now supports the A3, B, Legal, and Tabloid size names.</LI>
<LI>HTMLDOC now supports embedding of the base Type1 fonts in PostScript
and PDF output.
<H3><A NAME="12_8_2">Changes</A></H3>
</LI>
<LI>The HTML parser now allows BODY to auto-close HEAD and visa-versa.
<H3><A NAME="12_8_3">Bug Fixes</A></H3>
</LI>
<LI>HTMLDOC wouldn't compile using GCC under HP-UX due to a badly
"fixed" system header file (vmtypes.h).</LI>
<LI>Generating a book without a table-of-contents would produce a bad
PDF file.</LI>
<LI>The Xerox XRX comments used the wrong units for the media size,
points instead of millimeters.</LI>
<LI>IMG elements with links that use the ALIGN attribute didn't get the
links.</LI>
<LI>Header and footer comments would interfere with the top and bottom
margin settings.</LI>
<LI>Fixed a bug in the htmlReadFile() function which caused
user-provided title pages not to be displayed in PS or PDF output.</LI>
<LI>The table-of-contents would inherit the last media settings in the
document, but use the initial settings when formatting.</LI>
</UL>
<H2><A NAME="12_9">Changes in HTMLDOC v1.8.19</A></H2>
<UL>
<H3><A NAME="12_9_1">New Features</A></H3>
<LI>Now support the "subject" meta variable.</LI>
<H3><A NAME="12_9_2">Changes</A></H3>
<LI>Updated the HTML parser to use HTML 4.0 rules for embedding elements
inside a LI.</LI>
<LI>Now check for a TYPE attribute on EMBED elements, so that embedded
Flash files do not get treated as HTML.</LI>
<LI>Now put the COPYRIGHT meta data in the Author field in a PDF file
along with the AUTHOR meta data (if any).</LI>
<LI>No longer embed the prolog.ps command header when PostScript
commands are not being embedded in the output.</LI>
<LI>HTMLDOC now properly ignores the HTML 4.0 COL element.</LI>
<H3><A NAME="12_9_3">Bug Fixes</A></H3>
<LI>Squeezed tables were not centered or right-aligned properly.</LI>
<LI>Cells didn't align properly if they were the first things on the
page, or if there were several intervening empty cells.</LI>
<LI>The preferred cell width handling didn't account for the minimum
cell width, which could cause some tables to become too large.</LI>
<LI>Remote URLs didn't always resolve properly (like the images from the
Google web page...)</LI>
<LI>The font width loading code didn't force the non-breaking space to
have the same width as a regular space.</LI>
<LI>PRE text didn't adjust the line height for the tallest fragment in
the line.</LI>
<LI>HTMLDOC tried to seek backwards when reading HTML from the standard
input.</LI>
<LI>The media margin comments did not work properly when the current
media orientation was landscape.</LI>
</UL>
<H2><A NAME="12_10">Changes in HTMLDOC v1.8.18</A></H2>
<UL>
<H3><A NAME="12_10_1">New Features</A></H3>
<LI>Added support for remote HTML title pages.</LI>
<H3><A NAME="12_10_2">Changes</A></H3>
<LI>Now accept all JPEG files, even if they don't start with an APPn
marker.</LI>
<LI>Now only start a new page for a chapter/filter if we aren't already
at the top of a page.</LI>
<H3><A NAME="12_10_3">Bug Fixes</A></H3>
<LI>ROWSPAN handling in tables has been updated to match the MSIE
behavior, where the current rowspan is reduced by the minimum rowspan
in the table; that is, if you use "ROWSPAN=17" for all cells in a row,
HTMLDOC now treats this as if you did not use ROWSPAN at all. It is
unclear if this is what the W3C intends.</LI>
<LI>The "--webpage" option didn't force toc levels to 0, which caused a
bad page object reference to be inserted in the PDF output file.</LI>
<LI>Background colors in nested tables didn't always get drawn in the
right order, resulting in the wrong colors showing through.</LI>
<LI>The HEADER page comment didn't set the correct top position in
landscape orientation.</LI>
</UL>
<H2><A NAME="12_11">Changes in HTMLDOC v1.8.17</A></H2>
<UL>
<H3><A NAME="12_11_1">New Features</A></H3>
<LI>Improved table-of-contents generation, with chapter headings at the
top of new TOC pages and page numbers based on the header/footer
string.</LI>
<LI>Added new "--no-localfiles" option to disable access to local files
for added security in web services.</LI>
<LI>Long lines in book files can not be broken up using a trailing
backslash.</LI>
<LI>Added a modern "skin" to the GUI interface.</LI>
<H3><A NAME="12_11_2">Changes</A></H3>
<LI>Made some changes in how COLSPAN and ROWSPAN are handled to better
match how Netscape and MSIE format things.</LI>
<LI>HTMLDOC now handles .book files with CR, LF, or CR LF line endings.</LI>
<LI>Changed the TOC numbering to use 32-bit integers instead of 8-bit
integers...</LI>
<LI>Now handle local links with quoted (%HH) characters.</LI>
<LI>The command-line interface no longer sets PDF output mode when using
--continuous or --webpage.</LI>
<LI>HTMLDOC now opens HTML output files in binary mode to prevent extra
CR's under Windows, and strips incoming CR's from PRE text.</LI>
<LI>Now support inserting the current chapter and heading in the
table-of-contents headers and footers.</LI>
<H3><A NAME="12_11_3">Bug Fixes</A></H3>
<LI>The table cell border and background were offset by the cellpadding
when they should only be offset by the cellspacing.</LI>
<LI>The buffer used for periods that lead up to the page number in the
table-of-contents was not large enough for a legal-size document in
landscape format.</LI>
<LI>If a book only contained chapter headings, the PDF bookmarks would
be missing the last chapter heading.</LI>
<LI>Table cells that ended with a break would render incorrectly.</LI>
<LI>Fixed the table pre-format sizing code to properly account for
borders, padding, etc.</LI>
<LI>Fixed the table squeezing code to honor minimum widths and properly
resize the remaining space.</LI>
<LI>The MEDIA SIZE page comment did not reset the printable width and
length of the page.</LI>
<LI>Tables that used COLSPAN did not honor WIDTH values in non-spanned
cells.</LI>
</UL>
<H2><A NAME="12_12">Changes in HTMLDOC v1.8.16</A></H2>
<UL>
<H3><A NAME="12_12_1">Changes</A></H3>
<LI>Now break before and after DIV groups to match most browsers (the
HTML spec is ambivalent about it...)</LI>
<H3><A NAME="12_12_2">Bug Fixes</A></H3>
<LI>HR elements didn't render properly.</LI>
<LI>Background images didn't render properly and could lock up HTMLDOC.</LI>
<LI>The "HALF PAGE" comment would lock up HTMLDOC - HTMLDOC would keep
adding pages until it ran out of memory.</LI>
<LI>SUP and SUB used a fixed (reduced) size instead of using a smaller
size from the current one.</LI>
<LI>Empty cells could cause unnecessary vertical alignment on the same
row.</LI>
</UL>
<H2><A NAME="12_13">Changes in HTMLDOC v1.8.15</A></H2>
<UL>
<H3><A NAME="12_13_1">New Features</A></H3>
<LI>Now support media source, type, and color attributes in PS output.</LI>
<LI>Now support per-page size, margins, headers, footers, orientation,
and duplexing.</LI>
<LI>Now support plain text for headers and footers, with $ variables to
include page numbers and so forth.</LI>
<LI>New device control prolog file for printer-specific option commands.</LI>
<LI>Now support a new continuous web page mode that doesn't
automatically insert a page break with each HTML file or URL
(--continuous).</LI>
<LI>Now draw border around inline images as needed.</LI>
<LI>Now support MacOS X (only command-line at present).</LI>
<LI>Now support the "page-break-before", "text-align", "vertical-align"
style attributes, but only for style information in an element's STYLE
attribute.</LI>
<H3><A NAME="12_13_2">Changes</A></H3>
<LI>Now load images into memory only as needed, and unload them when no
longer needed. This provides a dramatic reduction in memory usage with
files that contain a lot of in-line images.</LI>
<LI>Now use the long names for the Flate and DCT filters in all
non-inline PDF streams. This avoids a stupid bug in Acrobat Reader when
printing to PostScript printers.</LI>
<LI>HTMLDOC now strips any trailing GET query information when saving
the start of files (target) in a document.</LI>
<LI>Unqualified URLs (no leading scheme name, e.g. http:) now default to
the HTTP port (80) instead of the IPP port (631).</LI>
<LI>Optimized the image writing code to do more efficient color
searching. This provides a significant speed improvement when including
images.</LI>
<LI>Now hide all text inside SCRIPT, SELECT, and TEXTAREA elements.</LI>
<LI>OS/2 port changes from Alexander Mai.</LI>
<H3><A NAME="12_13_3">Bug Fixes</A></H3>
<LI>If a document started with a heading greater than H1, HTMLDOC would
crash.</LI>
<LI>Full justification would incorrectly be applied to text ending with
a break.</LI>
<LI>Images using ALIGN="MIDDLE" were not centered properly on the
baseline.</LI>
<LI>Table cells that used both ROWSPAN and COLSPAN did not format
properly (the colspan was lost after the first row.)</LI>
<LI>Tables that used cells that exclusively used COLSPAN did not format
properly.</LI>
<LI>When writing HTML output, image references would incorrectly be
mapped using the current path.</LI>
<LI>Images with a width or height of 0 should not be written to PS or
PDF output.</LI>
<LI>The CreationDate comment in PostScript output contained a bad
timezone offset (+-0500, for example, instead of -0500).</LI>
<LI>The PHP portal example now verifies that the URL passed to it
contains no illegal characters.</LI>
</UL>
<H2><A NAME="12_14">Changes in HTMLDOC v1.8.14</A></H2>
<UL>
<H3><A NAME="12_14_1">New Features</A></H3>
<LI>Added support for 128-bit encryption.</LI>
<LI>Added support for GET form request data in the PHP and Java "portal"
examples.</LI>
<H3><A NAME="12_14_2">Changes</A></H3>
<LI>Most output generation limits have been removed; HTMLDOC now
dynamically allocates memory as needed for pages, images, headings, and
links. This has the happy side-effect of reducing the initial memory
footprint significantly.</LI>
<LI>Now call setlocale() when it is available to localize the date and
time in the output.</LI>
<LI>The table parsing code now checks to see that a ROWSPAN attribute
fits in the table; e.g., a ROWSPAN of 10 for a table that has only 6
rows remaining needs to be reduced to 6...</LI>
<H3><A NAME="12_14_3">Bug Fixes</A></H3>
<LI>Tables with a lot of COLSPANs could cause a divide- by-zero error or
bad pages (NAN instead of a number.)</LI>
<LI>Table cells with a single render element would not be vertically
aligned.</LI>
<LI>The --quiet option would enable progress messages on the
command-line.</LI>
<LI>Table cell widths could be computed incorrectly, causing unnecessary
wrapping.</LI>
</UL>
<H2><A NAME="12_15">Changes in HTMLDOC v1.8.13</A></H2>
<UL>
<H3><A NAME="12_15_1">New Features</A></H3>
<LI>Added support for secure (https) URLs via the OpenSSL library.</LI>
<LI>Added support for Acrobat 5.0 (PDF 1.4).</LI>
<LI>Added support for transparency in PostScript and PDF 1.1 and 1.2
output.</LI>
<LI>Added a --no-jpeg option (same as --jpeg=0)</LI>
<LI>Added support for the CSS2 page-break-before and page-break-after
properties.</LI>
<LI>Added a PHP example.</LI>
<H3><A NAME="12_15_2">Changes</A></H3>
<LI>External file references to non-PDF files now use the "Launch"
action so they can be opened/executed/saved as allowed by the OS and
PDF viewer.</LI>
<LI>Changed the indexed/JPEG'd transition point to 256 colors when using
Flate compression. This makes PDF files much smaller in general.</LI>
<LI>Changed the in-line image size limit to 64k.</LI>
<LI>Now allow "<" followed by whitespace, "=", or "<". This violates the
HTML specification, but we're sick of people complaining about it.</LI>
<LI>Preferences are now stored in a user-specific file under Windows,
just like UNIX. This provides user-specific preferences and allows
preferences to be kept when upgrading to new versions of HTMLDOC.</LI>
<LI>The book loading code now allows for blank lines, even though these
are not a part of the format. (added to support some scripted apps that
include extra newlines...)</LI>
<LI>Changed the leading space handling of blocks to more closely match
the standard browser behavior.</LI>
<H3><A NAME="12_15_3">Bug Fixes</A></H3>
<LI>The table formatting code adding the border width to the cell width,
while Netscape and MSIE don't. This caused some interesting formatting
glitches...</LI>
<LI>The table formatting code didn't account for the preferred width of
colspan'd cells.</LI>
<LI>The table formatting code tried to enforce the minimum cell width
when squeezing a table to fit on the page; this caused the table to
still exceed the width of the page.</LI>
<LI>The PDF catalog object could contain a reference to a /Names object
of "0 0 R", which is invalid. This would happen when the "--no-links"
option was used.</LI>
<LI>Several HTML elements were incorrectly written with closing tags.</LI>
<LI>When piping PDF output, the temporary file that is created needed to
be open for reading and writing, but HTMLDOC only opened the file for
writing.</LI>
<LI>Image links did not work.</LI>
<LI>The JPEG image loading code did not correctly handle grayscale JPEG
images.</LI>
<LI>JPEG images were not encrypted when writing a document with
encryption enabled.</LI>
<LI>The user password was not properly encrypted.</LI>
<LI>The colormap of indexed images were not encrypted when writing a
document with encryption enabled.</LI>
<LI>The temporary file creation and cleanup functions did not use the
same template under Windows, causing multiple conversions to fail when
temporary files were used.</LI>
<LI>Paragraphs could end up with one extra text fragment, causing the
line to be too long.</LI>
<LI>The command-line program would clear the error count after reading
all the files/URLs on the command-line, but before generating the
document. If there were problems reading the files/URLs, HTMLDOC would
return a 0 exit status instead of 1.</LI>
<LI>Image objects that were both JPEG and Flate compressed would not
display (filters specified in the wrong order.)</LI>
<LI>Images with more than 256 colors would cause a segfault on some
systems.</LI>
<LI>Background images would generate the error message "XObject 'Innn'
is unknown".</LI>
</UL>
<H2><A NAME="12_16">Changes in HTMLDOC v1.8.12</A></H2>
<UL>
<H3><A NAME="12_16_1">New Features</A></H3>
<LI>Added new "--batch" option to convert HTMLDOC book files from the
command-line.</LI>
<LI>Added support for the "-display" option on systems that use X11.</LI>
<LI>Now use image objects in PDF output for images when the image width
* height * depth > 32k.</LI>
<LI>Now use JPEG compression when the number of colors would be > 32
colors or 16 gray shades.</LI>
<LI>True transparency support for GIF files in PDF 1.3 output!</LI>
<LI>The GUI now automatically changes the extension of the output
filename as needed.</LI>
<LI>The GUI now collects all error messages and shows them once after
the document is generated.</LI>
<LI>Added support for HSPACE and VSPACE attributes for images with
ALIGN="LEFT" or ALIGN="RIGHT".</LI>
<LI>Added new Java interface to HTMLDOC.</LI>
<H3><A NAME="12_16_2">Changes</A></H3>
<LI>Consolidated temporary file management into new file_temp()
function. The new function also makes use of the Windows "short lived"
open option which may improve performance with small temporary files.</LI>
<LI>Updated book file format and added an appendix describing the
format.</LI>
<LI>Now default to PDF 1.3 (Acrobat 4.0) output format.</LI>
<LI>Now output length of PDF streams with the stream object; this offers
a modest reduction in file size.</LI>
<LI>The HTTP file cache now keeps track of previous URLs that were
downloaded.</LI>
<LI>The HTTP code now supports redirections (status codes 301 to 303) to
alternate URLs.</LI>
<LI>Limit the height check for table rows to 1/8th of the page length;
this seems to provide fairly consistent wrapping of tables without
leaving huge expanses of blank space at the bottom of pages.</LI>
<LI>The HTML output now also includes a font-family style for PRE text;
otherwise the body font would override the PRE font with some browsers.</LI>
<LI>The snprintf/vsnprintf emulation functions were not included in the
HTMLDOC makefile.</LI>
<LI>RGB hex colors are now recognized with or without the leading #.
This breaks HTML standards compliance but should reduce the number of
problem reports from buggy HTML.</LI>
<LI>The stylesheet generated with the HTML output no longer contains
absolute font sizes, just the typefaces and a relative size for
SUB/SUP.</LI>
<LI>The title image is no longer scaled to 100% in the HTML output.</LI>
<H3><A NAME="12_16_3">Bug Fixes</A></H3>
<LI>The web page output was not divided into chapters for each input
file.</LI>
<LI>The "make install" target did a clean.</LI>
<LI>The configure script would remove the image libraries if you did not
have FLTK installed.</LI>
<LI>The fix_filename() function didn't handle relative URLs for images
(e.g. SRC="../images/filename.gif")</LI>
<LI>Comments in the source document were being closed by a ".</LI>
<LI>The command-line and GUI interfaces looked for "outlines" instead of
"outline" for the page mode.</LI>
<LI>The HTML output code didn't output closing tags for empty elements.</LI>
<LI>The GUI interface started with the compression slider enabled, even
for HTML output.</LI>
<LI>The beginnings of some lines could start with whitespace.</LI>
<LI>Wasn't aligning images and text on lines based on the line height.</LI>
<LI>The compression slider was enabled in the GUI even though HTML
output was selected.</LI>
<LI>The Perl example code was incorrect.</LI>
<LI>Fixed the check for whether or not pages were generated.</LI>
<LI>htmlSetCharSet() wasn't reloading the character set data if the data
directory changed.</LI>
<LI>The GUI did not reset the default background color.</LI>
<LI>The 'C' page number style (chapter page numbers) started at 3
instead of 1.</LI>
<LI>The chapter links were off by 1 or 2 pages when no title page was
included.</LI>
</UL>
<H2><A NAME="12_17">Changes in HTMLDOC v1.8.8</A></H2>
<UL>
<H3><A NAME="12_17_1">New Features</A></H3>
<LI>Added support for PDF security/encryption!</LI>
<LI>Now support TABLE height attribute.</LI>
<LI>Now generate an error message if no pages are generated (with a
suggestion to use the webpage option.)</LI>
<LI>New "paths" option to specify additional directories to search for
files. This is useful when the source files use absolute server paths.</LI>
<H3><A NAME="12_17_2">Changes</A></H3>
<LI>Added missing casts in htmllib.cxx that were causing a compile
warning with some compilers.</LI>
<LI>No longer draw borders around empty cells in tables...</LI>
<LI>Now disable the TOC tab when using webpage mode.</LI>
<LI>Now scale title image to 100% in HTML output.</LI>
<LI>Now handle comments with missing whitespace after the "<!--".</LI>
<H3><A NAME="12_17_3">Bug Fixes</A></H3>
<LI>Nested tables didn't take into account the table border width,
spacing, or padding values.</LI>
<LI>HTMLDOC crashed under Solaris when reading HTML files from the
standard input.</LI>
<LI><ELEM>text</ELEM> <MELE>text</MELE> was rendered without an
intervening space.</LI>
</UL>
<H2><A NAME="12_18">Changes in HTMLDOC v1.8.7</A></H2>
<UL>
<H3><A NAME="12_18_1">New Features</A></H3>
<LI>The configure script now uses the local PNG, ZLIB, and/or JPEG
libraries when they are new enough.</LI>
<LI>The configure script now uses the -fno-rtti, -fno-exceptions, and
-fpermissive options as needed with GCC (smaller, faster executables,
works around X header bugs in Solaris.)</LI>
<LI>Added a --toctitle option to set the table-of-contents title from
the command-line (was only available in the GUI in previous
releases...)</LI>
<LI>New "<!-- NEED amount -->" comment to force a page feed if there is
not sufficient room on the page for the following text.</LI>
<LI>Page comments are now supported in tables.</LI>
<LI>Table rows are now allocated dynamically, MAX_ROWS at a time.</LI>
<H3><A NAME="12_18_2">Changes</A></H3>
<LI>Increased default MAX_PAGES to 10000 (was 5000.)</LI>
<LI>File links in book files now point to the top of the next page.</LI>
<LI><TABLE ALIGN=xyz> now aligns the table (previously it just set the
default alignment of cells.)</LI>
<LI>Transparent GIFs now use the body color instead of white for the
transparent color.</LI>
<LI>Updated to LIBPNG 1.0.6 in source distribution.</LI>
<LI>Updated the default cellpadding to be 1 pixel to match Netscape
output.</LI>
<LI>Updated line and block spacing to match Netscape.</LI>
<LI>DL/DT/DD output now matches browsers (was indented from browser
output.)</LI>
<LI>Now only output link (A) style if it is set to "none". Otherwise
Netscape would underline all targets as well as links.</LI>
<LI>Increased the MAX_COLUMNS constant to 200, and dropped MAX_ROWS to
200. Note that the new table code now allocates rows in increments of
MAX_ROWS rows, so the actual maximum number of rows depends on
available memory.</LI>
<H3><A NAME="12_18_3">Bug Fixes</A></H3>
<LI>Now ignore illegal HTML in tables.</LI>
<LI>The VALIGN code didn't handle empty cells properly.</LI>
<LI>Wasn't offsetting the start of each row by the cell padding.</LI>
<LI>The JPEG image loading code didn't work for some JPEG images,
particularly those from digital cameras (JPEG but not JFIF format.)</LI>
<LI>The strikethrough line was not being drawn in the correct position.</LI>
<LI>Wasn't setting the height of BR elements, so <BR><BR> didn't insert
a blank line.</LI>
<LI>The table of contents would show the wrong page numbers if no title
page was generated.</LI>
<LI>Cell widths did not subtract any border, padding, or spacing from
the "preferred" width, causing formatting differences between web
browsers and HTMLDOC.</LI>
<LI>The PNG loading code did not handle interlacing or transparency.</LI>
<LI>The HTML parsing code did not prevent elements in embedded files
from completing elements in the parent file.</LI>
<LI>The table CELLSPACING amount was being applied twice in the table
sizing calculations.</LI>
</UL>
<H2><A NAME="12_19">Changes in HTMLDOC v1.8.6</A></H2>
<UL>
<H3><A NAME="12_19_1">New Features</A></H3>
<LI>New linkcolor and linkstyle options.</LI>
<H3><A NAME="12_19_2">Changes</A></H3>
<LI>Minor source changes for OS/2 compilation.</LI>
<LI>SUP and SUB now raise/lower text more to be consistent with browser
look-n-feel.</LI>
<LI>Non-breaking space by itself was being output. Now check for that
and ignore strings that consist entirely of whitespace.</LI>
<LI>New progress bar.</LI>
<H3><A NAME="12_19_3">Bug Fixes</A></H3>
<LI>Didn't add whitespace after a table caption.</LI>
<LI>Nested tables caused formatting problems (flatten_tree() didn't
insert breaks for new rows)</LI>
<LI>A cell whose minimum width exceeded the available width for the
table would cause the table to go off the page.</LI>
<LI>Cells that spanned more than two pages were drawn with boxes around
them rather than just the sides.</LI>
<LI>The stylesheet info in the HTML output specified the H1 size for all
headings.</LI>
<LI>The title page was incorrectly formatted when an image was specified
- the text start position was computed using the pixel height of the
title image and not the formatted height.</LI>
<LI>1 color images didn't come out right; the "fix" to work around an
Acrobat Reader bug was being done too soon, so the color lookups were
wrong.</LI>
<LI>HTML file links now work properly.</LI>
<LI>Now limit all HTML input to the maximum size of input buffers to
avoid potential buffer overflow problems in CGIs.</LI>
<LI>If a row had a predefined height, HTMLDOC wasn't making sure that
the row would fit on the current page.</LI>
<LI>THEAD, TFOOT, and TBODY caused problems when formatting tables.
Note: THEAD and TFOOT are *still* not supported, however the code now
properly ignores them and parses the rows in the TBODY group.</LI>
<LI>The VALIGN code introduced in the 1.8.5 release didn't check for
NULL pointers in all cases.</LI>
</UL>
<H2><A NAME="12_20">Changes in HTMLDOC v1.8.5</A></H2>
<UL>
<H3><A NAME="12_20_1">New Features</A></H3>
<LI>New "--titlefile" option to include an HTML file for the title
page(s).</LI>
<LI>New 'C' header/footer option to show current page number within
chapter or HTML file.</LI>
<LI>Allow adding of .book files to import all HTML files in the book.</LI>
<LI>New "HALF PAGE" page comment to feed 1/2 page.</LI>
<LI>Added VALIGN and HEIGHT support in tables.</LI>
<H3><A NAME="12_20_2">Changes</A></H3>
<LI>Now optimize link objects in PDF files (provides a 40k reduction in
file size for the HTMLDOC manual alone)</LI>
<LI>Table rows that cross page boundaries are now rendered more like
Netscape and MSIE.</LI>
<LI>Now support HTMLDOC_DATA and HTMLDOC_HELP environment variables
under UNIX (for alternate install directory)</LI>
<LI>Now show error messages when HTMLDOC can't open the AFM, character
set, or PostScript glyph files.</LI>
<LI>The logo image is now scaled to its "natural" size (as it would
appear in a web browser)</LI>
<LI>Now recognize VALIGN="MIDDLE" or VALIGN="CENTER".</LI>
<H3><A NAME="12_20_3">Bug Fixes</A></H3>
<LI>Generation of PDF files to the standard output (i.e. to the web
server + browser) didn't work on some versions of UNIX. HTMLDOC now
writes the PDF output to a temporary file and then copies it to the
standard output as needed.</LI>
<LI>PDF links were missing the first 5 characters in the filename; the
code was trying to skip over the "file:" prefix, but that prefix was
already skipped elsewhere.</LI>
<LI>Nested descriptive lists (DL) did not get rendered properly.</LI>
<LI>Tables had extra whitespace before and after them.</LI>
<LI>Multiple aligned images confused parse_paragraph(); the images would
overlap instead of stack on the sides.</LI>
</UL>
<H2><A NAME="12_21">Changes in HTMLDOC v1.8.4</A></H2>
<UL>
<H3><A NAME="12_21_1">Changes</A></H3>
<LI>More configure script changes for FLTK DSOs.</LI>
<LI>FileIcon.cxx was still using NULL for outline (an integer), which
caused some ANSI C++ compilers to complain.</LI>
<H3><A NAME="12_21_2">Bug Fixes</A></H3>
<LI>The Fonts and Colors tab groups did not extend to the full width of
the tab area, which prevented the Browse button from working when
clicked on the right side.</LI>
<LI>The help dialog window did not scroll all the way to the bottom of
the text.</LI>
<LI>The chapter ("c") header/footer string did not work.</LI>
<LI>The heading ("h") header/footer string did not always match the
first heading on a page.</LI>
<LI>The header and footer fonts were not used when computing the widths
of the header and footer strings.</LI>
<LI>The Windows distribution did not create the right shortcut for the
Users Manual in the Start menu.</LI>
<LI>The command-line code did not accept "--grayscale", only "--gray"</LI>
<LI>Multi-file HTML output did not use the right link for the
table-of-contents file if no title page was being generated.</LI>
<LI>Extra whitespace before and after tables has been eliminated.</LI>
</UL>
<H2><A NAME="12_22">Changes in HTMLDOC v1.8.3</A></H2>
<UL>
<H3><A NAME="12_22_1">New Features</A></H3>
<LI>New "--browserwidth" option to control scaling of images and tables
that use fixed pixel widths.</LI>
<H3><A NAME="12_22_2">Changes</A></H3>
<LI>The configure script now looks for the OpenGL library (required if
you use a shared FLTK library with OpenGL support.)</LI>
<LI>Increased the max number of chapters to 1000.</LI>
<H3><A NAME="12_22_3">Bug Fixes</A></H3>
<LI>Page break comments didn't force a paragraph break.</LI>
<LI>--no-toc prevented chapters from being output in PS and PDF files.</LI>
<LI>Filenames didn't always get updated properly when doing a "save
as"...</LI>
<LI>Fixed some more leading/trailing whitespace problems.</LI>
<LI>Wasn't freeing page headings after the document was generated.</LI>
<LI>Wasn't range checking the current chapter number; now limits the
number of chapters to MAX_CHAPTERS and issues an error message whenever
the limit is exceeded.</LI>
</UL>
<H2><A NAME="12_23">Changes in HTMLDOC v1.8.2</A></H2>
<UL>
<H3><A NAME="12_23_1">New Features</A></H3>
<LI>New "setup" program for UNIX software installation.</LI>
<H3><A NAME="12_23_2">Changes</A></H3>
<LI>Documentation updated for new UNIX "setup" program and "..." usage
for headers and footers.</LI>
<LI>Changed margins to floating point (instead of integer) to improve
table column accuracy.</LI>
<H3><A NAME="12_23_3">Bug Fixes</A></H3>
<LI>HTMLDOC could crash under Microsoft Windows with some types of HTML
files. This was caused by a stack overflow, usually when processing
nested tables.</LI>
<LI>Multiple HTML files weren't being converted properly in web page
mode - only the last file would be generated for PostScript output, and
no file for PDF output.</LI>
<LI>Wasn't preserving the whitespace between "one" and "two" in the HTML
code "one<I> two</I> three".</LI>
<LI>Paragraph spacing was inconsistent.</LI>
<LI><TABLE WIDTH="xx"> wasn't formatted properly.</LI>
<LI>The command-line code wasn't opening HTML files in binary mode. This
caused problems under Microsoft Windows.</LI>
</UL>
<H2><A NAME="12_24">Changes in HTMLDOC v1.8.1</A></H2>
<UL>
<H3><A NAME="12_24_1">Changes</A></H3>
<LI>The configure script didn't update the ARFLAGS variable for *BSD
operating systems (no "s" option to build the symbol table...)</LI>
<LI>Changed the installation commands to only create the installation
directory if it does not exist. This prevents installation errors on
some platforms the second time around.</LI>
<LI>Now use the Microsoft definitions for characters 128 through 159
that are otherwise unused by the ISO-8859-x character sets.</LI>
<LI>Now set optimization settings when we know the compiler.</LI>
<LI>Now always quote attribute values in HTML output to make HTML lint
programs happy.</LI>
<H3><A NAME="12_24_2">Bug Fixes</A></H3>
<LI>Wasn't using TOC title string in PDF document outline.</LI>
<LI>Preformatted text in tables didn't force the column width.</LI>
<LI>Cells using COLSPAN > 1 didn't contribute to the width of columns.</LI>
<LI>The table code didn't enforce the per-column minimums under certain
circumstances, causing "scrambled" columns.</LI>
<LI>The configure script and makefiles didn't work when FLTK was not
available. They now only build the "gui" library when it is available.</LI>
<LI>The Windows distribution was installing files under PROGRAMDIR
instead of TARGETDIR. This prevented users from customizing the
installation directory.</LI>
<LI>The configure script overrode the LDFLAGS environment variable,
preventing FLTK from being located in a non- default directory.</LI>
</UL>
<H2><A NAME="12_25">Changes in HTMLDOC v1.8</A></H2>
<UL>
<H3><A NAME="12_25_1">New Features</A></H3>
<LI>Now support PDF 1.1 (Acrobat 2.x) and PDF 1.3 (Acrobat 4.0).</LI>
<LI>Now support PDF page modes, layouts, and effects, and the first page
that is displayed in Acrobat Reader.</LI>
<LI>Now support PostScript Level 3 output with Flate image compression.</LI>
<LI>Now support PostScript commands for page size and duplexing.</LI>
<LI>Now add filenames as needed to HTML links.</LI>
<LI>Added optimizations to output code to further reduce PDF and
PostScript file size.</LI>
<LI>Now support alternate 8-bit character sets. Currently we supply data
files for the ISO-8859-N character sets.</LI>
<LI>Added chapter headings to the available header/footer formats.</LI>
<LI>The GUI file chooser is significantly improved and supports
selection of multiple HTML files.</LI>
<LI>The GUI now provides on-line help.</LI>
<LI>Many other GUI improvements.</LI>
<LI>Added support for DIR and MENU block elements.</LI>
<LI>The header and footer text can now be made boldface, italic, etc.</LI>
<LI>Font settings are now exported to HTML files in a style sheet.</LI>
<LI>Now support page breaks using HTML comments.</LI>
<LI>The image dimensions are now exported to HTML files.</LI>
<LI>Added landscape printing option.</LI>
<LI>Added CAPTION support for tables.</LI>
<LI>Filename links now work for HTML files included in a document.</LI>
<LI>Now support BGCOLOR in tables.</LI>
<H3><A NAME="12_25_2">Changes</A></H3>
<LI>Lots of documentation changes.</LI>
<LI>Much better table formatting.</LI>
<LI>Changed HTML output to use less invasive navigation bars at the top
and bottom of each file. This also means that the "--barcolor" option
is no longer supported!</LI>
<LI>Updated to use existing filenames in HTML (directory) output.</LI>
<LI>Now recognize any local PDF file as a local file link (i.e. you just
need "HREF=filename.pdf" and not "HREF=file:filename.pdf")</LI>
<LI><TT>, <CODE>, and <SAMP> no longer reduce the font size.</LI>
<LI>Now put whitespace after image data in PDF files. This change was
needed to work around a bug in Acrobat Reader 4.0.</LI>
<LI>Now generate a complete encoding vector for fonts in PDF files. This
change was needed to work around a bug in all versions of Acrobat
Exchange that did not recognize the WinANSI encoding defined in the PDF
specifications.</LI>
<LI>Now filter out the BREAK attribute from HR elements.</LI>
<LI>Now only load images once.</LI>
<H3><A NAME="12_25_3">Bug Fixes</A></H3>
<LI>Wasn't escaping &,<, or > in HTML output</LI>
<LI>Wasn't preserving &nbsp;</LI>
<LI>Links in multi-file HTML output were off-by-one.</LI>
<LI>BLOCKQUOTE needed to be like CENTER and DIV.</LI>
<LI>Needed to use existing link name if present for headings to avoid
nested link name bug in Netscape and MSIE.</LI>
<LI>Extremely long link names could cause TOC generation to fail and
HTMLDOC to crash.</LI>
<LI>PDF output was not compatible with Ghostscript/Ghostview because
Ghostscript does not support inherited page resources or the "Fl"
abbreviation for the "FlateDecode" compression filter.</LI>
<LI>PostScript DSC comments didn't have unique page numbers. This caused
Ghostview (among others) to get confused.</LI>
<LI>Some functions didn't handle empty text fragments.</LI>
<LI>Images couldn't be scaled both horizontally and vertically.</LI>
<LI><LI> didn't support the VALUE attribute (but <OL> did...)</LI>
<LI>Fixed whitespace problems before and after some markups that was
caused by intervening links.</LI>
<LI>The indexed image output code could generate an image with only 1
color index used, which upset Acrobat Reader.</LI>
<LI>Fixed a bug in table-of-contents handling - HTMLDOC would crash on
some systems if you converted a web page on the command-line.</LI>
<LI>Wasn't setting the font size and spacing soon enough when generating
files on the command-line.</LI>
<LI>Didn't hide EMBED elements when generating indexed HTML files.</LI>
<LI>Didn't always set the current drawing position before drawing a box
or line.</LI>
<LI>Base85 encoding of image data was broken for PostScript output.</LI>
<LI>JPEG compression was broken for PostScript output.</LI>
<LI>Didn't set binary mode for the standard output under Windows and
OS/2 needed.</LI>
</UL>
<HR NOSHADE>
<!-- FOOTER RIGHT "1-$CHAPTERPAGE" -->
<DIV align="justify">
<H1 align="right"><A name="COMPILE">Appendix D - Compiling HTMLDOC from
Source</A></H1>
<P>This chapter describes the steps needed to install HTMLDOC on your
system from the source distributions.</P>
<H2><A NAME="13_1">Requirements</A></H2>
<P>HTMLDOC requires ANSI C and C++ compilers - recent versions of
GCC/EGCS work fine. To build the GUI you'll also need:</P>
<UL>
<LI><A href="http://www.fltk.org">Fast Light Tool Kit ("FLTK")</A>,
version 1.1 or higher.</LI>
<LI><A href="ftp://ftp.x.org">X11 libraries</A>, R5 or higher (needed to
build under UNIX and OS/2 only.)</LI>
</UL>
<P>Secure (https) URL support can be enabled via the <A HREF="http://www.openssl.org/">
OpenSSL</A> library. You should use at least version 0.9.6l.</P>
<H2><A NAME="13_2">Compiling under UNIX/Linux</A></H2>
<P>HTMLDOC uses a configuration script produced by GNU autoconf to
configure itself for your system. If your ANSI C compiler is not called<VAR>
cc</VAR> or<VAR> gcc</VAR>, set the <CODE>CC</CODE> environment
variable to the name and path of your ANSI C compiler:</P>
<PRE>
% <KBD>setenv CC /path/to/compiler ENTER</KBD> [C Shell]
% <KBD>CC=/path/to/compiler; export CC ENTER</KBD> [Bourne/Korn Shell]
</PRE>
<P>Similarly, if your C++ compiler is not called<VAR> CC</VAR>,<VAR> gcc</VAR>
,<VAR> c++</VAR>, or<VAR> g++</VAR>, set the <CODE>CXX</CODE>
environment variable to the name and path of your C++ compiler:</P>
<PRE>
% <KBD>setenv CXX /path/to/compiler ENTER</KBD> [C Shell]
% <KBD>CXX=/path/to/compiler; export CXX ENTER</KBD> [Bourne/Korn Shell]
</PRE>
<P>Then run the following command to configure HTMLDOC for installation
in the default directories:</P>
<PRE>
% <KBD>./configure ENTER</KBD>
</PRE>
<P>The default configuration will install HTMLDOC in the<VAR> /usr/bin</VAR>
directory with the data files under<VAR> /usr/share/htmldoc</VAR> and
the documentation and on-line help under<VAR> /usr/share/doc/htmldoc</VAR>
. Use the <CODE>--prefix</CODE> option to change the installation prefix
to a different directory such as<VAR> /usr/local</VAR>:</P>
<PRE>
% <KBD>./configure --prefix=/usr/local ENTER</KBD>
</PRE>
<P>If the OpenSSL library is not installed in a standard location for
your compilers, use the <CODE>--with-openssl-includes</CODE> and <CODE>
--with-openssl-libs</CODE> options to point to the OpenSSL library:</P>
<PRE>
% <KBD>./configure --with-openssl-libs=/path/to/openssl/lib \
--with-openssl-includes=/path/to/openssl ENTER</KBD>
</PRE>
<P>HTMLDOC is built from a Makefile in the distribution's main
directory. Simply run the "make" command to build HTMLDOC:</P>
<PRE>
% <KBD>make ENTER</KBD>
</PRE>
<P>If you get any fatal errors, please report them on the <CODE>
htmldoc.general</CODE> newsgroup at:</P>
<PRE>
<A href="http://www.easysw.com/newsgroups.php">http://www.easysw.com/newsgroups.php</A>
</PRE>
<P>Please note the version of HTMLDOC that you are using as well as any
pertinent system information such as the operating system, OS version,
compiler, and so forth. Omitting this information may delay or prevent
a solution to your problem.</P>
<P>Once you have compiled the software successfully, you may install
HTMLDOC by running the following command:</P>
<PRE>
% <KBD>make install ENTER</KBD>
</PRE>
<P>If you are installing in a restricted directory like<VAR> /usr</VAR>
then you'll need to be logged in as root.</P>
<H2><A NAME="13_3">Compiling on Windows Using Visual C++</A></H2>
<P>A Visual C++ 6.0 workspace file and associated project files are
included in the source distribution under the "visualc" directory. Open
the workspace file "htmldoc.dsw", adjust the FLTK include and project
file locations, and then build the HTMLDOC target.
<CENTER>
<TABLE bgcolor="#cccccc" border="1" cellpadding="5" cellspacing="0" width="80%">
<TR><TD><B>Note:</B>
<P>You also need to download the OpenSSL and FLTK libraries in order to
compile HTMLDOC with Visual C++.</P>
</TD></TR>
</TABLE>
</CENTER>
</P>
<H2><A NAME="13_4">Installing with Visual C++</A></H2>
<P>To install HTMLDOC with Visual C++, create an installation directory
and copy the<VAR> ghtmldoc.exe</VAR> and<VAR> htmldoc.exe</VAR>
executables, the<VAR> afm</VAR> directoryj, the<VAR> data</VAR>
directory, and the<VAR> doc</VAR> directory to it.</P>
<P>Then use the<VAR> regedit</VAR> program to create the following two
string entries:</P>
<DL>
<DT><CODE>HKEY_LOCAL_MACHINE\Software\Easy Software
Products\HTMLDOC\data</CODE></DT>
<DD>C:\installation\directory</DD>
<DT><CODE>HKEY_LOCAL_MACHINE\Software\Easy Software Products\HTMLDOC\doc</CODE>
</DT>
<DD>C:\installation\directory\doc</DD>
</DL>
</DIV></BODY>
</HTML>
