Update news and readmes
[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 was updated to version 2.0.26.
57     (See www.gnupg.org for more details.)
58   * Command line wildcards (like *.txt) now work again.
59   * Command line output is now encoded to the Windows console encoding.
60
61 - Kleopatra:
62   * A library load problem has been fixed that could keep Kleopatra
63     from starting on some systems.
64   * Kleopatra has been updated to KDE Sofware Colleciton Version 4.14.
65
66 - GpgEx:
67   * GpgEX no longer crashes if the environment variable GNUPGHOME is set.
68
69 - GpgOL:
70   * Problems with Outlook sender / recipient address lookup have been
71     fixed in GpgOL. Especially for Microsoft Exchange addresses.
72
73 - Pinentry-qt:
74   * Warnings and confirmation dialogs should now open in the
75     foreground.
76   * The pinentry dialog is now translated correctly in the French locale.
77
78 - General:
79   * Used libraries have been updated.
80
81 3. Known Bugs (and Workarounds)
82 ===============================
83
84 - Using smart cards with Kleopatra:
85
86    * OpenPGP card
87      The initial setting of a smart card with Kleopatra is not yet
88      possible. Please run the following steps once to use your smart
89      card with Kleopatra.
90      Use the gpg command line tool to create a new OpenPGP certificate
91      on your card (a) or to activate your existing certificate of
92      your card (b):
93
94      (a) Create new certificate
95        - Insert card.
96        - Run "gpg --card-edit".
97        - Switch to admin modus by enter: "admin".
98        - Enter "generate" to create a new certificate.
99
100      (b) Activate existing certificate of your card
101        - Import associated (public) certificate of your card (e.g.
102          from certificate server or from a exported certificate file).
103        - Insert card.
104        - Run "gpg --card-status".
105
106    * X.509 Telesec Netkey 3 card
107      Use Kleopatra to initialize your card:
108      - Insert card.
109      - Click on the flashing Kleopatra system tray icon (or use the 
110        context menu "smart card" of the system tray icon and run the 
111        "learn card" command directly).
112
113    After finishing these steps your OpenPGP / X.509 certificate from your
114    smart card is shown in Kleopatra under the tab "My certificates" 
115    (marked with a smart card icon).
116
117 - Using the Outlook Plugin "GpgOL":
118
119   * You defintely should create copies of your old encrypted/signed
120     emails before installing GpgOL, e.g. in the form of PST files.
121
122   * For Outlook 2003/2007 only:
123     Sending signed or encrypted messages via an Exchange based account
124     does not yet work.
125     [see https://bugs.g10code.com/gnupg/issue1102]
126     (Please note, using SMTP with GpgOL and Exchange seems to be work.
127     Or use GpgOL with Outlook 2010/2013.)
128
129   * For Outlook 2003/2007 only:
130     Encrypted E-Mails occuring un-encrypted on the email server: It
131     can happen that parts of encrypted emails are copied to your email
132     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
133     or viewing them.  Affected is the content of the email view
134     window, thus usually the so-called email body.  Attachments are
135     not affected.  Switching off the Outlook preview will lower the
136     probability of this to happen, but not eliminate the issue.
137     Or use GpgOL with Outlook 2010/2013.
138
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 Listed below are the changes as recorded in the source distribution's
155 NEWS 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 ***