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