2008-10-21 Marcus Brinkmann <marcus@g10code.com>
[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, vesion !VERSION!.
11
12 Content:
13
14      1. Important notes
15      2. Changes
16      3. Version numbers 
17      4. Installer options
18      5. Legal notices 
19
20
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
31
32
33 2. Record of Changes (NEWS file)
34 ================================
35
36 An up-to-date list of changes is also available at
37 http://www.gpg4win.de/change-history.html .  Below you find the raw
38 NEWS file:
39
40 !NEWSFILE!
41
42
43
44
45 3. Version Numbers of Included Software
46 =======================================
47
48 !VERSIONINFO!
49
50
51
52
53 4. Installer Options
54 ====================
55
56 The default installation path can be speficied with the /D=PATH
57 option, which must be last on the command line.  The installer
58 supports the options /S for unattended installation, and the option
59 /C=INIFILE to specify an .ini file which should contain exactly one
60 section "[gpg4win]".  This section contains various installer settings
61 and absolute file paths to configuration files that should be
62 preinstalled.  Most options just set a different default value.
63 Excetions are documented below.  Here is an example file which shows
64 all possible keys:
65
66 [gpg4win]
67   ; Installer settings.  Do not define or leave empty for defaults.
68   inst_gpgol = true
69   inst_gpgex = true
70   inst_kleopatra = true
71   inst_gpa = true
72   inst_scute = true
73   inst_claws_mail = false
74   inst_compendium_de = true
75   inst_novice_manual_en = true
76   inst_novice_manual_de = true
77   inst_advanced_manual_de = true
78   inst_advanced_manual_en = true
79
80   ; Where to install short-cuts.
81   inst_start_menu = true
82   inst_desktop = false
83   inst_quick_launch_bar = false
84
85   ; Contrary to other settings in this file, the start menu folder
86   ; setting here will override the user selection at installation
87   ; time.
88   inst_start_menu_folder = GnuPG for Windows
89
90   ; Additional configuration files to install.
91   gpg.conf = D:\config\gpg-site.conf
92   gpg-agent.conf = D:\config\gpg-agent-site.conf
93   trustlist.txt = D:\config\trustlist-site.txt
94   dirmngr.conf = D:\config\dirmngr-site.conf
95   dirmngr_ldapserver.conf = D:\config\dirmngr_ldapserver-site.conf
96   scdaemon.conf = D:\config\scdaemon-site.txt
97   gpa.conf = D:\config\gpa-site.conf
98
99 An example command for unattended installation could look like this:
100
101 gpg4win.exe /S /C=C:\TEMP\gpg4win.ini /D=D:\Programme\Gpg4win
102
103 For the MSI installer, the above also holds, with the following
104 changes: Unattended installation is achieved as usual with the /qb-
105 option to msiexec.  The control file must be called gpg4win.ini and
106 reside in the system directory (C:\WINDOWS).  It is found
107 automatically by the installer.  The installation directory can be
108 specified with an entry for "instdir".  Also, each entry can be given
109 in uppercase at the command line through INSTDIR=... and
110 INST_GPA=FALSE etc. (the control file takes precedence, though).  The
111 default config files as well as start menu directory and optional
112 installation of short cuts are currently not supported through the MSI
113 installer.
114
115
116 5. Legal notices pertaining to the individual packets
117 =====================================================
118
119 Gpg4win consist of several independent developed packages, available
120 under different license conditions.  Most of these packages however
121 are available under the GNU General Public License (GNU GPL).  Common
122 to all is that they are free to use without restrictions, may be
123 modified and that modifications may be distributed.  If the source
124 files (i.e. gpg4win-src-x.y.z.exe) are distributed along with the
125 binaries and the use of the GNU GPL has been pointed out, distribution
126 is in in all cases possible.
127
128 What follows is a list of copyright statements.
129
130 !PKG-COPYRIGHT!
131
132
133
134
135 Happy GiPiGing,
136
137   Your Gpg4win Team
138
139 ***end of file ***