X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.ggo;h=2ddc34e234acd87538fcfbc49abe9f53a83c1fbf;hp=bbca8712197007d217ae2468009080377994009d;hb=d0bef44ffe5b6f985f4ba6a718e08afb50f096c6;hpb=63cf7c8fbf05a53b58e1de1116ec2660b9cb7801 diff --git a/adu.ggo b/adu.ggo index bbca871..2ddc34e 100644 --- a/adu.ggo +++ b/adu.ggo @@ -26,17 +26,6 @@ details=" 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)" @@ -48,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" ############### @@ -58,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 @@ -105,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 @@ -150,7 +177,7 @@ optional dependon="select" details=" This option takes a string whose content is another set of - options as described below. Select options may be specified + options as described below. Select options may be specified either directly in select mode, in which case you have use quotes to prevent the select options from being interpreted as adu options, or via the \"set\" command in interactive mode.