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