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