j  � Running ht://Dig� � 0  

 Running ht://Dig



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 useA the ht://Dig system, after obtaining,, installing and0 configuring it.
 The main sections are:




. Building the databases



? After setting up all the configurationD files, you can build the required databases simply by running9 rundig. This script will runF htdig first to build the initial database,G then it runs htmerge to create a documentE index and word database from the files that were created by htdig.A It then runs htnotify, and finallyA runs htfuzzy if necessary, to buildE the endings and synonyms databases if they're missing or outdated.B The rundig script can be customized for your specific needs, orC you can develop your own script that runs any of these programs.B Read the reference sections for each of these programs to get a. better understanding of what each one does.



E The htfuzzy program deserves a bit moreB explaining. It is used to build databases that are used by some, of the fuzzy match algorithms selected by7 htsearch's= search_algorithmC attribute. The endings and synonyms algorithmsF use static dictionaries, so their databases only need to be rebuiltE by htfuzzy when the dictionary files are changed, or when ht://DigD is initially installed. The rundig script handles the building ofD these two databases as needed for the default setup. A few of theC other fuzzy match algorithms use databases that are derived from@ the word database built by htdig/htmerge, so if you use theseC algorithms you should rebuild their databases with htfuzzy everyA time you update your index. This isn't done in rundig, but theF comments in the script show where you can add your htfuzzy commands> as needed. Some fuzzy match algorithms don't need their ownE database, as they just operate on the word database, so they don't need any special setup.




4 Testing and troubleshooting



> Once the databases are built, you should test out htsearch.< It's recommended that you first try a few queries runningA htsearch on the command line, as it helps to separate problemsA that are specific to ht://Dig from web server or CGI problems.A Once you have that working, try running htsearch from your web1 browser, using the search form you configured.



D If you run into problems at any point in the building and testingD of your databases, there are many things you can do. All ht://DigF programs feature a -v option to get some debuggingE output. The more of these options you put on the command line, theD more output you'll usually get. To get help with common problems,D or with interpreting some of the debugging output, please look toG the ht://Dig FAQ (frequently asked questions)D as your first line of support. Most of the problems that ht://Dig2 users have are explained there, and the on-lineD FAQ on the website isC updated frequently as new problems arise. The FAQ will also tell@ you where you can turn if your question isn't answered there.D Remember that questions may not be phrased exactly as you'd stateA them, so look carefully for anything that seems similar to the" problem you're trying to solve. 

N Questions related to the OpenVMS port of ht://Dig should be directedK to Martin Vorlaender. 




3 Maintaining the system



D Once everything is running, you have to deal with the question ofD how you can keep everything running and up to date. The databasesC don't automatically update themselves, of course, so you'll needC to figure out how to schedule automatic updates of the database.@ Most users use the crontab facility on theirA systems to schedule daily or weekly updates of their database.@ This can be as simple as running "rundig" or "rundig -a" fromA your crontab, or from a file in /etc/cron.daily if your systemD uses this, to rebuild from scratch every night. For a small site,@ this may take only a few minutes to run. Other sites will runD more elaborate update scripts, to update their existing databasesC nightly, and schedule complete rebuilds less frequently, such as monthly.



C You need to pay close attention to how long updates take to run.C There are no database lockouts in ht://Dig, so you don't want toA schedule update or reindexing runs so frequently that they run into each other.


, Last modified: $Date: 2002/01/27 05:33:20 $ ÿÿ