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