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