Added !BUILD_ISODATE!.
[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. 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
73 Short overview on changes compared to version 2.0.4:
74 ----------------------------------------------------
75 [The following issue numbers reference to https://issues.kolab.org/.]
76
77 - Kleopatra:
78   * Conflict dialog 
79     - Certificate selection dialog now works context-sensitive
80       (dependent on selecting sign, encrypt or sign/encrypt)
81       [kolab/issue4492]
82     - Conflicts redefined and implemented, fixed errors
83       [kolab/issue4197,4234]
84     - New configuration option for "quick mode" (Power-User-Mode) to
85       sign and encrypt
86       [kolab/issue4136])
87     - No protocol (OpenPGP or S/MIME) pre-selection dialog required -
88       replaced by new certificate selection dialog.
89       [kolab/issue4213,4235]
90   * (recursive) sign/encrypt of files and folders possible (see
91     GnuPG-Backend)
92   * Create/verify checksum by sha1sum, sha256sum, md5sum possible
93     (see GnuPG-Backend)
94   * Certificate lookup on certificate server
95     - Search for fingerprint or key-id shows new information dialog 
96       (some server requires 0x-Präfix in search string)
97       [kolab/issue4453]
98   * Certify OpenPGP certificates
99     - Fingerprint and key-id in step 1 added
100       [kolab/issue4468,4458]
101     - Key-id in step 2 added
102       [kolab/issue4460]
103   * Several minor and medium (GUI) improvements:
104     - Export of secret X.509 certificats use new default (utf8) for
105       passphrase charset
106       [kolab/issue4454]
107     - Import certificate without file type improved (content checker)
108       [kolab/issue4457]
109     - Fix certificate list in delete confirm dialog
110       [kolab/issue4459] 
111     - New context menu entry for deleting certificate added
112       [kolab/issue4450]
113     - OwnerTrust added to tooltips and certificate details
114       [kolab/issue4198]
115     - Unit (Bits) to the key strength fields in NewCertificateWizard's
116       overview page added
117       [kolab/issue4183]
118     - E-Mail-Validator allows to delete '@' Zeichen
119       [kolab/issue4189]
120     - Trust/distrust root certificates via context menu
121       (write directly $GNUPGHOME\trustlist.txt)
122       [kolab/issue4190]
123     - For developer: KDebugDialog available (installed with Kleopatra,
124       run $INSTDIR\kdebugdialog.exe)
125       [kolab/issue4318]
126     - Hierarchical certificate list: toggling (regression)
127       [kolab/issue4327]
128     - Fixed exception for decrypt/verify special S/MIME e-mail
129       [kolab/issue4179]
130   * SmartCard 
131     - Detecting smartcard: Kleopatra's systemtray icon blinks after
132       inserting X.509 card. Click starts learn card command or opens
133       nullpin dialog.
134       [kolab/issue4191]
135     - Learn card commands suppress gpgsm error dialogs.
136       [kolab/issue4126]
137   * Miscellaneous
138     - Gpg4win credits added (see 'About Gpg4win' dialog)
139     - German translations fixed
140     - Several minor and medium issues and errors were fixed
141
142 - GpgOL:
143   * Portuguese translation added
144   * updated to new libassuan2 interface and libgpg-error 1.9
145
146 - GpgEX
147   * (recursive) sign/encrypt of files and folders possible (see
148     GnuPG-Backend)
149   * Create/verify checksum by sha1sum, sha256sum, md5sum possible
150     (see GnuPG-Backend)
151   * Portuguese translation added
152   * Updated to libgpg-error 1.9
153
154 - Pinentry:
155   * Change default: switch to QT4
156     (GTK still enabled for gpg4win-light installer)
157     [kolab/issue4378]
158   * Fixed German translation for 'Cancel' cancel
159     [kolab/issue4132]
160
161 - GnuPG-Backend:
162   * NEW: (recursive) sign/encrypt of files and folders possible
163     [kolab/issue4298,4299,4300] 
164   * NEW: Create/verify checksum by sha1sum, sha256sum, md5sum
165     possible via GpgEX
166     [kolab/issue41634,294,4295,4296,4297,4321]
167   * Updated to new libassuan v2 interface
168   * Several minor and medium improvements of stability
169     [u.a.: kolab/issue4212] 
170
171 - Installer:
172   * NEW: English language version of the Gpg4win Compendium
173     (v3.0.0-beta1) added. Old novices manual removed.
174   * Installer was signed with a CodeSigning certificate of GlobalSign
175     (Publisher: "Intevation GmbH")
176   * Portuguese translation added
177
178 - Included Gpg4win components are:
179     GnuPG:          2.0.16
180     Kleopatra:      2.1.0-svn1167864 (2010-08-11)
181     GPA:            0.9.0
182     GpgOL:          1.1.2
183     GpgEX:          0.9.7
184     Claws-Mail:     3.7.6
185     Kompendium DE:  3.0.0
186     Kompendium EN:  3.0.0-beta1
187
188
189 3. Known Bugs (and Workarounds)
190 ===============================
191
192 - Using smart card with Kleopatra
193
194    The initial setting of smart cards with Kleopatra is currently not
195    yet possible. Please run the following steps one-time to use your
196    smart card with Kleopatra.
197
198    * OpenPGP card
199      Use the gpg command line tool to create a new OpenPGP certificate
200      on your card (a) or to activate your existing certificate of
201      your card (b):
202
203      (a) Create new certificate
204        - Insert card.
205        - Run "gpg --card-edit".
206        - Switch to admin modus by enter: "admin".
207        - Enter "generate" to create a new certificate.
208
209      (b) Activate existing certificate of your card
210        - Import associated (public) certificate of your card (e.g.
211          from certificate server or from a exported certificate file).
212        - Insert card.
213        - Run "gpg --card-status".
214
215    * X.509 Telesec Netkey 3 card
216      Use Kleopatra to initializing your card:
217      - Insert card.
218      - Click at the Kleopatra systemtray icon (or use the context menu of
219        the systemtray icon and run the learn card command).
220
221    After finishing these steps your OpenPGP / X.509 certificate
222    from your smart card is shown in Kleopatra under the tab
223    "My certificates" (marked with a smart card icon).
224
225    A better smart card support for Kleopatra is in process.
226
227 - Using the Outlook Plugin "GpgOL":
228
229   * You defintely should create copies of your old encrypted/signed
230     emails, e.g. in the form of PST files.
231
232   * Sending signed or encrypted messages via an Exchange based account
233     does not yet work.
234     [see https://bugs.g10code.com/gnupg/issue1102]
235
236   * Outlook2007 crashes after opening attachments of an encrypted message
237     [see https://bugs.g10code.com/gnupg/issue1110]
238
239   * Encrypted E-Mails occuring un-encrypted on the email server: It
240     can happen that parts of encrypted emails are copied to your email
241     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
242     or viewing them.  Affected is the content of the email view
243     window, thus usually the so-called email body.  Attachments are
244     not affected.  Switching off the Outlook preview will lower the
245     probability of this to happen, but not eliminate the issue.
246     A solution is being worked on.
247
248 - Using GpgEX with Windows x64:
249
250    * In some cases sign/encrypt or decrypt/verify via GpgEX doesn't work 
251      correctly (Kleopatra freezed). Then you should kill Kleopatra via 
252      task manager and run the file crypto operation directly in Kleopatra
253      (see file menu).
254
255    * Problems with Windows x64:
256      GpgEX is a (32bit) plugin for the (32bit) Windows
257      Explorer and it does _not_ run in a 64bit Explorer
258      (= default for a Windows 64bit system).
259
260      Workaround: Run the 32bit Explorer to use GpgEX.
261      Click "Start" -> "Run", type the following in the box, and then
262      click OK:
263          C:\windows\syswow64\explorer.exe /separate
264      Note: Adjust the path to your x64-based version of Windows if
265      necessary. 
266      This separate command seems to be currently broken in Win7/64bit.
267
268
269 4. Version History
270 ==================
271
272 Find below the changes as recorded in the source distribution's NEWS
273 file.  An up-to-date list of changes is also available at
274 http://www.gpg4win.de/change-history.html .
275
276 !NEWSFILE!
277
278
279 5. Version Numbers of Included Software
280 =======================================
281
282 !VERSIONINFO!
283
284
285
286 6. Installer Options
287 ====================
288
289 The default installation path can be speficied with the /D=PATH
290 option, which must be last on the command line.  The installer
291 supports the options /S for unattended installation, and the option
292 /C=INIFILE to specify an .ini file which should contain exactly one
293 section "[gpg4win]".  This section contains various installer settings
294 and absolute file paths to configuration files that should be
295 preinstalled.  Most options just set a different default value.
296 Excetions are documented below.  Here is an example file which shows
297 all possible keys:
298
299 [gpg4win]
300   ; Installer settings.  Do not define or leave empty for defaults.
301   inst_gpgol = true
302   inst_gpgex = true
303   inst_kleopatra = true
304   inst_gpa = true
305   inst_claws_mail = false
306   inst_compendium_de = true
307   inst_man_novice_en = true
308
309   ; Where to install short-cuts.
310   inst_start_menu = true
311   inst_desktop = false
312   inst_quick_launch_bar = false
313
314   ; Contrary to other settings in this file, the start menu folder
315   ; setting here will override the user selection at installation
316   ; time.
317   inst_start_menu_folder = Gpg4win
318
319   ; Additional configuration files to install.
320   gpg.conf = D:\config\gpg-site.conf
321   gpg-agent.conf = D:\config\gpg-agent-site.conf
322   trustlist.txt = D:\config\trustlist-site.txt
323   dirmngr.conf = D:\config\dirmngr-site.conf
324   dirmngr_ldapserver.conf = D:\config\dirmngr_ldapserver-site.conf
325   scdaemon.conf = D:\config\scdaemon-site.txt
326   gpa.conf = D:\config\gpa-site.conf
327
328 An example command for unattended installation could look like this:
329
330 gpg4win.exe /S /C=C:\TEMP\gpg4win.ini /D=D:\Programme\Gpg4win
331
332 For the MSI installer, the above also holds, with the following
333 changes: Unattended installation is achieved as usual with the /qb-
334 option to msiexec.  The control file must be called gpg4win.ini and
335 reside in the system directory (C:\WINDOWS).  It is found
336 automatically by the installer.  The installation directory can be
337 specified with an entry for "instdir".  Also, each entry can be given
338 in uppercase at the command line through INSTDIR=... and
339 INST_GPA=FALSE etc. (the control file takes precedence, though).  The
340 default config files as well as start menu directory and optional
341 installation of short cuts are currently not supported through the MSI
342 installer.
343
344
345 7. Legal notices pertaining to the individual packets
346 =====================================================
347
348 Gpg4win consist of several independent developed packages, available
349 under different license conditions.  Most of these packages however
350 are available under the GNU General Public License (GNU GPL).  Common
351 to all is that they are free to use without restrictions, may be
352 modified and that modifications may be distributed.  If the source
353 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
354 binaries and the use of the GNU GPL has been pointed out, distribution
355 is in in all cases possible.
356
357 What follows is a list of copyright statements.
358
359 !PKG-COPYRIGHT!
360
361
362
363
364 Happy GiPiGing,
365
366   Your Gpg4win Team
367
368 ***end of file ***