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