X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=873cc22cdca5d2102f27fc3731515c9e84048d3c;hp=a180f1fc43e546e1d8c789cfb45678f01aeff0cc;hb=e505632b96561200b3d5d308b14b853d48952aab;hpb=d623adf133aaaee36091b840b8644c1884cd970c diff --git a/adu.ggo b/adu.ggo index a180f1f..873cc22 100644 --- a/adu.ggo +++ b/adu.ggo @@ -14,17 +14,18 @@ usage patterns of subdirectories and/or files owned by a given user id. section "General options" ######################### -option "database-dir" d -#~~~~~~~~~~~~~~~~~~~~~~ -"directory containing the osl tables" -string typestr="path" -required +option "config-file" c +#~~~~~~~~~~~~~~~~~~~~~ +"(default='~/.adurc')" +string typestr="filename" +optional 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. - + 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 "loglevel" l #~~~~~~~~~~~~~~~~~~ "Set loglevel (0-6)" @@ -36,6 +37,46 @@ details=" 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. +" + +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. +" + +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=" + 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. +" + ############### section "Modes" ############### @@ -46,7 +87,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 @@ -93,7 +133,6 @@ option "base-dir" b #~~~~~~~~~~~~~~~~~~ "directory to traverse" string typestr="path" -dependon="create" optional details=" The base directory to be traversed recursively. A warning