-# Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
+# Copyright (C) 2008 Andre Noll <maan@tuebingen.mpg.de>
#
# Licensed under the GPL v2. For licencing details see COPYING.
section "General options"
#########################
-option "config-file" c
-#~~~~~~~~~~~~~~~~~~~~~
-"(default='~/.adurc')"
-string typestr="filename"
+option "loglevel" l
+#~~~~~~~~~~~~~~~~~~
+"Set loglevel (0-6)"
+int typestr="level"
+default="4"
optional
details="
- Options may be given at the command line or in the
- configuration file. As usual, if an option is given both at
- the command line and in the configuration file, the command
- line option takes precedence.
+ Log messages are always written to stderr while normal output
+ goes to stdout. Lower values mean more verbose logging.
+"
+
+defgroup "database"
+#==================
+groupdesc="
+ There are two ways to specify a database directory. You can either
+ specify a full path using the database-dir option or a root path
+ using the database-root option. In the latter case, a directory
+ structure matching that of the base-dir argument is created
+ below the given full path.
+
+ The advantage of using database-root is that the base-dir is
+ used to find the relevant database both in create and select mode
+ and you do not have to care for setting the database-dir explicitly.
"
-option "database-dir" d
-#~~~~~~~~~~~~~~~~~~~~~~
+groupoption "database-dir" d
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~
"directory containing the osl tables"
+group="database"
string typestr="path"
-required
details="
Full path to the directory containing the osl tables. This
- directory must exist. It must be writable for the user running
- adu in --create mode and readable in --select mode.
-
+ directory is created if it does not exist. It must be writable for the
+ user running adu in --create mode and readable in --select mode.
"
-option "loglevel" l
-#~~~~~~~~~~~~~~~~~~
-"Set loglevel (0-6)"
-int typestr="level"
-default="4"
+
+groupoption "database-root" r
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"directory containing directories containing the osl tables"
+group="database"
+string typestr="path"
+default="/var/lib/adu"
+dependon="base-dir"
optional
details="
- Log messages are always written to stderr while normal output
- goes to stdout. Lower values mean more verbose logging.
+ Base path to the directory containing the osl tables. The real
+ database-dir is generated by appending base-dir. This
+ directory is created if it does not exist. When used in select
+ mode you have to specify the base-dir as well.
"
###############
adu may be started in one of three possible modes, each of
which corresponds to a different command line option. Exactly
one of these options must be given.
-
"
required
#~~~~~~~~~~~~~~~~~~
"directory to traverse"
string typestr="path"
-dependon="create"
optional
details="
The base directory to be traversed recursively. A warning
users. Decreasing the value causes adu to use slightly less memory.
"
+option "bloom-filter-order" B
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"use bloom filters for hard link detection"
+int typestr="order"
+dependon="create"
+default="23"
+optional
+details="
+ Allocate bloom filters of size 2^order bits. Each regular
+ file with hard link count greater than one is added to these
+ filters which allows to detect hard links on a per-user basis.
+ Greater values reduce the probability of false positives but
+ require more memory.
+
+ Values less than 10 deactivate this feature so that no hard
+ links are being detected.
+"
+
+option "num-bloom-filter-hash-functions" N
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"number of hash functions for the bloom filters"
+int typestr="num"
+dependon="create"
+default="10"
+optional
+details="
+ Cause each entry which is added to the bloom filter to set
+ \"num\" bits of the bloom filter.
+"
+
##############################
section "Options for --select"
##############################