Automagically add a BETA warning if the version number includes
[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
73 3. Known Bugs (and Workarounds)
74 ===============================
75
76 - Using smart card with Kleopatra
77
78    The initial setting of smart cards with Kleopatra is currently not
79    yet possible. Please run the following steps one-time to use your
80    smart card with Kleopatra.
81
82    * OpenPGP card
83      Use the gpg command line tool to create a new OpenPGP certificate
84      on your card (a) or to activate your existing certificate of
85      your card (b):
86
87      (a) Create new certificate
88        - Insert card.
89        - Run "gpg --card-edit".
90        - Switch to admin modus by enter: "admin".
91        - Enter "generate" to create a new certificate.
92
93      (b) Activate existing certificate of your card
94        - Import associated (public) certificate of your card (e.g.
95          from certificate server or from a exported certificate file).
96        - Insert card.
97        - Run "gpg --card-status".
98
99    * X.509 Telesec Netkey 3 card
100      Use the gpgsm command line tool to initializing your card:
101      - Insert card.
102      - Run "gpgsm --learn-card".
103
104    After finishing these steps your OpenPGP / X.509 certificate
105    from your smart card is shown in Kleopatra under the tab
106    "My certificates" (marked with a smart card icon).
107
108    A good (graphical) alternative for setting up your smart
109    card and changing PIN is GPA. A better smart card support for
110    Kleopatra is in process.
111
112 - Using the Outlook Plugin "GpgOL":
113
114   * You defintely should create copies of your old encrypted/signed
115     emails, e.g. in the form of PST files.
116
117   * Encrypted E-Mails occuring un-encrypted on the email server: It
118     can happen that parts of encrypted emails are copied to your email
119     server (IMAP or MAPI) in un-encrypted/decrypted form when creating
120     or viewing them.  Affected is the content of the email view
121     window, thus usually the so-called email body.  Attachments are
122     not affected.  Switching off the Outlook preview will lower the
123     probability of this to happen, but not eliminate the issue.
124     A solution is being worked on.
125
126   * Sending signed or encrypted messages via an Exchange based account
127     does not yet work.
128
129 - Using GpgEX with Windows x64:
130
131    * GpgEX is a (32bit) plugin for the (32bit) Windows
132      Explorer and it does _not_ run in a 64bit Explorer
133      (= default for a Windows 64bit system).
134
135      Workaround: Run the 32bit Explorer to use GpgEX.
136      Click "Start" -> "Run", type the following in the box, and then
137      click OK:
138          C:\windows\syswow64\explorer.exe /separate
139      Note: Adjust the path to your x64-based version of Windows if
140      necessary.
141
142
143 4. Version History
144 ==================
145
146 Find below the changes as recorded in the source distribution's NEWS
147 file.  An up-to-date list of changes is also available at
148 http://www.gpg4win.de/change-history.html .
149
150 !NEWSFILE!
151
152
153 5. Version Numbers of Included Software
154 =======================================
155
156 !VERSIONINFO!
157
158
159
160 6. Installer Options
161 ====================
162
163 The default installation path can be speficied with the /D=PATH
164 option, which must be last on the command line.  The installer
165 supports the options /S for unattended installation, and the option
166 /C=INIFILE to specify an .ini file which should contain exactly one
167 section "[gpg4win]".  This section contains various installer settings
168 and absolute file paths to configuration files that should be
169 preinstalled.  Most options just set a different default value.
170 Excetions are documented below.  Here is an example file which shows
171 all possible keys:
172
173 [gpg4win]
174   ; Installer settings.  Do not define or leave empty for defaults.
175   inst_gpgol = true
176   inst_gpgex = true
177   inst_kleopatra = true
178   inst_gpa = true
179   inst_claws_mail = false
180   inst_compendium_de = true
181   inst_man_novice_en = true
182
183   ; Where to install short-cuts.
184   inst_start_menu = true
185   inst_desktop = false
186   inst_quick_launch_bar = false
187
188   ; Contrary to other settings in this file, the start menu folder
189   ; setting here will override the user selection at installation
190   ; time.
191   inst_start_menu_folder = Gpg4win
192
193   ; Additional configuration files to install.
194   gpg.conf = D:\config\gpg-site.conf
195   gpg-agent.conf = D:\config\gpg-agent-site.conf
196   trustlist.txt = D:\config\trustlist-site.txt
197   dirmngr.conf = D:\config\dirmngr-site.conf
198   dirmngr_ldapserver.conf = D:\config\dirmngr_ldapserver-site.conf
199   scdaemon.conf = D:\config\scdaemon-site.txt
200   gpa.conf = D:\config\gpa-site.conf
201
202 An example command for unattended installation could look like this:
203
204 gpg4win.exe /S /C=C:\TEMP\gpg4win.ini /D=D:\Programme\Gpg4win
205
206 For the MSI installer, the above also holds, with the following
207 changes: Unattended installation is achieved as usual with the /qb-
208 option to msiexec.  The control file must be called gpg4win.ini and
209 reside in the system directory (C:\WINDOWS).  It is found
210 automatically by the installer.  The installation directory can be
211 specified with an entry for "instdir".  Also, each entry can be given
212 in uppercase at the command line through INSTDIR=... and
213 INST_GPA=FALSE etc. (the control file takes precedence, though).  The
214 default config files as well as start menu directory and optional
215 installation of short cuts are currently not supported through the MSI
216 installer.
217
218
219 7. Legal notices pertaining to the individual packets
220 =====================================================
221
222 Gpg4win consist of several independent developed packages, available
223 under different license conditions.  Most of these packages however
224 are available under the GNU General Public License (GNU GPL).  Common
225 to all is that they are free to use without restrictions, may be
226 modified and that modifications may be distributed.  If the source
227 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
228 binaries and the use of the GNU GPL has been pointed out, distribution
229 is in in all cases possible.
230
231 What follows is a list of copyright statements.
232
233 !PKG-COPYRIGHT!
234
235
236
237
238 Happy GiPiGing,
239
240   Your Gpg4win Team
241
242 ***end of file ***