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