574e8aa6faf6aa745bdb51f95d7c5a7e16c02b48
[gpg4win.git] / doc / README.en.txt
1 ;; README.en.txt                               -*- coding: latin-1; -*-
2 ;; This is the README installed with Gpg4win. Lines with a ; in the first
3 ;; column are considered a comment and not included in the actually
4 ;; installed version.  Certain keywords are replaced by the Makefile;
5 ;; those words are enclosed by exclamation marks.
6
7                    English README file for Gpg4win
8                    ===============================
9 !BETA-WARNING!
10 This is Gpg4win, version !VERSION! (!BUILD_ISODATE!).
11
12 Content:
13
14      1. Important Notes
15      2. Changes
16      3. Known Bugs (and Workarounds)
17      4. Installation
18      5. Version History
19      6. Version Numbers of Included Software
20      7. Legal Notices
21
22
23 1. Important Notes
24 ==================
25
26 The Gpg4win Compendium describes the installation and use of Gpg4win.
27 After installation it is available in the Gpg4win start menu or online:
28 http://www.gpg4win.org/doc/en/gpg4win-compendium.html
29
30 If you used Gpg4win 1.x or another program in the past, please check
31 out the migration hints in the Gpg4win Compendium's appendix.
32 http://www.gpg4win.org/doc/en/gpg4win-compendium_36.html
33
34 Please read the section "3. Known Bugs (and Workarounds)" before you
35 start working with Gpg4win.
36
37 Gpg4win supports these platforms:
38   * Operating System: Windows 2000, XP (32/64), Vista (32/64), 7 (32/64)
39   * MS Outlook: 2003, 2007
40   Note: Currently, there is no 64-bit support for GpgEX 
41   (see section 3, "Using GpgEX with Windows x64", for details)
42
43
44 2. Changes
45 ==========
46 [The following issue numbers reference to https://issues.kolab.org/.]
47
48 Included Gpg4win components in Version !VERSION! are:
49     GnuPG:          2.0.17
50     Kleopatra:      2.1.0 (2011-02-04)
51     GPA:            0.9.1-svn1024
52     GpgOL:          1.1.2
53     GpgEX:          0.9.7
54     Claws-Mail:     3.7.8cvs47
55     Kompendium DE:  3.0.0
56     Kompendium EN:  3.0.0-beta1
57
58 New in Gpg4win version !VERSION! (!BUILD_ISODATE!):
59 ------------------------------------------
60 - Kleopatra:
61   * recursive sign/encrypt of files and folders possible (see
62     GnuPG Backend)
63   * Checksums 
64     - Create/verify checksum by sha1sum, sha256sum, md5sum possible
65       (see GnuPG Backend)
66     - create checksums for more than one files 
67       [kolab/issue4540]
68     - Create/verify checksum entry to file menu of Kleopatra added
69       [kolab/issue4464]
70     - Create and verify dialogs of Kleopatra extended
71       [kolab/issue4487]
72   * Conflict dialog 
73     - Certificate selection dialog now works context-sensitive
74       (dependent on selecting sign, encrypt or sign/encrypt)
75       [kolab/issue4492]
76     - Conflicts redefined and implemented, fixed errors
77       [kolab/issue4197,4234]
78     - New configuration option for "quick mode" (Power-User-Mode) to
79       sign and encrypt
80       [kolab/issue4136])
81     - No protocol (OpenPGP or S/MIME) pre-selection dialog required -
82       replaced by new certificate selection dialog.
83       [kolab/issue4213,4235]
84   * Certificate lookup on certificate server
85     - Search for fingerprint or key-id shows new information dialog 
86       (some server requires 0x-Präfix in search string)
87       [kolab/issue4453]
88   * Certify OpenPGP certificates
89     - Fingerprint and key-id in step 1 added
90       [kolab/issue4468,4458]
91     - Key-id in step 2 added
92       [kolab/issue4460]
93   * Several minor and medium (GUI) improvements:
94     - Kleopatra's main window: column 'fingerprint' with 'key-id' replaced 
95       [kolab/issue4542]
96     - Show key-id always in 8-digit format
97       [kolab/issue4659]
98     - Decrypt/verify files dialog layout improved
99       [kolab/issue4662] 
100     - Export of secret X.509 certificats use new default (utf8) for
101       passphrase charset
102       [kolab/issue4454]
103     - Import certificate without file type improved (content checker)
104       [kolab/issue4457]
105     - Fix certificate list in delete confirm dialog
106       [kolab/issue4459] 
107     - New context menu entry for deleting certificate added
108       [kolab/issue4450]
109     - OwnerTrust added to tooltips and certificate details
110       [kolab/issue4198]
111     - Unit (Bits) to the key strength fields in NewCertificateWizard's
112       overview page added
113       [kolab/issue4183]
114     - E-Mail-Validator allows to delete '@' Zeichen
115       [kolab/issue4189]
116     - Trust/distrust root certificates via context menu
117       (write directly $GNUPGHOME\trustlist.txt)
118       [kolab/issue4190]
119     - For developer: KDebugDialog available (installed with Kleopatra,
120       run $INSTDIR\kdebugdialog.exe)
121       [kolab/issue4318]
122     - Hierarchical certificate list: toggling (regression)
123       [kolab/issue4327]
124     - Fixed exception for decrypt/verify special S/MIME e-mail
125       [kolab/issue4179]
126   * Kleopatra Settings - S/MIME dialog:
127     - Option 'allow-mark-trusted' removed if gnupg provides
128       'no-allow-mark-trusted'
129   * SmartCard
130     - Improve initialize smart card process with Kleopatra 
131       [kolab/issue4519]
132     - Detecting smartcard: Kleopatra's systemtray icon blinks after
133       inserting X.509 card. Click starts learn card command or opens
134       nullpin dialog.
135       [kolab/issue4191]
136     - Learn card commands suppress gpgsm error dialogs.
137       [kolab/issue4126]
138   * Miscellaneous
139     - Gpg4win credits added (see 'About Gpg4win' dialog)
140     - German translations fixed
141     - Several minor and medium issues and errors were fixed
142
143 - GnuPG Backend:
144   * Update to gnupg 2.0.17
145   * Option 'allow-mark-trusted' enabled by default (no-allow-mark-trusted
146     added)
147   * gpgme and libassuan updated (fixed increase of open handles in
148     Kleopatra, see [kolab/issue4705])
149   * fixed: gpgconf doesn't restart gpg-agent automatically
150     [kolab/issue4563]
151   * bzip2 updated (from 1.0.4 to 1.0.6)
152   * Add better error code for missing certificates
153   * (recursive) sign/encrypt of files and folders possible
154     [kolab/issue4298,4299,4300] 
155   * Create/verify checksum by sha1sum, sha256sum, md5sum
156     possible via GpgEX
157     [kolab/issue41634,294,4295,4296,4297,4321]
158   * Updated to new libassuan v2 interface
159   * Several minor and medium improvements of stability
160     [u.a.: kolab/issue4212]
161
162 - GpgEX
163   * (recursive) sign/encrypt of files and folders possible (see
164     GnuPG Backend)
165   * Create/verify checksum by sha1sum, sha256sum, md5sum possible
166     (see GnuPG-Backend)
167   * Portuguese translation added
168   * Updated to libgpg-error 1.9
169
170 - GpgOL:
171   * Portuguese translation added
172   * updated to new libassuan2 interface and libgpg-error 1.9
173
174 - Pinentry:
175   * Pinentry-qt4 hanger while signing e-mail fixed
176     (update from 0.8.0 to 0.8.1)
177     [kolab/issue4302] 
178   * Change default: switch to QT4
179     (GTK still enabled for gpg4win-light installer)
180     [kolab/issue4378]
181   * Fixed German translation for 'Cancel' cancel
182     [kolab/issue4132]
183
184 - Installer:
185   * Installation of dektop shortcuts using non-German installer language fixed
186   * Windows7 support for Gpg4win
187   * S/MIME configuration instruction added
188   * English language version of the Gpg4win Compendium
189     (v3.0.0-beta1) added. Old novices manual removed.
190   * Installer was signed with a CodeSigning certificate of GlobalSign
191     (Publisher: "Intevation GmbH")
192   * Portuguese translation added
193
194 - Claws:
195   see http://www.claws-mail.org
196
197
198 3. Known Bugs (and Workarounds)
199 ===============================
200
201 - Using smart card with Kleopatra
202
203    The initial setting of smart cards with Kleopatra is currently not
204    yet possible. Please run the following steps one-time to use your
205    smart card with Kleopatra.
206
207    * OpenPGP card
208      Use the gpg command line tool to create a new OpenPGP certificate
209      on your card (a) or to activate your existing certificate of
210      your card (b):
211
212      (a) Create new certificate
213        - Insert card.
214        - Run "gpg --card-edit".
215        - Switch to admin modus by enter: "admin".
216        - Enter "generate" to create a new certificate.
217
218      (b) Activate existing certificate of your card
219        - Import associated (public) certificate of your card (e.g.
220          from certificate server or from a exported certificate file).
221        - Insert card.
222        - Run "gpg --card-status".
223
224    * X.509 Telesec Netkey 3 card
225      Use Kleopatra to initializing your card:
226      - Insert card.
227      - Click at the Kleopatra systemtray icon (or use the context menu of
228        the systemtray icon and run the learn card command).
229
230    After finishing these steps your OpenPGP / X.509 certificate
231    from your smart card is shown in Kleopatra under the tab
232    "My certificates" (marked with a smart card icon).
233
234 - Using the Outlook Plugin "GpgOL":
235
236   * You defintely should create copies of your old encrypted/signed
237     emails, e.g. in the form of PST files.
238
239   * Sending signed or encrypted messages via an Exchange based account
240     does not yet work.
241     [see https://bugs.g10code.com/gnupg/issue1102]
242     (Please note: Using SMTP with GpgOL and Exchange seems to be work.) 
243
244   * Outlook2007 crashes after opening attachments of an encrypted message
245     [see https://bugs.g10code.com/gnupg/issue1110]
246
247   * Encrypted E-Mails occuring un-encrypted on the email server: It
248     can happen that parts of encrypted emails are copied to your email
249     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
250     or viewing them.  Affected is the content of the email view
251     window, thus usually the so-called email body.  Attachments are
252     not affected.  Switching off the Outlook preview will lower the
253     probability of this to happen, but not eliminate the issue.
254     A solution is being worked on.
255
256 - Using GpgEX with Windows x64:
257
258    * In some cases sign/encrypt or decrypt/verify via GpgEX doesn't work 
259      correctly (Kleopatra freezed). Then you should kill Kleopatra via 
260      task manager and run the file crypto operation directly in Kleopatra
261      (see file menu).
262
263    * Problems with Windows x64:
264      GpgEX is a (32bit) plugin for the (32bit) Windows
265      Explorer and it does _not_ run in a 64bit Explorer
266      (= default for a Windows 64bit system).
267
268      Workaround: Run the 32bit Explorer to use GpgEX.
269      Click "Start" -> "Run", type the following in the box, and then
270      click OK:
271          C:\windows\syswow64\explorer.exe /separate
272      Note: Adjust the path to your x64-based version of Windows if
273      necessary. 
274      This 'separate' command seems to be currently broken in Windows7/64bit.
275      Alternatively you can use the file crypto operations of GpgEX
276      directly via the file menu of Kleopatra.
277
278
279 4. Installation
280 ===============
281
282 For installation instructions please read the new Gpg4win Compendium:
283 http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
284
285 Hints for automated installations (without user dialogs):
286 http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
287
288
289 5. Version History
290 ==================
291
292 Find below the changes as recorded in the source distribution's NEWS
293 file.  An up-to-date list of changes is also available at
294 http://www.gpg4win.org/change-history.html .
295
296 !NEWSFILE!
297
298
299 6. Version Numbers of Included Software
300 =======================================
301
302 !VERSIONINFO!
303
304
305 7. Legal notices pertaining to the individual packets
306 =====================================================
307
308 Gpg4win consist of several independent developed packages, available
309 under different license conditions.  Most of these packages however
310 are available under the GNU General Public License (GNU GPL).  Common
311 to all is that they are free to use without restrictions, may be
312 modified and that modifications may be distributed.  If the source
313 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
314 binaries and the use of the GNU GPL has been pointed out, distribution
315 is in in all cases possible.
316
317 What follows is a list of copyright statements.
318
319 !PKG-COPYRIGHT!
320
321
322
323
324 Happy GiPiGing,
325
326   Your Gpg4win Team
327
328
329 ***end of file ***