gnupg/tools
Daniel Kahn Gillmor dc107b7850 More cleanup of "allow to".
* README, agent/command.c, agent/keyformat.txt, common/i18n.c,
  common/iobuf.c, common/keyserver.h, dirmngr/cdblib.c,
  dirmngr/ldap-wrapper.c, doc/DETAILS, doc/TRANSLATE,
  doc/announce-2.1.txt, doc/gpg.texi, doc/gpgsm.texi,
  doc/scdaemon.texi, doc/tools.texi, doc/whats-new-in-2.1.txt,
  g10/export.c, g10/getkey.c, g10/import.c, g10/keyedit.c, m4/ksba.m4,
  m4/libgcrypt.m4, m4/ntbtls.m4, po/ca.po, po/cs.po, po/da.po,
  po/de.po, po/el.po, po/eo.po, po/es.po, po/et.po, po/fi.po,
  po/fr.po, po/gl.po, po/hu.po, po/id.po, po/it.po, po/ja.po,
  po/nb.po, po/pl.po, po/pt.po, po/ro.po, po/ru.po, po/sk.po,
  po/sv.po, po/tr.po, po/uk.po, po/zh_CN.po, po/zh_TW.po,
  scd/app-p15.c, scd/ccid-driver.c, scd/command.c, sm/gpgsm.c,
  sm/sign.c, tools/gpgconf-comp.c, tools/gpgtar.h: replace "Allow to"
  with clearer text.

In standard English, the normal construction is "${XXX} allows ${YYY}
to" -- that is, the subject (${XXX}) of the sentence is allowing the
object (${YYY}) to do something.  When the object is missing, the
phrasing sounds awkward, even if the object is implied by context.
There's almost always a better construction that isn't as awkward.

These changes should make the language a bit clearer.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2016-08-03 16:55:33 +02:00
..
ChangeLog-2011 Generate the ChangeLog from commit logs. 2011-12-01 11:09:02 +01:00
Makefile.am build: Always build gpgtar. 2016-07-15 17:24:49 +02:00
Manifest * Manifest: New. 2004-01-05 09:28:27 +00:00
README.gpgconf Remove what is now in the texi docs. 2004-09-29 23:06:58 +00:00
addgnupghome Nuked almost all trailing white space. 2011-02-04 12:57:53 +01:00
applygnupgdefaults Nuked almost all trailing white space. 2011-02-04 12:57:53 +01:00
call-dirmngr.c tools: Add gpg-wks-client and gpg-wks-server. 2016-06-29 12:04:11 +02:00
call-dirmngr.h tools: Add gpg-wks-client and gpg-wks-server. 2016-06-29 12:04:11 +02:00
ccidmon.c Use inline functions to convert buffer data to scalars. 2015-02-11 10:28:25 +01:00
clean-sat.c Nuked almost all trailing white space. 2011-02-04 12:57:53 +01:00
convert-from-106 Changed to GPLv3. 2007-07-04 19:49:40 +00:00
crlf.c Migrated more stuff to doc/ 2006-08-21 20:20:23 +00:00
der-to-pem Added a very simple tool. 2003-12-01 10:54:59 +00:00
gpg-check-pattern.c Replace use of opt.homedir by accessor functions. 2016-06-07 10:59:46 +02:00
gpg-connect-agent-w32info.rc w32: Add icons and version information. 2013-05-07 21:35:48 +02:00
gpg-connect-agent.c tools: Fix trivial memory leak. 2016-06-30 18:50:16 +02:00
gpg-wks-client.c wks: Publish as binary file. 2016-07-15 17:21:25 +02:00
gpg-wks-server.c wks: Publish as binary file. 2016-07-15 17:21:25 +02:00
gpg-wks.h tools: Call sendmail directly from the wks tools. 2016-07-03 00:41:30 +02:00
gpg-zip.in tests: Silence output of some tests. 2016-05-03 11:26:06 +02:00
gpgconf-comp.c More cleanup of "allow to". 2016-08-03 16:55:33 +02:00
gpgconf.c gpgconf: Enhance --list-dirs. 2016-07-11 13:06:48 +02:00
gpgconf.h gpgconf: Exit with failure if --launch fails. 2014-12-17 10:39:31 +01:00
gpgparsemail.c gpgparsemail: Allow weirdly-mixed pkcs7 signatures. 2016-02-18 12:15:46 +01:00
gpgsplit.c Fix spelling and grammar. 2016-08-03 16:54:01 +02:00
gpgtar-create.c common: Add a status callback to gnupg_exec_tool_stream. 2016-05-28 00:07:09 +02:00
gpgtar-extract.c tools/gpgtar: Fix handling of '-'. 2016-06-28 15:03:07 +02:00
gpgtar-list.c tools/gpgtar: Fix handling of '-'. 2016-06-28 15:03:07 +02:00
gpgtar.c tools/gpgtar: Provide --create and --extract. 2016-07-05 15:18:30 +02:00
gpgtar.h More cleanup of "allow to". 2016-08-03 16:55:33 +02:00
lspgpot Migrated more stuff to doc/ 2006-08-21 20:20:23 +00:00
mail-signed-keys Fix a signing problem with the card 2010-10-18 12:59:19 +00:00
make-dns-cert.c Utilize new automake vars for proper installation into doc/. 2008-03-27 13:18:19 +00:00
mime-maker.c tools: Extend mime-maker.c:mime_maker_add_header. 2016-07-02 18:55:22 +02:00
mime-maker.h tools: Add modules for MIME parsing and creating. 2016-06-29 12:04:11 +02:00
mime-parser.c tools: Add modules for MIME parsing and creating. 2016-06-29 12:04:11 +02:00
mime-parser.h tools: Add modules for MIME parsing and creating. 2016-06-29 12:04:11 +02:00
mk-tdata.c tools/mk-tdata: Fix data generation on Windows. 2016-02-23 11:58:20 +01:00
no-libgcrypt.c Fix left over use of jnlib on some platforms 2012-08-24 09:29:56 +02:00
pgpgroup-to-gpggroup Changed to GPLv3. 2007-07-04 19:49:40 +00:00
rfc822parse.c tools: Improve debug output of rfc822parse. 2016-05-27 15:51:25 +02:00
rfc822parse.h tools: Add modules for MIME parsing and creating. 2016-06-29 12:04:11 +02:00
send-mail.c tools: Call sendmail directly from the wks tools. 2016-07-03 00:41:30 +02:00
send-mail.h tools: Call sendmail directly from the wks tools. 2016-07-03 00:41:30 +02:00
sockprox.c Two minor code cleanups and one NULL deref on error fix. 2014-04-16 10:18:17 +02:00
symcryptrun.c tools: Fix typo in function name of symcryptrun. 2016-06-16 11:25:20 +02:00
watchgnupg.c common: Remove two JNLIB_ macros (jnlib merge). 2015-04-24 16:10:15 +02:00
wks-receive.c tools: Add gpg-wks-client and gpg-wks-server. 2016-06-29 12:04:11 +02:00
wks-util.c tools: Call sendmail directly from the wks tools. 2016-07-03 00:41:30 +02:00

README.gpgconf

============
  GPG Conf
============

Main documentation for this tool can be found in doc/tools.texi.

BACKENDS
========

Backends should support the following commands:

Command --gpgconf-list
----------------------

List the location of the configuration file, and all default values of
all options.  The location of the configuration file must be an
absolute pathname.

The format of each line is:

NAME:FLAGS:DEFAULT:ARGDEF

NAME

This field contains a name tag for the group or option.  The name tag
is used to specify the group or option in all communication with
GPGConf.  The name tag is to be used verbatim.  It is not in any
escaped format.

FLAGS

The flags field contains an unsigned number.  Its value is the
OR-wise combination of the following flag values:

	16 default	If this flag is set, a default value is available.
	32 default desc If this flag is set, a (runtime) default is available.
			This and the "default" flag are mutually exclusive.
	64 no arg desc	If this flag is set, and the "optional arg" flag
			is set, then the option has a special meaning if no
			argument is given.

DEFAULT

This field is defined only for options.  Its format is that of an
option argument (see section Format Conventions for details).  If the
default value is empty, then no default is known.  Otherwise, the
value specifies the default value for this option.  Note that this
field is also meaningful if the option itself does not take a real
argument.

ARGDEF

This field is defined only for options for which the "optional arg"
flag is set.  If the "no arg desc" flag is not set, its format is that
of an option argument (see section Format Conventions for details).
If the default value is empty, then no default is known.  Otherwise,
the value specifies the default value for this option.  If the "no arg
desc" flag is set, the field is either empty or contains a description
of the effect of this option if no argument is given.  Note that this
field is also meaningful if the option itself does not take a real
argument.


Example:
$ dirmngr --gpgconf-list
gpgconf-config-file:/mnt/marcus/.gnupg/dirmngr.conf
ldapservers-file:/mnt/marcus/.gnupg/dirmngr_ldapservers.conf
add-servers:0
max-replies:10


TODO
----

* Implement --dry-run and --quiet.

* Extend the backend interface to include gettext domain and
description, if available, to avoid repeating this information in
gpgconf.