You are on page 1of 4

Name

htfuzzy - fuzzy command-line search utility for the ht://Dig search engine
Synopsis
htfuzzy [-c configfile] [-v] algorithm [options]
Description
Description to follow here
Options
-c configfile
Use the specified configfile instead of the default.
-v
Verbose mode , -vvv etc ). Specifying more than two v's is probably only useful
for debugging purposes.
Supported Algorithms
Different algoritms are supported for searching:
soundex Creates a slightly modified soundex key database. Differences with the s
tandard soundex algorithm are: Keys are 6 digits and the first letter is also en
coded.
metaphone Creates a metaphone key database. This algorithm is more specific
to English, but will get fewer "weird" matches than the soundex algorithm.
accents (No description of the algorithm at the moment)
endings Creates two databases which can be used to match common word endings
. The creation of these databases requires a list of affix rules and a dictionar
y which uses those affix rules. The format of the affix rules and dictionary fil
es are the ones used by the ispell program. Included with the distribution are t
he affix rules for English and a fairly small English dictionary. Other language
s can be supported by getting the appropriate affix rules and dictionaries. Thes
e are available for many languages; check the ispell distribu- tion for more det
ails.
synonyms Creates a database of synonyms for words. It reads a text database
of synonyms and creates a database that htsearch can then use. Each line of the
text database consists of words where the first word will have the other words o
n that line as synonyms.
Notes on searching
Please consult specialised literature to find out how the different algorithms w
ork or simply try another
search stragegy you do not get the intended search results.
Files
/etc/htdig/htdig.conf
The default configuration file. /var/lib/htdig/db.accents.db (Output) Maps b
etween characters with and without accents for accents fuzzy rule /var/lib/htdig
/db.metaphone.db (Output) Database of similar-sounding words for metaphone fuzzy
rule /var/lib/htdig/db.soundex.db (Output) Database of similar-sounding words f

or soundex fuzzy rule /var/www/html/htdig/english.0, /var/www/html/htdig/english


.aff (Input) List of words and affix rules used to generate endings /var/www/htm
l/htdig/root2word.db, /var/www/html/htdig/word2rood.db (Output) Database used fo
r endings fuzzy rule /var/www/html/htdig/synonyms (Input) List of groups of word
s considered synonymous /var/www/html/htdig/synonyms.db (Output) Database used f
or synonyms fuzzy rule
Name
rundig - sample script to create a search database for ht://Dig
Synopsis
rundig [options]
Description
rundig is a sample script to create a search database for the ht://Dig search en
gine.
Options
-v
Verbose mode. This increases the verbosity of the program.
-a
Use alternate work files.
-s
Print statistics about the dig after completion
-c configfile
Use alternate config file.
+i
Use incremental digging instead non-incremental

Name
htdig - retrieve HTML documents for ht://Dig search engine
Synopsis
htdig [options]
Description
Htdig retrieves HTML documents using the HTTP protocol and gathers information f
rom these documents which can later be used to search these documents. This prog
ram can be referred to as the search robot.
Options
Get the list of URLs to start indexing from standard input. This will overri
de the default parameter start_url specified in the config file and the file sup
plied to the -m option.
-a
Use alternate work files. Tells htdig to append .work to database files, cau
sing a second copy of the database to be built. This allows the original files t
o be used by htsearch during the indexing run.
-c configfile
Use the specified configfile instead of the default.
-h maxhops
Restrict the dig to documents that are at most maxhops links away from the s
tarting document. This only works if option -i is also given.
-i
Initial. Do not use any old databases. Old databases will be erased before r
uning the program.
-m filename
Minimal run. Only index the URLs given in the file filename, ignoring all ot
hers. URLs in the file should be formatted one URL per line. -s Print statistics
about the dig after completion.

-t
Create an ASCII version of the document database. This database is easy to p
arse with other programs so that information can be extracted from it for purpos
es other than searching. One could gather some interesting statistics from this
database.
Fieldname Value
u URL
t Title
a State
(0 normal, 1 not found, 2 not indexed, 3 obsolete)
m Time of last modification reported by the server
s Document Size in bytes
H Excerpt of the document
h Meta Description
l Time of last rerievial
L Count of links in the document or of outgoing links
b Number of links to the document, also called
incoming links or backlinks
c Hop count of this document
g Signature of this document
(used to detect duplicates)
e E-Mail address to use for a notification from htnotify
n Date on which such notification is sent
S Subject of the notfication message
d The text of Incoming links pointing to this document
(e.g. <a href="docURL">description</a>)
A Anchors in the document (i.e. <A NAME=...)
-u username:password
Tells htdig to send the supplied username and password with each HTTP reques
t. The credentials will be encoded using the 'Basic' authentication method. Ther
e HAS to be a colon (:) between the username and password.
-v
Verbose mode. This increases the verbosity of the program. Using more than 2
is probably only useful for debugging purposes. The default verbose mode (using
only one -v) gives a nice progress report while digging. Please consult the sec
tion below on the exact format of the progress report.
Format of the Progress Report Given in Verbose Mode
A line is shown for each URL, with 3 numbers before the URL and some symbols aft
er the URL. The first number is the number of documents parsed so far, the secon
d is the DocID for this document, and the third is the hop count of the document
(number of hops from one of the start_url documents). Signification of the sybo
ls printed after the url:
"*" is printed for a link already visited
"+" is printed for a new link just queued
"-" is output for a link rejected for any of a number of reasons. To find out wh
at those reasons are, you need to run htdig with at least 3 -v options, i.e. -vv
v.
If there are no "*", "+" or "-" symbols after the URL, it doesn't mean the docum
ent was not parsed or was empty, but only that no links to other documents were
found within it. With more verbose output, these symbols will get interspersed i
n several lines of debugging output.
Files
/etc/htdig/htdig.conf
The default configuration file. /var/lib/htdig/db.docdb Stores data about ea
ch document (title, url, etc.). /var/lib/htdig/db.words.db, /var/lib/htdig/db.wo
rds.db_weakcmpr Record which documents each word occurs in. /var/lib/htdig/db.ex

cerpts Stores start of each document to show context of matches.

You might also like