Next: Format conventions, Up: gpgconf [Contents][Index]
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-profile file
Apply the configuration settings listed in file to the
configuration files. If file has no suffix and no slashes the
command first tries to read a file with the suffix .prf
from
the data directory (gpgconf --list-dirs datadir
) before it
reads the file verbatim. A profile is divided into sections using the
bracketed component name. Each section then lists the option which
shall go into the respective configuration file.
--apply-defaults
Update all configuration files with values taken from the global configuration file (usually /etc/gnupg/gpgconf.conf).
--list-dirs [names]
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. If
names are given only the directories or file names specified by
the list names are printed without any escaping.
--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.
--query-swdb package_name [version_string]
Returns the current version for package_name and if
version_string is given also an indicator on whether an update
is available. The actual file with the software version is
automatically downloaded and checked by dirmngr
.
dirmngr
uses a thresholds to avoid download the file too
often and it does this by default only if it can be done via Tor. To
force an update of that file this command can be used:
gpg-connect-agent --dirmngr 'loadswdb --force' /bye
--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. Without component or by using "all" for component all components which are daemons are reloaded.
--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. Using "all" for
component launches all components which are daemons.
--kill [component]
Kill the given component. Components which support killing are
gpg-agent
and scdaemon
. Components which don’t
support reloading are ignored. Using "all" for component kills
all components running as daemons. Note that as of now reload and
kill have the same effect for scdaemon
.
--create-socketdir
Create a directory for sockets below /run/user or /var/run/user. This is command is only required if a non default home directory is used and the /run based sockets shall be used. For the default home directory GnUPG creates a directory on the fly.
--remove-socketdir
Remove a directory created with command --create-socketdir.
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.
--status-fd n
Write special status strings to the file descriptor n. This program returns the status messages SUCCESS or FAILURE which are helpful when the caller uses a double fork approach and can’t easily get the return code of the process.
Next: Format conventions, Up: gpgconf [Contents][Index]