j  � ht://Dig: Installation� � 0  

 Installation



W ht://Dig Copyright © 1995-2002 The ht://Dig Group
8 Please see the file COPYING for license information.




? This document will attempt to show the steps needed to build' and install the ht://Dig system.
 The main sections are:




0 Extracting the software



? The distribution of ht://Dig is in the form of a gzipped tar9 file. The name of the file will be something like B htdig-3.1.0.tar.gz. To extract, you can use either the GNU tar command as follows:

+ % tar xzf tarfile.tar.gz


8 If you do not have GNU tar, you can do the following:

8 % gunzip -c tarfile.tar.gz | tar xf -


B In either case, a new directory will be created under which the@ distribution will be extracted. The directory it creates will5 be htdig- followed by the version number.




$ Configure



@ Once the distribution has been extracted, change to the newly created directory.
J In this directory you will need execute the configure program:

 % ./configure


> This program will attempt to determine what your particular system can and can't do.



? The configure program may produce some warnings about> libguile and guile. Ignore those warnings since they do not& affect the ht://Dig program at all.



1 After this, you may wish to edit the file : CONFIG. There are several values which you need toB change in this file. Note that more recent versions of ht://Dig9 (after 3.1.0b2) will allow you to use

./configure@	  --prefix=
and
--exec-prefix=
to set the DEST< and BIN_DIR variables automatically. As of the full 3.1.0A release, configure also supports setting the other directories6 in CONFIG using the flags --with-cgi-bin-dir=DIR,2 --with-image-dir=DIR and --with-search-dir=DIR.



 DEST

< This is where all of the ht://Dig parts will be installed.< Various other variables will use this value as their base.

 BIN_DIR

4 All the ht://Dig executable programs will go here.

 CONFIG_DIR

* Configuration files will be placed here.

 COMMON_DIR

9 This directory is for files which can be shared between different search databases.

 DATABASE_DIR

: Set this to the directory where the search databases are9 going to be. (Make sure there is plenty of space on the partition you put this on!)

 DEFAULT_CONFIG_FILE

5 Point this to where all the tools will look for the: configuration file. You can define this in terms of CONFIG_DIR if you'd like.

 CGIBIN_DIR

4 The directory where your HTTP server looks for CGI6 programs. This is where htsearch will get installed.

 IMAGE_DIR

< Define this to be a place that can be accessed by your web= server. This is where a couple of images will be installed.

 IMAGE_URL_PREFIX

< This is the URL which points to the directory specified by( the IMAGE_DIR variable above.

 SEARCH_FORM

; The name of the file in which the sample search form will be installed.




Compile



? The configure program will have created Makefiles in all the: important directories. It is important to note that the@ Makefiles created assume that you use a make program that knows how to deal with

 include filename


B Some make programs do not allow this or have a different syntax= for including. In this case, you should probably obtain GNU make.



> At this point you can optionally add dependency information) to all the make files with the command

 % make depend


? This only needs to be done if you are going to change any of the sources to ht://Dig.



% Now build the complete system with

 % make


& (Sit back and relax for a while...)



? If the compilation failed with the error that it cannot find@ libht.a, the most likely problem is that your system does not- have libstdc++ installed. Please check theF system requirements for details on this.




Install



= Everything should have built at this point. To install the software, you need to execute

 % make install


< This will perform several tasks. It will first attempt to@ create the directories that you specified in the CONFIG file.7 It will then copy the following programs to the ; BIN_DIR directory you specified in the CONFIG file:

 

< It will also copy the htsearch program to your CGIBIN_DIR directory.



> After this, several files will be customized and installed.2 Here is a list of the files that get installed:




O * CONFIG_DIR/htdig.conf

6 A minimal config file which can be used to create a+ search database for http://www.htdig.org

E * SEARCH_FORM

6 A sample HTML document that contains a search form.

P * COMMON_DIR/footer.html

8 A sample HTML document that can be used as the search results footer.

P * COMMON_DIR/header.html

8 A sample HTML document that can be used as the search results header.

Q * COMMON_DIR/nomatch.html

9 A sample HTML document that can be used if nothing was found.

P * COMMON_DIR/syntax.html

7 A sample HTML document that will be displayed if the5 user entered an illegal boolean expression. found.

N * COMMON_DIR/english.0

5 Default list of words with affixes that is used by htfuzzy.
T
P * COMMON_DIR/english.aff

7 Default affix rule database that is used by htfuzzy.
s
L * IMAGE_DIR/star.gif
h
7 The default star image that is used to rank matches.m
/
R * IMAGE_DIR/star_blank.gif
<
9 The default placeholder image that is the same size ass4 the star, but is blank. This is used to align the results in the short listing.

M * IMAGE_DIR/htdig.gif
a
 The nifty ht://Dig logo.e
l
O * IMAGE_DIR/button*.gif"
>
6 Sample images used to show the search result pages.
r
H * BIN_DIR/rundig
r
6 A sample shell script which will create a database.
e
l


A Note that these files will never replace any existingU' files that may already be installed.l

e

; It is also important to note that these files are mostly<< examples. As they stand, they will work, but you probably- want to modify them to reflect your needs.a

a

8 After the installation, you will be ready to test out? everything. You can use the rundig script to make ao/ test database of the online documentation atl http://www.htdig.org/

b

2 The only thing left to do is to modify the 7 htdig.conf config file which was placed in 8 CONFIG_DIR/htdig.conf. The 7 Configuration manual has the details on how what  attributes are needed.u9 Then, you'll be ready to begin  running ht://Dig.

g
+Last modified: $Date: 2002/01/28 03:56:10 $a pÿÿ The configure program may produce some warnings about> libguile and guile. Ignore those warnings since they do not& affect the ht://Dig program at all.



1 After this, you may wish to edit the file : CONFIG. There are several values which you need toB change in this file. Note that more recent versions of ht://Dig9 (after 3.1.0b2) will allow