First draft of hard link detection via bloom filters.

[adu.git] / adu.ggo

diff --git a/adu.ggo b/adu.ggo
index bbca8712197007d217ae2468009080377994009d..84187eb19b7f52667242f9e882fe22872103bb14 100644 (file)
--- a/adu.ggo
+++ b/adu.ggo
@@ -138,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"
 ##############################
@@ -150,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.