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