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