NAME
wnindexmaker - produce index to a set of HTML files for wn HTTP server
SYNOPSIS
wnindexmaker [-t title] [-d directory] [-o out_file] words_file
DESCRIPTION
wnindexmaker is a perl(1) program that is part of the wn(1) HTTP server package. It produces an index (in the usual sense not the wn(1) sense) for a virtual document consisting of a number of HTML files in a single directory. The index is placed in an output file which contains a list of anchors, one for each word in the words file. Each word is linked to a context search for itself. The index to the manual http:/doc/wn/docindex.html is a good example of how an index produced by wnindexmaker works.
words_file is the final argument to the wnindexmaker program. It is a list of words or phrases, in alphabetical order, one per line, which you wish to appear in the index. One way to produce it is to use UNIX utilities to produce a list of all words in the files, then run sort(1) -dfu on it and remove unsuitable words from the list.
OPTIONS
- -d directory
-
The directory containing the files being indexed. It should either begin with a '/' and be relative to the wn(1) root directory or not begin with a '/' and be relative to the directory which will contain the output file. If this option is not used then the output file must reside in the same directory as the files being indexed. If this is done then it is a good idea to add an "Attribute=nosearch" to the output file record in the index file for the directory. Otherwise the output file will index itself in addition to the other files in the directory.
- -o out_file
-
Sets the name of the output HTML documentation file to out_file. The default is docindex.html.
- -t title
-
Sets the title of the output HTML document to title. The default is "Index".
FILES
- out_file
-
Output of the wnindexmaker program.
- words_file
-
Input to the wnindexmaker program.
SEE ALSO
sort(1), wn(1), wn_mkdigest(1), wn_uncache(1), wndex(1), wnpnuts(1), wnauth(3), wncat(3), wnhtmlify(3), wnredir(3), wnsectsearch(3), wnseven_m(3), wn_md5passwd(8), wn_mkpasswd(8), wnconfig(8), wnd(8), wnsd(8), wnupdatewww(8), wnv2c(8)
http:/doc/wn/utility.html
http:/doc/wn/manual.html
http://hopf.math.nwu.edu/
AUTHOR
wn is written by John Franks <[email protected]>. Modified by Jean Pierre LeJacq <[email protected]> as part of packaging for the Debian GNU/Linux distribution. Manual page also added by Jean Pierre LeJacq.