Contents of /mitgcm.org/devel/buildweb/pkg/swish-e/conf/README

This "conf" directory contains example swish-e configuration settings.

In the "stopwords" directory are files that contain lists of common
stopwords for a few languages.  They can be selected with the IgnoreWords
configuration directive.  See SWISH-CONFIG.pod for more information.

Configuration examples:

Note: In many cases you may not need a configurataion file at all when indexing
with swish.  The configuration defaults should get you started.  The configuration
defaults can also be set when compiling swish-e by adjusting the settings in config.h.

For example, you can index a directory (and sub directories)
simply by calling swish as:

    swish-e -i .

In general, though, you will use a config file to specify the configuration parameters
to use while indexing:

    swish-e -c mysettings.config

If you are having problems indexing some files, you can specify a single file
on the command line which will override the IndexDir configuration setting in
your config file:

   swish-e -c mysettings.config -i test.html -f other.index

which will index with your settings, but only index one file, and write the index
to the file specified with the -f option.

The files included here are examples.  It is recommended that you create your own
configuration file as needed, only adding additional directives when you need to
change the default behavior.

If you are generating a number of indexes, then consider moving common configuration
directives into a single file, and then including that configuration file in
other configuration files.  See the IncludeConfig directive in the SWISH-CONFIG.pod
manual page.

Examples:

    example1.conf   - index only html files, plus
                      add labels to the index file
                      
    example2.conf   - include metanames in your index

    example3.conf   - add descriptive tags to your index

    example4.conf   - site-wide settings

    example5.conf   - Using "FileRules" to control
                      what gets indexed

    example6.conf   - spider using "prog" feature

    example7.conf   - spider using the "http" method of indexing

    example8.conf   - using "filters" to convert PDF files.

    example9.conf   - using the "prog" method for filtering
    example9.pl
1	This "conf" directory contains example swish-e configuration settings.
2
3	In the "stopwords" directory are files that contain lists of common
4	stopwords for a few languages. They can be selected with the IgnoreWords
5	configuration directive. See SWISH-CONFIG.pod for more information.
6
7	Configuration examples:
8
9	Note: In many cases you may not need a configurataion file at all when indexing
10	with swish. The configuration defaults should get you started. The configuration
11	defaults can also be set when compiling swish-e by adjusting the settings in config.h.
12
13	For example, you can index a directory (and sub directories)
14	simply by calling swish as:
15
16	swish-e -i .
17
18	In general, though, you will use a config file to specify the configuration parameters
19	to use while indexing:
20
21	swish-e -c mysettings.config
22
23	If you are having problems indexing some files, you can specify a single file
24	on the command line which will override the IndexDir configuration setting in
25	your config file:
26
27	swish-e -c mysettings.config -i test.html -f other.index
28
29	which will index with your settings, but only index one file, and write the index
30	to the file specified with the -f option.
31
32	The files included here are examples. It is recommended that you create your own
33	configuration file as needed, only adding additional directives when you need to
34	change the default behavior.
35
36	If you are generating a number of indexes, then consider moving common configuration
37	directives into a single file, and then including that configuration file in
38	other configuration files. See the IncludeConfig directive in the SWISH-CONFIG.pod
39	manual page.
40
41	Examples:
42
43	example1.conf - index only html files, plus
44	add labels to the index file
45
46	example2.conf - include metanames in your index
47
48	example3.conf - add descriptive tags to your index
49
50	example4.conf - site-wide settings
51
52	example5.conf - Using "FileRules" to control
53	what gets indexed
54
55	example6.conf - spider using "prog" feature
56
57	example7.conf - spider using the "http" method of indexing
58
59	example8.conf - using "filters" to convert PDF files.
60
61	example9.conf - using the "prog" method for filtering
62	example9.pl