389e1c4e20b4cba4d3500a96bb4792a9c29ac82f
[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)" of this
35 README before you start working with Gpg4win.
36
37 Gpg4win supports these platforms:
38
39   * Operating System: Windows XP, Vista, 7, 8 (for all: 32/64 bit)
40
41   * MS Outlook: 2003, 2007, 2010, 2013
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 - GnuPG:
56   * GnuPG wurde auf Version 2.0.26 aktualisiert. Details zu dieser
57     Version finden sich unter www.gnupg.org
58
59 - Kleopatra:
60   * A library load problem has been fixed that could keep Kleopatra
61     from starting on some systems.
62   * Kleopatra has been updated to KDE Sofware Colleciton Version 4.14.
63
64 - GpgEx:
65   * GpgEX no longer crashes if the environment variable GNUPGHOME is set.
66
67 - GpgOL:
68   * Problems with Outlook sender / recipient address lookup have been
69     fixed in GpgOL. Especially for Microsoft Exchange addresses.
70
71 - Pinentry-qt:
72   * Warnings and confirmation dialogs should now open in the
73   foreground.
74
75 - General:
76   * Used libraries have been updated.
77
78 3. Known Bugs (and Workarounds)
79 ===============================
80
81 - Using smart cards with Kleopatra:
82
83    * OpenPGP card
84      The initial setting of a smart card with Kleopatra is not yet
85      possible. Please run the following steps once to use your smart
86      card with Kleopatra.
87      Use the gpg command line tool to create a new OpenPGP certificate
88      on your card (a) or to activate your existing certificate of
89      your card (b):
90
91      (a) Create new certificate
92        - Insert card.
93        - Run "gpg --card-edit".
94        - Switch to admin modus by enter: "admin".
95        - Enter "generate" to create a new certificate.
96
97      (b) Activate existing certificate of your card
98        - Import associated (public) certificate of your card (e.g.
99          from certificate server or from a exported certificate file).
100        - Insert card.
101        - Run "gpg --card-status".
102
103    * X.509 Telesec Netkey 3 card
104      Use Kleopatra to initialize your card:
105      - Insert card.
106      - Click on the flashing Kleopatra system tray icon (or use the 
107        context menu "smart card" of the system tray icon and run the 
108        "learn card" command directly).
109
110    After finishing these steps your OpenPGP / X.509 certificate from your
111    smart card is shown in Kleopatra under the tab "My certificates" 
112    (marked with a smart card icon).
113
114 - Using the Outlook Plugin "GpgOL":
115
116   * You defintely should create copies of your old encrypted/signed
117     emails before installing GpgOL, e.g. in the form of PST files.
118
119   * For Outlook 2003/2007 only:
120     Sending signed or encrypted messages via an Exchange based account
121     does not yet work.
122     [see https://bugs.g10code.com/gnupg/issue1102]
123     (Please note, using SMTP with GpgOL and Exchange seems to be work.
124     Or use GpgOL with Outlook 2010/2013.)
125
126   * For Outlook 2003/2007 only:
127     Encrypted E-Mails occuring un-encrypted on the email server: It
128     can happen that parts of encrypted emails are copied to your email
129     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
130     or viewing them.  Affected is the content of the email view
131     window, thus usually the so-called email body.  Attachments are
132     not affected.  Switching off the Outlook preview will lower the
133     probability of this to happen, but not eliminate the issue.
134     Or use GpgOL with Outlook 2010/2013.
135
136
137
138 4. Installation
139 ===============
140
141 For installation instructions please read the new Gpg4win Compendium:
142 http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
143
144 Hints for automated installations (without user dialogs):
145 http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
146
147
148 5. Version History
149 ==================
150
151 Listed below are the changes as recorded in the source distribution's
152 NEWS file. An up-to-date list of changes is also available at:
153 http://www.gpg4win.org/change-history.html
154
155 !NEWSFILE!
156
157
158 6. Version Numbers of Included Software
159 =======================================
160
161 !VERSIONINFO!
162
163
164 7. Legal notices pertaining to the individual packets
165 =====================================================
166
167 Gpg4win consist of several independent developed packages, available
168 under different license conditions.  Most of these packages however
169 are available under the GNU General Public License (GNU GPL).  Common
170 to all is that they are free to use without restrictions, may be
171 modified and that modifications may be distributed.  If the source
172 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
173 binaries and the use of the GNU GPL has been pointed out, distribution
174 is in in all cases possible.
175
176 What follows is a list of copyright statements.
177
178 !PKG-COPYRIGHT!
179
180
181
182
183 Happy GiPiGing,
184
185   Your Gpg4win Team
186
187
188 ***end of file ***