X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=873cc22cdca5d2102f27fc3731515c9e84048d3c;hp=d3dbfdef315330431bd1ccad142c558aea0decf4;hb=59af25aafd51b706ed67784aa84332965c31bb26;hpb=a974b581e7e351e36900ad9359c9f4271e8444ac diff --git a/adu.ggo b/adu.ggo index d3dbfde..873cc22 100644 --- a/adu.ggo +++ b/adu.ggo @@ -3,8 +3,7 @@ # Licensed under the GPL v2. For licencing details see COPYING. package "adu" -version "0.0.2" -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 @@ -25,61 +24,57 @@ details=" 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" -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. - -" 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 "uid" u -#~~~~~~~~~~~~~ -"user id(s) to take into account" -string typestr="uid_spec" -optional -multiple -details=" - An uid specifier may be a single number, or a range of uids. - Example: - - --uid 42 # only consider uid 42 - --uid 42- # only consider uids greater or equal than 42 - --uid 23-42 # only consider uids between 23 and 42, inclusively. +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. - This option may be given multiple times. An uid is taken into - account if it satisfies at least one --uid option. + 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. " +groupoption "database-dir" d +#~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"directory containing the osl tables" +group="database" +string typestr="path" +details=" + Full path to the directory containing the osl tables. This + 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 "paths" p -#~~~~~~~~~~~~~~~ -"files to take into account" -string typestr="pattern" +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=" - 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. + 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. " ############### @@ -89,10 +84,9 @@ section "Modes" defgroup "mode" #============== groupdesc=" - adu may be started in one of two possible modes, each of which - corresponds to a different command line option. Exactly one - of these options must be given. - + 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 @@ -101,10 +95,23 @@ 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 +#~~~~~~~~~~~~~~~~~~~~~~~~~~ +"activate interactive mode" +group="mode" +details=" + 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 @@ -112,8 +119,10 @@ groupoption "select" S "query a database previously created with --create" group="mode" details=" - This option prints statistics about matching subdirectories to - stdout. The output depends on the other options, see below. + This option prints statistics about matching subdirectories + 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. " ############################## @@ -124,14 +133,12 @@ option "base-dir" b #~~~~~~~~~~~~~~~~~~ "directory to traverse" 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 @@ -140,7 +147,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. " @@ -158,113 +165,50 @@ details=" users. Decreasing the value causes adu to use slightly less memory. " - -############################## -section "Options for --select" -############################## - -option "limit" L -#~~~~~~~~~~~~~~~ -"Limit output" -int typestr="num" -default="-1" -optional -dependon="select" -details=" - Only print num lines of output. If negative (the default), - print all lines. -" - -option "size-unit" - -#~~~~~~~~~~~~~~~~~~~ -"select output format for sizes" -enum typestr="format" -values="h","b","k","m","g","t" -default="h" -optional -dependon="select" -details=" - Print sizes in the given unit: human-readable, bytes, - kilobytes (2^10), megabytes (2^20), gigabytes (2^30), terabytes - (2^40). The default is \"h\", i.e. human-readable. -" - -option "count-unit" - -#~~~~~~~~~~~~~~~~~~~~ -"select output format for counted values" -enum typestr="format" -values="h","n","k","m","g","t" -default="h" +option "bloom-filter-order" B +#~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"use bloom filters for hard link detection" +int typestr="order" +dependon="create" +default="23" optional -dependon="select" -details=" - Print the number of files/directories in the given unit: - human-readable, number, number/10^3, number/10^6, number/10^12, - number/10^15. The default is to print numbers in human-readable - format. -" - -option "no-headers" - -#~~~~~~~~~~~~~~~~~~~~ -"supress descriptions for listings/tables" -flag off -dependon="select" details=" - This is mostly useful to feed the output of adu to scripts. -" + 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. -option "global-list" - -#~~~~~~~~~~~~~~~~~~~~~ -"how to print global directory listings" -enum typestr="which" -values="size","file_count","both","none" -default="both" -optional -dependon="select" -details=" - By default adu prints two global directory listings: The - first prints the directory names ordered by the sum of the - sizes of the contained files while the second listing prints - them sorted by the number of files. This option can be used - to print only one or neither of these two listings. + Values less than 10 deactivate this feature so that no hard + links are being detected. " -option "no-global-summary" - -#~~~~~~~~~~~~~~~~~~~~~~~~~~~ -"do not print the summary line" -flag off -dependon="select" - -option "user-list" - -#~~~~~~~~~~~~~~~~~~~ -"how to print per-user directory listings" -enum typestr="which" -values="size","file_count","both","none" -default="both" +option "num-bloom-filter-hash-functions" N +#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"number of hash functions for the bloom filters" +int typestr="num" +dependon="create" +default="10" optional -dependon="select" details=" - Similar to the global directory listings mentioned above, - adu can print two directory listings per user. This option - controls which of the these should be printed. + Cause each entry which is added to the bloom filter to set + \"num\" bits of the bloom filter. " -option "no-user-summary" - -#~~~~~~~~~~~~~~~~~~~~~~~~~~~ -"do not print the user summary table" -flag off -dependon="select" - +############################## +section "Options for --select" +############################## -option "user-summary-sort" - -#~~~~~~~~~~~~~~~~~~~~~~~~~~~ -"how to sort the user-summary" -enum typestr="col_spec" -values="name","uid","dir_count","file_count","size" -default="size" +option "select-options" s +#~~~~~~~~~~~~~~~~~~~~~~~~~ +"Options for select mode" +string typestr="" optional dependon="select" details=" - It is enough to specify the first letter of the column specifier, - e.g. \"--user-summary-sort f\" sorts by file count. + 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 use + quotes to prevent the select options from being interpreted + as adu options, or via the \"set\" command in interactive mode. "