WN home page

Version 2.5.0
[Previous] [Next] [Up] [Top] [Search] [Index]

Command Line Options for WN Server wndex Utility


These are the command line options for the wndex utility used to process index.wn files.

-a -- Serveall (mnemonic "all").

Using the -a option is equivalent to putting the directive Attributes=serveall at the beginning of the index.wn file (or files) being processed, with one important exception. If wndex is used with this option in a directory which contains no index.wn file, it will behave as if there were an index.wn file containing only the line Attributes=serveall. This allows the creation of an index.cache file permitting access to all files in a directory without first creating an index.wn file. This can be used with the -r option to grant access to a directory hierarchy without the need to create an index.wn file in each directory.

-c file_name -- Use "file_name" instead of "index.cache".

Causes wndex to write its output to the file "file_name" rather than the default "index.cache".

-d dir_name -- Process directory "dir_name".

When wndex is run with this option it will process the directory "dir_name" rather than the current directory. It will use the index.wn file in "dir_name" and write the file "dir_name/index.cache".

-i file_name -- Use "file_name" instead of "index.wn".

Causes wndex to read its input from the file "file_name" rather than the default "index.wn".

-q -- Use quiet mode.

Causes wndex to suppress any warning messages (except fatal errors) sent to UNIX stderr(3) stream as well as other informational messages.

-r -- Recursively process subdirectories.

Causes wndex to recursively descend through some subdirectories and process them as well. By default it processes only those subdirectories listed in the Subdirs= directory directive. However, this can be changed to be either all subdirectories or all subdirectories containing an index.wn file by use of the -s option. If the -r and -a are used together then the default is to use all subdirectories.

-s all|index -- Set the value of the Subdirs= directory directive automatically.

Using the "wndex -s index" command with an index.wn file containing no Subdirs= directory directive is equivalent to having such a directive whose value is a list of all subdirectories which contain an index.wn file. Using the "wndex -s all" command with an index.wn file containing no Subdirs= directory directive is equivalent to having such a directive whose value is a list of all subdirectories of the directory being processed. If the -r and -a are used together then "wndex -s all" is automatically assumed. This can be overridden by using a real Subdirs= directory directive or using "wndex -s index".

-v -- Use verbose mode.

Causes wndex to be extra verbose.

-V -- Print version.

Causes wndex to print its version and exit.

-x -- Use UNIX stdout(3) stream.

Causes wndex to read from the UNIX stdin(3) stream instead of the file index.wn and write to the UNIX stdout(3) stream rather than the file index.cache.


WN version 2.5.0
Copyright © 1998-2005 John Franks <john@math.northwestern.edu>
licensed under the GNU Free Documentation License
Last modified: Sat June 18 2005
[Previous] [Next] [Up] [Top] [Search] [Index]