summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorIngo Klöcker <dev@ingo-kloecker.de>2021-07-12 12:20:28 +0200
committerWerner Koch <wk@gnupg.org>2021-08-10 12:05:53 +0200
commitbf20a80f68449cc83b67c53ba9a0a84c45827ac4 (patch)
treea4c0e1469cb7755d7a7e2e6a74097d910a355a77 /doc
parentbuild: Simplify for string.h and getopt.h. (diff)
downloadgnupg2-bf20a80f68449cc83b67c53ba9a0a84c45827ac4.tar.xz
gnupg2-bf20a80f68449cc83b67c53ba9a0a84c45827ac4.zip
agent: New option --pinentry-formatted-passphrase
* agent/agent.h (opt): Add field pinentry_formatted_passphrase. * agent/call-pinentry.c (setup_formatted_passphrase): New. (agent_get_passphrase): Pass option to pinentry. * agent/gpg-agent.c (oPinentryFormattedPassphrase): New. (opts): Add option. (parse_rereadable_options): Set option. -- GnuPG-bug-id: 5517
Diffstat (limited to 'doc')
-rw-r--r--doc/gpg-agent.texi24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 41bfb09c2..e83dc6268 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -465,6 +465,30 @@ user input. The default value of 0 does not ask the pinentry to
timeout, however a Pinentry may use its own default timeout value in
this case. A Pinentry may or may not honor this request.
+@item --pinentry-formatted-passphrase @var{n}
+@opindex pinentry-formatted-passphrase
+This option asks the Pinentry to use the mode @var{n} for passphrase
+formatting when asking the user for a new passphrase.
+Possible values are:
+@table @code
+@item 0
+Passphrase formatting is disabled. The option to change it is not shown,
+so that the user cannot turn it on. This is the default.
+@item 1
+Passphrase formatting is disabled. The option to change it is shown, so
+that the user can turn it on.
+@item 2
+Passphrase formatting is enabled. The option to change it is shown, but
+disabled, so that the user cannot turn it off.
+@item 3
+Passphrase formatting is enabled. The option to change it is shown, so
+that the user can turn it off.
+@end table
+
+If passphrase formatting is enabled, then all non-breaking space characters
+are stripped from the entered passphrase. Passphrase formatting is mostly
+useful in combination with passphrases generated with the GENPIN command.
+
@item --pinentry-program @var{filename}
@opindex pinentry-program
Use program @var{filename} as the PIN entry. The default is