gnupg/doc/examples/common.conf

# common.conf - common defaults for all components.
#
# This file may provide defaults as well as options which needs to be
# synchronized between components.  As usual this file is read from
# the system wide config directory (e.g. /etc/gnupg/common.conf) as
# well as from the home directory (e.g. ~/.gnupg/common.conf).


# Uncomment to enable the use of the keybox daemon (keyboxd) by gpg
# and gpgsm.
#use-keyboxd

# For testing it is sometimes useful to use a different binary
# of keybox.  This option can be used to specify this.
#keyboxd-program /foo/bar/keyboxd

# For the daemons (gpg-agent, scdaemon, dirmngr, keyboxd) it is often
# useful to define a shared logging destination.  This is either the
# standard logging socket (socket://) or a tcp server (tcp://ip:port).
# If a file name is given the name of the component is internally
# appended.
#log-file socket://
gpg,gpgsm: Move use-keyboxd to the new conf file common.conf * common/comopt.c, common/comopt.h: New. * common/Makefile.am: Add them. * g10/gpg.c: Include comopt.h. (main): Also parse common.conf. * sm/gpgsm.c: Include comopt.h. (main): Set a flag for the --no-logfile option. Parse common.conf. * tools/gpgconf-comp.c (known_options_gpg): Remove "use-keyboxd", add pseudo option "use_keyboxd". (known_pseudo_options_gpg): Add pseudo option "use_keyboxd". (known_options_gpgsm): Remove "use-keyboxd". * tests/openpgp/defs.scm (create-gpghome): Create common.conf. * doc/examples/common.conf: New. -- Note that --use-keybox still works but prints a warning. We will eventually remove this option becuase it was marked as an experimental feature anyway. It would be too confusing if gpg and gpgsm use different key storages. Further, other components (e.g. dirmngr or gpg-wks-client) which call gpg or gpgsm need to be aware that the keyboxd is used and pass that option on the command line. Now that common.conf is always read (even if --no-options is used) those tools will work instantly. 2021-04-19 11:33:19 +02:00			`# common.conf - common defaults for all components.`
			`#`
			`# This file may provide defaults as well as options which needs to be`
			`# synchronized between components. As usual this file is read from`
			`# the system wide config directory (e.g. /etc/gnupg/common.conf) as`
doc: fix home dir path in common.conf * doc/examples/common.conf: fix home dir path -- Fix a few typos in user-specific path of common.conf added in d13c5bc24 (gpg,gpgsm: Move use-keyboxd to the new conf file common.conf, 2021-04-19). The file is in the GnuPG home dir. Replace 'use if' with 'use of' as well. Signed-off-by: Todd Zullinger <tmz@pobox.com> 2024-06-14 18:49:28 +02:00			`# well as from the home directory (e.g. ~/.gnupg/common.conf).`
gpg,gpgsm: Move use-keyboxd to the new conf file common.conf * common/comopt.c, common/comopt.h: New. * common/Makefile.am: Add them. * g10/gpg.c: Include comopt.h. (main): Also parse common.conf. * sm/gpgsm.c: Include comopt.h. (main): Set a flag for the --no-logfile option. Parse common.conf. * tools/gpgconf-comp.c (known_options_gpg): Remove "use-keyboxd", add pseudo option "use_keyboxd". (known_pseudo_options_gpg): Add pseudo option "use_keyboxd". (known_options_gpgsm): Remove "use-keyboxd". * tests/openpgp/defs.scm (create-gpghome): Create common.conf. * doc/examples/common.conf: New. -- Note that --use-keybox still works but prints a warning. We will eventually remove this option becuase it was marked as an experimental feature anyway. It would be too confusing if gpg and gpgsm use different key storages. Further, other components (e.g. dirmngr or gpg-wks-client) which call gpg or gpgsm need to be aware that the keyboxd is used and pass that option on the command line. Now that common.conf is always read (even if --no-options is used) those tools will work instantly. 2021-04-19 11:33:19 +02:00

doc: fix home dir path in common.conf * doc/examples/common.conf: fix home dir path -- Fix a few typos in user-specific path of common.conf added in d13c5bc24 (gpg,gpgsm: Move use-keyboxd to the new conf file common.conf, 2021-04-19). The file is in the GnuPG home dir. Replace 'use if' with 'use of' as well. Signed-off-by: Todd Zullinger <tmz@pobox.com> 2024-06-14 18:49:28 +02:00			`# Uncomment to enable the use of the keybox daemon (keyboxd) by gpg`
gpg,gpgsm: Move use-keyboxd to the new conf file common.conf * common/comopt.c, common/comopt.h: New. * common/Makefile.am: Add them. * g10/gpg.c: Include comopt.h. (main): Also parse common.conf. * sm/gpgsm.c: Include comopt.h. (main): Set a flag for the --no-logfile option. Parse common.conf. * tools/gpgconf-comp.c (known_options_gpg): Remove "use-keyboxd", add pseudo option "use_keyboxd". (known_pseudo_options_gpg): Add pseudo option "use_keyboxd". (known_options_gpgsm): Remove "use-keyboxd". * tests/openpgp/defs.scm (create-gpghome): Create common.conf. * doc/examples/common.conf: New. -- Note that --use-keybox still works but prints a warning. We will eventually remove this option becuase it was marked as an experimental feature anyway. It would be too confusing if gpg and gpgsm use different key storages. Further, other components (e.g. dirmngr or gpg-wks-client) which call gpg or gpgsm need to be aware that the keyboxd is used and pass that option on the command line. Now that common.conf is always read (even if --no-options is used) those tools will work instantly. 2021-04-19 11:33:19 +02:00			`# and gpgsm.`
			`#use-keyboxd`

indent: Fix spelling -- These are non-substantive corrections for minor spelling mistakes within the GnuPG codebase. With something like this applied to the codebase, and a judiciously tuned spellchecker integrated as part of a standard test suite, it should be possible to keep a uniform orthography within the project. GnuPG-bug-id: 7116 2024-05-13 00:09:23 +02:00			`# For testing it is sometimes useful to use a different binary`
			`# of keybox. This option can be used to specify this.`
gpg,gpgsm: Move use-keyboxd to the new conf file common.conf * common/comopt.c, common/comopt.h: New. * common/Makefile.am: Add them. * g10/gpg.c: Include comopt.h. (main): Also parse common.conf. * sm/gpgsm.c: Include comopt.h. (main): Set a flag for the --no-logfile option. Parse common.conf. * tools/gpgconf-comp.c (known_options_gpg): Remove "use-keyboxd", add pseudo option "use_keyboxd". (known_pseudo_options_gpg): Add pseudo option "use_keyboxd". (known_options_gpgsm): Remove "use-keyboxd". * tests/openpgp/defs.scm (create-gpghome): Create common.conf. * doc/examples/common.conf: New. -- Note that --use-keybox still works but prints a warning. We will eventually remove this option becuase it was marked as an experimental feature anyway. It would be too confusing if gpg and gpgsm use different key storages. Further, other components (e.g. dirmngr or gpg-wks-client) which call gpg or gpgsm need to be aware that the keyboxd is used and pass that option on the command line. Now that common.conf is always read (even if --no-options is used) those tools will work instantly. 2021-04-19 11:33:19 +02:00			`#keyboxd-program /foo/bar/keyboxd`

			`# For the daemons (gpg-agent, scdaemon, dirmngr, keyboxd) it is often`
			`# useful to define a shared logging destination. This is either the`
			`# standard logging socket (socket://) or a tcp server (tcp://ip:port).`
			`# If a file name is given the name of the component is internally`
			`# appended.`
gpgconf: Fix a diagnostic output. * tools/gpgconf-comp.c (gc_component_launch): Fix diagnostic. * doc/examples/common.conf: Fix example. Signed-off-by: Werner Koch <wk@gnupg.org> 2021-04-20 10:27:04 +02:00			`#log-file socket://`