Updated 'Changes' section in README for next beta release.
[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
39   * Operating System: Windows XP (32/64), Vista (32/64), 7 (32/64)
40
41   * MS Outlook: 2003, 2007
42
43 Note: Currently, there is no 64-bit support for GpgEX
44       (see section 3, "Using GpgEX with Windows x64", for details)
45
46
47 2. Changes
48 ==========
49
50 Included Gpg4win components in Version !VERSION! are:
51
52 !COMPONENTS!
53
54
55 New in Gpg4win Version !VERSION! (!BUILD_ISODATE!)
56 -------------------------------------------------
57
58 - Kleopatra:
59   * Updated to Kleopatra 2.1.1 (from KDE 4.10.3).
60   * Fixed bugs in none latin environments.
61   * Several minor and medium improvements of stability.
62  
63 - Qt:
64   * Updated to 4.8.4 (from Qt 4.4.0) with a lot of 
65     improvements in Kleopatra UI.
66   * Improved support for Windows7 and Windows8.
67
68 - GnuPG-Backend:
69   * Updated to gnupg 2.0.20.
70   * Updated most included packages to recent versions (e.g. gpgme,
71     dirmngr, libassuan, libgcrypt, libgpg-error, libksba, pinentry, 
72     libpng and much more - see 'packages.current' file in Gpg4win git
73     repository).
74   * Fixed a long standing bug in GPGME which led to spurious Kleopatra
75     hangs.
76
77 - GPA:
78   * Updated to GPA 0.9.4.
79
80 - Installer:
81   * Migrated the installer to the i686-w64-mingw32 toolchain.
82   * Improved of the build system.
83
84 - Claws-Mail:
85   * Updated Claws Mail to 3.9.1 - see http://www.claws-mail.org .
86
87
88 3. Known Bugs (and Workarounds)
89 ===============================
90
91 - Using smart card with Kleopatra
92
93    The initial setting of smart cards with Kleopatra is currently not
94    yet possible. Please run the following steps one-time to use your
95    smart card with Kleopatra.
96
97    * OpenPGP card
98      Use the gpg command line tool to create a new OpenPGP certificate
99      on your card (a) or to activate your existing certificate of
100      your card (b):
101
102      (a) Create new certificate
103        - Insert card.
104        - Run "gpg --card-edit".
105        - Switch to admin modus by enter: "admin".
106        - Enter "generate" to create a new certificate.
107
108      (b) Activate existing certificate of your card
109        - Import associated (public) certificate of your card (e.g.
110          from certificate server or from a exported certificate file).
111        - Insert card.
112        - Run "gpg --card-status".
113
114    * X.509 Telesec Netkey 3 card
115      Use Kleopatra to initializing your card:
116      - Insert card.
117      - Click at the Kleopatra systemtray icon (or use the context menu of
118        the systemtray icon and run the learn card command).
119
120    After finishing these steps your OpenPGP / X.509 certificate
121    from your smart card is shown in Kleopatra under the tab
122    "My certificates" (marked with a smart card icon).
123
124 - Using the Outlook Plugin "GpgOL":
125
126   * You defintely should create copies of your old encrypted/signed
127     emails, e.g. in the form of PST files.
128
129   * Sending signed or encrypted messages via an Exchange based account
130     does not yet work.
131     [see https://bugs.g10code.com/gnupg/issue1102]
132     (Please note: Using SMTP with GpgOL and Exchange seems to be work.)
133
134   * Outlook2007 crashes after opening attachments of an encrypted message
135     [see https://bugs.g10code.com/gnupg/issue1110]
136
137   * Encrypted E-Mails occuring un-encrypted on the email server: It
138     can happen that parts of encrypted emails are copied to your email
139     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
140     or viewing them.  Affected is the content of the email view
141     window, thus usually the so-called email body.  Attachments are
142     not affected.  Switching off the Outlook preview will lower the
143     probability of this to happen, but not eliminate the issue.
144     A solution is being worked on.
145
146 - Using GpgEX with 64 bit versions Windows:
147
148    * In some cases sign/encrypt or decrypt/verify via GpgEX doesn't work
149      correctly (Kleopatra freezed). Then you should kill Kleopatra via
150      task manager and run the file crypto operation directly in Kleopatra
151      (see file menu).
152
153    * Problems with Windows x64:
154      GpgEX is a (32bit) plugin for the (32bit) Windows
155      Explorer and it does _not_ run in a 64bit Explorer
156      (= default for a Windows 64bit system).
157
158      Workaround: Run the 32bit Explorer to use GpgEX.
159      Click "Start" -> "Run", type the following in the box, and then
160      click OK:
161          C:\windows\syswow64\explorer.exe /separate
162      Note: Adjust the path to your x64-based version of Windows if
163      necessary.
164      This 'separate' command seems to be currently broken in Windows7/64bit.
165      Alternatively you can use the file crypto operations of GpgEX
166      directly via the file menu of Kleopatra.
167
168
169 4. Installation
170 ===============
171
172 For installation instructions please read the new Gpg4win Compendium:
173 http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
174
175 Hints for automated installations (without user dialogs):
176 http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
177
178
179 5. Version History
180 ==================
181
182 Find below the changes as recorded in the source distribution's NEWS
183 file.  An up-to-date list of changes is also available at
184 http://www.gpg4win.org/change-history.html .
185
186 !NEWSFILE!
187
188
189 6. Version Numbers of Included Software
190 =======================================
191
192 !VERSIONINFO!
193
194
195 7. Legal notices pertaining to the individual packets
196 =====================================================
197
198 Gpg4win consist of several independent developed packages, available
199 under different license conditions.  Most of these packages however
200 are available under the GNU General Public License (GNU GPL).  Common
201 to all is that they are free to use without restrictions, may be
202 modified and that modifications may be distributed.  If the source
203 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
204 binaries and the use of the GNU GPL has been pointed out, distribution
205 is in in all cases possible.
206
207 What follows is a list of copyright statements.
208
209 !PKG-COPYRIGHT!
210
211
212
213
214 Happy GiPiGing,
215
216   Your Gpg4win Team
217
218
219 ***end of file ***