speedo: Improve building of the w32 installer.
[gnupg.git] / README
1                        The GNU Privacy Guard 2
2                       =========================
3                              Version 2.1
4
5    THIS IS A DEVELOPMENT VERSION AND NOT INTENDED FOR REGULAR USE.
6
7           Copyright 1997-1998, 2013-2014 Werner Koch
8           Copyright 1998-2013 Free Software Foundation, Inc.
9
10
11 INTRODUCTION
12 ============
13
14 GnuPG is a tool for secure communication and data storage.  It can be
15 used to encrypt data and to create digital signatures.  It includes an
16 advanced key management facility and is compliant with the proposed
17 OpenPGP Internet standard as described in RFC4880 and the S/MIME
18 standard as described by several RFCs.
19
20 GnuPG is distributed under the terms of the GNU General Public
21 License.  See the file COPYING for details.  GnuPG works best on
22 GNU/Linux or *BSD systems.  Most other Unices are also supported but
23 are not as well tested as the Free Unices.
24
25 GnuPG-2 is the stable version of GnuPG integrating support for OpenPGP
26 and S/MIME.  It does not conflict with an installed 1.4 OpenPGP-only
27 version.
28
29
30 BUILD INSTRUCTIONS
31 ==================
32
33 GnuPG 2.1 depends on the following packages:
34
35   npth         (ftp://ftp.gnupg.org/gcrypt/npth/)
36   libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
37   libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
38   libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
39   libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
40
41 You should get the latest versions of course, the GnuPG configure
42 script complains if a version is not sufficient.
43
44 For some advanced features several other libraries are required.  The
45 configure script prints diagnostic messages if one of these libraries
46 is not available and a feature will not be available..
47
48 You also need the Pinentry package for most functions of GnuPG;
49 however it is not a build requirement.  Pinentry is available at
50 ftp://ftp.gnupg.org/gcrypt/pinentry/ .
51
52 After building and installing the above packages in the order as given
53 above, you may continue with GnuPG installation (you may also just try
54 to build GnuPG to see whether your already installed versions are
55 sufficient).
56
57 As with all packages, you just have to do
58
59  ./configure
60  make
61  make install
62
63 (Before doing install you might need to become root.)
64
65 If everything succeeds, you have a working GnuPG with support for
66 OpenPGP, S/MIME, ssh-agent, and smartcards.  Note that there is no
67 binary gpg but a gpg2 so that this package won't conflict with a GnuPG
68 1.4 installation.  gpg2 behaves just like gpg.
69
70 In case of problem please ask on the gnupg-users@gnupg.org mailing
71 list for advise.
72
73 Note that the PKITS tests are always skipped unless you copy the PKITS
74 test data file into the tests/pkits directory.  There is no need to
75 run these test and some of them may even fail because the test scripts
76 are not yet complete.
77
78 You may run
79
80   gpgconf --list-dirs
81
82 to view the default directories used by GnuPG.
83
84
85 MIGRATION FROM 1.4 or 2.0 to 2.1
86 ================================
87
88 The major change in 2.1 is gpg-agent taking care of the OpenPGP secret
89 keys (those managed by GPG).  The former file "secring.gpg" will not
90 be used anymore.  Newly generated keys are stored in the agent's key
91 store directory "~/.gnupg/private-keys-v1.d/".  The first time gpg
92 needs a secret key it checks whether a "secring.gpg" exists and
93 copies them to the new store.  The old secring.gpg is kept for use by
94 older versions of gpg.
95
96 Note that gpg-agent now uses a fixed socket by default.  All tools
97 will start the gpg-agent as needed.  In general there is no more need
98 to set the GPG_AGENT_INFO environment variable.  The SSH_AUTH_SOCK
99 environment variable should be set to a fixed value.
100
101 GPG's smartcard commands --card-edit and --card-status as well as some
102 of the card related sub-commands of --edit-key are not yet fully
103 supported.  However, signing and decryption with a smartcard does
104 work.
105
106 The Dirmngr is now part of GnuPG proper and also used to access
107 OpenPGP keyservers.  The directroy layout of Dirmngr changed to make
108 use of the GnuPG directories.  Dirmngr is started by gpg or gpgsm as
109 needed needed. There is no more need to install a separate dirmngr
110 package.
111
112
113
114 DOCUMENTATION
115 =============
116
117 The complete documentation is in the texinfo manual named
118 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
119 copy of the manual, change to the "doc" directory and enter "make pdf"
120 For a HTML version enter "make html" and point your browser to
121 gnupg.html/index.html.  Standard man pages for all components are
122 provided as well.  An online version of the manual is available at
123 http://www.gnupg.org/documentation/manuals/gnupg/ .  A version of the
124 manual pertaining to the current development snapshot is at
125 http://www.gnupg.org/documentation/manuals/gnupg-devel/ .
126
127
128 GNUPG 1.4 AND GNUPG 2.0
129 =======================
130
131 GnuPG 2.0 is a newer version of GnuPG with additional support for
132 S/MIME.  It has a different design philosophy that splits
133 functionality up into several modules.  Both versions may be installed
134 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
135 In fact, the gpg version from GnuPG 1.4 is able to make use of the
136 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
137 caching.  The advantage of GnuPG 1.4 is its smaller size and no
138 dependency on other modules at run and build time.
139
140
141 HOW TO GET MORE INFORMATION
142 ===========================
143
144 The primary WWW page is "https://www.gnupg.org"
145            or using TOR "http://ic6au7wa3f6naxjq.onion"
146 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
147
148 See https://www.gnupg.org/download/mirrors.html for a list of mirrors
149 and use them if possible.  You may also find GnuPG mirrored on some of
150 the regular GNU mirrors.
151
152 We have some mailing lists dedicated to GnuPG:
153
154    gnupg-announce@gnupg.org   For important announcements like new
155                               versions and such stuff.  This is a
156                               moderated list and has very low traffic.
157                               Do not post to this list.
158
159    gnupg-users@gnupg.org      For general user discussion and
160                               help (English).
161
162    gnupg-de@gnupg.org         German speaking counterpart of
163                               gnupg-users.
164
165    gnupg-ru@gnupg.org         Russian speaking counterpart of
166                               gnupg-users.
167
168    gnupg-devel@gnupg.org      GnuPG developers main forum.
169
170 You subscribe to one of the list by sending mail with a subject of
171 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
172 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
173 lists are available at http://www.gnupg.org/documentation/mailing-lists.html
174
175 Please direct bug reports to http://bugs.gnupg.org or post them direct
176 to the mailing list <gnupg-devel@gnupg.org>.
177
178 Please direct questions about GnuPG to the users mailing list or one
179 of the pgp newsgroups; please do not direct questions to one of the
180 authors directly as we are busy working on improvements and bug fixes.
181 The English and German mailing lists are watched by the authors and we
182 try to answer questions when time allows us to do so.
183
184 Commercial grade support for GnuPG is available; for a listing of
185 offers see https://www.gnupg.org/service.html .  Maintaining and
186 improving GnuPG is costly.  Since 2001, g10 Code GmbH, a German
187 company owned and headed by GnuPG's principal author Werner Koch, is
188 bearing the majority of these costs.  To help them carry on this work,
189 they need your support.  See https://gnupg.org/donate/ .
190
191   This file is Free Software; as a special exception the authors gives
192   unlimited permission to copy and/or distribute it, with or without
193   modifications, as long as this notice is preserved. For conditions
194   of the whole package, please see the file COPYING.  This file is
195   distributed in the hope that it will be useful, but WITHOUT ANY
196   WARRANTY, to the extent permitted by law; without even the implied
197   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.