home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2005 February / PCpro_2005_02.ISO / files / opensource / HTMLDOC_1.8.23 / htmldoc.exe / data1.cab / Program_Executables / README.txt < prev    next >
Encoding:
Text File  |  2002-10-28  |  8.9 KB  |  266 lines
  1. README.txt - 10/24/2002
  2. -----------------------
  3.  
  4. INTRODUCTION
  5.  
  6.     This README file describes HTMLDOC, a HTML processing program that
  7.     generates HTML, PostScript, and PDF files with a table of contents.
  8.  
  9.     **** HTMLDOC CURRENTLY ONLY SUPPORTS HTML 3.2 AND DOES NOT ****
  10.     **** SUPPORT STYLE SHEETS!  PLEASE READ THE DOCUMENTATION  ****
  11.     **** BEFORE ASKING QUESTIONS.                              ****
  12.  
  13.     Commercial support for HTMLDOC is available from Easy Software
  14.     Products for $495 US.  Besides giving you priority bug fixes and
  15.     guaranteed support, the commercial support fee includes access to a
  16.     "members only" web site that provides examples, tutorials, and tips
  17.     for using HTMLDOC to publish documents on your web site.
  18.  
  19.     HTMLDOC is copyright 1997-2002 by Easy Software Products and is
  20.     currently available under the GNU General Public License, version
  21.     2.  See the LEGAL STUFF section below for details.
  22.  
  23.     Documentation for HTMLDOC is available in the "doc" subdirectory
  24.     and is been generated from HTML "source" files into HTML,
  25.     PostScript, and PDF using HTMLDOC.
  26.  
  27.     HTMLDOC supports most HTML 3.2 and some HTML 4.0 markups as well as
  28.     GIF, JPEG, and PNG images.  Eventually HTMLDOC will be compliant
  29.     with HTML 4.0 and support style sheets.
  30.  
  31.  
  32. INTERNET RESOURCES
  33.  
  34.     For general discussions about HTMLDOC, subscribe to the HTMLDOC
  35.     mailing list by sending a message to "majordomo@easysw.com" with
  36.     the text "subscribe htmldoc".
  37.  
  38.     The HTMLDOC home page is located at:
  39.  
  40.         http://www.easysw.com/htmldoc
  41.  
  42.     The current version of HTMLDOC can be also downloaded from:
  43.  
  44.         http://www.easysw.com/software.html
  45.  
  46.     Commercial support is available from Easy Software Products; send
  47.     requests to "htmldoc-support@easysw.com" (note: support via this
  48.     email address is only provided to customers with a valid support
  49.     contract!)
  50.  
  51.  
  52. REQUIREMENTS
  53.  
  54.     HTMLDOC requires an average of 2MB of disk space for installation.
  55.     Binary distributions are available for the following platforms for
  56.     customers with a support contract:
  57.  
  58.     - AIX 4.3.3 or higher
  59.         - Compaq Tru64 UNIX 4.0 or higher
  60.         - Digital UNIX 4.0 or higher
  61.     - FreeBSD 4.5 or higher
  62.     - HP-UX 10.20 or higher
  63.     - IRIX 5.3 or higher
  64.     - Linux 2.0 or higher (Intel only)
  65.     - MacOS X 10.1 or higher
  66.     - Microsoft Windows 95
  67.     - Microsoft Windows 98
  68.     - Microsoft Windows Me
  69.     - Microsoft Windows NT 4.0
  70.     - Microsoft Windows 2000
  71.     - Red Hat Linux 5.2 or higher (Intel only)
  72.     - Solaris 2.5 or higher (SPARC and Intel)
  73.  
  74.     A free, unsupported binary distribution is also available for
  75.     Microsoft Windows.
  76.  
  77.     See the file "COMPILE.txt" for instructions on compiling HTMLDOC
  78.     from the source code.
  79.  
  80.  
  81. INSTALLING HTMLDOC UNDER MICROSOFT WINDOWS
  82.  
  83.     HTMLDOC comes in a self-extracting archive.  Double-click on or run
  84.     the "htmldoc-1.8.23-windows.exe" or "htmldoc-1.8.23-winfree.exe" files
  85.     to start the installation wizard.
  86.  
  87.     (the -windows file is the supported version, while the -winfree file
  88.      is the unsupported version)
  89.  
  90.  
  91. INSTALLING HTMLDOC UNDER RED HAT LINUX
  92.  
  93.     Type the following command to install HTMLDOC under Red Hat Linux:
  94.  
  95.         rpm -i htmldoc-1.8.23-linux-2.0-intel.rpm ENTER
  96.  
  97.     or:
  98.  
  99.         rpm -i htmldoc-1.8.23-linux-2.2-intel.rpm ENTER
  100.  
  101.     or:
  102.  
  103.         rpm -i htmldoc-1.8.23-linux-2.4-intel.rpm ENTER
  104.  
  105.  
  106. INSTALLING HTMLDOC UNDER UNIX
  107.  
  108.     Type the following commands to install HTMLDOC under UNIX:
  109.  
  110.         gunzip htmldoc-1.8.23-platform.tar.gz ENTER
  111.     tar xf htmldoc-1.8.23-platform.tar ENTER
  112.     ./setup ENTER *or* ./htmldoc.install ENTER
  113.  
  114.     (replace "platform" with the appropriate platform name)
  115.  
  116.  
  117. RUNNING HTMLDOC FROM THE COMMAND-LINE
  118.  
  119.     HTMLDOC accepts a list of HTML "source" files and will generate
  120.     HTML, PostScript, or PDF output via command-line options.  A
  121.     summary of command-line options can be shown with the "--help"
  122.     option:
  123.  
  124.         htmldoc --help
  125.  
  126.     HTMLDOC normally expects "structured" documents, with chapters,
  127.     etc.  Chapters begin with a <H1> markup and continue to the end of
  128.     the listed HTML files or the next <H1> markup, whichever comes
  129.     first.  To convert unstructured documents such as web pages, use
  130.     the "--webpage" option to HTMLDOC:
  131.  
  132.         htmldoc --webpage ...
  133.  
  134.     To generate a Level 2 PostScript file you might use:
  135.  
  136.         htmldoc -f outfile.ps chapter1.html ... chapterN.html
  137.  
  138.     Similarly you can generate a PDF file of the same source files
  139.     using:
  140.  
  141.         htmldoc -f outfile.pdf chapter1.html ... chapterN.html
  142.  
  143.     Finally, to generate HTML files for viewing (with a linked table-
  144.     of-contents) do the following:
  145.  
  146.         htmldoc -t html -d outdir chapter1.html ... chapterN.html
  147.  
  148.     or:
  149.  
  150.         htmldoc -t html -f outfile.html chapter1.html ... chapterN.html
  151.  
  152.     A complete description of all command-line options and HTML
  153.     guidelines can be found in the software users manual in the "doc"
  154.     directory.
  155.  
  156.  
  157. RUNNING THE GUI SOFTWARE
  158.  
  159.     To run the UNIX GUI type:
  160.  
  161.         htmldoc ENTER
  162.  
  163.     To run the Windows GUI choose "HTMLDOC" from the "Start" menu.
  164.  
  165.     This version of HTMLDOC reads and writes "book" files containing a
  166.     list of HTML source files and a set of output options.  Eventually
  167.     the GUI will support multiple output files so you can automagically
  168.     generate N files, each formatted differently.
  169.  
  170.  
  171. RUNNING HTMLDOC FROM YOUR WEB SERVER
  172.  
  173.     HTMLDOC supports filtering of documents from stdin to stdout.  This
  174.     can be useful for producing PDF or PostScript versions of HTML
  175.     reports on your web server.
  176.  
  177.     The special filename "-" specifies the standard input or standard
  178.     output.  To filter web pages to PDF use the command:
  179.     
  180.          htmldoc --webpage -t pdf -
  181.  
  182.     Note that this does not handle sending the "Content-Type:
  183.     application/pdf" header, so if you do this in a CGI script you'll
  184.     need to send this header prior to running htmldoc.  See Chapter 5
  185.     for more information.
  186.  
  187.  
  188. CURRENT LIMITATIONS
  189.  
  190.     - No support for style sheets.
  191.     - No support for HTML forms.
  192.     - CAPTIONs are always shown at the top of the table.
  193.     - HTML 4.0 table elements and attributes are not supported
  194.       (rules, THEAD, TFOOT, etc.)
  195.  
  196.  
  197. CREDITS
  198.  
  199.     Many thanks to Leonard Rosenthol (leonardr@lazerware.com) for
  200.     providing changes to support a MacOS version of HTMLDOC.
  201.  
  202.     The table VALIGN and "HALF PAGE" code was contributed by
  203.     D. Richard Hipp (drh@acm.org).
  204.  
  205.     The RC4 encryption code is from librc4 1.1 by the folks at
  206.     Carnegie Mellon University.
  207.  
  208.     The MD5 hash code is from L. Peter Deutsch (ghost@aladdin.com)
  209.     at Aladdin Enterprises (creators of Ghostscript).
  210.  
  211.  
  212. ENCRYPTION SUPPORT
  213.  
  214.     HTMLDOC includes code to encrypt PDF document files using
  215.     the RC4 algorithm with up to a 128-bit key. While this
  216.     software and code may be freely used and exported under
  217.     current US laws, other countries may restrict your use and
  218.     possession of this code and software.
  219.  
  220.  
  221. LEGAL STUFF
  222.  
  223.     The Adobe Portable Document Format is Copyright 1993-1999 by Adobe
  224.     Systems Incorporated. Adobe, FrameMaker, and PostScript are
  225.     registered trademarks of Adobe Systems, Incorporated.
  226.  
  227.     The Graphics Interchange Format is the copyright and GIF is the
  228.     service mark property of CompuServe Incorporated.
  229.  
  230.     Digital is a registered trademark of Compaq Computer Corporation.
  231.  
  232.     Intel is a registered trademark of Intel Corporation.
  233.  
  234.     IRIX and sgi are registered trademarks of sgi.
  235.  
  236.     Linux is a registered trademark of Linus Torvalds.
  237.  
  238.     Microsoft, Windows, Windows 95, Windows 98, and Windows NT are
  239.     registered trademarks of Microsoft Corporation.
  240.  
  241.     Solaris is a registered trademark of Sun Microsystems, Inc.
  242.  
  243.     SPARC is a registered trademark of SPARC International, Inc.
  244.  
  245.     UNIX is a registered trademark of the X/Open Company, Ltd.
  246.  
  247.     HTMLDOC is copyright 1997-2002 by Easy Software Products. This
  248.     program is free software; you can redistribute it and/or modify it
  249.     under the terms of the GNU General Public License as published by
  250.     the Free Software Foundation; either version 2 of the License, or
  251.     (at your option) any later version.
  252.  
  253.     This program is distributed in the hope that it will be useful, but
  254.     WITHOUT ANY WARRANTY; without even the implied warranty of
  255.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  256.     General Public License for more details.
  257.  
  258.     A copy of the GNU General Public License is included in the file
  259.     "COPYING.txt" and in Appendix A of the Software Users Manual. If
  260.     the file or appendix is missing from your copy of HTMLDOC, write to
  261.     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  262.     Boston, MA 02111-1307, USA.
  263.  
  264.     This software is based in part on the work of the Independent JPEG
  265.     Group.
  266.