Created help files form the current po entries.
[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 <http://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 .gpg.edit_ownertrust.value
56 # The help identies prefixed with "gpg." used to be hard coded in gpg
57 # but may now be overridden by help texts from this file.
58 It's up to you to assign a value here; this value will never be exported
59 to any 3rd party.  We need it to implement the web-of-trust; it has nothing
60 to do with the (implicitly created) web-of-certificates.
61 .
62
63 .gpg.edit_ownertrust.set_ultimate.okay
64 To build the Web-of-Trust, GnuPG needs to know which keys are
65 ultimately trusted - those are usually the keys for which you have
66 access to the secret key.  Answer "yes" to set this key to
67 ultimately trusted.
68
69
70 .gpg.untrusted_key.override
71 If you want to use this untrusted key anyway, answer "yes".
72 .
73
74 .gpg.pklist.user_id.enter
75 Enter the user ID of the addressee to whom you want to send the message.
76 .
77
78 .gpg.keygen.algo
79 Select the algorithm to use.
80
81 DSA (aka DSS) is the Digital Signature Algorithm and can only be used
82 for signatures.
83
84 Elgamal is an encrypt-only algorithm.
85
86 RSA may be used for signatures or encryption.
87
88 The first (primary) key must always be a key which is capable of signing.
89 .
90
91
92 .gpg.keygen.algo.rsa_se
93 In general it is not a good idea to use the same key for signing and
94 encryption.  This algorithm should only be used in certain domains.
95 Please consult your security expert first.
96 .
97
98
99 .gpg.keygen.size
100 Enter the size of the key.
101 .
102
103 .gpg.keygen.size.huge.okay
104 Answer "yes" or "no".
105 .
106
107
108 .gpg.keygen.size.large.okay
109 Answer "yes" or "no".
110 .
111
112
113 .gpg.keygen.valid
114 Enter the required value as shown in the prompt.
115 It is possible to enter a ISO date (YYYY-MM-DD) but you won't
116 get a good error response - instead the system tries to interpret
117 the given value as an interval.
118 .
119
120 .gpg.keygen.valid.okay
121 Answer "yes" or "no".
122 .
123
124
125 .gpg.keygen.name
126 Enter the name of the key holder.
127 .
128
129
130 .gpg.keygen.email
131 Please enter an optional but highly suggested email address.
132 .
133
134 .gpg.keygen.comment
135 Please enter an optional comment.
136 .
137
138
139 .gpg.keygen.userid.cmd
140 # (Keep a leading empty line)
141
142 N  to change the name.
143 C  to change the comment.
144 E  to change the email address.
145 O  to continue with key generation.
146 Q  to to quit the key generation.
147 .
148
149 .gpg.keygen.sub.okay
150 Answer "yes" (or just "y") if it is okay to generate the sub key.
151 .
152
153 .gpg.sign_uid.okay
154 Answer "yes" or "no".
155 .
156
157 .gpg.sign_uid.class
158 When you sign a user ID on a key, you should first verify that the key
159 belongs to the person named in the user ID.  It is useful for others to
160 know how carefully you verified this.
161
162 "0" means you make no particular claim as to how carefully you verified the
163     key.
164
165 "1" means you believe the key is owned by the person who claims to own it
166     but you could not, or did not verify the key at all.  This is useful for
167     a "persona" verification, where you sign the key of a pseudonymous user.
168
169 "2" means you did casual verification of the key.  For example, this could
170     mean that you verified the key fingerprint and checked the user ID on the
171     key against a photo ID.
172
173 "3" means you did extensive verification of the key.  For example, this could
174     mean that you verified the key fingerprint with the owner of the key in
175     person, and that you checked, by means of a hard to forge document with a
176     photo ID (such as a passport) that the name of the key owner matches the
177     name in the user ID on the key, and finally that you verified (by exchange
178     of email) that the email address on the key belongs to the key owner.
179
180 Note that the examples given above for levels 2 and 3 are *only* examples.
181 In the end, it is up to you to decide just what "casual" and "extensive"
182 mean to you when you sign other keys.
183
184 If you don't know what the right answer is, answer "0".
185 .
186
187 .gpg.change_passwd.empty.okay
188 Answer "yes" or "no".
189 .
190
191
192 .gpg.keyedit.save.okay
193 Answer "yes" or "no".
194 .
195
196
197 .gpg.keyedit.cancel.okay
198 Answer "yes" or "no".
199 .
200
201 .gpg.keyedit.sign_all.okay
202 Answer "yes" if you want to sign ALL the user IDs.
203 .
204
205 .gpg.keyedit.remove.uid.okay
206 Answer "yes" if you really want to delete this user ID.
207 All certificates are then also lost!
208 .
209
210 .gpg.keyedit.remove.subkey.okay
211 Answer "yes" if it is okay to delete the subkey.
212 .
213
214
215 .gpg.keyedit.delsig.valid
216 This is a valid signature on the key; you normally don't want
217 to delete this signature because it may be important to establish a
218 trust connection to the key or another key certified by this key.
219 .
220
221 .gpg.keyedit.delsig.unknown
222 This signature can't be checked because you don't have the
223 corresponding key.  You should postpone its deletion until you
224 know which key was used because this signing key might establish
225 a trust connection through another already certified key.
226 .
227
228 .gpg.keyedit.delsig.invalid
229 The signature is not valid.  It does make sense to remove it from
230 your keyring.
231 .
232
233 .gpg.keyedit.delsig.selfsig
234 This is a signature which binds the user ID to the key. It is
235 usually not a good idea to remove such a signature.  Actually
236 GnuPG might not be able to use this key anymore.  So do this
237 only if this self-signature is for some reason not valid and
238 a second one is available.
239 .
240
241 .gpg.keyedit.updpref.okay
242 Change the preferences of all user IDs (or just of the selected ones)
243 to the current list of preferences.  The timestamp of all affected
244 self-signatures will be advanced by one second.
245 .
246
247
248 .gpg.passphrase.enter
249 # (keep a leading empty line)
250
251 Please enter the passhrase; this is a secret sentence.
252 .
253
254
255 .gpg.passphrase.repeat
256 Please repeat the last passphrase, so you are sure what you typed in.
257 .
258
259 .gpg.detached_signature.filename
260 Give the name of the file to which the signature applies.
261 .
262
263 .gpg.openfile.overwrite.okay
264 # openfile.c (overwrite_filep)
265 Answer "yes" if it is okay to overwrite the file.
266 .
267
268 .gpg.openfile.askoutname
269 # openfile.c (ask_outfile_name)
270 Please enter a new filename.  If you just hit RETURN the default
271 file (which is shown in brackets) will be used.
272 .
273
274 .gpg.ask_revocation_reason.code
275 # revoke.c (ask_revocation_reason) 
276 You should specify a reason for the certification.  Depending on the
277 context you have the ability to choose from this list:
278   "Key has been compromised"
279       Use this if you have a reason to believe that unauthorized persons
280       got access to your secret key.
281   "Key is superseded"
282       Use this if you have replaced this key with a newer one.
283   "Key is no longer used"
284       Use this if you have retired this key.
285   "User ID is no longer valid"
286       Use this to state that the user ID should not longer be used;
287       this is normally used to mark an email address invalid.
288 .
289
290 .gpg.ask_revocation_reason.text
291 # revoke.c (ask_revocation_reason)
292 If you like, you can enter a text describing why you issue this
293 revocation certificate.  Please keep this text concise.
294 An empty line ends the text.
295 .
296
297
298
299
300
301
302
303
304
305
306
307
308 # Local variables:
309 # mode: fundamental
310 # coding: utf-8
311 # End: