tools/README.gpgconf

   1 ============
   2   GPG Conf
   3 ============
   4
   5 Main documentation for this tool can be found in doc/tools.texi.
   6
   7 BACKENDS
   8 ========
   9
  10 Backends should support the following commands:
  11
  12 Command --gpgconf-list
  13 ----------------------
  14
  15 List the location of the configuration file, and all default values of
  16 all options.  The location of the configuration file must be an
  17 absolute pathname.
  18
  19 The format of each line is:
  20
  21 NAME:FLAGS:DEFAULT:ARGDEF
  22
  23 NAME
  24
  25 This field contains a name tag for the group or option.  The name tag
  26 is used to specify the group or option in all communication with
  27 GPGConf.  The name tag is to be used verbatim.  It is not in any
  28 escaped format.
  29
  30 FLAGS
  31
  32 The flags field contains an unsigned number.  Its value is the
  33 OR-wise combination of the following flag values:
  34
  35         16 default      If this flag is set, a default value is available.
  36         32 default desc If this flag is set, a (runtime) default is available.
  37                         This and the "default" flag are mutually exclusive.
  38         64 no arg desc  If this flag is set, and the "optional arg" flag
  39                         is set, then the option has a special meaning if no
  40                         argument is given.
  41
  42 DEFAULT
  43
  44 This field is defined only for options.  Its format is that of an
  45 option argument (see section Format Conventions for details).  If the
  46 default value is empty, then no default is known.  Otherwise, the
  47 value specifies the default value for this option.  Note that this
  48 field is also meaningful if the option itself does not take a real
  49 argument.
  50
  51 ARGDEF
  52
  53 This field is defined only for options for which the "optional arg"
  54 flag is set.  If the "no arg desc" flag is not set, its format is that
  55 of an option argument (see section Format Conventions for details).
  56 If the default value is empty, then no default is known.  Otherwise,
  57 the value specifies the default value for this option.  If the "no arg
  58 desc" flag is set, the field is either empty or contains a description
  59 of the effect of this option if no argument is given.  Note that this
  60 field is also meaningful if the option itself does not take a real
  61 argument.
  62
  63
  64 Example:
  65 $ dirmngr --gpgconf-list
  66 gpgconf-config-file:/mnt/marcus/.gnupg/dirmngr.conf
  67 ldapservers-file:/mnt/marcus/.gnupg/dirmngr_ldapservers.conf
  68 add-servers:0
  69 max-replies:10
  70
  71
  72 TODO
  73 ----
  74
  75 * Implement --dry-run and --quiet.
  76
  77 * Extend the backend interface to include gettext domain and
  78 description, if available, to avoid repeating this information in
  79 gpgconf.