Chapter 1 - Installing HTMLDOC

This chapter describes the steps needed to install HTMLDOC on your system from any of the source or binary distributions.

Installing a Binary Distribution

HTMLDOC binary distributions are available for a number of UNIX and Windows platforms.

Requirements

HTMLDOC requires approximately 2MB of disk space and one of the following environments:

Installing HTMLDOC under Red Hat Linux

Run the following command to install HTMLDOC under Red Hat Linux:

Uninstalling HTMLDOC under Red Hat Linux

Run the following command to remove HTMLDOC from your Red Hat Linux system:

Installing HTMLDOC under UNIX

Run the following commands to install HTMLDOC under UNIX: Substitute the correct platform string as needed.

Uninstalling HTMLDOC under UNIX

Run the following command to remove HTMLDOC from your UNIX system:

Installing HTMLDOC under Windows

HTMLDOC is provided in a self-extracting installation file under Windows. Double-click on the setup icon to install HTMLDOC under Windows.

Uninstalling HTMLDOC under Windows

Open the Control Panel window and double-click on the Add/Remove Software icon. When the available software list is displayed, select HTMLDOC and click on the Remove button.

Installing HTMLDOC from the Source Distribution

The complete source to HTMLDOC is available to build HTMLDOC for different directories, architectures, or operating systems.

Requirements

HTMLDOC requires ANSI C and C++ compilers (GCC/EGCS work fine.) To build the GUI you'll also need:

Configuring the UNIX Source

HTMLDOC uses a configuration script produced by GNU autoconf to configure itself for your system. If your ANSI C compiler is not called cc or gcc, set the CC environment variable to the name and path of your ANSI C compiler: Similarly, if your C++ compiler is not called CC, gcc, c++, or g++, set the CXX environment variable to the name and path of your C++ compiler: Finally, if the FLTK library is not installed in a standard location for your compilers, set the CFLAGS, CXXFLAGS, and LDFLAGS environment variables to point to the FLTK library: Then run the following command to configure HTMLDOC for installation in the default directories: The default configuration will install HTMLDOC in the /usr/bin directory with the data files under /usr/share/htmldoc and the documentation and on-line help under /usr/share/doc/htmldoc. Use the --prefix option to change the installation prefix to /usr/local:

Compiling under UNIX

HTMLDOC is built from a Makefile in the distribution's main directory. Simply run the "make" command to build HTMLDOC: If you get any fatal errors please send a copy of the make/compiler output to "htmldoc-support@easysw.com" for assistance. Please note the version of HTMLDOC that you are using as well as any pertinent system information (operating system, OS version, compiler, etc.)

Installing under UNIX

To install HTMLDOC simply run the "make install" command as root:

Compiling with Visual C++

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.

Installing with Visual C++

The Windows installation package is created using InstallShield for Visual C++ 6. The "visualc/HTMLDOC" directory contains the installation information for HTMLDOC needed to build a binary distribution with InstallShield.

To install HTMLDOC without InstallShield, create an installation directory and copy the htmldoc.exe executable, the afm directory, the data directory, and the doc directory to it.

Then use the regedit program to create the following two string entries:

HKEY_LOCAL_MACHINE\Software\Easy Software Products\HTMLDOC\data
C:\installation\directory
HKEY_LOCAL_MACHINE\Software\Easy Software Products\HTMLDOC\doc
C:\installation\directory\doc