See ChangeLog: Tue Mar 2 16:44:57 CET 1999 Werner Koch
[gnupg.git] / g10 / helptext.c
1 /* helptext.c  - English help texts
2  *      Copyright (C) 1998 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  * Translators should use the key as msgid, this is to keep the msgid short
37  * and to allow for easy changing of the helptexts.
38  *
39  * Mini glossary:
40  *
41  * "user ID", "trustdb", "NOTE" and "WARNING".
42  */
43
44 static struct helptexts { const char *key; const char *help; } helptexts[] = {
45
46 /* begin of list */
47
48 { N_("edit_ownertrust.value"),
49 "It's up to you to assign a value here; this value will never be exported\n"
50 "to any 3rd party.  We need it to implement the web-of-trust; it has nothing\n"
51 "to do with the (implicitly created) web-of-certificates."
52 },
53
54 { N_("revoked_key.override"),
55 "If you want to use this revoked key anyway, answer \"yes\"."
56 },
57
58 { N_("untrusted_key.override"),
59 "If you want to use this untrusted key anyway, answer \"yes\"."
60 },
61
62 { N_("pklist.user_id.enter"),
63 "Enter the user id of the addressee to whom you want to send the message."
64 },
65
66 { N_("keygen.algo"),
67 "Select the algorithm to use.\n"
68 "DSA (aka DSS) is the digital signature algorithm which can only be used\n"
69 "for signatures.  This is the suggested algorithm because verification of\n"
70 "DSA signatures are much faster than those of ElGamal.\n"
71 "ElGamal is a algorithm which can be used for signatures and encryption.\n"
72 "OpenPGP distunguishs between two flavors of this algorithms: a 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 implemenations are not required to understand\n"
76 "the signature+encryption flavor.\n"
77 "The first (primary) key must always be a key which is capable of signing;\n"
78 "this is the reason why the encryption only ElGamal key is disabled in this."
79 },
80
81
82 { N_("keygen.algo.elg_se"),
83 "Although these keys are defined in RFC2440 they are not suggested\n"
84 "because they are not supported by all programs and signatures created\n"
85 "with them are quite large and very slow to verify."
86 },
87
88
89 { N_("keygen.size"),
90  "Enter the size of the key"
91 },
92
93 { N_("keygen.size.huge.okay"),
94  "Answer \"yes\" or \"no\""
95 },
96
97
98 { N_("keygen.size.large.okay"),
99  "Answer \"yes\" or \"no\""
100 },
101
102
103 { N_("keygen.valid"),
104  "Enter the required value"
105 },
106
107 { N_("keygen.valid.okay"),
108  "Answer \"yes\" or \"no\""
109 },
110
111
112 { N_("keygen.name"),
113  "Enter the name of the key holder"
114 },
115
116
117 { N_("keygen.email"),
118  "please enter an optional but highly suggested email address"
119 },
120
121 { N_("keygen.comment"),
122  "Please enter an optional comment"
123 },
124
125
126 { N_("keygen.userid.cmd"),
127  ""
128 "N  to change the name.\n"
129 "C  to change the comment.\n"
130 "E  to change the email address.\n"
131 "O  to continue with key generation.\n"
132 "Q  to to quit the key generation."
133 },
134
135 { N_("keygen.sub.okay"),
136  "Answer \"yes\" (or just \"y\") if it is okay to generate the sub key."
137 },
138
139 { N_("sign_uid.okay"),
140  "Answer \"yes\" or \"no\""
141 },
142
143
144 { N_("change_passwd.empty.okay"),
145  "Answer \"yes\" or \"no\""
146 },
147
148
149 { N_("keyedit.cmd"),
150  "Please enter \"help\" to see the list of commands."
151 },
152
153 { N_("keyedit.save.okay"),
154  "Answer \"yes\" or \"no\""
155 },
156
157
158 { N_("keyedit.cancel.okay"),
159  "Answer \"yes\" or \"no\""
160 },
161
162 { N_("keyedit.sign_all.okay"),
163  "Answer \"yes\" is you want to sign ALL the user IDs"
164 },
165
166 { N_("keyedit.remove.uid.okay"),
167  "Answer \"yes\" if you really want to delete this user ID.\n"
168  "All certificates are then also lost!"
169 },
170
171 { N_("keyedit.remove.subkey.okay"),
172  "Answer \"yes\" if it is okay to delete the subkey"
173 },
174
175 { N_("passphrase.enter"),
176  ""
177 "Please enter the passhrase; this is a secret sentence \n"
178 "  Blurb, blurb,.... "
179 },
180
181
182 { N_("passphrase.repeat"),
183  "Please repeat the last passphrase, so you are sure what you typed in."
184 },
185
186 { N_("detached_signature.filename"),
187  "Give the name fo the file to which the signature applies"
188 },
189
190 { N_("openfile.overwrite.okay"),
191  "Answer \"yes\" if it is okay to overwrite the file"
192 },
193
194 /* end of list */
195 { NULL, NULL } };
196
197
198 void
199 display_online_help( const char *keyword )
200 {
201
202     tty_kill_prompt();
203     if( !keyword )
204         tty_printf(_("No help available") );
205     else {
206         const char *p = _(keyword);
207
208         if( strcmp( p, keyword ) )
209             tty_printf("%s", p );
210         else {
211             int i;
212
213             for(i=0; (p=helptexts[i].key) && strcmp( p, keyword ); i++ )
214                 ;
215             if( !p || !*helptexts[i].help )
216                 tty_printf(_("No help available for `%s'"), keyword );
217             else
218                 tty_printf("%s", helptexts[i].help );
219         }
220     }
221     tty_printf("\n");
222 }
223
224