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