\
\
<SELECT NAME=\"search_algorithm\"> | \
contrib/examples \
directory. \
" }, \
{ "bin_dir", BIN_DIR, \
"string", "all", "", "all", "File Layout", "bin_dir: /usr/local/bin", " \
This is the directory in which the executables \
related to ht://Dig are installed. It is never used \
directly by any of the programs, but other attributes \
can be defined in terms of this one. \
\ The default value of this attribute is determined at \ compile time. \
\ " }, \ { "boolean_keywords", "and or not", \ "string list", "htsearch", "", "3.1.6", "Presentation:How", "boolean_keywords: et ou non", " \ These three strings are used as the keywords used in \ constructing the \ LOGICAL_WORDS \ template variable, \ and in parsing the words input \ parameter when the method \ parameter or match_method attribute \ is set toboolean. \
See also the \
boolean_syntax_errors attribute. \
" },
{ "boolean_syntax_errors", "Expected \
'a search word, a quoted phrase or a boolean expression between ()' \
'at the end' 'instead of' 'end of expression' quotes", \
"quoted string list", "htsearch", "", "3.1.6", "Presentation:How",
"boolean_syntax_errors: Attendait \"un mot\" \"à la fin\" \
\"au lieu de\" \"fin d'expression\" \"guillemet\"", " \
These six strings are used as the keywords used to \
construct various syntax error messages for errors encountered in \
parsing the words input \
parameter when the method parameter \
or match_method attribute \
is set to boolean. \
They are used in conjunction with the \
boolean_keywords attribute, and \
comprise all \
English-specific parts of these error messages. The order in which \
the strings are put together may not be ideal, or even gramatically \
correct, for all languages, but they can be used to make fairly \
intelligible messages in many languages. \
" },
{ "build_select_lists", "", \
"quoted string list", "htsearch", "", "3.2.0b1", "Searching:UI", "build_select_lists: \
MATCH_LIST matchesperpage matches_per_page_list \\\ The default value of this attribute is determined at \ compile time. \
\ " }, { "content_classifier", "${bin_dir}/HtFileType", \ "string", "htdig", "", "3.2.0b4", "Indexing:What", "content_classifier: file -i -b", " \ When ht://Dig can't determine the type of afile:// \
URL from its extension, this program is used to determine the type. \
The program is called with one argument, the name of (possibly a \
temporary copy of) the file. \
\ See also mime_types.\
\ " }, \ { "cookies_input_file", "", \ "string", "htdig", "", "3.2.0b4", "Indexing:Connection", "cookies_input_file: ${common_dir}/cookies.txt", " \ Specifies the location of the file used for importing cookies \ for the crawl. These cookies will be preloaded into htdig's \ in-memory cookie jar, but aren't written back to the file. \ Cookies are specified according to Netscape's format \ (tab-separated fields). If this attribute is left blank, \ no cookie file will be read. \ For more information, see the sample cookies.txt file in the \ ht://Dig source distribution. \ " }, \ { "create_image_list", "false", \ "boolean", "htdig", "", "all", "Extra Output", "create_image_list: yes", " \ If set to true, a file with all the image URLs that \ were seen will be created, one URL per line. This list \ will not be in any order and there will be lots of \ duplicates, so after htdig has completed, it should be \ piped throughsort -u to get a unique list. \
" }, \
{ "create_url_list", "false", \
"boolean", "htdig", "", "all", "Extra Output", "create_url_list: yes", " \
If set to true, a file with all the URLs that were seen \
will be created, one URL per line. This list will not \
be in any order and there will be lots of duplicates, \
so after htdig has completed, it should be piped \
through sort -u to get a unique list. \
" }, \
{ "database_base", "${database_dir}/db", \
"string", "all", "", "all", "File Layout", "database_base: ${database_dir}/sales", " \
This is the common prefix for files that are specific \
to a search database. Many different attributes use \
this prefix to specify filenames. Several search \
databases can share the same directory by just changing \
this value for each of the databases. \
" }, \
{ "database_dir", DATABASE_DIR, \
"string", "all", "", "all", "File Layout", "database_dir: /var/htdig", " \
This is the directory which contains all database and \
other files related to ht://Dig. It is never used \
directly by any of the programs, but other attributes \
are defined in terms of this one. \
\ The default value of this attribute is determined at \ compile time. \
\ " }, \ { "date_factor", "0", \ "number", "htsearch", "", "3.1.0", "Searching:Ranking", "date_factor: 0.35", " \ This factor, gives higher \ rankings to newer documents and lower rankings to older \ documents. Before setting this factor, it's advised to \ make sure your servers are returning accurate dates \ (check the dates returned in the long format). \ Additionally, setting this to a nonzero value incurs a \ small performance hit on searching. \ " }, \ { "date_format", "", \ "string", "htsearch", "", "3.1.2", "Presentation:How", "date_format: %Y-%m-%d", " \ This format string determines the output format for \ modification dates of documents in the search results. \ It is interpreted by your system's strftime \ function. Please refer to your system's manual page \ for this function, for a description of available \ format codes. If this format string is empty, as it \ is by default, \ htsearch \ will pick a format itself. In this case, the iso_8601 attribute can be used \ to modify the appearance of the date. \ " }, \ { "description_factor", "150", \ "number", "htsearch", "", "3.1.0b3", "Searching:Ranking", "description_factor: 350", " \ Plain old \"descriptions\" are the text of a link pointing \ to a document. This factor gives weight to the words of \ these descriptions of the document. Not surprisingly, \ these can be pretty accurate summaries of a document's \ content. See also heading_factor \ and meta_description_factor. \ " }, \ { "description_meta_tag_names", "description", \ "string list", "htdig", "", "3.1.6", "Searching:Ranking", "description_meta_tag_names: \"description htdig-description\"", " \ The words in this list are used to search for descriptions in HTML \ META tags. This list can contain any number of strings \ that each will be seen as the name for whatever description \ convention is used. While words in any of the specified \ description contents will be indexed, only the last meta tag \ containing a description will be kept for the \ \ variable in search results. The order in \ which the names are specified in this configuration attribute \ is irrelevant, as it is the order in which the tags appear in \ the documents that matters. ...", \
"string", "htsearch", "", "all", "Presentation:Text", "end_ellipses: ...", " \
When excerpts are displayed in the search output, this \
string will be appended to the excerpt if there is text \
following the text displayed. This is just a visual \
reminder to the user that the excerpt is only part of \
the complete document. \
" }, \
{ "end_highlight", "", \
"string", "htsearch", "", "3.1.4", "Presentation:Text", "end_highlight: </font>", " \
When excerpts are displayed in the search output, matched \
words will be highlighted using \
start_highlight and this string. \
You should ensure that highlighting tags are balanced, \
that is, this string should close any formatting \
tag opened by start_highlight. \
" }, \
{ "endings_affix_file", "${common_dir}/english.aff", \
"string", "htfuzzy", "", "all", "File Layout", "endings_affix_file: /var/htdig/affix_rules", " \
Specifies the location of the file which contains the \
affix rules used to create the endings search algorithm \
databases. Consult the documentation on \
htfuzzy for more information on the \
format of this file. \
" }, \
{ "endings_dictionary", "${common_dir}/english.0", \
"string", "htfuzzy", "", "all", "File Layout", "endings_dictionary: /var/htdig/dictionary", " \
Specifies the location of the file which contains the \
dictionary used to create the endings search algorithm \
databases. Consult the documentation on \
htfuzzy for more information on the \
format of this file. \
" }, \
{ "endings_root2word_db", "${common_dir}/root2word.db", \
"string", "htfuzzy htsearch", "", "all", "File Layout", "endings_root2word_db: /var/htdig/r2w.db", " \
This attributes specifies the database filename to be \
used in the 'endings' fuzzy search algorithm. The \
database maps word roots to all legal words with that \
root. For more information about this and other fuzzy \
search algorithms, consult the \
htfuzzy documentation. \
The parser program takes four command-line \
parameters, not counting any parameters already \
given in the command string:
\
infile content-type URL configuration-file
\
| Parameter | \Description | \Example | \
|---|---|---|
| infile | \A temporary file with the contents to be parsed. | \/var/tmp/htdext.14242 | \
| content-type | \The MIME-type of the contents. | \text/html | \
| URL | \The URL of the contents. | \http://www.htdig.org/attrs.html | \
| configuration-file | \The configuration-file in effect. | \/etc/htdig/htdig.conf | \
\
The external parser is to write information for \
htdig on its standard output. Unless it is an \
external converter, which will output a document \
of a different content-type, then its output must \
follow the format described here.
\
The output consists of records, each record terminated \
with a newline. Each record is a series of (unless \
expressively allowed to be empty) non-empty tab-separated \
fields. The first field is a single character \
that specifies the record type. The rest of the fields \
are determined by the record type. \
| Record type | \Fields | \Description | \
|---|---|---|
| w | \word | \A word that was found in the document. | \
| location | \\ A number indicating the normalized location of \ the word within the document. The number has to \ fall in the range 0-1000 where 0 means the top of \ the document. \ | \|
| heading level | \ \
A heading level that is used to compute the \
weight of the word depending on its context in \
the document itself. The level is in the range of \
0-11 and are defined as follows: \
| \
|
| u | \document URL | \\ A hyperlink to another document that is \ referenced by the current document. It must be \ complete and non-relative, using the URL parameter to \ resolve any relative references found in the document. \ | \
| hyperlink description | \\ For HTML documents, this would be the text \ between the <a href...> and </a> \ tags. \ | \|
| t | \title | \The title of the document | \
| h | \head | \\ The top of the document itself. This is used to \ build the excerpt. This should only contain \ normal ASCII text \ | \
| a | \anchor | \\ The label that identifies an anchor that can be \ used as a target in an URL. This really only \ makes sense for HTML documents. \ | \
| i | \image URL | \\ An URL that points at an image that is part of \ the document. \ | \
| m | \http-equiv | \\ The HTTP-EQUIV attribute of a \ META tag. \ May be empty. \ | \
| name | \\ The NAME attribute of this \ META tag. \ May be empty. \ | \|
| contents | \\ The CONTENTS attribute of this \ META tag. \ May be empty. \ | \
See also FAQ questions 4.8 and \ 4.9 for more examples.
\ " }, \ { "external_protocols", "", \ "quoted string list", "htdig", "", "3.2.0b1", "External:Protocols", "external_protocols: https /usr/local/bin/handler.pl \\| Parameter | \Description | \Example | \
|---|---|---|
| protocol | \The URL scheme to be used. | \https | \
| URL | \The URL to be retrieved. | \https://www.htdig.org:8008/attrs.html | \
| configuration-file | \The configuration-file in effect. | \/etc/htdig/htdig.conf | \
\ The external protocol script is to write information for htdig on the \ standard output. The output must follow the form described here. The \ output consists of a header followed by a blank line, followed by \ the contents of the document. Each record in the header is terminated \ with a newline. Each record is a series of (unless expressively \ allowed to be empty) non-empty tab-separated fields. The first field \ is a single character that specifies the record type. The rest of \ the fields are determined by the record type. \
| Record type | \Fields | \Description | \
|---|---|---|
| s | \status code | \ \
An HTTP-style status code, e.g. 200, 404. Typical codes include: \
| \
| r | \reason | \\ A text string describing the status code, \ e.g \"Redirect\" or \"Not Found.\" \ | \
| m | \status code | \\ The modification time of this document. While the code is \ fairly flexible about the time/date formats it accepts, it \ is recommended to use something standard, like \ RFC1123: Sun, 06 Nov 1994 08:49:37 GMT, or \ ISO-8601: 1994-11-06 08:49:37 GMT. \ | \
| t | \content-type | \\ A valid MIME type for the document, like text/html or text/plain. \ | \
| l | \content-length | \\ The length of the document on the server, which may not \ necessarily be the length of the buffer returned. \ | \
| u | \url | \\ The URL of the document, or in the case of a redirect, the \ URL that should be indexed as a result of the redirect. \ | \
http_proxy environement variable, but it currently cannot.\
The use of a proxy server greatly improves performance \
of the indexing process.sort -u on the file to \
eliminate duplicates from the file. \
" }, \
{ "image_url_prefix", IMAGE_URL_PREFIX, \
"string", "htsearch", "", "all", "Presentation:Text", "image_url_prefix: /images/htdig", " \
This specifies the directory portion of the URL used \
to display star images. This attribute isn't directly \
used by htsearch, but is used in the default URL for \
the star_image and \
star_blank attributes, and \
other attributes may be defined in terms of this one. \
\ The default value of this attribute is determined at \ compile time. \
\ " }, \ { "include", "", \ "string", "all", "", "3.1.0", "", "include: ${config_dir}/htdig.conf", " \ This is not quite a configuration attribute, but \ rather a directive. It can be used within one \ configuration file to include the definitions of \ another file. The last definition of an attribute \ is the one that applies, so after including a file, \ any of its definitions can be overridden with \ subsequent definitions. This can be useful when \ setting up many configurations that are mostly the \ same, so all the common attributes can be maintained \ in a single configuration file. The include directives \ can be nested, but watch out for nesting loops. \ " }, \ { "iso_8601", "false", \ "boolean", "htsearch htnotify", "", "3.1.0b2", "Presentation:How,Extra Output", "iso_8601: true", " \ This sets whether dates should be output in ISO 8601 \ format. For example, this was written on: 1998-10-31 11:28:13 EST. \ See also the date_format attribute, which \ can override any date format that \ htsearch \ picks by default. \
<META name=\"somename\" content=\"somevalue\"> \
\
" }, \
{ "limit_normalized", "", \
"pattern list", "htdig", "", "3.1.0b2", "Indexing:Where", "limit_normalized: http://www.mydomain.com", " \
This specifies a set of patterns that all URLs have to \
match against in order for them to be included in the \
search. Unlike the limit_urls_to attribute, this is done \
after the URL is normalized and the \
server_aliases \
attribute is applied. This allows filtering after any \
hostnames and DNS aliases are resolved. Otherwise, this \
attribute is the same as the limit_urls_to attribute. \
" }, \
{ "limit_urls_to", "${start_url}", \
"pattern list", "htdig", "", "all", "Indexing:Where", "limit_urls_to: .sdsu.edu kpbs [.*\\.html]", " \
This specifies a set of patterns that all URLs have to \
match against in order for them to be included in the \
search. Any number of strings can be specified, \
separated by spaces. If multiple patterns are given, at \
least one of the patterns has to match the URL.http:// if none is \
specified).file:// urls \
are not retrieved, except throught the local_urls mechanism.\
" }, \
{ "local_user_urls", "", \
"string list", "htdig", "", "3.0.8b2", "Indexing:Where", "local_user_urls: http://www.my.org/=/home/,/www/", " \
Set this to access user directory URLs through the local \
filesystem. If you leave the \"path\" portion out, it will \
look up the user's home directory in /etc/password (or NIS \
or whatever). As with local_urls, \
if the files are not found, ht://Dig will try with HTTP or the \
appropriate protocol. Again, note the \
example's format. To map http://www.my.org/~joe/foo/bar.html \
to /home/joe/www/foo/bar.html, try the example below. \
\
See also content_classifier.\
"}, \
{ "minimum_prefix_length", "1", \
"integer", "htsearch", "", "3.1.0b1", "Searching:Method", "minimum_prefix_length: 2", " \
This sets the minimum length of prefix matches used by the \
\"prefix\" fuzzy matching algorithm. Words shorter than this \
will not be used in prefix matching. \
" }, \
{ "minimum_speling_length", "5", \
"integer", "htsearch", "", "3.2.0b1", "Searching:Method", "minimum_speling_length: 3", " \
This sets the minimum length of words used by the \
\"speling\" fuzzy matching algorithm. Words shorter than this \
will not be used in this fuzzy matching. \
" }, \
{ "minimum_word_length", "3", \
"integer", "htdig htsearch", "", "all", "Indexing:What", "minimum_word_length: 2", " \
This sets the minimum length of words that will be \
indexed. Words shorter than this value will be silently \
ignored but still put into the excerpt.
\
Note that by making this value less than 3, a lot more \
words that are very frequent will be indexed. It might \
be advisable to add some of these to the \
bad_words list. \
" }, \
{ "multimatch_factor", "1", \
"number", "htsearch", "", "3.1.6", "Searching:Ranking", "multimatch_factor: 1000", " \
This factor gives higher rankings to documents that have more than \
one matching search word when the or \
match_method is used. \
In version 3.1.6, the matching words' combined scores were multiplied \
by this factor for each additional matching word. Currently, this \
multiplier is applied at most once. \
" },
{ "next_page_text", "[next]", \
"string", "htsearch", "", "3.1.0", "Presentation:Text", "next_page_text: <img src=\"/htdig/buttonr.gif\">", " \
The text displayed in the hyperlink to go to the next \
page of matches. \
" }, \
{ "no_excerpt_show_top", "false", \
"boolean", "htsearch", "", "3.1.0b3", "Presentation:How", "no_excerpt_show_top: yes", " \
If no excerpt is available, this option will act the \
same as excerpt_show_top, that is, \
it will show the top of the document. \
" }, \
{ "no_excerpt_text", "(None of the search words were found in the top of this document.)", \
"string", "htsearch", "", "3.0", "Presentation:Text", "no_excerpt_text:", " \
This text will be displayed in place of the excerpt if \
there is no excerpt available. If this attribute is set \
to nothing (blank), the excerpt label will not be \
displayed in this case. \
" }, \
{ "no_next_page_text", "${next_page_text}", \
"string", "htsearch", "", "3.0", "Presentation:Text", "no_next_page_text:", " \
The text displayed where there would normally be a \
hyperlink to go to the next page of matches. \
" }, \
{ "no_page_list_header", "", \
"string", "htsearch", "", "3.0", "Presentation:Text", "no_page_list_header: <hr noshade size=2>All results on this page.<br>", " \
This text will be used as the value of the PAGEHEADER \
variable, for use in templates or the \
search_results_footer \
file, when all search results fit on a single page. \
" }, \
{ "no_page_number_text", "", \
"quoted string list", "htsearch", "", "3.0", "Presentation:Text", "no_page_number_text: \
<strong>1</strong> <strong>2</strong> \\
\
<strong>3</strong> <strong>4</strong> \\
\
<strong>5</strong> <strong>6</strong> \\
\
<strong>7</strong> <strong>8</strong> \\
\
<strong>9</strong> <strong>10</strong> \
", " \
The text strings in this list will be used when putting \
together the PAGELIST variable, for use in templates or \
the search_results_footer \
file, when search results fit on more than page. The PAGELIST \
is the list of links at the bottom of the search results page. \
There should be as many strings in the list as there are \
pages allowed by the maximum_page_buttons \
attribute. If there are not enough, or the list is empty, \
the page numbers alone will be used as the text for the links. \
An entry from this list is used for the current page, as the \
current page is shown in the page list without a hypertext link, \
while entries from the \
page_number_text list are used for the links to other pages. \
The text strings can contain HTML tags to highlight page numbers \
or embed images. The strings need to be quoted if they contain \
spaces. \
" }, \
{ "no_prev_page_text", "${prev_page_text}", \
"string", "htsearch", "", "3.0", "Presentation:Text", "no_prev_page_text:", " \
The text displayed where there would normally be a \
hyperlink to go to the previous page of matches. \
" }, \
{ "no_title_text", "filename", \
"string", "htsearch", "", "3.1.0", "Presentation:Text", "no_title_text: \"No Title Found\"", " \
This specifies the text to use in search results when no \
title is found in the document itself. If it is set to \
filename, htsearch will use the name of the file itself, \
enclosed in brackets (e.g. [index.html]). \
" }, \
{ "noindex_end", " ", \
"quoted string list", "htdig", "", "3.1.0", "Indexing:What", "noindex_end: </SCRIPT>", " \
This string marks the end of a section of an HTML file that should be \
completely ignored when indexing. Note that text between noindex_start\
and noindex_end isn't even counted as white space; the text \
\"foosomethingbar\" \
matches the word \"foobar\", not the phrase \"foo bar\". White space \
following noindex_end is counted as white space. See also \
noindex_start. \
" }, \
{ "noindex_start", " \
HTML text to display when no matches were found. \
The file should contain a complete HTML \
document.
\
Note that this attribute could also be defined in \
terms of database_base to \
make is specific to the current search database. \
" }, \
{ "nph", "false", \
"boolean", "htsearch", "", "3.2.0b2", "Presentation:How", "nph: true", " \
This attribute determines whether htsearch sends out full HTTP \
headers as required for an NPH (non-parsed header) CGI. Some \
servers assume CGIs will act in this fashion, for example MS \
IIS. If your server does not send out full HTTP headers, you \
should set this to true. \
" }, \
{ "page_list_header", "
Pages:
", \
"string", "htsearch", "", "3.0", "Presentation:Text", "page_list_header:", " \
This text will be used as the value of the PAGEHEADER \
variable, for use in templates or the \
search_results_footer \
file, when all search results fit on more than one page. \
" }, \
{ "page_number_separator", "\" \"", \
"quoted string list", "htsearch", "", "3.1.4", "Presentation:Text", "page_number_separator: \"</td> <td>\"", " \
The text strings in this list will be used when putting \
together the PAGELIST variable, for use in templates or \
the search_results_footer \
file, when search results fit on more than page. The PAGELIST \
is the list of links at the bottom of the search results page. \
The strings in the list will be used in rotation, and will \
separate individual entries taken from \
page_number_text and \
no_page_number_text. \
There can be as many or as few strings in the list as you like. \
If there are not enough for the number of pages listed, it goes \
back to the start of the list. If the list is empty, a space is \
used. The text strings can contain HTML tags. The strings need \
to be quoted if they contain spaces, or to specify an empty string. \
" }, \
{ "page_number_text", "", \
"quoted string list", "htsearch", "", "3.0", "Presentation:Text", "page_number_text: \
<em>1</em> <em>2</em> \\
\
<em>3</em> <em>4</em> \\
\
<em>5</em> <em>6</em> \\
\
<em>7</em> <em>8</em> \\
\
<em>9</em> <em>10</em> \
", " \
The text strings in this list will be used when putting \
together the PAGELIST variable, for use in templates or \
the search_results_footer \
file, when search results fit on more than page. The PAGELIST \
is the list of links at the bottom of the search results page. \
There should be as many strings in the list as there are \
pages allowed by the maximum_page_buttons \
attribute. If there are not enough, or the list is empty, \
the page numbers alone will be used as the text for the links. \
Entries from this list are used for the links to other pages, \
while an entry from the \
no_page_number_text list is used for the current page, as the \
current page is shown in the page list without a hypertext link. \
The text strings can contain HTML tags to highlight page numbers \
or embed images. The strings need to be quoted if they contain \
spaces. \
" }, \
{ "persistent_connections", "true", \
"boolean", "htdig", "Server", "3.2.0b1", "Indexing:Connection", "persistent_connections: false", " \
If set to true, when servers make it possible, htdig can take advantage \
of persistent connections, as defined by HTTP/1.1 (RFC2616). This permits \
to reduce the number of open/close operations of connections, when retrieving \
a document with HTTP. \
" }, \
{ "plural_suffix", "s", \
"string", "htsearch", "", "3.2.0b2", "Presentation: Text", "plural_suffix: en", " \
Specifies the value of the PLURAL_MATCHES template \
variable used in the header, footer and template files. \
This can be used for localization for non-English languages \
where 's' is not the appropriate suffix. \
" }, \
{ "prefix_match_character", "*", \
"string", "htsearch", "", "3.1.0b1", "Searching:Method", "prefix_match_character: ing", " \
A null prefix character means that prefix matching should be \
applied to every search word. Otherwise prefix matching is \
done on any search word ending with the characters specified \
in this string, with the string being stripped off before \
looking for matches. The \"prefix\" algorithm must be enabled \
in search_algorithm \
for this to work. You may also want to set the max_prefix_matches and minimum_prefix_length attributes \
to get it working as you want.
As a special case, in version \
3.1.6 and later, if this string is non-null and is entered alone \
as a search word, it is taken as a wildcard that matches all \
documents in the database. If this string is null, the wildcard \
for this special case will be *. This wildcard \
doesn't require the prefix algorithm to be enabled. \
" }, \
{ "prev_page_text", "[prev]", \
"string", "htsearch", "", "3.0", "Presentation:Text", "prev_page_text: <img src=\"/htdig/buttonl.gif\">", " \
The text displayed in the hyperlink to go to the \
previous page of matches. \
" }, \
{ "regex_max_words", "25", \
"integer", "htsearch", "", "3.2.0b1", "Searching:Method", "regex_max_words: 10", " \
The \"regex\" fuzzy algorithm \
could potentially match a \
very large number of words. This value limits the \
number of words each regular expression can match. Note \
that this does not limit the number of documents that \
are matched in any way. \
" }, \
{ "remove_bad_urls", "true", \
"boolean", "htpurge", "Server", "all", "Indexing:How", "remove_bad_urls: true", " \
If TRUE, htpurge will remove any URLs which were marked \
as unreachable by htdig from the database. If FALSE, it \
will not do this. When htdig is run in initial mode, \
documents which were referred to but could not be \
accessed should probably be removed, and hence this \
option should then be set to TRUE, however, if htdig is \
run to update the database, this may cause documents on \
a server which is temporarily unavailable to be \
removed. This is probably NOT what was intended, so \
hence this option should be set to FALSE in that case. \
" }, \
{ "remove_default_doc", "index.html", \
"string list", "htdig", "", "3.1.0", "Indexing:How", "remove_default_doc: default.html default.htm index.html index.htm", " \
Set this to the default documents in a directory used by the \
servers you are indexing. These document names will be stripped \
off of URLs when they are normalized, if one of these names appears \
after the final slash, to translate URLs like \
http://foo.com/index.html into http://foo.com/
\
Note that you can disable stripping of these names during \
normalization by setting the list to an empty string. \
The list should only contain names that all servers you index \
recognize as default documents for directory URLs, as defined \
by the DirectoryIndex setting in Apache's srm.conf, for example. \
This does not apply to file:/// or ftp:// URLS. \
See also local_default_doc. \
" }, \
{ "remove_unretrieved_urls", "false", \
"boolean", "htpurge", "Server", "3.2.0b1", "Indexing:How", "remove_unretrieved_urls: true", " \
If TRUE, htpurge will remove any URLs which were discovered \
and included as stubs in the database but not yet retrieved. If FALSE, it \
will not do this. When htdig is run in initial mode with no restrictions \
on hopcount or maximum documents, these should probably be removed and set \
to true. However, if you are hoping to index a small set of documents and \
eventually get to the rest, you should probably leave this as false. \
" }, \
{ "restrict", "", \
"pattern list", "htsearch", "", "3.2.0b4", "Searching:Method", "restrict: http://www.acme.com/widgets/", " \
This specifies a set of patterns that all URLs have to \
match against in order for them to be included in the search \
results. Any number of strings can be specified, separated by \
spaces. If multiple patterns are given, at least one of the \
patterns has to match the URL. The list can be specified \
from within the configuration file, and can be overridden \
with the \"restrict\" input parameter in the search form. Note \
that the restrict list does not take precedence over the \
exclude list - if a URL matches patterns \
in both lists it is still excluded from the search results. \
To restrict URLs in htdig, use \
limit_urls_to. \
" }, \
{ "robotstxt_name", "htdig", \
"string", "htdig", "Server", "3.0.7", "Indexing:Out", "robotstxt_name: myhtdig", " \
Sets the name that htdig will look for when parsing \
robots.txt files. This can be used to make htdig appear \
as a different spider than ht://Dig. Useful to \
distinguish between a private and a global index. \
" }, \
{ "script_name", "", \
"string", "htsearch", "", "3.1.4", "Presentation:Text", "script_name: /search/results.shtml", " \
Overrides the value of the SCRIPT_NAME \
environment attribute. This is useful if \
htsearch is not being called directly as a CGI \
program, but indirectly from within a dynamic \
.shtml page using SSI directives. Previously, \
you needed a wrapper script to do this, but \
this configuration attribute makes wrapper \
scripts obsolete for SSI and possibly for \
other server scripting languages, as \
well. (You still need a wrapper script when \
using PHP, though.)
\
Check out the contrib/scriptname \
directory for a small example. Note that this \
attribute also affects the value of the CGI variable \
used in htsearch templates. \
" }, \
{ "search_algorithm", "exact:1", \
"string list", "htsearch", "", "all", "Searching:Method", "search_algorithm: exact:1 soundex:0.3", " \
Specifies the search algorithms and their weight to use \
when searching. Each entry in the list consists of the \
algorithm name, followed by a colon (:) followed by a \
weight multiplier. The multiplier is a floating point \
number between 0 and 1. Note that depending on your \
locale setting, and whether your \
system's locale implementation affects floating point \
input, you may need to specify the decimal point as a \
comma rather than a period.
\
Note:If the exact \
method is not listed, the search may not work since the \
original terms will not be used.
\
Current algorithms supported are: \
\
\
" }, \
{ "search_results_contenttype", "text/html", \
"string", "htsearch", "", "all", "Presentation:Files", "search_results_contenttype: text/xml", " \
This specifies a Content-type to be output as an HTTP header \
at the start of search results. If set to an empty string, \
the Content-type header will be omitted altogether. \
" },
{ "search_results_footer", "${common_dir}/footer.html", \
"string", "htsearch", "", "all", "Presentation:Files", "search_results_footer: /usr/local/etc/ht/end-stuff.html", " \
This specifies a filename to be output at the end of \
search results. While outputting the footer, some \
variables will be expanded. Variables use the same \
syntax as the Bourne shell. If there is a variable VAR, \
the following will all be recognized: \
\
\
The following variables are available. See \
hts_template.html for a complete \
list. \
\
\
Note that this file will NOT be output \
if no matches were found. In this case the \
nothing_found_file \
attribute is used instead. \
Also, this file will not be output if it is \
overridden by defining the \
search_results_wrapper \
attribute. \
" }, \
{ "search_results_header", "${common_dir}/header.html", \
"string", "htsearch", "", "all", "Presentation:Files", "search_results_header: /usr/local/etc/ht/start-stuff.html", " \
This specifies a filename to be output at the start of \
search results. While outputting the header, some \
variables will be expanded. Variables use the same \
syntax as the Bourne shell. If there is a variable VAR, \
the following will all be recognized: \
\
\
The following variables are available. See \
hts_template.html for a complete \
list. \
\
\
\
Note that this file will NOT be output \
if no matches were found. In this case the \
nothing_found_file \
attribute is used instead. \
Also, this file will not be output if it is \
overridden by defining the \
search_results_wrapper \
attribute. \
" }, \
{ "search_results_order", "", \
"string list", "htsearch", "", "3.2.0b2", "Searching:Ranking", "search_results_order: \
/docs/|faq.html * /maillist/ /testresults/", " \
This specifies a list of patterns for URLs in \
search results. Results will be displayed in the \
specified order, with the search algorithm result \
as the second order. Remaining areas, that do not \
match any of the specified patterns, can be placed \
by using * as the pattern. If no * is specified, \
one will be implicitly placed at the end of the \
list.
\
See also url_seed_score. \
" }, \
{ "search_results_wrapper", "", \
"string", "htsearch", "", "3.1.0", "Presentation:Files", "search_results_wrapper: ${common_dir}/wrapper.html", " \
This specifies a filename to be output at the start and \
end of search results. This file replaces the \
search_results_header and \
search_results_footer \
files, with the contents of both in one file, and uses the \
pseudo-variable $(HTSEARCH_RESULTS) as a \
separator for the header and footer sections. \
If the filename is not specified, the file is unreadable, \
or the pseudo-variable above is not found, htsearch reverts \
to the separate header and footer files instead. \
While outputting the wrapper, \
some variables will be expanded, just as for the \
search_results_header and \
search_results_footer \
files.
\
Note that this file will NOT be output \
if no matches were found. In this case the \
nothing_found_file \
attribute is used instead. \
" }, \
{ "search_rewrite_rules", "",
"string list", "htsearch", "", "3.1.6", "URLs", "search_rewrite_rules: http://(.*)\\\\.mydomain\\\\.org/([^/]*) http://\\\\2.\\\\1.com \\
\
http://www\\\\.myschool\\\\.edu/myorgs/([^/]*) http://\\\\1.org", " \
This is a list of pairs, regex replacement, used \
to rewrite URLs in the search results. The left hand string is a \
regular expression; the right hand string is a literal string with \
embedded placeholders for fragments that matched inside brackets in \
the regular expression. \\0 is the whole matched string, \\1 to \\9 \
are bracketted substrings. The backslash must be doubled-up in the \
attribute setting to get past the variable expansion parsing. Rewrite \
rules are applied sequentially to each URL before it is displayed \
or checked against the restrict or \
exclude lists. Rewriting does not stop once a \
match has been made, so multiple rules may affect a given URL. See \
also url_part_aliases which allows \
URLs to be of one form during indexing and translated for results, \
and url_rewrite_rules which allows \
URLs to be rewritten while indexing. \
" },
{ "server_aliases", "", \
"string list", "htdig", "", "3.1.0b2", "Indexing:Where", "server_aliases: \
foo.mydomain.com:80=www.mydomain.com:80 \\
\
bar.mydomain.com:80=www.mydomain.com:80 \
", " \
This attribute tells the indexer that servers have several \
DNS aliases, which all point to the same machine and are NOT \
virtual hosts. This allows you to ensure pages are indexed \
only once on a given machine, despite the alias used in a URL. \
As shown in the example, the mapping goes from left to right, \
so the server name on the right hand side is the one that is \
used. As of version 3.1.3, the port number is optional, and is \
assumed to be 80 if omitted. There is no easy way to map all \
ports from one alias to another without listing them all. \
" }, \
{ "server_max_docs", "-1", \
"integer", "htdig", "Server", "3.1.0b3", "Indexing:Where", "server_max_docs: 50", " \
This attribute tells htdig to limit the dig to retrieve a maximum \
number of documents from each server. This can cause \
unusual behavior on update digs since the old URLs are \
stored alphabetically. Therefore, update digs will add \
additional URLs in pseudo-alphabetical order, up to the \
limit of the attribute. However, it is most useful to \
partially index a server as the URLs of additional \
documents are entered into the database, marked as never \
retrieved.
\
A value of -1 specifies no limit. \
" }, \
{ "server_wait_time", "0", \
"integer", "htdig", "Server", "3.1.0b3", "Indexing:Connection", "server_wait_time: 20", " \
This attribute tells htdig to ensure a server has had a \
delay (in seconds) from the beginning of the last \
connection. This can be used to prevent \"server abuse\" \
by digging without delay. It's recommended to set this \
to 10-30 (seconds) when indexing servers that you don't \
monitor yourself. Additionally, this attribute can slow \
down local indexing if set, which may or may not be what \
you intended. \
" }, \
{ "sort", "score", \
"string", "htsearch", "", "3.1.0", "Presentation:How", "sort: revtime", " \
This is the default sorting method that htsearch \
uses to determine the order in which matches are displayed. \
The valid choices are: \
\
\
This attribute will only be used if the HTML form that \
calls htsearch didn't have the sort \
value set. The words date and revdate can be used instead \
of time and revtime, as both will sort by the time that \
the document was last modified, if this information is \
given by the server. The default is to sort by the score, \
which ranks documents by best match. The sort methods that \
begin with \"rev\" simply reverse the order of the \
sort. Note that setting this to something other than \
\"score\" will incur a slowdown in searches. \
" }, \
{ "sort_names", "score Score time Time title Title revscore 'Reverse Score' revtime 'Reverse Time' revtitle 'Reverse Title'", \
"quoted string list", "htsearch", "", "3.1.0", "Searching:UI", "sort_names: \
score 'Best Match' time Newest title A-Z \\ \
\
\
\
\
\
\
\
\
\
\
revscore 'Worst Match' revtime Oldest revtitle Z-A \
", " \
These values are used to create the \
sort menu. It consists of pairs. The first \
element of each pair is one of the known sort methods, the \
second element is the text that will be shown in the \
menu for that sort method. This text needs to be quoted if \
it contains spaces. \
See the select list documentation \
for more information on how this attribute is used. \
" }, \
{ "soundex_db", "${database_base}.soundex.db", \
"string", "htfuzzy htsearch", "", "all", "File Layout", "soundex_db: ${database_base}.snd.db", " \
The database file used for the fuzzy \"soundex\" search \
algorithm. This database is created by \
htfuzzy and used by \
htsearch. \
" }, \
{ "star_blank", "${image_url_prefix}/star_blank.gif", \
"string", "htsearch", "", "all", "Presentation:Text", "star_blank: http://www.somewhere.org/icons/noelephant.gif", " \
This specifies the URL to use to display a blank of the \
same size as the star defined in the \
star_image attribute or in the \
star_patterns attribute. \
" }, \
{ "star_image", "${image_url_prefix}/star.gif", \
"string", "htsearch", "", "all", "Presentation:Text", "star_image: http://www.somewhere.org/icons/elephant.gif", " \
This specifies the URL to use to display a star. This \
allows you to use some other icon instead of a star. \
(We like the star...)
\
The display of stars can be turned on or off with the \
use_star_image \
attribute and the maximum number of stars that can be \
displayed is determined by the \
max_stars attribute.
\
Even though the image can be changed, the ALT value \
for the image will always be a '*'. \
" }, \
{ "star_patterns", "", \
"string list", "htsearch", "", "3.0", "Presentation:How", "star_patterns: \
http://www.sdsu.edu /sdsu.gif \\
\
http://www.ucsd.edu /ucsd.gif \
", " \
This attribute allows the star image to be changed \
depending on the URL or the match it is used for. This \
is mainly to make a visual distinction between matches \
on different web sites. The star image could be \
replaced with the logo of the company the match refers \
to.
\
It is advisable to keep all the images the same size \
in order to line things up properly in a short result \
listing.
\
The format is simple. It is a list of pairs. The first \
element of each pair is a pattern, the second element \
is a URL to the image for that pattern. \
" }, \
{ "startday", "", \
"integer", "htsearch", "", "3.1.6", "Searching:Method", "startday: 1", " \
Day component of first date allowed as last-modified date \
of returned docutments. \
This is most usefully specified as a \
GCI argument. \
See also startyear. \
" }, \
{ "start_ellipses", "... ", \
"string", "htsearch", "", "all", "Presentation:Text", "start_ellipses: ...", " \
When excerpts are displayed in the search output, this \
string will be prepended to the excerpt if there is \
text before the text displayed. This is just a visual \
reminder to the user that the excerpt is only part of \
the complete document. \
" }, \
{ "start_highlight", "", \
"string", "htsearch", "", "3.1.4", "Presentation:Text", "start_highlight: <font color=\"#FF0000\">", " \
When excerpts are displayed in the search output, matched \
words will be highlighted using this string and \
end_highlight. \
You should ensure that highlighting tags are balanced, \
that is, any formatting tags that this string \
opens should be closed by end_highlight. \
" }, \
{ "startmonth", "", \
"integer", "htsearch", "", "3.1.6", "Searching:Method", "startmonth: 1", " \
Month component of first date allowed as last-modified date \
of returned docutments. \
This is most usefully specified as a \
GCI argument. \
See also startyear. \
" }, \
{ "start_url", "http://www.htdig.org/", \
"string list", "htdig", "", "all", "Indexing:Where", "start_url: http://www.somewhere.org/alldata/index.html", " \
This is the list of URLs that will be used to start a \
dig when there was no existing database. Note that \
multiple URLs can be given here. \
Note also that the value of start_url \
will be the default value for \
limit_urls_to, so if \
you set start_url to the URLs for specific files, \
rather than a site or subdirectory URL, you may need \
to set limit_urls_to to something less restrictive \
so htdig doesn't reject links in the documents. \
" }, \
{ "startyear", "", \
"integer", "htsearch", "", "3.1.6", "Searching:Method", "startyear: 2001", " \
This specifies the year of the cutoff start date for \
search results. If the start or end date are specified, \
only results with a last modified date within this \
range are shown. If a start or end date is specified, but startyear \
is not, then it defaults to 1970. \
See also startday, \
startmonth, \
endday, \
endmonth, \
endyear. \
These are most usefully specified as a \
GCI argument.
\
For each component, if a negative number is given, \
it is taken as relative to the current date. \
Relative days can span several months or even years if desired, \
and relative months can span several years. A startday of \
-90 will select matching documents modified within \
the last 90 days. \
" }, \
{ "store_phrases", "true", \
"boolean", "htdig", "", "3.2.0b5", "Indexing:How", "startyear: false", " \
Causes htdig to record all occurrences of each word in a document, \
to allow accurate phrase searches. If this is false, only the first \
occurrence of each word will be stored, causing many phrases to be \
missed. Setting this false increases indexing speed by about 20%, \
and reduces disk requirements by about 60%.\
" }, \
{ "substring_max_words", "25", \
"integer", "htsearch", "", "3.0.8b1", "Searching:Method", "substring_max_words: 100", " \
The Substring fuzzy algorithm \
could potentially match a \
very large number of words. This value limits the \
number of words each substring pattern can match. Note \
that this does not limit the number of documents that \
are matched in any way. \
" }, \
{ "synonym_db", "${common_dir}/synonyms.db", \
"string", "htsearch htfuzzy", "", "3.0", "File Layout", "synonym_db: ${database_base}.syn.db", " \
Points to the database that \
htfuzzy creates when the synonyms \
algorithm is used.
\
htsearch \
uses this to perform synonym dictionary lookups. \
" }, \
{ "synonym_dictionary", "${common_dir}/synonyms", \
"string", "htfuzzy", "", "3.0", "File Layout", "synonym_dictionary: /usr/dict/synonyms", " \
This points to a text file containing the synonym \
dictionary used for the synonyms search algorithm.
\
Each line of this file has at least two words. The \
first word is the word to replace, the rest of the \
words are synonyms for that word. \
" }, \
{ "syntax_error_file", "${common_dir}/syntax.html", \
"string", "htsearch", "", "all", "Presentation:Files", "syntax_error_file: ${common_dir}/synerror.html", " \
This points to the file which will be displayed if a \
boolean expression syntax error was found. \
" }, \
{ "tcp_max_retries", "1", \
"integer", "htdig", "Server", "3.2.0b1", "Indexing:Connection", "tcp_max_retries: 6", " \
This option set the maximum number of attempts when a connection \
timeouts. \
After all these retries, the connection attempt results
\
Normal normal builtin-long \\
\
Detailed detail ${common_dir}/detail.html \
", " \
This maps match template names to internal names and \
template file names. It is a list of triplets. The \
first element in each triplet is the name that will be \
displayed in the FORMAT menu. The second element is the \
name used internally and the third element is a \
filename of the template to use.
\
There are two predefined templates, namely \
builtin-long and \
builtin-short. If the filename is one of \
those, they will be used instead.
\
More information about templates can be found in the \
htsearch \
documentation. The particular template is selecterd by the \
format cgi argument, and the \
default is given by template_name in \
the config file. \
" }, \
{ "template_name", "builtin-long", \
"string", "htsearch", "", "3.0", "Searching:UI,Presentation:How", "template_name: long", " \
Specifies the default template if no \
format field is given by the \
search form. This needs to map to the \
template_map. \
" }, \
{ "template_patterns", "", \
"string list", "htsearch", "", "3.1.4", "Presentation:How", "template_patterns: \
http://www.sdsu.edu ${common_dir}/sdsu.html \\
\
http://www.ucsd.edu ${common_dir}/ucsd.html \
", " \
This attribute allows the results template to be changed \
depending on the URL or the match it is used for. This \
is mainly to make a visual distinction between matches \
on different web sites. The results for each site could \
thus be shown in a style matching that site.
\
The format is simply a list of pairs. The first \
element of each pair is a pattern, the second element \
is the name of the template file for that pattern.
\
More information about templates can be found in the \
htsearch \
documentation.
\
Normally, when using this template selection method, you \
would disable user selection of templates via the format \
input parameter in search forms, as the two methods were not \
really designed to interact. Templates selected by URL patterns \
would override any user selection made in the form. If you want \
to use the two methods together, see the notes on \
combining \
them for an example of how to do this. \
" }, \
{ "text_factor", "1", \
"number", "htsearch", "", "3.0", "Searching:Ranking", "text_factor: 0", " \
This is a factor which will be used to multiply the \
weight of words that are not in any special part of a \
document. Setting a factor to 0 will cause normal words \
to be ignored. The number may be a floating point \
number. See also the heading_factor \
attribute. \
" }, \
{ "timeout", "30", \
"integer", "htdig", "Server", "all", "Indexing:Connection", "timeout: 42", " \
Specifies the time the digger will wait to complete a \
network read. This is just a safeguard against \
unforeseen things like the all too common \
transformation from a network to a notwork.
\
The timeout is specified in seconds. \
" }, \
{ "title_factor", "100", \
"number", "htsearch", "", "all", "Searching:Ranking", "title_factor: 12", " \
This is a factor which will be used to multiply the \
weight of words in the title of a document. Setting a \
factor to 0 will cause words in the title to be \
ignored. The number may be a floating point number. See \
also the \
heading_factor attribute. \
" }, \
{ "translate_latin1", "true", \
"boolean", "htdig htsearch", "", "3.2.0b5", "Indexing:What", "translate_latin1: false", " \
If set to false, the SGML entities for ISO-8859-1 (or \
Latin 1) characters above (or  ) \
will not be translated into their 8-bit equivalents. \
This attribute should be set to false when using a \
locale that doesn't use the \
ISO-8859-1 character set, to avoid these entities \
being mapped to inappropriate 8-bit characters, or \
perhaps more importantly to avoid 8-bit characters from \
your locale being mapped back to Latin 1 SGML entities \
in search results. \
" }, \
{ "url_list", "${database_base}.urls", \
"string", "htdig", "", "all", "Extra Output", "url_list: /tmp/urls", " \
This file is only created if \
create_url_list is set to \
true. It will contain a list of all URLs that were \
seen. \
" }, \
{ "url_log", "${database_base}.log", \
"string", "htdig", "", "3.1.0", "Extra Output", "url_log: /tmp/htdig.progress", " \
If htdig is \
interrupted, it will write out its progress to this \
file. Note that if it has a large number of URLs to write, \
it may take some time to exit. This can especially happen \
when running update digs and the run is interrupted soon \
after beginning. \
" }, \
{ "url_part_aliases", "", \
"string list", "all", "", "3.1.0", "URLs", "url_part_aliases: \
http://search.example.com/~htdig *site \\
\
http://www.htdig.org/this/ *1 \\
\
.html *2 \
url_part_aliases: \
http://www.htdig.org/ *site \\
\
http://www.htdig.org/that/ *1 \\
\
.htm *2 \
", " \
A list of translations pairs from and \
to, used when accessing the database. \
If a part of an URL matches with the \
from-string of each pair, it will be \
translated into the to-string just before \
writing the URL to the database, and translated \
back just after reading it from the database.
\
This is primarily used to provide an easy way to \
rename parts of URLs for e.g. changing \
www.example.com/~htdig to www.htdig.org. Two \
different configuration files for digging and \
searching are then used, with url_part_aliases \
having different from strings, but \
identical to-strings.
\
See also common_url_parts.
\
Strings that are normally incorrect in URLs or \
very seldom used, should be used as \
to-strings, since extra storage will be \
used each time one is found as normal part of a \
URL. Translations will be performed with priority \
for the leftmost longest match. Each \
to-string must be unique and not be a \
part of any other to-string. It also helps \
to keep the to-strings short to save space \
in the database. Other than that, the choice of \
to-strings is pretty arbitrary, as they \
just provide a temporary, internal encoding in the \
databases, and none of the characters in these \
strings have any special meaning.
\
Note that when this attribute is changed, the \
database should be rebuilt, unless the effect of \
\"moving\" the affected URLs in the database is \
wanted, as described above.
\
Please note: Don't just copy the \
example below into a single configuration file. \
There are two separate settings of \
url_part_aliases below; the first one is \
for the configuration file to be used by htdig, \
htmerge, and htnotify, and the second one is for the \
configuration file to be used by htsearch. \
In this example, htdig will encode the URL \
\"http://search.example.com/~htdig/contrib/stuff.html\" \
as \"*sitecontrib/stuff*2\" in the databases, and \
htsearch will decode it as \
\"http://www.htdig.org/contrib/stuff.htm\".
\
As of version 3.1.6, you can also do more complex \
rewriting of URLs using \
url_rewrite_rules and \
search_rewrite_rules. \
" }, \
{ "url_rewrite_rules", "", \
"string list", "htdig", "", "3.2.0b3", "URLs", "url_rewrite_rules: (.*)\\\\?JServSessionIdroot=.* \\\\1 \\
\
(.*)\\\\&JServSessionIdroot=.* \\\\1 \\
\
(.*)&context=.* \\\\1
", " \
This is a list of pairs, regex replacement used to \
permanently rewrite URLs as they are indexed. The left hand string is \
a regular expression; the right hand string is a literal string with \
embedded placeholders for fragments that matched inside brackets in \
the regex. \\0 is the whole matched string, \\1 to \\9 are bracketted \
substrings. Note that the entire URL is replaced by \
the right hand string (not just the portion which matches the left hand\
string). Thus, a leading and trailing (.*) should be included in the \
pattern, with matching placeholders in the replacement string.
\
Rewrite rules are applied sequentially to each \
incoming URL before normalization occurs. Rewriting does not stop \
once a match has been made, so multiple rules may affect a given URL. \
See also url_part_aliases which \
allows URLs to be of one \
form during indexing and translated for results. \
"}, \
{ "url_seed_score", "", \
"string list", "htsearch", "", "3.2.0b2", "Searching::Ranking", "url_seed_score: \
/mailinglist/ *.5-1e6
\
/docs/|/news/ *1.5
\
/testresults/ "*.7 -200"
\
/faq-area/ *2+10000", " \
This is a list of pairs, pattern \
formula, used to weigh the score of \
hits, depending on the URL of the document.
\
The pattern part is a substring to match \
against the URL. Pipe ('|') characters can be \
used in the pattern to concatenate substrings for \
web-areas that have the same formula.
\
The formula describes a factor and a \
constant, by which the hit score is \
weighed. The factor part is multiplied \
to the original score, then the constant \
part is added.
\
The format of the formula is the factor part: \
"*N" optionally followed by comma and \
spaces, followed by the constant part : \
"+M", where the plus sign may be emitted \
for negative numbers. Either part is optional, \
but must come in this order.
\
The numbers N and M are floating \
point constants.
\
More straightforward is to think of the format as \
"newscore = oldscore*N+M", \
but with the "newscore = oldscore" part left out. \
" }, \
{ "url_text_factor", "1", \
"number", "htsearch", "", "??", "Searching:Ranking", "url_text_factor: 1", " \
TO BE COMPLETED
\
See also heading_factor. \
" }, \
{ "use_doc_date", "false", \
"boolean", "htdig", "", "3.2.0b1", "Indexing:How", "use_doc_date: true", " \
If set to true, htdig will use META date tags in documents, \
overriding the modification date returned by the server. \
Any documents that do not have META date tags will retain \
the last modified date returned by the server or found on \
the local file system. \
As of version 3.1.6, in addition to META date tags, htdig will also \
recognize dc.date, dc.date.created and dc.date.modified. \
" }, \
{ "use_meta_description", "false", \
"boolean", "htsearch", "", "3.1.0b1", "Presentation:How", "use_meta_description: true", " \
If set to true, any META description tags will be used as \
excerpts by htsearch. Any documents that do not have META \
descriptions will retain their normal excerpts. \
" }, \
{ "use_star_image", "true", \
"boolean", "htsearch", "", "all", "Presentation:How", "use_star_image: no", " \
If set to true, the \
star_image attribute is used to display upto \
max_stars images for \
each match. \
" }, \
{ "user_agent", "htdig", \
"string", "htdig", "Server", "3.1.0b2", "Indexing:Out", "user_agent: htdig-digger", " \
This allows customization of the user_agent: field sent when \
the digger requests a file from a server. \
" }, \
{ "valid_extensions", "", \
"string list", "htdig", "URL", "3.1.4", "Indexing:Where", "valid_extensions: .html .htm .shtml", " \
This is a list of extensions on URLs which are \
the only ones considered acceptable. This list is used to \
supplement the MIME-types that the HTTP server provides \
with documents. Some HTTP servers do not have a correct \
list of MIME-types and so can advertise certain \
documents as text while they are some binary format. \
If the list is empty, then all extensions are acceptable, \
provided they pass other criteria for acceptance or rejection. \
If the list is not empty, only documents with one of the \
extensions in the list are parsed. \
See also bad_extensions. \
" }, \
{ "valid_punctuation", ".-_/!#\\$%^&'", \
"string", "htdig htsearch", "", "all", "Indexing:What", "valid_punctuation: -'", " \
This is the set of characters which may be deleted \
from the document before determining what a word is. \
This means that if a document contains something like \
half-hearted the digger will see this as the three \
words half, hearted and \
halfhearted.
\
These characters are also removed before keywords are passed to the \
search engine, so a search for \"half-hearted\" works as expected.
\
Note that the dollar sign ($) and backslash (\\) must be escaped by a \
backslash in both valid_punctuation and extra_word_characters. \
Moreover, the backslash should not be the last character on the line. \
There is currently no way to include a back-quote (`) in \
extra_word_characters or valid_punctuation.
\
See also the \
extra_word_characters \
and allow_numbers \
attributes. \
" }, \
{ "version", VERSION, \
"string", "htsearch", "", "all", "Presentation:Text", "version: 3.2.0", " \
This specifies the value of the VERSION \
variable which can be used in search templates. \
The default value of this attribute is determined \
at compile time, and will not normally be set \
in configuration files. \
" }, \
{ "word_db", "${database_base}.words.db", \
"string", "all", "", "all", "File Layout", "word_db: ${database_base}.allwords.db", " \
This is the main word database. It is an index of all \
the words to a list of documents that contain the \
words. This database can grow large pretty quickly. \
" }, \
{ "word_dump", "${database_base}.worddump", \
"string", "htdig htdump htload", "", "3.2.0b1", "File Layout", "word_dump: /tmp/words.txt", " \
This file is basically a text version of the file \
specified in word_db. Its \
only use is to have a human readable database of all \
words. The file is easy to parse with tools like \
perl or tcl. \
" }, \
{ "wordlist_cache_inserts", "false", \
"boolean", "???", "", "???", "Indexing:How", "wordlist_cache_inserts: true", " \
If true, create a cache of size wordlist_cache_size/2 for class \
WordListOne. I don't know what this is for. Does anyone? \
" }, \
{ "wordlist_cache_size", "10000000", \
"integer", "all", "", "3.2.0b1", "Indexing:How", "wordlist_cache_size: 40000000", " \
Size (in bytes) of memory cache used by Berkeley DB (DB used by the indexer) \
IMPORTANT: It makes a huge difference. The rule \
is that the cache size should be at least 2% of the expected index size. The \
Berkeley DB file has 1% of internal pages that must be cached for good \
performances. Giving an additional 1% leaves room for caching leaf pages. \
" }, \
{ "wordlist_compress", "true", \
"boolean", "all", "", "3.2.0b1", "Indexing:How", "wordlist_compress: false", " \
Enables or disables the default compression system for the indexer. \
This currently attempts to compress the index by a factor of 8. If the \
Zlib library is not found on the system, the default is false. \
" }, \
{ "wordlist_compress_zlib", "true", \
"boolean", "all", "", "3.2.0b4", "Indexing:How", "wordlist_compress_zlib: false", " \
Enables or disables the zlib compression system for the indexer. \
Both wordlist_compress and \
compression_level must be true \
(non-zero) to use this option!\
" }, \
{ "wordlist_monitor", "false", \
"boolean", "all", "", "3.2.0b1", "Extra Output", "wordlist_monitor: true", " \
This enables monitoring of what's happening in the indexer. \
It can help to detect performance/configuration problems. \
" }, \
{ "wordlist_monitor_period","0", \
"number", "all", "", "3.2.0b1", "Extra Output", "wordlist_monitor_period: .1", " \
Sets the number of seconds between each monitor output. \
" }, \
{ "wordlist_monitor_output","", \
"string", "all", "", "3.2.0b1", "Extra Output", "wordlist_monitor_output: myfile", " \
Print monitoring output on file instead of the default stderr. \
" },
{ "wordlist_page_size", "0", \
"integer", "all", "", "3.2.0b1", "Indexing:How", "wordlist_page_size: 8192", " \
Size (in bytes) of pages used by Berkeley DB (DB used by the indexer). \
Must be a power of two. \
" }, \
{ "wordlist_verbose", "", \
"integer", "", "", "", "", "wordlist_verbose: true", " \
wordlist_verbose 1 walk logic
\
wordlist_verbose 2 walk logic details
\
wordlist_verbose 2 walk logic lots of details
\
" }, \
{ "wordlist_wordkey_description", "Word/DocID 32/Flags 8/Location 16", \
"string", "all", "", "3.2.0b1", "Indexing:How", "**this should not be configured by user**", " \
Internal key description: *not user configurable* \
" }, \
{ "wordlist_wordrecord_description", "DATA", \
"string", "all", "", "3.2.0b1", "Indexing:How", "**this should not be configured by user**", " \
Internal data description: *not user configurable* \
" }, \
{0, 0, 0, 0, 0, 0, 0, 0, 0}
};
HtConfiguration config;