# Copyright (C) 2008 Andre Noll # # Licensed under the GPL v2. For licencing details see COPYING. package "adu" version "0.0.1" purpose "advanced disk usage adu creates a database containing disk usage statistics of a given directory. It allows to query that database to quickly retrieve 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" 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" 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. This option may be given multiple times. An uid is taken into account if it satisfies at least one --uid option. " 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" ############### 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. " required 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. " 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. " ############################## section "Options for --create" ############################## option "base-dir" b #~~~~~~~~~~~~~~~~~~ "directory to traverse" string typestr="path" dependon="create" required details=" The base directory to be traversed recursively. 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. " option "one-file-system" x #~~~~~~~~~~~~~~~~~~~~~~~~~ "do not dive into other file systems" flag off dependon="create" details=" Skip directories that are on different filesystems from the one that the argument being processed is on. " ############################## 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 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" optional 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. "