build: Change SWDB tag "gnupg21" to "gnupg22".
[gnupg.git] / README
1                        The GNU Privacy Guard 2
2                       =========================
3                              Version 2.1
4
5           Copyright 1997-2017 Werner Koch
6           Copyright 1998-2017 Free Software Foundation, Inc.
7
8
9 * INTRODUCTION
10
11   GnuPG is a complete and free implementation of the OpenPGP standard
12   as defined by RFC4880 (also known as PGP).  GnuPG enables encryption
13   and signing of data and communication, and features a versatile key
14   management system as well as access modules for public key
15   directories.
16
17   GnuPG, also known as GPG, is a command line tool with features for
18   easy integration with other applications.  A wealth of frontend
19   applications and libraries are available that make use of GnuPG.
20   Starting with version 2 GnuPG provides support for S/MIME and Secure
21   Shell in addition to OpenPGP.
22
23   GnuPG is Free Software (meaning that it respects your freedom). It
24   can be freely used, modified and distributed under the terms of the
25   GNU General Public License.
26
27   Note that the 2.0 series of GnuPG will reach end-of-life on
28   2017-12-31.  It is not possible to install a 2.1.x version along
29   with any 2.0.x version.  However, it is possible to install GnuPG
30   1.4 along with a 2.x version.
31
32
33 * BUILD INSTRUCTIONS
34
35   GnuPG 2.1 depends on the following GnuPG related packages:
36
37     npth         (ftp://ftp.gnupg.org/gcrypt/npth/)
38     libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
39     libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
40     libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
41     libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
42
43   You should get the latest versions of course, the GnuPG configure
44   script complains if a version is not sufficient.
45
46   For some advanced features several other libraries are required.
47   The configure script prints diagnostic messages if one of these
48   libraries is not available and a feature will not be available..
49
50   You also need the Pinentry package for most functions of GnuPG;
51   however it is not a build requirement.  Pinentry is available at
52   ftp://ftp.gnupg.org/gcrypt/pinentry/ .
53
54   After building and installing the above packages in the order as
55   given above, you may continue with GnuPG installation (you may also
56   just try to build GnuPG to see whether your already installed
57   versions are sufficient).
58
59   As with all packages, you just have to do
60
61     ./configure
62     make
63     make check
64     make install
65
66   The "make check" is optional but highly recommended.  To run even
67   more tests you may add "--enable-all-tests" to the configure run.
68   Before running the "make install" you might need to become root.
69
70   If everything succeeds, you have a working GnuPG with support for
71   OpenPGP, S/MIME, ssh-agent, and smartcards.  Note that there is no
72   binary gpg but a gpg2 so that this package won't conflict with a
73   GnuPG 1.4 installation.  gpg2 behaves just like gpg.
74
75   In case of problem please ask on the gnupg-users@gnupg.org mailing
76   list for advise.
77
78   Instruction on how to build for Windows can be found in the file
79   doc/HACKING in the section "How to build an installer for Windows".
80   This requires some experience as developer.
81
82   Note that the PKITS tests are always skipped unless you copy the
83   PKITS test data file into the tests/pkits directory.  There is no
84   need to run these test and some of them may even fail because the
85   test scripts are not yet complete.
86
87   You may run
88
89     gpgconf --list-dirs
90
91   to view the default directories used by GnuPG.
92
93   To quickly build all required software without installing it, the
94   Speedo method may be used:
95
96     make -f build-aux/speedo.mk  native
97
98   This method downloads all required libraries and does a native build
99   of GnuPG to PLAY/inst/.  GNU make is required and you need to set
100   LD_LIBRARY_PATH to $(pwd)/PLAY/inst/lib to test the binaries.
101
102 ** Specific build problems on some machines:
103
104 *** Apple OSX 10.x using XCode
105
106   On some versions the correct location of a header file can't be
107   detected by configure.  To fix that you should run configure like
108   this
109
110     ./configure  gl_cv_absolute_stdint_h=/usr/include/stdint.h
111
112   Add other options as needed.
113
114
115 *** Systems without a full C99 compiler
116
117   If you run into problems with your compiler complaining about dns.c
118   you may use
119
120     ./configure --disable-libdns
121
122   Add other options as needed.
123
124
125 * MIGRATION from 1.4 or 2.0 to 2.1
126
127   The major change in 2.1 is gpg-agent taking care of the OpenPGP
128   secret keys (those managed by GPG).  The former file "secring.gpg"
129   will not be used anymore.  Newly generated keys are stored in the
130   agent's key store directory "~/.gnupg/private-keys-v1.d/".  The
131   first time gpg needs a secret key it checks whether a "secring.gpg"
132   exists and copies them to the new store.  The old secring.gpg is
133   kept for use by older versions of gpg.
134
135   Note that gpg-agent now uses a fixed socket.  All tools will start
136   the gpg-agent as needed.  The formerly used environment variable
137   GPG_AGENT_INFO is ignored by 2.1.  The SSH_AUTH_SOCK environment
138   variable should be set to a fixed value.
139
140   The Dirmngr is now part of GnuPG proper and also used to access
141   OpenPGP keyservers.  The directory layout of Dirmngr changed to make
142   use of the GnuPG directories.  Dirmngr is started by gpg or gpgsm as
143   needed. There is no more need to install a separate Dirmngr package.
144
145 * RECOMMENDATIONS
146
147 ** Socket directory
148
149   GnuPG uses Unix domain sockets to connect its components (on Windows
150   an emulation of these sockets is used).  Depending on the type of
151   the file system, it is sometimes not possible to use the GnuPG home
152   directory (i.e. ~/.gnupg) as the location for the sockets.  To solve
153   this problem GnuPG prefers the use of a per-user directory below the
154   the /run (or /var/run) hierarchy for the the sockets.  It is thus
155   suggested to create per-user directories on system or session
156   startup.  For example the following snippet can be used in
157   /etc/rc.local to create these directories:
158
159       [ ! -d /run/user ] && mkdir /run/user
160       awk -F: </etc/passwd '$3 >= 1000 && $3 < 65000 {print $3}' \
161         | ( while read uid rest; do
162               if [ ! -d "/run/user/$uid" ]; then
163                 mkdir /run/user/$uid
164                 chown $uid /run/user/$uid
165                 chmod 700 /run/user/$uid
166               fi
167             done )
168
169
170 * DOCUMENTATION
171
172   The complete documentation is in the texinfo manual named
173   `gnupg.info'.  Run "info gnupg" to read it.  If you want a a
174   printable copy of the manual, change to the "doc" directory and
175   enter "make pdf" For a HTML version enter "make html" and point your
176   browser to gnupg.html/index.html.  Standard man pages for all
177   components are provided as well.  An online version of the manual is
178   available at [[https://gnupg.org/documentation/manuals/gnupg/]] .  A
179   version of the manual pertaining to the current development snapshot
180   is at [[https://gnupg.org/documentation/manuals/gnupg-devel/]] .
181
182
183 * Installing GnuPG 2.2. and GnuPG 1.4
184
185   GnuPG 2.2 is a current version of GnuPG with state of the art
186   security design and many more features.  To install both versions
187   alongside, it is suggested to rename the 1.4 version of "gpg" to
188   "gpg1" as well as the corresponding man page.  Newer releases of the
189   1.4 branch will likely do this by default.  In case this is not
190   possible, the 2.2 version can be installed under the name "gpg2"
191   using the configure option --enable-gpg-is-gpg2.
192
193
194 * HOW TO GET MORE INFORMATION
195
196   A description of new features and changes in version 2.1 can be
197   found in the file "doc/whats-new-in-2.1.txt" and online at
198   "https://gnupg.org/faq/whats-new-in-2.1.html" .
199
200   The primary WWW page is "https://www.gnupg.org"
201              or using Tor "http://ic6au7wa3f6naxjq.onion"
202   The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
203
204   See [[https://gnupg.org/download/mirrors.html]] for a list of
205   mirrors and use them if possible.  You may also find GnuPG mirrored
206   on some of the regular GNU mirrors.
207
208   We have some mailing lists dedicated to GnuPG:
209
210      gnupg-announce@gnupg.org   For important announcements like new
211                                 versions and such stuff.  This is a
212                                 moderated list and has very low traffic.
213                                 Do not post to this list.
214
215      gnupg-users@gnupg.org      For general user discussion and
216                                 help (English).
217
218      gnupg-de@gnupg.org         German speaking counterpart of
219                                 gnupg-users.
220
221      gnupg-ru@gnupg.org         Russian speaking counterpart of
222                                 gnupg-users.
223
224      gnupg-devel@gnupg.org      GnuPG developers main forum.
225
226   You subscribe to one of the list by sending mail with a subject of
227   "subscribe" to x-request@gnupg.org, where x is the name of the
228   mailing list (gnupg-announce, gnupg-users, etc.). See
229   https://www.gnupg.org/documentation/mailing-lists.html for archives
230   of the mailing lists.
231
232   Please direct bug reports to [[http://bugs.gnupg.org]] or post them
233   direct to the mailing list <gnupg-devel@gnupg.org>.
234
235   Please direct questions about GnuPG to the users mailing list or one
236   of the PGP newsgroups; please do not direct questions to one of the
237   authors directly as we are busy working on improvements and bug
238   fixes.  The English and German mailing lists are watched by the
239   authors and we try to answer questions when time allows us.
240
241   Commercial grade support for GnuPG is available; for a listing of
242   offers see https://www.gnupg.org/service.html .  Maintaining and
243   improving GnuPG requires a lot of time.  Since 2001, g10 Code GmbH,
244   a German company owned and headed by GnuPG's principal author Werner
245   Koch, is bearing the majority of these costs.  To keep GnuPG in a
246   healthy state, they need your support.
247
248   Please consider to donate at https://gnupg.org/donate/ .
249
250
251 # This file is Free Software; as a special exception the authors gives
252 # unlimited permission to copy and/or distribute it, with or without
253 # modifications, as long as this notice is preserved. For conditions
254 # of the whole package, please see the file COPYING.  This file is
255 # distributed in the hope that it will be useful, but WITHOUT ANY
256 # WARRANTY, to the extent permitted by law; without even the implied
257 # warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
258 #
259 # Local Variables:
260 # mode:org
261 # End: