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