Rename bloom_test_and_insert() to bloom_insert().

[adu.git] / adu.ggo

diff --git a/adu.ggo b/adu.ggo
index 8c23e3611f657ced1fca94635e2d82ff4faba490..84187eb19b7f52667242f9e882fe22872103bb14 100644 (file)
--- a/adu.ggo
+++ b/adu.ggo
@@ -41,26 +41,13 @@ option "loglevel" l
 #~~~~~~~~~~~~~~~~~~
 "Set loglevel (0-6)"
 int typestr="level"
-default="3"
+default="4"
 optional
 details="
        Log messages are always written to stderr while normal output
        goes to stdout. Lower values mean more verbose logging.
 "
 
-option "paths" p
-#~~~~~~~~~~~~~~~
-"files to take into account"
-string typestr="pattern"
-optional
-details="
-       Shell wildcard pattern that must match a file in order to be
-       included in the database in --create mode or in the output
-       for --select mode. Only the part of the filename below the
-       base directory is matched against the pattern. The default
-       is to take all files into account. See fnmatch(3) for details.
-"
-
 ###############
 section "Modes"
 ###############
@@ -80,10 +67,10 @@ groupoption "create" C
 "Create a new database"
 group="mode"
 details="
-       Traverse the given directory and track disk user on a per-user
-       basis. Results are stored in N + 1 osl tables where N is
-       the number of uids that own at least one regular file in
-       that directory.
+       Traverse the given directory and track disk usage on a
+       per-user basis. Results are stored in N + 1 osl tables where
+       N is the number of uids that own at least one regular file
+       in that directory.
 "
 
 groupoption "interactive" I
@@ -91,7 +78,7 @@ groupoption "interactive" I
 "activate interactive mode"
 group="mode"
 details="
-       In this mode, adu reads commands from stdin.  This makes it
+       In this mode, adu reads commands from stdin. This makes it
        possible to run different select queries without opening the
        underlying osl database for each query (which is expensive).
 
@@ -105,8 +92,9 @@ groupoption "select" S
 group="mode"
 details="
        This option prints statistics about matching subdirectories
-       to stdout. The output can be customized by specifying select
-       options, see below.
+       to stdout, to an output file or pipes the output to a given
+       command, depending on the --output option. The output format
+       can be customized by specifying select options, see below.
 "
 
 ##############################
@@ -120,11 +108,10 @@ string typestr="path"
 dependon="create"
 optional
 details="
-       The base directory to be traversed recursively. Must be
-       given if --create mode was selected. A warning message is
-       printed for each subdirectory that could not be read because
-       of insufficient permission. These directories will be ignored
-       when computing statistics.
+       The base directory to be traversed recursively. A warning
+       message is printed for each subdirectory that could not be
+       read because of insufficient permissions. These directories
+       will be ignored when computing statistics.
 "
 
 option "one-file-system" x
@@ -151,6 +138,36 @@ details="
        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"
 ##############################
@@ -163,7 +180,7 @@ optional
 dependon="select"
 details="
        This option takes a string whose content is another set of
-       options as described below.  Select options may be specified
+       options as described below. Select options may be specified
        either directly in select mode, in which case you have use
        quotes to prevent the select options from being interpreted
        as adu options, or via the \"set\" command in interactive mode.