X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=f8c4a1fccfd531c6ba711350673b5f979f9e5841;hp=84187eb19b7f52667242f9e882fe22872103bb14;hb=f56aa749790691ac3a44cc9c67a0ee7055939f78;hpb=2842e5142322dcc2e42172c28fc041dcc5673dd5 diff --git a/adu.ggo b/adu.ggo index 84187eb..f8c4a1f 100644 --- a/adu.ggo +++ b/adu.ggo @@ -14,38 +14,55 @@ 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" +option "loglevel" l +#~~~~~~~~~~~~~~~~~~ +"Set loglevel (0-6)" +int typestr="level" +default="4" 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. + Log messages are always written to stderr while normal output + goes to stdout. Lower values mean more verbose logging. +" + +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. + + 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. " -option "database-dir" d -#~~~~~~~~~~~~~~~~~~~~~~ +groupoption "database-dir" d +#~~~~~~~~~~~~~~~~~~~~~~~~~~~ "directory containing the osl tables" +group="database" 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. - + 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 "loglevel" l -#~~~~~~~~~~~~~~~~~~ -"Set loglevel (0-6)" -int typestr="level" -default="4" + +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=" - Log messages are always written to stderr while normal output - goes to stdout. Lower values mean more verbose logging. + 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. " ############### @@ -58,7 +75,6 @@ groupdesc=" 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 @@ -105,7 +121,6 @@ option "base-dir" b #~~~~~~~~~~~~~~~~~~ "directory to traverse" string typestr="path" -dependon="create" optional details=" The base directory to be traversed recursively. A warning