X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=4c9b4febaf64e54140729950819bf377e7b80c42;hp=55e5c5aaeb7c4e63de6342c9257cb2e72e91ed7b;hb=6dc3d02ae5959a4ec5f3de4765d7440a580ff3e1;hpb=063c3ce425c76cc938b21de99a6e24086fc4b20a diff --git a/adu.ggo b/adu.ggo index 55e5c5a..4c9b4fe 100644 --- a/adu.ggo +++ b/adu.ggo @@ -69,9 +69,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 @@ -92,7 +92,9 @@ groupoption "interactive" I "activate interactive mode" group="mode" details=" - In this mode, adu reads commands from stdin. + 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). " groupoption "select" S @@ -100,8 +102,9 @@ 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. The output can be customized by specifying select + options, see below. " ############################## @@ -152,85 +155,14 @@ section "Options for --select" option "select-options" s #~~~~~~~~~~~~~~~~~~~~~~~~~ -"options for select mode" +"Options for select mode" string typestr="" optional dependon="select" details=" - Try --select-options \"-h\" -" - -option "print-base-dir" - -#~~~~~~~~~~~~~~~~~~~~~~~~ -"whether to include the base-dir in the output" -flag off -details=" - If this flag is given, all directories printed are prefixed - with the base directory. The default is to print paths relative - to the base dir. -" - -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. -" - -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. -" - -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" -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. -" - -option "no-user-summary" - -#~~~~~~~~~~~~~~~~~~~~~~~~~~~ -"do not print the user summary table" -flag off -dependon="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" -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 to quote + them to prevent them from being interpreted as adu options, + or via the \"set\" command in interactive mode. "