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