agent: Make --no-grab the default.
[gnupg.git] / doc / help.txt
1 # help.txt - English GnuPG online help
2 # Copyright (C) 2007 Free Software Foundation, Inc.
3 #
4 # This file is part of GnuPG.
5 #
6 # GnuPG is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # GnuPG is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, see <https://www.gnu.org/licenses/>.
18
19
20 # Note that this help file needs to be UTF-8 encoded.  When looking
21 # for a help item, GnuPG scans the help files in the following order
22 # (assuming a GNU or Unix system):
23 #
24 #    /etc/gnupg/help.LL_TT.txt
25 #    /etc/gnupg/help.LL.txt
26 #    /etc/gnupg/help.txt
27 #    /usr/share/gnupg/help.LL_TT.txt
28 #    /usr/share/gnupg/help.LL.txt
29 #    /usr/share/gnupg/help.txt
30 #
31 # Here LL_TT denotes the full name of the current locale with the
32 # territory (.e.g. "de_DE"), LL denotes just the locale name
33 # (e.g. "de").  The first matching item is returned.  To put a dot or
34 # a hash mark at the beginning of a help text line, it needs to be
35 # prefixed with ". ".  A single dot may be used to terminated ahelp
36 # entry.
37
38 .#pinentry.qualitybar.tooltip
39 # [remove the hash mark from the key to enable this text]
40 # This entry is just an example on how to customize the tooltip shown
41 # when hovering over the quality bar of the pinentry.  We don't
42 # install this text so that the hardcoded translation takes
43 # precedence.  An administrator should write up a short help to tell
44 # the users about the configured passphrase constraints and save that
45 # to /etc/gnupg/help.txt.  The help text should not be longer than
46 # about 800 characters.
47 This bar indicates the quality of the passphrase entered above.
48
49 As long as the bar is shown in red, GnuPG considers the passphrase too
50 weak to accept.  Please ask your administrator for details about the
51 configured passphrase constraints.
52 .
53
54
55 .gnupg.agent-problem
56 # There was a problem accessing or starting the agent.
57 It was either not possible to connect to a running Gpg-Agent or a
58 communication problem with a running agent occurred.
59
60 The system uses a background process, called Gpg-Agent, for processing
61 private keys and to ask for passphrases.  The agent is usually started
62 when the user logs in and runs as long the user is logged in. In case
63 that no agent is available, the system tries to start one on the fly
64 but that version of the agent is somewhat limited in functionality and
65 thus may lead to little problems.
66
67 You probably need to ask your administrator on how to solve the
68 problem.  As a workaround you might try to log out and in to your
69 session and see whether this helps.  If this helps please tell the
70 administrator anyway because this indicates a bug in the software.
71 .
72
73
74 .gnupg.dirmngr-problem
75 # There was a problen accessing the dirmngr.
76 It was either not possible to connect to a running Dirmngr or a
77 communication problem with a running Dirmngr occurred.
78
79 To lookup certificate revocation lists (CRLs), performing OCSP
80 validation and to lookup keys through LDAP servers, the system uses an
81 external service program named Dirmngr.  The Dirmngr is usually running
82 as a system service (daemon) and does not need any attention by the
83 user.  In case of problems the system might start its own copy of the
84 Dirmngr on a per request base; this is a workaround and yields limited
85 performance.
86
87 If you encounter this problem, you should ask your system
88 administrator how to proceed.  As an interim solution you may try to
89 disable CRL checking in gpgsm's configuration.
90 .
91
92
93 .gpg.edit_ownertrust.value
94 # The help identies prefixed with "gpg." used to be hard coded in gpg
95 # but may now be overridden by help texts from this file.
96 It's up to you to assign a value here; this value will never be exported
97 to any 3rd party.  We need it to implement the web-of-trust; it has nothing
98 to do with the (implicitly created) web-of-certificates.
99 .
100
101 .gpg.edit_ownertrust.set_ultimate.okay
102 To build the Web-of-Trust, GnuPG needs to know which keys are
103 ultimately trusted - those are usually the keys for which you have
104 access to the secret key.  Answer "yes" to set this key to
105 ultimately trusted.
106
107
108 .gpg.untrusted_key.override
109 If you want to use this untrusted key anyway, answer "yes".
110 .
111
112 .gpg.pklist.user_id.enter
113 Enter the user ID of the addressee to whom you want to send the message.
114 .
115
116 .gpg.keygen.algo
117 Select the algorithm to use.
118
119 DSA (aka DSS) is the Digital Signature Algorithm and can only be used
120 for signatures.
121
122 Elgamal is an encrypt-only algorithm.
123
124 RSA may be used for signatures or encryption.
125
126 The first (primary) key must always be a key which is capable of signing.
127 .
128
129
130 .gpg.keygen.algo.rsa_se
131 In general it is not a good idea to use the same key for signing and
132 encryption.  This algorithm should only be used in certain domains.
133 Please consult your security expert first.
134 .
135
136
137 .gpg.keygen.flags
138 Toggle the capabilities of the key.
139
140 It is only possible to toggle those capabilities which are possible
141 for the selected algorithm.
142
143 To quickly set the capabilities all at once it is possible to enter a
144 '=' as first character followed by a list of letters indicating the
145 capability to set: 's' for signing, 'e' for encryption, and 'a' for
146 authentication.  Invalid letters and impossible capabilities are
147 ignored.  This submenu is immediately closed after using this
148 shortcut.
149 .
150
151
152 .gpg.keygen.size
153 Enter the size of the key.
154
155 The suggested default is usually a good choice.
156
157 If you want to use a large key size, for example 4096 bit, please
158 think again whether it really makes sense for you.  You may want
159 to view the web page http://www.xkcd.com/538/ .
160 .
161
162 .gpg.keygen.size.huge.okay
163 Answer "yes" or "no".
164 .
165
166
167 .gpg.keygen.size.large.okay
168 Answer "yes" or "no".
169 .
170
171
172 .gpg.keygen.valid
173 Enter the required value as shown in the prompt.
174 It is possible to enter a ISO date (YYYY-MM-DD) but you won't
175 get a good error response - instead the system tries to interpret
176 the given value as an interval.
177 .
178
179 .gpg.keygen.valid.okay
180 Answer "yes" or "no".
181 .
182
183
184 .gpg.keygen.name
185 Enter the name of the key holder.
186 The characters "<" and ">" are not allowed.
187 Example: Heinrich Heine
188 .
189
190
191 .gpg.keygen.email
192 Please enter an optional but highly suggested email address.
193 Example: heinrichh@duesseldorf.de
194 .
195
196 .gpg.keygen.comment
197 Please enter an optional comment.
198 The characters "(" and ")" are not allowed.
199 In general there is no need for a comment.
200 .
201
202
203 .gpg.keygen.userid.cmd
204 # (Keep a leading empty line)
205
206 N  to change the name.
207 C  to change the comment.
208 E  to change the email address.
209 O  to continue with key generation.
210 Q  to quit the key generation.
211 .
212
213 .gpg.keygen.sub.okay
214 Answer "yes" (or just "y") if it is okay to generate the sub key.
215 .
216
217 .gpg.sign_uid.okay
218 Answer "yes" or "no".
219 .
220
221 .gpg.sign_uid.class
222 When you sign a user ID on a key, you should first verify that the key
223 belongs to the person named in the user ID.  It is useful for others to
224 know how carefully you verified this.
225
226 "0" means you make no particular claim as to how carefully you verified the
227     key.
228
229 "1" means you believe the key is owned by the person who claims to own it
230     but you could not, or did not verify the key at all.  This is useful for
231     a "persona" verification, where you sign the key of a pseudonymous user.
232
233 "2" means you did casual verification of the key.  For example, this could
234     mean that you verified the key fingerprint and checked the user ID on the
235     key against a photo ID.
236
237 "3" means you did extensive verification of the key.  For example, this could
238     mean that you verified the key fingerprint with the owner of the key in
239     person, and that you checked, by means of a hard to forge document with a
240     photo ID (such as a passport) that the name of the key owner matches the
241     name in the user ID on the key, and finally that you verified (by exchange
242     of email) that the email address on the key belongs to the key owner.
243
244 Note that the examples given above for levels 2 and 3 are *only* examples.
245 In the end, it is up to you to decide just what "casual" and "extensive"
246 mean to you when you sign other keys.
247
248 If you don't know what the right answer is, answer "0".
249 .
250
251 .gpg.change_passwd.empty.okay
252 Answer "yes" or "no".
253 .
254
255
256 .gpg.keyedit.save.okay
257 Answer "yes" or "no".
258 .
259
260
261 .gpg.keyedit.cancel.okay
262 Answer "yes" or "no".
263 .
264
265 .gpg.keyedit.sign_all.okay
266 Answer "yes" if you want to sign ALL the user IDs.
267 .
268
269 .gpg.keyedit.remove.uid.okay
270 Answer "yes" if you really want to delete this user ID.
271 All certificates are then also lost!
272 .
273
274 .gpg.keyedit.remove.subkey.okay
275 Answer "yes" if it is okay to delete the subkey.
276 .
277
278
279 .gpg.keyedit.delsig.valid
280 This is a valid signature on the key; you normally don't want
281 to delete this signature because it may be important to establish a
282 trust connection to the key or another key certified by this key.
283 .
284
285 .gpg.keyedit.delsig.unknown
286 This signature can't be checked because you don't have the
287 corresponding key.  You should postpone its deletion until you
288 know which key was used because this signing key might establish
289 a trust connection through another already certified key.
290 .
291
292 .gpg.keyedit.delsig.invalid
293 The signature is not valid.  It does make sense to remove it from
294 your keyring.
295 .
296
297 .gpg.keyedit.delsig.selfsig
298 This is a signature which binds the user ID to the key. It is
299 usually not a good idea to remove such a signature.  Actually
300 GnuPG might not be able to use this key anymore.  So do this
301 only if this self-signature is for some reason not valid and
302 a second one is available.
303 .
304
305 .gpg.keyedit.updpref.okay
306 Change the preferences of all user IDs (or just of the selected ones)
307 to the current list of preferences.  The timestamp of all affected
308 self-signatures will be advanced by one second.
309 .
310
311
312 .gpg.passphrase.enter
313 # (keep a leading empty line)
314
315 Please enter the passphrase; this is a secret sentence.
316 .
317
318
319 .gpg.passphrase.repeat
320 Please repeat the last passphrase, so you are sure what you typed in.
321 .
322
323 .gpg.detached_signature.filename
324 Give the name of the file to which the signature applies.
325 .
326
327 .gpg.openfile.overwrite.okay
328 # openfile.c (overwrite_filep)
329 Answer "yes" if it is okay to overwrite the file.
330 .
331
332 .gpg.openfile.askoutname
333 # openfile.c (ask_outfile_name)
334 Please enter a new filename.  If you just hit RETURN the default
335 file (which is shown in brackets) will be used.
336 .
337
338 .gpg.ask_revocation_reason.code
339 # revoke.c (ask_revocation_reason)
340 You should specify a reason for the revocation.  Depending on the
341 context you have the ability to choose from this list:
342   "Key has been compromised"
343       Use this if you have a reason to believe that unauthorized persons
344       got access to your secret key.
345   "Key is superseded"
346       Use this if you have replaced this key with a newer one.
347   "Key is no longer used"
348       Use this if you have retired this key.
349   "User ID is no longer valid"
350       Use this to state that the user ID should not longer be used;
351       this is normally used to mark an email address invalid.
352 .
353
354 .gpg.ask_revocation_reason.text
355 # revoke.c (ask_revocation_reason)
356 If you like, you can enter a text describing why you issue this
357 revocation certificate.  Please keep this text concise.
358 An empty line ends the text.
359 .
360
361 .gpg.tofu.conflict
362 # tofu.c
363 TOFU has detected another key with the same (or a very similar) email
364 address.  It might be that the user created a new key.  In this case,
365 you can safely trust the new key (but, confirm this by asking the
366 person).  However, it could also be that the key is a forgery or there
367 is an active Man-in-the-Middle (MitM) attack.  In this case, you
368 should mark the key as being bad, so that it is untrusted.  Marking a
369 key as being untrusted means that any signatures will be considered
370 bad and attempts to encrypt to the key will be flagged.  If you are
371 unsure and can't currently check, you should select either accept once
372 or reject once.
373 .
374
375 .gpgsm.root-cert-not-trusted
376 # This text gets displayed by the audit log if
377 # a root certificates was not trusted.
378 The root certificate (the trust-anchor) is not trusted.  Depending on
379 the configuration you may have been prompted to mark that root
380 certificate as trusted or you need to manually tell GnuPG to trust that
381 certificate.  Trusted certificates are configured in the file
382 trustlist.txt in GnuPG's home directory.  If you are in doubt, ask
383 your system administrator whether you should trust this certificate.
384
385
386 .gpgsm.crl-problem
387 # This text is displayed by the audit log for problems with
388 # the CRL or OCSP checking.
389 Depending on your configuration a problem retrieving the CRL or
390 performing an OCSP check occurred.  There are a great variety of
391 reasons why this did not work.  Check the manual for possible
392 solutions.
393
394
395 # Local variables:
396 # mode: default-generic
397 # coding: utf-8
398 # End: