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 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 (2010 and later also in 64bit)
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 is now of the modern 2.1 variant. See:
52   https://www.gnupg.org/faq/whats-new-in-2.1.html
53   for more information about this.
54
55 - GpgOL is now also supported for 64bit Outlook.
56
57 - GpgOL for Outlook 2010 and later now uses toggle buttons
58   to let you select Encypt and Sign. The operations are done
59   when the mail is sent, including all attachments,
60   using a standard format (MIME).
61
62 - GpgOL for Outlook 2010 and later now automatically decrypts mails
63   again.
64
65 - All 68 KDE translations for Kleopatra are now included in Gpg4win.
66
67 - Kleopatra uses an updated icon theme.
68
69 - Kleopatra now shows the used curve in for ECC keys under technical
70   details.
71
72 - Kleopatra has been updated to a new set of base libraries.
73
74 - Binaries are now all installed in a bin subdirectory. DBus
75   and kbuildsycoa are no longer required. This fixes the startup issues
76   of Kleopatra some users were facing.
77
78 - After importing a secret key in Kleopatra you will be asked to directly
79   mark it as your own key. (Ownertrust)
80
81 - Kleopatra now allows you to create ECC keys in the Advanced Settings
82   during Key generation.
83
84 - Kleopatras file menu now also offers to encrypt Folders.
85
86 - Kleopatra has a new option to print a secret key through the paperkey tool.
87
88 - GPA and Kleopatra are now registred for OpenPGP and S/MIME related file extensions.
89
90 3. Known Bugs (and Workarounds)
91 ===============================
92
93 - Using smart cards with Kleopatra:
94
95    * OpenPGP card
96      The initial setting of a smart card with Kleopatra is not yet
97      possible. Please run the following steps once to use your smart
98      card with Kleopatra.
99      Use the gpg command line tool to create a new OpenPGP certificate
100      on your card (a) or to activate your existing certificate of
101      your card (b):
102
103      (a) Create new certificate
104        - Insert card.
105        - Run "gpg --card-edit".
106        - Switch to admin modus by enter: "admin".
107        - Enter "generate" to create a new certificate.
108
109      (b) Activate existing certificate of your card
110        - Import associated (public) certificate of your card (e.g.
111          from certificate server or from a exported certificate file).
112        - Insert card.
113        - Run "gpg --card-status".
114
115    * X.509 Telesec Netkey 3 card
116      Use Kleopatra to initialize your card:
117      - Insert card.
118      - Click on the flashing Kleopatra system tray icon (or use the 
119        context menu "smart card" of the system tray icon and run the 
120        "learn card" command directly).
121
122    After finishing these steps your OpenPGP / X.509 certificate from your
123    smart card is shown in Kleopatra under the tab "My certificates" 
124    (marked with a smart card icon).
125
126 - Using the Outlook Plugin "GpgOL":
127
128   * You defintely should create copies of your old encrypted/signed
129     emails before installing GpgOL, e.g. in the form of PST files.
130
131   * For Outlook 2003/2007 only:
132     Sending signed or encrypted messages via an Exchange based account
133     does not yet work.
134     [see https://bugs.g10code.com/gnupg/issue1102]
135     (Please note, using SMTP with GpgOL and Exchange seems to be work.
136     Or use GpgOL with Outlook 2010/2013.)
137
138   * For Outlook 2003/2007 only:
139     Encrypted E-Mails occuring un-encrypted on the email server: It
140     can happen that parts of encrypted emails are copied to your email
141     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
142     or viewing them.  Affected is the content of the email view
143     window, thus usually the so-called email body.  Attachments are
144     not affected.  Switching off the Outlook preview will lower the
145     probability of this to happen, but not eliminate the issue.
146     Or use GpgOL with Outlook 2010/2013.
147
148
149 4. Installation
150 ===============
151
152 For installation instructions please read the new Gpg4win Compendium:
153 http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
154
155 Hints for automated installations (without user dialogs):
156 http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
157
158
159 5. Version History
160 ==================
161
162 Listed below are the changes as recorded in the source distribution's
163 NEWS file. An up-to-date list of changes is also available at:
164 http://www.gpg4win.org/change-history.html
165
166 !NEWSFILE!
167
168
169 6. Version Numbers of Included Software
170 =======================================
171
172 !VERSIONINFO!
173
174
175 7. Legal notices pertaining to the individual packets
176 =====================================================
177
178 Gpg4win consist of several independent developed packages, available
179 under different license conditions.  Most of these packages however
180 are available under the GNU General Public License (GNU GPL).  Common
181 to all is that they are free to use without restrictions, may be
182 modified and that modifications may be distributed.  If the source
183 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
184 binaries and the use of the GNU GPL has been pointed out, distribution
185 is in in all cases possible.
186
187 What follows is a list of copyright statements.
188
189 !PKG-COPYRIGHT!
190
191
192
193
194 Happy GiPiGing,
195
196   Your Gpg4win Team
197
198
199 ***end of file ***