summaryrefslogtreecommitdiffstats
path: root/doc/tools.texi
diff options
context:
space:
mode:
authorMarcus Brinkmann <mb@g10code.com>2008-05-20 00:46:41 +0200
committerMarcus Brinkmann <mb@g10code.com>2008-05-20 00:46:41 +0200
commit7d714a378864eef96cb6f4b4bc3cd2833149f42a (patch)
treead9a5a2c37dc82761ee204b143fa7d6fea27c6b5 /doc/tools.texi
parent2008-05-15 Marcus Brinkmann <marcus@g10code.de> (diff)
downloadgnupg2-7d714a378864eef96cb6f4b4bc3cd2833149f42a.tar.xz
gnupg2-7d714a378864eef96cb6f4b4bc3cd2833149f42a.zip
doc/
2008-05-20 Marcus Brinkmann <marcus@g10code.de> * tools.texi (Invoking gpgconf): Add --dry-run and --check-options. (Checking programs): Document --check-options. tools/ 2008-05-20 Marcus Brinkmann <marcus@g10code.de> * gpgconf.h (gc_component_check_programs): Rename to ... (gc_check_programs): ... this. (gc_component_change_options): Add argument OUT. (gc_component_check_options): New function. * gpgconf.c (enum cmd_and_opt_values): New option aCheckOptions. (opts): Add new option aCheckOptions (aka --check-options). (main): Handle new option aCheckOptions. * gpgconf-comp.c (gc_component_check_programs): Rename to ... (gc_check_programs): ... this. Refactor core of it to ... (gc_component_check_options): ... this new function. (gc_component_change_options): Add new argument OUT. Externally verify all changes. Implement option --dry-run.
Diffstat (limited to 'doc/tools.texi')
-rw-r--r--doc/tools.texi21
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/tools.texi b/doc/tools.texi
index 79a909d2f..888012e0c 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -230,6 +230,9 @@ List all options of the component @var{component}.
@item --change-options @var{component}
Change the options of the component @var{component}.
+@item --check-options @var{component}
+Check the options for the component @var{component}.
+
@item --apply-defaults
Update all configuration files with values taken from the global
configuration file (usually @file{/etc/gnupg/gpgconf.conf}).
@@ -260,11 +263,10 @@ The following options may be used:
Outputs additional information while running. Specifically, this
extends numerical field values by human-readable descriptions.
-@c FIXME: Not yet supported.
-@c @item -n
-@c @itemx --dry-run
-@c Do not actually change anything. Useful together with
-@c @code{--change-options} for testing purposes.
+@item -n
+@itemx --dry-run
+Do not actually change anything. This is currently only implemented
+for @code{--change-options} and can be used for testing purposes.
@item -r
@itemx --runtime
@@ -531,6 +533,11 @@ gpgsm:GPG for S/MIME:/usr/local/bin/gpgsm:1:1:
dirmngr:Directory Manager:/usr/local/bin/dirmngr:0:0:
@end example
+@noindent
+The command @w{@code{--check-options @var{component}}} will verify the
+configuration file in the same manner as @code{--check-programs}, but
+only for the component @var{component}.
+
@node Listing options
@subsection Listing options
@@ -769,6 +776,10 @@ argument is used (only allowed if the argument is optional for this
option). Otherwise, the option will be set to the specified value.
@end table
+@noindent
+The output of the command is the same as that of
+@code{--check-options} for the modified configuration file.
+
Examples:
To set the force option, which is of basic type @code{none (0)}: