gpg: Add new --auto-key-locate mechanism "dane".
[gnupg.git] / doc / help.txt
index afaaa29..f545c2b 100644 (file)
@@ -7,12 +7,12 @@
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # GnuPG is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, see <http://www.gnu.org/licenses/>.
 
@@ -27,7 +27,7 @@
 #    /usr/share/gnupg/help.LL_TT.txt
 #    /usr/share/gnupg/help.LL.txt
 #    /usr/share/gnupg/help.txt
-#    
+#
 # Here LL_TT denotes the full name of the current locale with the
 # territory (.e.g. "de_DE"), LL denotes just the locale name
 # (e.g. "de").  The first matching item is returned.  To put a dot or
@@ -44,7 +44,7 @@
 # the users about the configured passphrase constraints and save that
 # to /etc/gnupg/help.txt.  The help text should not be longer than
 # about 800 characters.
-This bar indicates the quality of the passphrase entered above.  
+This bar indicates the quality of the passphrase entered above.
 
 As long as the bar is shown in red, GnuPG considers the passphrase too
 weak to accept.  Please ask your administrator for details about the
@@ -52,6 +52,44 @@ configured passphrase constraints.
 .
 
 
+.gnupg.agent-problem
+# There was a problem accessing or starting the agent.
+It was either not possible to connect to a running Gpg-Agent or a
+communication problem with a running agent occurred.
+
+The system uses a background process, called Gpg-Agent, for processing
+private keys and to ask for passphrases.  The agent is usually started
+when the user logs in and runs as long the user is logged in. In case
+that no agent is available, the system tries to start one on the fly
+but that version of the agent is somewhat limited in functionality and
+thus may lead to little problems.
+
+You probably need to ask your administrator on how to solve the
+problem.  As a workaround you might try to log out and in to your
+session and see whether this helps.  If this helps please tell the
+administrator anyway because this indicates a bug in the software.
+.
+
+
+.gnupg.dirmngr-problem
+# There was a problen accessing the dirmngr.
+It was either not possible to connect to a running Dirmngr or a
+communication problem with a running Dirmngr occurred.
+
+To lookup certificate revocation lists (CRLs), performing OCSP
+validation and to lookup keys through LDAP servers, the system uses an
+external service program named Dirmngr.  The Dirmngr is usually running
+as a system service (daemon) and does not need any attention by the
+user.  In case of problems the system might start its own copy of the
+Dirmngr on a per request base; this is a workaround and yields limited
+performance.
+
+If you encounter this problem, you should ask your system
+administrator how to proceed.  As an interim solution you may try to
+disable CRL checking in gpgsm's configuration.
+.
+
+
 .gpg.edit_ownertrust.value
 # The help identies prefixed with "gpg." used to be hard coded in gpg
 # but may now be overridden by help texts from this file.
@@ -96,8 +134,29 @@ Please consult your security expert first.
 .
 
 
+.gpg.keygen.flags
+Toggle the capabilities of the key.
+
+It is only possible to toggle those capabilities which are possible
+for the selected algorithm.
+
+To quickly set the capabilities all at once it is possible to enter a
+'=' as first character followed by a list of letters indicating the
+capability to set: 's' for signing, 'e' for encryption, and 'a' for
+authentication.  Invalid letters and impossible capabilities are
+ignored.  This submenu is immediately closed after using this
+shortcut.
+.
+
+
 .gpg.keygen.size
 Enter the size of the key.
+
+The suggested default is usually a good choice.
+
+If you want to use a large key size, for example 4096 bit, please
+think again whether it really makes sense for you.  You may want
+to view the web page http://www.xkcd.com/538/ .
 .
 
 .gpg.keygen.size.huge.okay
@@ -124,15 +183,20 @@ Answer "yes" or "no".
 
 .gpg.keygen.name
 Enter the name of the key holder.
+The characters "<" and ">" are not allowed.
+Example: Heinrich Heine
 .
 
 
 .gpg.keygen.email
 Please enter an optional but highly suggested email address.
+Example: heinrichh@duesseldorf.de
 .
 
 .gpg.keygen.comment
 Please enter an optional comment.
+The characters "(" and ")" are not allowed.
+In general there is no need for a comment.
 .
 
 
@@ -272,7 +336,7 @@ file (which is shown in brackets) will be used.
 .
 
 .gpg.ask_revocation_reason.code
-# revoke.c (ask_revocation_reason) 
+# revoke.c (ask_revocation_reason)
 You should specify a reason for the certification.  Depending on the
 context you have the ability to choose from this list:
   "Key has been compromised"
@@ -308,10 +372,16 @@ trustlist.txt in GnuPG's home directory.  If you are in doubt, ask
 your system administrator whether you should trust this certificate.
 
 
-
+.gpgsm.crl-problem
+# This tex is displayed by the audit log for problems with
+# the CRL or OCSP checking.
+Depending on your configuration a problem retrieving the CRL or
+performing an OCSP check occurred.  There are a great variety of
+reasons why this did not work.  Check the manual for possible
+solutions.
 
 
 # Local variables:
-# mode: fundamental
+# mode: default-generic
 # coding: utf-8
 # End: