htsearch(1) General Commands Manual htsearch(1)NAME
htsearch - create document index and word database for the ht://Dig search engine
SYNOPSIS
htsearch [options] [query_string]
DESCRIPTION
Htsearch is used to search in de databases created by htdig for content. is the actual search engine of the htdig search system. It is a
CGI program that is expected to be invoked by an HTML form. It will accept both the GET and POST methods of passing data to the CGI pro-
gram.
OPTIONS
query_string
A CGI-style query string can be given as a single argument, and is only used if the REQUEST_METHOD environment variable is not set.
If no query_string is given, and REQUEST_METHOD is not set, htsearch will prompt for the query.
-c configfile
Use the specified configfile instead of the default (for security reasons this option is only available when htsearch is used on the
commandline).
-v -d Run in verbose mode. This increases the verbosity of the program. Using more than 2 is probably only useful for debugging pur-
poses. The default verbose mode gives a progress on what it is doing and where it is.
FILES
/etc/htdig/htdig.conf
The default configuration file.
/srv/www/htdig/common/header.html
The default search results header file
/srv/www/htdig/common/footer.html
The default search results footer file
/srv/www/htdig/common/wrapper.html
The default search results wrapper file, that contains the header and footer together in one file
/srv/www/htdig/common/nomatch.html
The default 'no matches found' HTML file
/srv/www/htdig/common/syntax.html
The default file that explains boolean expression syntax errors
SEE ALSO
Please refer to the HTML pages (in the htdig-doc package) /usr/share/doc/htdig-doc/html/index.html and the manual pages htdig(1) and
htmerge(1) for a detailed description of ht://Dig and its commands.
AUTHOR
This manual page was written by Stijn de Bekker, based on the HTML documentation of ht://Dig.
6 October 2001 htsearch(1)
Check Out this Related Man Page
htload(1) General Commands Manual htload(1)NAME
htload - reads in an ASCII-text version of the document database
SYNOPSIS
htload [options]
DESCRIPTION
Htload reads in an ASCII-text version of the document database in the same form as the -t option of htdig and htdump. Note that this
will overwrite data in your databases, so this should be used with great care.
OPTIONS -a Use alternate work files. Tells htload to append .work to database files, allowing it to operate on a second set of databases.
-c configfile
Use the specified configfile instead of the default.
-i Initial. Do not use any old databases. This is accomplished by first erasing the databases.
-v Verbose mode. This doesn't have much effect.
File Formats
Document Database
Each line in the file starts with the document id followed by a list of fieldname : value separated by tabs. The fields always
appear in the order listed below:
u URL
t Title
a State (0 = normal, 1 = not found, 2 = not indexed, 3 = obsolete)
m Last modification time as reported by the server
s Size in bytes
H Excerpt
h Meta description
l Time of last retrieval
L Count of the links in the document (outgoing links)
b Count of the links to the document (incoming links or backlinks)
c HopCount of this document
g Signature of the document used for duplicate-detection
e E-mail address to use for a notification message from htnotify
n Date to send out a notification e-mail message
S Subject for a notification e-mail message
d The text of links pointing to this document. (e.g. <a href="docURL">description</a>)
A Anchors in the document (i.e. <A NAME=...)
Word Database
While htdump and htload don't deal with the word database directly, it's worth mentioning it here because you need to deal with it
when copying the ASCII databases from one system to another. The initial word database produced by htdig is already in ASCII format,
and a binary version of it is produced by htmerge, for use by htsearch. So, when you copy over the ASCII version of the document
database produced by htdump, you need to copy over the wordlist as well, then run htload to make the binary document database on the
target system, followed by running htmerge to make the word index.
Each line in the word list file starts with the word
followed by a list of fieldname : value separated by tabs. The fields always appear in the order listed below, with the last two
being optional:
i Document ID
l Location of word in document (1 to 1000)
w Weight of word based on scoring factors
c Count of word's appearances in document, if more than 1
a Anchor number if word occurred after a named anchor
FILES
/etc/htdig/htdig.conf
The default configuration file.
/var/lib/htdig/db.docs
The default ASCII document database file.
/var/lib/htdig/db.wordlist
The default ASCII word database file.
SEE ALSO
Please refer to the HTML pages (in the htdig-doc package) /usr/share/doc/htdig-doc/html/index.html and the manual pages htdig(1) ,
htmerge(1) and htdump(1) for a detailed description of ht://Dig and its commands.
AUTHOR
This manual page was written by Stijn de Bekker, based on the HTML documentation of ht://Dig.
15 October 2001 htload(1)