Preparing a release candidate
[gnupg.git] / doc / README.W32
1 README.W32                                                -*- text -*-
2
3 This is a binary package with GnuPG for MS-Windows NT-4, W2000, XP and
4 Vista.  A native version for 64 bit is not available.  See the file
5 README for generic instructions and usage hints.
6
7 A FAQ comes with this package and a probably more recent one can be
8 found online at http://www.gnupg.org/faq.html.  See
9 http://www.gnupg.org/docs-mls.html for a list of mailing lists. In
10 particular the list gnupg-users@gnupg.org might be useful to answer
11 questions - but please read the FAQ first.
12
13
14 Installation directory:
15 =======================
16
17 The installation directory of GnuPG is stored in the Registry under
18 the key HKEY_LOCAL_MACHINE\Software\GNU\GnuPG with the name "Install
19 Directory".  The installer does not change the PATH environment
20 variable to include this directory.  You might want to do this
21 manually.
22
23 Note, that this registry entry is also used to locate the keyserver
24 helper programs (e.g. gpgkeys_ldap).
25
26 Below the Installation directory, you will find directories named
27 "Doc", "gnupg.nls" and "Src".  The latter will be used for distributed
28 patched, if any, and to store the source file if they have been
29 included in this package.  The source files usually require further
30 unpacking using the TAR utility.
31
32
33 Internationalization support:
34 =============================
35
36 Store the locale id (like "de") into the Registry under the key
37 HKEY_CURRENT_USER\Software\GNU\GnuPG with the name "Lang".  This must
38 match one of the installed languages files in the directory named
39 "gnupg.nls" below the installation directory.  Note, that the ".mo"
40 extension is not part of the locale id.
41
42
43 Home directory:
44 ===============
45
46 GnuPG makes use of a per user home directory to store its keys as well
47 as configuration files.  The default home directory is a directory
48 named "gnupg" below the application data directory of the user.  This
49 directory will be created if it does not exist.  Being only a default,
50 it may be changed by setting the name of the home directory into the
51 Registry under the key HKEY_CURRENT_USER\Software\GNU\GnuPG using the
52 name "HomeDir".  If an environment variable "GNUPGHOME" exists, this
53 even overrides the registry setting.  The command line option
54 "--homedir" may be used to override all other settings of the home
55 directory.
56
57
58 Reporting bugs:
59 ===============
60
61 Please check the documentation first before asking or reporting a
62 bugs.  In particular check the archives of the mailing lists (see
63 www.gnupg.org) and the bug tracking system at http://bugs.gnupg.org
64 (login is "guest" password is "guest") whether the problem is already
65 known.  Asking on the gnupg-users mailing list is also strongly
66 encouraged; if you are not subscribed it may some time until a posting
67 is approved (this is an anti-spam measure). Bug reporting addresses
68 are listed in the file AUTHORS.
69
70 If you want to report a bug or have other problems, always give
71 detailed description of the problem, the version of GnuPG you used,
72 the version of the OS, whether it is the official version from
73 gnupg.org or how you built it.  Don't edit error messages - replacing
74 sensitive information like user IDs, fingerprints and keyids is okay.
75 If possible, switch to English messages by changing the "Lang" entry
76 to empty (see under Internationalization support).
77
78
79 How to build GnuPG from the source:
80 ===================================
81
82 Until recently all official GnuPG versions have been build using the
83 Mingw32/CPD kit as available at
84 ftp://ftp.gnupg.org/people/werner/cpd/mingw32-cpd-0.3.2.tar.gz .
85 However, for maintenance reasons we switched to Debian's mingw32 cross
86 compiler package and that is now the recommended way of building GnuPG
87 for W32 platforms.  It might be possible to build it nativly on a W32
88 platform but this is not supported.  Please don't file any bug reports
89 if it does not build with any other system than the recommended one.
90
91 According to the conditions of the GNU General Public License you
92 either got the source files with this package, a written offer to send
93 you the source on demand or the source is available at the same site
94 you downloaded the binary package.  If you downloaded the package from
95 the official GnuPG site or one of its mirrors, the corresponding
96 source tarball is available in the sibling directory named gnupg.  The
97 source used to build all versions is always the same and the version
98 numbers should match.  If the version number of the binary package has
99 a letter suffix, you will find a patch file installed in the "Src"
100 directory with the changes relative to the generic version.
101
102 The source is distributed as a BZIP2 or GZIP compressed tar archive.
103 See the instructions in file README on how to check the integrity of
104 that file.  Wir a properly setup build environment, you unpack the
105 tarball change to the created directory and run
106
107  $ ./autogen.sh --build-w32
108  $ make
109  $ cp g10/gpg*.exe  /some_windows_drive/
110
111 Building a version with the installer is a bit more complex and
112 basically works by creating a top directory, unpacking in that top
113 directory, switching to the gnupg-1.x.y directory, running
114 "./autogen.sh --build-w32" and "make", switching back to the top
115 directory, running a "mkdir dist-w32; mkdir iconv", copying the
116 required iconv files (iconv.dll, README.iconv, COPYING.LIB) into the
117 iconv directory, running gnupg-1.x.y/scripts/mk-w32-dist and voila,
118 the installer package will be available in the dist-w32 directory.
119
120
121 Copying:
122 ========
123
124 GnuPG is
125
126   Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004, 
127             2005, 2006, 2007 Free Software Foundation, Inc.
128
129   GnuPG is free software; you can redistribute it and/or modify it
130   under the terms of the GNU General Public License as published by
131   the Free Software Foundation; either version 3 of the License, or
132   (at your option) any later version.
133
134   GnuPG is distributed in the hope that it will be useful, but WITHOUT
135   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
136   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
137   License for more details.
138
139   You should have received a copy of the GNU General Public License
140   along with this program; if not, see <http://www.gnu.org/licenses/>.
141
142
143 See the files AUTHORS and THANKS for credits, further legal
144 information and bug reporting addresses pertaining to GnuPG.
145
146 For copying conditions of the GNU LIBICONV library see the file
147 README.iconv.
148   
149 The installer software used to create the official binary packages for
150 W32 is NSIS (http://nsis.sourceforge.net/):
151
152   Copyright (C) 1999-2005 Nullsoft, Inc.
153
154   This license applies to everything in the NSIS package, except where
155   otherwise noted.
156
157   This software is provided 'as-is', without any express or implied
158   warranty. In no event will the authors be held liable for any
159   damages arising from the use of this software.
160
161   Permission is granted to anyone to use this software for any
162   purpose, including commercial applications, and to alter it and
163   redistribute it freely, subject to the following restrictions:
164
165   1. The origin of this software must not be misrepresented; you must
166      not claim that you wrote the original software. If you use this
167      software in a product, an acknowledgment in the product
168      documentation would be appreciated but is not required.
169
170   2. Altered source versions must be plainly marked as such, and must
171      not be misrepresented as being the original software.
172
173   3. This notice may not be removed or altered from any source
174      distribution.
175
176 The user interface used with the installer is
177
178   Copyright (C) 2002-2005 Joost Verburg
179
180   [It is distributed along with NSIS and the same conditions as stated
181   above apply]
182
183
184 The term "W32" is used to describe the API used by current Microsoft
185 Windows versions.  We don't use the Microsft terminology here; in
186 hacker terminology, calling something a "win" is a form of praise.
187 Keep in mind that Windows ist just a temporary workaround until you
188 can switch to a complete Free Software system.  Be the source always
189 with you.