Add new sponsor
[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!.
11
12 Content:
13
14      1. Important Notes
15      2. Changes
16      3. Known Bugs (and Workarounds)
17      4. Version History
18      5. Version Numbers of Included Software
19      6. Installer Options
20      7. Legal Notices
21
22
23 1. Important Notes
24 ==================
25
26 Manuals describing the installation of Gpg4win are currently only
27 available in German.  Check out http://www/gpg4win.org for latest
28 news.
29
30 If you used an older version of Gpg4win in the past, please check
31 out the migration hints in the Gpg4win Compendium's appendix.
32
33 Please read the "Known bugs" section before you start working with
34 Gpg4win.
35
36
37 2. Changes
38 ==========
39
40 Gpg4win2 has major changes compared to Gpg4win 1.x.  Below is a list
41 of the most important ones:
42
43 - Kleopatra is the new certificate manager.  Kleopatra is the S/MIME
44   certificate manager of KDE (a desktop environment used on many
45   GNU/Linux systems).  For use in Gpg4win it has been extended to
46   support OpenPGP and to act as a graphical user interface for all
47   cryptographic operations.  It is automatically started if another
48   component requests its services and then runs permanently in your
49   system tray.  WinPT has been dropped.
50
51 - GpgEX is the new plugin for the Microsoft Explorer and replaces GpgEE.
52
53 - The mail program Claws Mail has been updated to a modern version.
54   It now supports SSL, NNTP and IMAP.
55
56 - GpgOL, the plugin for Outlook 2003 and 2007 has been comprehensively
57   updated.  It now supports PGP/MIME and thus makes the use of
58   encrypted or signed attachments much easier and standard conform.
59   Support for S/MIME has been added.  Most dialogs are now provided by
60   Kleopatra for graphical user dialogs.
61
62 - The German "Gpg4win-Kompendium" is the new documentation for Gpg4win.
63   This combines the previous "Einsteiger" and "Durchblicker" manuals.
64   All chapters were reworked and extended to describe the new Gpg4win
65   Version 2.0. Among other things, this means adaption to Kleopatra,
66   GpgEX and PGP/MIME and new texts for S/MIME and X.509.
67
68 - Support of these platforms:
69   Operating System: Windows 2000, XP (32/64), Vista (32/64)
70   Outlook: 2003, 2007
71
72 Short overview on changes compared to version 2.0.1:
73 ----------------------------------------------------
74 - Kleopatra:
75   * New certificate wizard for OpenPGP and X.509 improved
76   * Certificate selection dialog for sign/encrypt comes up in case of  
77     conflict only
78   * Result dialog for sign/encrypt combined in one window
79   * File crypto operations with GpgEX stabilized
80   * SmartCard support for X.509 NetKey cards improved
81   * Rekursive sign/encrypt of files/directory now possible; condition:  
82     external archive tool required (see README file for configuration)
83   * new oxygen icons
84   * Several minor and medium issues and errors were fixed
85
86 - GpgOL:
87   * Symbol load mechanism improved to add new icons
88     (now with crypto icons for the message list)
89
90 - Pinentry:
91   * Change default: switch from GTK to QT4
92     (GTK still enabled for gpg4win-light installer)
93   * new icons for pinentry-qt4
94   * Pinentry-qt4 dialog always comes up in foreground
95
96 - GnuPG-Backend:
97   * Generate new certificate for OpenPGP/X.509: default key length
98     updated (new Default: RSA, 2048 bit); 
99     furthermore select list of key length in Kleopatra updated
100
101 - Installer:
102   * new images for NSIS installer
103
104 - Included components are:
105     GnuPG:        2.0.14
106     Kleopatra:    2.0.14-svn1098530 (20100303)
107     GPA:          0.9.0
108     GpgOL:        1.1.1
109     GpgEX:        0.9.5
110     Claws-Mail:   3.7.4cvs1
111     Kompendium:   3.0.0-rc1
112
113
114 3. Known Bugs (and Workarounds)
115 ===============================
116
117 - Using smart card with Kleopatra
118
119    The initial setting of smart cards with Kleopatra is currently not
120    yet possible. Please run the following steps one-time to use your
121    smart card with Kleopatra.
122
123    * OpenPGP card
124      Use the gpg command line tool to create a new OpenPGP certificate
125      on your card (a) or to activate your existing certificate of
126      your card (b):
127
128      (a) Create new certificate
129        - Insert card.
130        - Run "gpg --card-edit".
131        - Switch to admin modus by enter: "admin".
132        - Enter "generate" to create a new certificate.
133
134      (b) Activate existing certificate of your card
135        - Import associated (public) certificate of your card (e.g.
136          from certificate server or from a exported certificate file).
137        - Insert card.
138        - Run "gpg --card-status".
139
140    * X.509 Telesec Netkey 3 card
141      Use Kleopatra to initializing your card:
142      - Insert card.
143      - Click at the Kleopatra systemtray icon (or use the context menu of
144        the systemtray icon and run the learn card command).
145
146    After finishing these steps your OpenPGP / X.509 certificate
147    from your smart card is shown in Kleopatra under the tab
148    "My certificates" (marked with a smart card icon).
149
150    A good (graphical) alternative for setting up your smart
151    card and changing PIN is GPA. A better smart card support for
152    Kleopatra is in process.
153
154 - Using the Outlook Plugin "GpgOL":
155
156   * You defintely should create copies of your old encrypted/signed
157     emails, e.g. in the form of PST files.
158
159   * Encrypted E-Mails occuring un-encrypted on the email server: It
160     can happen that parts of encrypted emails are copied to your email
161     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
162     or viewing them.  Affected is the content of the email view
163     window, thus usually the so-called email body.  Attachments are
164     not affected.  Switching off the Outlook preview will lower the
165     probability of this to happen, but not eliminate the issue.
166     A solution is being worked on.
167
168   * Sending signed or encrypted messages via an Exchange based account
169     does not yet work.
170
171 - Using GpgEX with Windows x64:
172
173    * In some cases sign/encrypt or decrypt/verify via GpgEX doesn't work 
174      correctly (Kleopatra freezed). Then you should kill Kleopatra via 
175      task manager and run the file crypto operation directly in Kleopatra
176      (see file menu).
177
178    * Problems with Windows x64:
179      GpgEX is a (32bit) plugin for the (32bit) Windows
180      Explorer and it does _not_ run in a 64bit Explorer
181      (= default for a Windows 64bit system).
182
183      Workaround: Run the 32bit Explorer to use GpgEX.
184      Click "Start" -> "Run", type the following in the box, and then
185      click OK:
186          C:\windows\syswow64\explorer.exe /separate
187      Note: Adjust the path to your x64-based version of Windows if
188      necessary. 
189      This separate command seems to be currently broken in Win7/64bit.
190
191 - sign/encrypt files with archive function:
192
193    * The new Kleopatra function to sign/encrypt files as archive
194      is currently not full implemented. It's for testing for 
195      expert users only. An extra archive application is required.
196      Configure the pack command in the config file of Kleopatra:
197        C:\Programme\GNU\GnuPG\share\config\libkleopatrarc
198      Here an exemple for the tool "7-ZIP" (http://www.7-zip.org):
199         [Archive Definition #0]
200         Name=TAR (via 7-ZIP)
201         id=7zip
202         extensions=tar
203         pack-command=7z a dummy -ttar -so
204
205
206 4. Version History
207 ==================
208
209 Find below the changes as recorded in the source distribution's NEWS
210 file.  An up-to-date list of changes is also available at
211 http://www.gpg4win.de/change-history.html .
212
213 !NEWSFILE!
214
215
216 5. Version Numbers of Included Software
217 =======================================
218
219 !VERSIONINFO!
220
221
222
223 6. Installer Options
224 ====================
225
226 The default installation path can be speficied with the /D=PATH
227 option, which must be last on the command line.  The installer
228 supports the options /S for unattended installation, and the option
229 /C=INIFILE to specify an .ini file which should contain exactly one
230 section "[gpg4win]".  This section contains various installer settings
231 and absolute file paths to configuration files that should be
232 preinstalled.  Most options just set a different default value.
233 Excetions are documented below.  Here is an example file which shows
234 all possible keys:
235
236 [gpg4win]
237   ; Installer settings.  Do not define or leave empty for defaults.
238   inst_gpgol = true
239   inst_gpgex = true
240   inst_kleopatra = true
241   inst_gpa = true
242   inst_claws_mail = false
243   inst_compendium_de = true
244   inst_man_novice_en = true
245
246   ; Where to install short-cuts.
247   inst_start_menu = true
248   inst_desktop = false
249   inst_quick_launch_bar = false
250
251   ; Contrary to other settings in this file, the start menu folder
252   ; setting here will override the user selection at installation
253   ; time.
254   inst_start_menu_folder = Gpg4win
255
256   ; Additional configuration files to install.
257   gpg.conf = D:\config\gpg-site.conf
258   gpg-agent.conf = D:\config\gpg-agent-site.conf
259   trustlist.txt = D:\config\trustlist-site.txt
260   dirmngr.conf = D:\config\dirmngr-site.conf
261   dirmngr_ldapserver.conf = D:\config\dirmngr_ldapserver-site.conf
262   scdaemon.conf = D:\config\scdaemon-site.txt
263   gpa.conf = D:\config\gpa-site.conf
264
265 An example command for unattended installation could look like this:
266
267 gpg4win.exe /S /C=C:\TEMP\gpg4win.ini /D=D:\Programme\Gpg4win
268
269 For the MSI installer, the above also holds, with the following
270 changes: Unattended installation is achieved as usual with the /qb-
271 option to msiexec.  The control file must be called gpg4win.ini and
272 reside in the system directory (C:\WINDOWS).  It is found
273 automatically by the installer.  The installation directory can be
274 specified with an entry for "instdir".  Also, each entry can be given
275 in uppercase at the command line through INSTDIR=... and
276 INST_GPA=FALSE etc. (the control file takes precedence, though).  The
277 default config files as well as start menu directory and optional
278 installation of short cuts are currently not supported through the MSI
279 installer.
280
281
282 7. Legal notices pertaining to the individual packets
283 =====================================================
284
285 Gpg4win consist of several independent developed packages, available
286 under different license conditions.  Most of these packages however
287 are available under the GNU General Public License (GNU GPL).  Common
288 to all is that they are free to use without restrictions, may be
289 modified and that modifications may be distributed.  If the source
290 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
291 binaries and the use of the GNU GPL has been pointed out, distribution
292 is in in all cases possible.
293
294 What follows is a list of copyright statements.
295
296 !PKG-COPYRIGHT!
297
298
299
300
301 Happy GiPiGing,
302
303   Your Gpg4win Team
304
305 ***end of file ***