Prepare 2.2.5 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 Please read the section "3. Known Bugs (and Workarounds)" of this
31 README before you start working with Gpg4win.
32
33 Gpg4win supports these platforms:
34
35   * Operating System: Windows XP, Vista, 7, 8 (for all: 32/64 bit)
36
37   * MS Outlook: 2003, 2007, 2010, 2013 (for all: only 32bit!)
38
39
40 2. Changes
41 ==========
42
43 Included Gpg4win components in Version !VERSION! are:
44
45 !COMPONENTS!
46
47
48 New in Gpg4win Version !VERSION! (!BUILD_ISODATE!)
49 -----------------------------------------
50
51 - GnuPG has been updated to version 2.0.28. See release notes on
52   www.gnupg.org for details.
53
54 - A potential crash during certificate search has been fixed.
55
56 - Kleopatra no longer queries revocation information for X509
57   certificates during startup. This will drastically improve
58   the startup time of Kleopatra for some users.
59   Revocation information is still checked once a certificate is used.
60
61 - Kleopatra now uses the same defaults as GnuPG for new OpenPGP
62   certificates.
63
64 - Third party libraries included in Gpg4win have been updated.
65
66
67 3. Known Bugs (and Workarounds)
68 ===============================
69
70 - Using smart cards with Kleopatra:
71
72    * OpenPGP card
73      The initial setting of a smart card with Kleopatra is not yet
74      possible. Please run the following steps once to use your smart
75      card with Kleopatra.
76      Use the gpg command line tool to create a new OpenPGP certificate
77      on your card (a) or to activate your existing certificate of
78      your card (b):
79
80      (a) Create new certificate
81        - Insert card.
82        - Run "gpg --card-edit".
83        - Switch to admin modus by enter: "admin".
84        - Enter "generate" to create a new certificate.
85
86      (b) Activate existing certificate of your card
87        - Import associated (public) certificate of your card (e.g.
88          from certificate server or from a exported certificate file).
89        - Insert card.
90        - Run "gpg --card-status".
91
92    * X.509 Telesec Netkey 3 card
93      Use Kleopatra to initialize your card:
94      - Insert card.
95      - Click on the flashing Kleopatra system tray icon (or use the 
96        context menu "smart card" of the system tray icon and run the 
97        "learn card" command directly).
98
99    After finishing these steps your OpenPGP / X.509 certificate from your
100    smart card is shown in Kleopatra under the tab "My certificates" 
101    (marked with a smart card icon).
102
103 - Using the Outlook Plugin "GpgOL":
104
105   * You defintely should create copies of your old encrypted/signed
106     emails before installing GpgOL, e.g. in the form of PST files.
107
108   * For Outlook 2003/2007 only:
109     Sending signed or encrypted messages via an Exchange based account
110     does not yet work.
111     [see https://bugs.g10code.com/gnupg/issue1102]
112     (Please note, using SMTP with GpgOL and Exchange seems to be work.
113     Or use GpgOL with Outlook 2010/2013.)
114
115   * For Outlook 2003/2007 only:
116     Encrypted E-Mails occuring un-encrypted on the email server: It
117     can happen that parts of encrypted emails are copied to your email
118     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
119     or viewing them.  Affected is the content of the email view
120     window, thus usually the so-called email body.  Attachments are
121     not affected.  Switching off the Outlook preview will lower the
122     probability of this to happen, but not eliminate the issue.
123     Or use GpgOL with Outlook 2010/2013.
124
125
126 4. Installation
127 ===============
128
129 For installation instructions please read the new Gpg4win Compendium:
130 http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
131
132 Hints for automated installations (without user dialogs):
133 http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
134
135
136 5. Version History
137 ==================
138
139 Listed below are the changes as recorded in the source distribution's
140 NEWS file. An up-to-date list of changes is also available at:
141 http://www.gpg4win.org/change-history.html
142
143 !NEWSFILE!
144
145
146 6. Version Numbers of Included Software
147 =======================================
148
149 !VERSIONINFO!
150
151
152 7. Legal notices pertaining to the individual packets
153 =====================================================
154
155 Gpg4win consist of several independent developed packages, available
156 under different license conditions.  Most of these packages however
157 are available under the GNU General Public License (GNU GPL).  Common
158 to all is that they are free to use without restrictions, may be
159 modified and that modifications may be distributed.  If the source
160 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
161 binaries and the use of the GNU GPL has been pointed out, distribution
162 is in in all cases possible.
163
164 What follows is a list of copyright statements.
165
166 !PKG-COPYRIGHT!
167
168
169
170
171 Happy GiPiGing,
172
173   Your Gpg4win Team
174
175
176 ***end of file ***