Skip to content

Commit 2e5df48

Browse files
michaelrsweetmichaelrsweet
committed
Mirror doco changes.
1 parent 54cab30 commit 2e5df48

File tree

3 files changed

+141
-179
lines changed

3 files changed

+141
-179
lines changed

‎COMPILE.txt

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,67 @@
1-
COMPILE.txt - 2009-01-02
1+
COMPILE.txt - 2011-12-25
22
------------------------
33

44
REQUIREMENTS
55

6-
To compile HTMLDOC you'll need ANSI-compliant C and C++
7-
compilers (gcc is fine, most vendor compilers work, too).
8-
The JPEG, PNG, and ZLIB libraries are provided with HTMLDOC.
6+
To compile HTMLDOC you'll need C and C++ compilers (gcc is fine, most vendor
7+
compilers work, too). The JPEG, PNG, and ZLIB libraries are provided with
8+
HTMLDOC.
99

10-
The OpenSSL library is required for SSL (https) support.
10+
For the GUI support you'll need FLTK 1.1.x or 1.3.x. FLTK is a LGPL'd
11+
cross-platform GUI toolkit and can be downloaded from:
12+
13+
http://www.fltk.org/
1114

1215

1316
COMPILING HTMLDOC UNDER WINDOWS
1417

15-
For the Windows version we have included Visual C++.NET
16-
solution and project files under the "vcnet" directory. You
17-
must add the OpenSSL include and library directories to your
18-
VC++ environment options.
18+
For the Windows version we have included Visual C++ workspace and project
19+
files under the "visualc" and "vcnet" directories. You must add the FLTK
20+
include and library directories to your VC++ environment options.
1921

2022

2123
INSTALLING HTMLDOC UNDER WINDOWS
2224

23-
If you want to install the software by hand, create a
24-
directory for the software and copy the HTMLDOC executable,
25-
the "fonts" directory, the "data" directory, and the "doc"
26-
directory to it.
25+
We highly recommend installing the software using the VC++ MSI file as
26+
provided in the project files under the "vcnet" directory.
27+
28+
If you want to install the software by hand, create a directory for the
29+
software and copy the HTMLDOC executable, the "fonts" directory, the "data"
30+
directory, and the "doc" directory to it.
2731

2832
Then create the following registry entries with REGEDIT:
2933

30-
HKEY_LOCAL_MACHINE\Software\Easy Software Products\HTMLDOC\doc
31-
= C:/install/dir/doc
32-
HKEY_LOCAL_MACHINE\Software\Easy Software Products\HTMLDOC\data
33-
= C:/install/dir
34+
HKEY_LOCAL_MACHINE\Software\HTMLDOC\doc = C:\install\dir\doc
35+
HKEY_LOCAL_MACHINE\Software\HTMLDOC\data = C:\install\dir
3436

3537

3638
CONFIGURING HTMLDOC UNDER UNIX
3739

38-
To compile the software under UNIX you just need to run the
39-
"configure" script in this directory. Usually this is just:
40+
To compile the software under UNIX you just need to run the "configure"
41+
script in this directory. Usually this is just:
42+
43+
./configure
44+
45+
If the "configure" script does not exist in your copy of the sources, run
46+
"autoconf" to create it:
4047

48+
autoconf
4149
./configure
4250

43-
If you don't want to install HTMLDOC in the default
44-
directories (/usr/bin, /usr/man/man1, etc.), use the
45-
"--prefix" option when you run the configure script:
51+
If you don't want to install HTMLDOC in the default directories (/usr/bin,
52+
/usr/man/man1, etc.), use the "--prefix" option when you run the configure
53+
script:
4654

4755
./configure --prefix=/some/directory
4856

49-
If the OpenSSL library is in a non-standard location you can
50-
specify it using:
57+
If the OpenSSL library is in a non-standard location you can specify it
58+
using:
5159

5260
./configure --with-openssl-includes=/some/directory/include \
53-
--with-openssl-libs=/some/directory/lib
61+
--with-openssl-libs=/some/directory/lib
5462

55-
If you aren't using "cc" or "gcc" for your ANSI C compiler,
56-
you'll need to set the CC environment variable prior to
57-
running the configure script:
63+
If you aren't using "cc" or "gcc" for your ANSI C compiler, you'll need to
64+
set the CC environment variable prior to running the configure script:
5865

5966
CC=compiler; export CC
6067

@@ -64,9 +71,8 @@ CONFIGURING HTMLDOC UNDER UNIX
6471

6572
for C shell.
6673

67-
If you aren't using "gcc", "g++", "c++", or "CC" for your
68-
C++ compiler, you'll also need to set the CXX environment
69-
variable:
74+
If you aren't using "gcc", "g++", "c++", or "CC" for your C++ compiler,
75+
you'll also need to set the CXX environment variable:
7076

7177
CXX=compiler; export CXX
7278

@@ -79,10 +85,9 @@ CONFIGURING HTMLDOC UNDER UNIX
7985

8086
COMPILING HTMLDOC UNDER UNIX
8187

82-
Just run "make" to build the software and generate the
83-
documentation.
88+
Just run "make" to build the software and generate the documentation.
8489

8590

8691
INSTALLING HTMLDOC UNDER UNIX
8792

88-
Run "make install" to install the software.
93+
Run "make install" as root to install the software.

‎doc/1-install.html

Lines changed: 88 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -2,145 +2,138 @@
22
<body>
33

44
<!-- FOOTER RIGHT "1-$CHAPTERPAGE" -->
5-
<h1><a name='INSTALL'>Chapter 1 - Installing HTMLDOC</a></h1>
5+
<h1 align='right'><a name='INSTALL'>Chapter 1 - Installing
6+
HTMLDOC</a></h1>
67

7-
<p>This chapter describes the steps needed to install the
8-
commercial version of HTMLDOC on your system. If you are
9-
installing HTMLDOC from source code, please see <a
10-
href='#COMPILE'>Appendix D, Compiling HTMLDOC from
11-
Source</a>.</p>
8+
<p>This chapter describes the steps needed to install HTMLDOC on
9+
your system from the source distributions.</p>
1210

1311
<h2>Requirements</h2>
1412

15-
<p>HTMLDOC requires approximately 4MB of disk space and one of
16-
the following environments:</p>
13+
<p>HTMLDOC requires C and C++ compilers - recent versions of GCC/LLVM work fine. To build the GUI you'll also need:</p>
1714

1815
<ul>
1916

20-
<li>Microsoft Windows<sup>&reg;</sup> 2000 or higher</li>
17+
<li><a href='http://www.fltk.org'>Fast Light Tool Kit ("FLTK")</a>,
18+
version 1.1.x or 1.3.x.
2119

22-
<li>MacOS<sup>&reg;</sup> X 10.2 or higher</li>
23-
24-
<li>Linux<sup>&reg;</sup> 2.4 or higher</li>
25-
26-
<li>Solaris<sup>&reg;</sup> 7 or higher</li>
20+
<li><a href='ftp://ftp.x.org'>X11 libraries</a>, R5 or higher (needed
21+
to build under UNIX/Linux only.)
2722

2823
</ul>
2924

30-
<p>HTMLDOC may run on other platforms, however we do not provide
31-
packages for platforms other than those listed.</p>
32-
33-
34-
<h2>Installing HTMLDOC</h2>
35-
36-
<p>The following instructions describe how to install the
37-
HTMLDOC software on your system.</p>
38-
39-
<h3>Installing HTMLDOC on Microsoft Windows</h3>
40-
41-
<p>HTMLDOC is provided as a Microsoft installer file under
42-
Windows. Insert the CD or double-click on the <var>htmldoc</var>
43-
icon in the <var>Explorer</var> window to install HTMLDOC under
44-
Windows using the Microsoft software installation wizard (Figure
45-
1-1).</p>
46-
47-
<p align='center'><img src='htmldoc-fig11.png' alt='The software installation wizard'/><br />
48-
<i>Figure 1-1: The Microsoft software installation wizard</i></p>
49-
50-
51-
<h3>Installing HTMLDOC on MacOS X</h3>
52-
53-
<p>Double-click on the <var>Install</var> icon in the
54-
<var>Finder</var> window to start the software
55-
installation wizard (Figure 1-2) and follow the installer
56-
prompts.</p>
25+
<p>Secure (https) URL support can be enabled via the <A
26+
HREF='http://www.openssl.org/'>OpenSSL</a> or <A HREF="http://www.gnutls.org/">GNU TLS</a> libraries, among others.</p>
5727

58-
<p align='center'><img src='htmldoc-fig12.png' alt='The software installation wizard'/><br />
59-
<i>Figure 1-2: The software installation wizard</i></p>
28+
<h2>Compiling under UNIX/Linux</h2>
6029

30+
<p>HTMLDOC uses a configuration script produced by GNU autoconf
31+
to configure itself for your system. If your C compiler is
32+
not called <var>cc</var> or <var>gcc</var>, set the
33+
<code>CC</code> environment variable to the name and path of
34+
your C compiler:</p>
6135

62-
<h3>Installing HTMLDOC on Linux</h3>
63-
64-
<p>Double-click on the
65-
<var>htmldoc-linux-intel.rpm</var> icon or run the
66-
following command to install HTMLDOC on Linux:</p>
67-
68-
<pre class='command'>
69-
rpm -i htmldoc-linux-intel.rpm
36+
<pre>
37+
% <kbd>setenv CC /path/to/compiler ENTER</kbd> [C Shell]
38+
% <kbd>CC=/path/to/compiler; export CC ENTER</kbd> [Bourne/Korn Shell]
7039
</pre>
7140

41+
<p>Similarly, if your C++ compiler is not called <var>CC</var>,
42+
<var>gcc</var>, <var>c++</var>, or <var>g++</var>, set the
43+
<code>CXX</code> environment variable to the name and path of
44+
your C++ compiler:</p>
7245

73-
<h3>Installing HTMLDOC on Solaris</h3>
74-
75-
<p>Run the following command to install HTMLDOC on Solaris SPARC:</p>
76-
77-
<pre class='command'>
78-
pkgadd -d htmldoc-solaris-sparc.pkg
46+
<pre>
47+
% <kbd>setenv CXX /path/to/compiler ENTER</kbd> [C Shell]
48+
% <kbd>CXX=/path/to/compiler; export CXX ENTER</kbd> [Bourne/Korn Shell]
7949
</pre>
8050

81-
<p>Run the following command to install HTMLDOC on Solaris Intel:</p>
51+
<p>Then run the following command to configure HTMLDOC for
52+
installation in the default directories:</p>
8253

83-
<pre class='command'>
84-
pkgadd -d htmldoc-solaris-intel.pkg
54+
<pre>
55+
% <kbd>./configure ENTER</kbd>
8556
</pre>
8657

58+
<p>The default configuration will install HTMLDOC in the
59+
<var>/usr/bin</var> directory with the data files under
60+
<var>/usr/share/htmldoc</var> and the documentation and on-line
61+
help under <var>/usr/share/doc/htmldoc</var>. Use the
62+
<code>--prefix</code> option to change the installation prefix
63+
to a different directory such as <var>/usr/local</var>:
8764

88-
<h2>Licensing HTMLDOC</h2>
65+
<pre>
66+
% <kbd>./configure --prefix=/usr/local ENTER</kbd>
67+
</pre>
8968

90-
<p>Before you can use HTMLDOC, you must license it. When you first run
91-
HTMLDOC, the license dialog (Figure 1-3) will appear.</p>
69+
<p>If the OpenSSL library is not installed in a standard
70+
location for your compilers, use the
71+
<code>--with-openssl-includes</code> and
72+
<code>--with-openssl-libs</code> options to point to the OpenSSL
73+
library:
9274

93-
<p align='center'><img src='htmldoc-fig13.png'><br />
94-
<i>Figure 1-3 - The HTMLDOC License Dialog</i></p>
75+
<pre>
76+
% <kbd>./configure --with-openssl-libs=/path/to/openssl/lib \
77+
--with-openssl-includes=/path/to/openssl ENTER</kbd>
78+
</pre>
9579

96-
<p>Click on the <var>Update License</var> button to show the
97-
license manager window (Figure 1-4).</p>
80+
<p>HTMLDOC is built from a Makefile in the distribution's main
81+
directory. Simply run the "make" command to build HTMLDOC:
9882

99-
<p align='center'><img src='htmldoc-fig14.png'><br />
100-
<i>Figure 1-4 - The HTMLDOC License Dialog</i></p>
83+
<pre>
84+
% <kbd>make ENTER</kbd>
85+
</pre>
10186

102-
<p>Enter the license key that was emailed to you or came on the
103-
inside of the HTMLDOC CD-ROM case and click on the <var>OK</var>
104-
button. Click on the <var>Close</var> button to start using the
105-
software.</p>
87+
<p>If you get any fatal errors, please report them on the
88+
<code>htmldoc</code> mailing list referenced on the <a href="http://www.htmldoc.org/">htmldoc.org</a> web site.</p>
10689

90+
<p>Please note the version of HTMLDOC that you are using as well
91+
as any pertinent system information such as the operating
92+
system, OS version, compiler, and so forth. Omitting this
93+
information may delay or prevent a solution to your problem.</p>
10794

108-
<h2>Uninstalling HTMLDOC</h2>
95+
<p>Once you have compiled the software successfully, you may
96+
install HTMLDOC by running the following command:</p>
10997

110-
<p>The following instructions describe how to remove the HTMLDOC
111-
software from your system.</p>
98+
<pre>
99+
% <kbd>make install ENTER</kbd>
100+
</pre>
112101

113-
<h3>Uninstalling HTMLDOC on Microsoft Windows</h3>
102+
<p>If you are installing in a restricted directory like
103+
<var>/usr</var> then you'll need to be logged in as root.</p>
114104

115-
<p>Open the Control Panel window and double-click on the
116-
<var>Add/Remove Software</var> icon. When the available software
117-
list is displayed, select HTMLDOC and click on the
118-
<var>Remove</var> button.</p>
119105

106+
<h2>Compiling on Windows Using Visual C++</h2>
120107

121-
<h3>Uninstalling HTMLDOC on MacOS X</h3>
108+
<p>A Visual C++ 2008 workspace file and associated project files are
109+
included in the source distribution under the "visualc" directory. Open
110+
the workspace file "htmldoc.dsw", adjust the FLTK include and project
111+
file locations, and then build the HTMLDOC target.
122112

123-
<p>Double-click on the <var>Uninstall</var> icon in the
124-
<var>Finder</var> and follow the prompts.</p>
113+
<center><table width='80%' border='1' cellpadding='5' cellspacing='0' bgcolor='#cccccc'>
114+
<tr>
115+
<td><b>Note:</b>
125116

117+
<p>You also need to download the FLTK library in order to compile HTMLDOC with Visual C++.</p>
126118

127-
<h3>Uninstalling HTMLDOC on Linux</h3>
119+
</td>
120+
</tr>
121+
</table></center>
128122

129-
<p>Run the following command to remove HTMLDOC from your Linux
130-
system:</p>
123+
<h2>Installing with Visual C++</h2>
131124

132-
<pre class='command'>
133-
rpm -e htmldoc
134-
</pre>
125+
<p>To install HTMLDOC with Visual C++, open the MSI file that is created by
126+
the Visual C++ solution file. That will populate the necessary registry entries:</p>
135127

128+
<dl>
136129

137-
<h3>Uninstalling HTMLDOC on Solaris</h3>
130+
<dt><code>HKEY_LOCAL_MACHINE\Software\HTMLDOC\data</code>
131+
<dd>C:\installation\directory
138132

139-
<p>Run the following command to remove HTMLDOC from Solaris:</p>
133+
<dt><code>HKEY_LOCAL_MACHINE\Software\HTMLDOC\doc</code>
134+
<dd>C:\installation\directory\doc
140135

141-
<pre class='command'>
142-
pkgrm htmldoc
143-
</pre>
136+
</dl>
144137

145138
</body>
146139
</html>

0 commit comments

Comments
 (0)