/* -*- mode: c++ */
/*! \page DiskCacheConfigurationFile Configuration File For The Diskcache
\tableofcontents
This document describes the format of the configuration file that is
used by the diskcache command line utility.
\section DccfIntroduction Introduction
The configuration file has a simple syntax intended to make it easier
to pass large quantities of configuration information outside of the
standard command line arguments.

\section DccfVariables Variable Names
Variables have the form @<name@>=@<value@>.

<b>SERVER_PORT</b>
This is the port on which the server communicates.

<b>CONCURRENCY</b>
This is the maximum number of threads used during a scan.

<b>LOG</b>
The name of the file to store logging information.

<b>LOG_DIRECTORY</b>
The directory in which to write the LOG.

<b>OUTPUT_ASCII</b>
The name of the diskcache cache file in ASCII format.

<b>OUTPUT_ASCII_VERSION</b>
The version format to use when writing the ASCII cache file.

<b>OUTPUT_BINARY</b>
The name of the diskcache cache file in binary format.

<b>OUTPUT_BINARY_VERSION</b>
The version format to use when wriing the binary cache file.

\section DccfSection Section Names
Section have the form of [@<section name@>] on a single line with
the lines following being entries to associate with @<section name@>.
Sections are terminated by the naming of a new section.

<b>[EXTENSIONS]</b>
Each line represents a file extension of interest.
To be considered a match, the extension listed must be the right most
characters of the filename.
The extensions listed in this section must contain the period.

<b>[EXCLUDED_DIRECTORIES]</b>
Each line represents a directory name pattern to be excluded from the
cache.
The pattern may appear anywhere in the directory component of the file
being examined.

<b>[MOUNT_POINTS]</b>
Each line under this section is a root directory that should be
recursively scanned for files of interest.
Directories closer to the top will be preferred when searching for
files of interest.

\example diskcache.cfg.sample
*/
