Next: , Up: gpgconf   [Contents][Index]


8.4.1 Invoking gpgconf

One of the following commands must be given:

--list-components

List all components. This is the default command used if none is specified.

--check-programs

List all available backend programs and test whether they are runnable.

--list-options component

List all options of the component component.

--change-options component

Change the options of the component component.

--check-options component

Check the options for the component component.

--apply-defaults

Update all configuration files with values taken from the global configuration file (usually /etc/gnupg/gpgconf.conf).

--list-dirs

Lists the directories used by gpgconf. One directory is listed per line, and each line consists of a colon-separated list where the first field names the directory type (for example sysconfdir) and the second field contains the percent-escaped directory. Although they are not directories, the socket file names used by gpg-agent and dirmngr are printed as well. Note that the socket file names and the homedir lines are the default names and they may be overridden by command line switches.

--list-config [filename]

List the global configuration file in a colon separated format. If filename is given, check that file instead.

--check-config [filename]

Run a syntax check on the global configuration file. If filename is given, check that file instead.

--reload [component]

Reload all or the given component. This is basically the same as sending a SIGHUP to the component. Components which don’t support reloading are ignored.

--launch [component]

If the component is not already running, start it. component must be a daemon. This is in general not required because the system starts these daemons as needed. However, external software making direct use of gpg-agent or dirmngr may use this command to ensure that they are started.

--kill [component]

Kill the given component. Components which support killing are gpg-agent and scdaemon. Components which don’t support reloading are ignored. Note that as of now reload and kill have the same effect for scdaemon.

The following options may be used:

-o file
--output file

Write output to file. Default is to write to stdout.

-v
--verbose

Outputs additional information while running. Specifically, this extends numerical field values by human-readable descriptions.

-q
--quiet

Try to be as quiet as possible.

-n
--dry-run

Do not actually change anything. This is currently only implemented for --change-options and can be used for testing purposes.

-r
--runtime

Only used together with --change-options. If one of the modified options can be changed in a running daemon process, signal the running daemon to ask it to reparse its configuration file after changing.

This means that the changes will take effect at run-time, as far as this is possible. Otherwise, they will take effect at the next start of the respective backend programs.


Next: , Up: gpgconf   [Contents][Index]