Add rudimentary interactive support.

[adu.git] / adu.ggo

diff --git a/adu.ggo b/adu.ggo
index 0be213df4c7117025a8b717220887b7aa45a1e75..38986afbb4b604312be18b294fc5f8b684a38b4a 100644 (file)
--- a/adu.ggo
+++ b/adu.ggo
@@ -3,7 +3,6 @@
 # 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
@@ -107,6 +106,14 @@ details="
        that directory.
 "
 
+groupoption "interactive" I
+#~~~~~~~~~~~~~~~~~~~~~
+"activate interactive mode"
+group="mode"
+details="
+       In this mode, adu reads commands from stdin.
+"
+
 groupoption "select" S
 #~~~~~~~~~~~~~~~~~~~~~
 "query a database previously created with --create"
@@ -158,7 +165,6 @@ details="
        users. Decreasing the value causes adu to use slightly less memory.
 "
 
-
 ##############################
 section "Options for --select"
 ##############################
@@ -175,26 +181,28 @@ details="
        print all lines.
 "
 
-option "size_unit" -
+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" -
+option "count-unit" -
 #~~~~~~~~~~~~~~~~~~~~
 "select output format for counted values"
 enum typestr="format"
 values="h","n","k","m","g","t"
 default="h"
 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,
@@ -202,6 +210,68 @@ details="
        format.
 "
 
+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"
@@ -209,6 +279,7 @@ 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.