X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=a180f1fc43e546e1d8c789cfb45678f01aeff0cc;hp=4c9b4febaf64e54140729950819bf377e7b80c42;hb=0194c573c16dce254095636e303d9cda80898025;hpb=6b77f83065f5176b43e2824b0b208499e11b373e diff --git a/adu.ggo b/adu.ggo index 4c9b4fe..a180f1f 100644 --- a/adu.ggo +++ b/adu.ggo @@ -3,7 +3,7 @@ # Licensed under the GPL v2. For licencing details see COPYING. package "adu" -purpose "advanced disk usage +purpose " adu creates a database containing disk usage statistics of a given directory. It allows to query that database to quickly retrieve @@ -14,19 +14,6 @@ usage patterns of subdirectories and/or files owned by a given user id. section "General options" ######################### -option "config-file" c -#~~~~~~~~~~~~~~~~~~~~~ -"(default='~/.adurc')" -string typestr="filename" -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. - -" - option "database-dir" d #~~~~~~~~~~~~~~~~~~~~~~ "directory containing the osl tables" @@ -42,26 +29,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" ############### @@ -81,10 +55,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 @@ -92,9 +66,12 @@ 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). + + In interactive mode, several subcommands are available, see + the end of this document. " groupoption "select" S @@ -103,8 +80,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. " ############################## @@ -118,11 +96,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 @@ -131,7 +108,7 @@ option "one-file-system" x flag off dependon="create" details=" - Skip directories that are on different filesystems from the + Skip directories that are on different file systems from the one that the argument being processed is on. " @@ -149,6 +126,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" ############################## @@ -161,8 +168,8 @@ optional dependon="select" details=" This option takes a string whose content is another set of - options as described below. Select options may be specified - either directly in select mode, in which case you have to quote - them to prevent them from being interpreted as adu options, - or via the \"set\" command in interactive mode. + 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. "