See ChangeLog: Fri Jul 14 19:38:23 CEST 2000 Werner Koch
[gnupg.git] / g10 / helptext.c
1 /* helptext.c  - English help texts
2  *      Copyright (C) 1998, 1999, 2000 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include "util.h"
26 #include "ttyio.h"
27 #include "main.h"
28 #include "i18n.h"
29
30
31 /****************
32  * These helptexts are used for the "online" help feature. We use
33  * a key consisting of words and dots.  Because the lookup is only
34  * done in an interactive mode on a user request (when she enters a "?"
35  * as response to a prompt) we can use a simple search through the list.
36  *
37  * Mini glossary:
38  *
39  * "user ID", "trustdb", "NOTE" and "WARNING".
40  */
41
42 static struct helptexts { const char *key; const char *help; } helptexts[] = {
43
44 /* begin of list */
45
46 { "edit_ownertrust.value", N_(
47 "It's up to you to assign a value here; this value will never be exported\n"
48 "to any 3rd party.  We need it to implement the web-of-trust; it has nothing\n"
49 "to do with the (implicitly created) web-of-certificates."
50 )},
51
52 { "revoked_key.override", N_(
53 "If you want to use this revoked key anyway, answer \"yes\"."
54 )},
55
56 { "untrusted_key.override", N_(
57 "If you want to use this untrusted key anyway, answer \"yes\"."
58 )},
59
60 { "pklist.user_id.enter", N_(
61 "Enter the user ID of the addressee to whom you want to send the message."
62 )},
63
64 { "keygen.algo", N_(
65 "Select the algorithm to use.\n"
66 "\n"
67 "DSA (aka DSS) is the digital signature algorithm which can only be used\n"
68 "for signatures.  This is the suggested algorithm because verification of\n"
69 "DSA signatures are much faster than those of ElGamal.\n"
70 "\n"
71 "ElGamal is an algorithm which can be used for signatures and encryption.\n"
72 "OpenPGP distinguishs between two flavors of this algorithms: an encrypt only\n"
73 "and a sign+encrypt; actually it is the same, but some parameters must be\n"
74 "selected in a special way to create a safe key for signatures: this program\n"
75 "does this but other OpenPGP implementations are not required to understand\n"
76 "the signature+encryption flavor.\n"
77 "\n"
78 "The first (primary) key must always be a key which is capable of signing;\n"
79 "this is the reason why the encryption only ElGamal key is not available in\n"
80 "this menu."
81 )},
82
83
84 { "keygen.algo.elg_se", N_(
85 "Although these keys are defined in RFC2440 they are not suggested\n"
86 "because they are not supported by all programs and signatures created\n"
87 "with them are quite large and very slow to verify."
88 )},
89
90
91 { "keygen.size", N_(
92  "Enter the size of the key"
93 )},
94
95 { "keygen.size.huge.okay", N_(
96  "Answer \"yes\" or \"no\""
97 )},
98
99
100 { "keygen.size.large.okay", N_(
101  "Answer \"yes\" or \"no\""
102 )},
103
104
105 { "keygen.valid", N_(
106  "Enter the required value as shown in the prompt.\n"
107  "It is possible to enter a ISO date (YYYY-MM-DD) but you won't\n"
108  "get a good error response - instead the system tries to interpret\n"
109  "the given value as an interval."
110 )},
111
112 { "keygen.valid.okay", N_(
113  "Answer \"yes\" or \"no\""
114 )},
115
116
117 { "keygen.name", N_(
118  "Enter the name of the key holder"
119 )},
120
121
122 { "keygen.email", N_(
123  "please enter an optional but highly suggested email address"
124 )},
125
126 { "keygen.comment", N_(
127  "Please enter an optional comment"
128 )},
129
130
131 { "keygen.userid.cmd", N_(
132  ""
133 "N  to change the name.\n"
134 "C  to change the comment.\n"
135 "E  to change the email address.\n"
136 "O  to continue with key generation.\n"
137 "Q  to to quit the key generation."
138 )},
139
140 { "keygen.sub.okay", N_(
141  "Answer \"yes\" (or just \"y\") if it is okay to generate the sub key."
142 )},
143
144 { "sign_uid.okay", N_(
145  "Answer \"yes\" or \"no\""
146 )},
147
148
149 { "change_passwd.empty.okay", N_(
150  "Answer \"yes\" or \"no\""
151 )},
152
153
154 { "keyedit.save.okay", N_(
155  "Answer \"yes\" or \"no\""
156 )},
157
158
159 { "keyedit.cancel.okay", N_(
160  "Answer \"yes\" or \"no\""
161 )},
162
163 { "keyedit.sign_all.okay", N_(
164  "Answer \"yes\" is you want to sign ALL the user IDs"
165 )},
166
167 { "keyedit.remove.uid.okay", N_(
168  "Answer \"yes\" if you really want to delete this user ID.\n"
169  "All certificates are then also lost!"
170 )},
171
172 { "keyedit.remove.subkey.okay", N_(
173  "Answer \"yes\" if it is okay to delete the subkey"
174 )},
175
176
177 { "keyedit.delsig.valid", N_(
178  "This is a valid signature on the key; you normally don't want\n"
179  "to delete this signature because it may be important to establish a\n"
180  "trust connection to the key or another key certified by this key."
181 )},
182 { "keyedit.delsig.unknown", N_(
183  "This signature can't be checked because you don't have the\n"
184  "corresponding key.  You should postpone its deletion until you\n"
185  "know which key was used because this signing key might establish\n"
186  "a trust connection through another already certified key."
187 )},
188 { "keyedit.delsig.invalid", N_(
189  "The signature is not valid.  It does make sense to remove it from\n"
190  "your keyring."
191 )},
192 { "keyedit.delsig.selfsig", N_(
193  "This is a signature which binds the user ID to the key. It is\n"
194  "usually not a good idea to remove such a signature.  Actually\n"
195  "GnuPG might not be able to use this key anymore.  So do this\n"
196  "only if this self-signature is for some reason not valid and\n"
197  "a second one is available."
198 )},
199
200
201 { "passphrase.enter", N_(
202  ""
203 "Please enter the passhrase; this is a secret sentence \n"
204 "  Blurb, blurb,.... "
205 )},
206
207
208 { "passphrase.repeat", N_(
209  "Please repeat the last passphrase, so you are sure what you typed in."
210 )},
211
212 { "detached_signature.filename", N_(
213  "Give the name of the file to which the signature applies"
214 )},
215
216 /* openfile.c (overwrite_filep) */
217 { "openfile.overwrite.okay", N_(
218  "Answer \"yes\" if it is okay to overwrite the file"
219 )},
220
221 /* openfile.c (ask_outfile_name) */
222 { "openfile.askoutname", N_(
223  "Please enter a new filename. If you just hit RETURN the default\n"
224  "file (which is shown in brackets) will be used."
225 )},
226
227 /* revoke.c (ask_revocation_reason) */
228 { "ask_revocation_reason.code", N_(
229  "You should specify a reason for the certification.  Depending on the\n"
230  "context you have the ability to choose from this list:\n"
231  "  \"Key has been compromised\"\n"
232  "      Use this if you have a reason to believe that unauthorized persons\n"
233  "      got access to your secret key.\n"
234  "  \"Key is superseeded\"\n"
235  "      Use this if you have replaced this key with a newer one.\n"
236  "  \"Key is no longer used\"\n"
237  "      Use this if you have retired this key.\n"
238  "  \"User ID is no longer valid\"\n"
239  "      Use this to state that the user ID should not longer be used;\n"
240  "      this is normally used to mark an email address invalid.\n"
241 )},
242
243 /* revoke.c (ask_revocation_reason) */
244 { "ask_revocation_reason.text", N_(
245  "If you like, you can enter a text describing why you issue this\n"
246  "revocation certificate.  Please keep this text concise.\n"
247  "An empty line ends the text.\n"
248 )},
249
250 /* end of list */
251 { NULL, NULL } };
252
253
254 void
255 display_online_help( const char *keyword )
256 {
257
258     tty_kill_prompt();
259     if( !keyword )
260         tty_printf(_("No help available") );
261     else {
262         const char *p;
263         int i;
264
265         for(i=0; (p=helptexts[i].key) && strcmp( p, keyword ); i++ )
266             ;
267         if( !p || !*helptexts[i].help )
268             tty_printf(_("No help available for `%s'"), keyword );
269         else
270             tty_printf("%s", _(helptexts[i].help) );
271     }
272     tty_printf("\n");
273 }
274
275