Update the README and NEWS files.
[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
10 This is GnuPG for Windows, version !VERSION!.
11
12 Content:
13
14      1. Important notes
15      2. Known bugs
16      3. Changes
17      4. Version numbers 
18      5. Installer options
19      6. Legal notices 
20
21
22 1. Important Notes
23 ==================
24
25 Manuals describing the installation of Gpg4win are currently only
26 available in German.  Check out http://www/gpg4win.org for latest
27 news.
28
29 If you used an older version of Gpg4win in the past, please check
30 out the migration hints in the Gpg4win Compendium's appendix.
31
32
33 2. Known Bugs
34 =============
35
36   * Kleopatra is still under development: Some functionalities for
37     OpenPGP are still missing.  You can use GPA for the missing
38     functionality.
39
40
41
42 3. Changes
43 ==========
44
45 Gpg4win/2 has major changes compared to Gpg4win 1.x.  Below is a list
46 of the most important ones:
47
48 - Kleopatra is the new certificate manager.  Kleopatra is the S/MIME
49   certificate manager of KDE (a desktop environment used on many
50   GNU/Linux systems).  For use in Gpg4win it has been extended to
51   support OpenPGP and to act as a graphical user interface for all
52   cryptographic operations.  It is automagically started if another
53   component requests its services and then runs permanently in your
54   system tray.  WinPT has been dropped.
55
56 - GpgEX is the new plugin for the Explorer and replaces GpgEE.
57
58 - The mail program Claws Mail has been updated to a modern version.
59   It now supports SSL, NNTP and IMAP.
60
61 - GpgOL, the plugin for Outlook 2003 and 2007 has been comprehensively
62   updated.  It now supports PGP/MIME and thus makes the use of
63   encrypted or signed attachments much easier and standard conform.
64   Support for S/MIME has been added.  Most dialogs are now provided by
65   Kleopatra for graphical user dialogs.
66
67 - The German Gpg4win Kompendium is the new documentation for Gpg4win.
68   This combines the previous "Einsteiger" and "Durchblicker" manuals.
69   All chapters were reworked and extended to describe the new Gpg4win
70   Version 2.0.  Among other things, this means adaption to Kleopatra,
71   GpgEX and PGP/MIME and new texts for S/MIME and X.509.
72
73
74 3.1 Version history
75 -------------------
76
77 Find below the changes as recorded in the source distribution's NEWS
78 file.  An up-to-date list of changes is also available at
79 http://www.gpg4win.de/change-history.html .
80
81
82 !NEWSFILE!
83
84
85
86
87 4. Version Numbers of Included Software
88 =======================================
89
90 !VERSIONINFO!
91
92
93
94
95 5. Installer Options
96 ====================
97
98 The default installation path can be speficied with the /D=PATH
99 option, which must be last on the command line.  The installer
100 supports the options /S for unattended installation, and the option
101 /C=INIFILE to specify an .ini file which should contain exactly one
102 section "[gpg4win]".  This section contains various installer settings
103 and absolute file paths to configuration files that should be
104 preinstalled.  Most options just set a different default value.
105 Excetions are documented below.  Here is an example file which shows
106 all possible keys:
107
108 [gpg4win]
109   ; Installer settings.  Do not define or leave empty for defaults.
110   inst_gpgol = true
111   inst_gpgex = true
112   inst_kleopatra = true
113   inst_gpa = true
114   inst_scute = true
115   inst_claws_mail = false
116   inst_compendium_de = true
117   inst_novice_manual_en = true
118   inst_novice_manual_de = true
119   inst_advanced_manual_de = true
120   inst_advanced_manual_en = true
121
122   ; Where to install short-cuts.
123   inst_start_menu = true
124   inst_desktop = false
125   inst_quick_launch_bar = false
126
127   ; Contrary to other settings in this file, the start menu folder
128   ; setting here will override the user selection at installation
129   ; time.
130   inst_start_menu_folder = GnuPG for Windows
131
132   ; Additional configuration files to install.
133   gpg.conf = D:\config\gpg-site.conf
134   gpg-agent.conf = D:\config\gpg-agent-site.conf
135   trustlist.txt = D:\config\trustlist-site.txt
136   dirmngr.conf = D:\config\dirmngr-site.conf
137   dirmngr_ldapserver.conf = D:\config\dirmngr_ldapserver-site.conf
138   scdaemon.conf = D:\config\scdaemon-site.txt
139   gpa.conf = D:\config\gpa-site.conf
140
141 An example command for unattended installation could look like this:
142
143 gpg4win.exe /S /C=C:\TEMP\gpg4win.ini /D=D:\Programme\Gpg4win
144
145 For the MSI installer, the above also holds, with the following
146 changes: Unattended installation is achieved as usual with the /qb-
147 option to msiexec.  The control file must be called gpg4win.ini and
148 reside in the system directory (C:\WINDOWS).  It is found
149 automatically by the installer.  The installation directory can be
150 specified with an entry for "instdir".  Also, each entry can be given
151 in uppercase at the command line through INSTDIR=... and
152 INST_GPA=FALSE etc. (the control file takes precedence, though).  The
153 default config files as well as start menu directory and optional
154 installation of short cuts are currently not supported through the MSI
155 installer.
156
157
158 6. Legal notices pertaining to the individual packets
159 =====================================================
160
161 Gpg4win consist of several independent developed packages, available
162 under different license conditions.  Most of these packages however
163 are available under the GNU General Public License (GNU GPL).  Common
164 to all is that they are free to use without restrictions, may be
165 modified and that modifications may be distributed.  If the source
166 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
167 binaries and the use of the GNU GPL has been pointed out, distribution
168 is in in all cases possible.
169
170 What follows is a list of copyright statements.
171
172 !PKG-COPYRIGHT!
173
174
175
176
177 Happy GiPiGing,
178
179   Your Gpg4win Team
180
181 ***end of file ***