Release 2.0.31
[gnupg.git] / README
1                        The GNU Privacy Guard
2                       =======================
3                             Version 2.0
4
5    Copyright 1997-2015 Werner Koch
6    Copyright 1998-2015 Free Software Foundation, Inc.
7
8
9 NOTE: This branch is not anymore supported.
10       Please upgrade to version 2.2
11
12
13 INTRODUCTION
14 ============
15
16 GnuPG is GNU's tool for secure communication and data storage.  It can
17 be used to encrypt data and to create digital signatures.  It includes
18 an advanced key management facility and is compliant with the proposed
19 OpenPGP Internet standard as described in RFC4880 and the S/MIME
20 standard as described by several RFCs.
21
22 GnuPG is distributed under the terms of the GNU General Public
23 License.  See the file COPYING for details.  GnuPG works best on
24 GNU/Linux or *BSD systems.  Most other Unices are also supported but
25 are not as well tested as the Free Unices.
26
27 GnuPG 2.0 is the stable version of GnuPG integrating support for
28 OpenPGP and S/MIME.  It does not conflict with an installed 1.4
29 OpenPGP-only version.
30
31
32
33 BUILD INSTRUCTIONS
34 ==================
35
36 GnuPG 2.0 depends on the following packages:
37
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 >= 2.0 (ftp://ftp.gnupg.org/gcrypt/libassuan/)
42
43 You also need the Pinentry package for most function of GnuPG; however
44 it is not a build requirement.  Pinentry is available at
45 ftp://ftp.gnupg.org/gcrypt/pinentry/ .
46
47 You should get the latest versions of course, the GnuPG configure
48 script complains if a version is not sufficient.
49
50 After building and installing the above packages in the order as given
51 above, you may now continue with GnuPG installation (you may also just
52 try to build GnuPG to see whether your already installed versions are
53 sufficient).
54
55 As with all packages, you just have to do
56
57  ./configure
58  make
59  make install
60
61 (Before doing install you might need to become root.)
62
63 If everything succeeds, you have a working GnuPG with support for
64 S/MIME and smartcards.  Note that there is no binary gpg but a gpg2 so
65 that this package won't conflict with a GnuPG 1.4 installation.  gpg2
66 behaves just like gpg.
67
68 In case of problem please ask on gnupg-users@gnupg.org for advise.
69
70 Note that the PKITS tests are always skipped unless you copy the PKITS
71 test data file into the tests/pkits directory.
72
73
74 INCOMPATIBLE CHANGES
75 ====================
76
77 - With 2.0.20 the scdaemon option 'disable-keypad' has been renamed to
78   'disable-pinpad'.  If you are using this option in scdaemon.conf you
79   should rename it there.  In case you are using this option to work
80   around a problem with your card reader, you may want to test whether
81   this version of GnuPG works better with your reader.
82
83
84 DOCUMENTATION
85 =============
86
87 The complete documentation is in the texinfo manual named
88 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
89 copy of the manual, change to the "doc" directory and enter "make pdf"
90 For a HTML version enter "make html" and point your browser to
91 gnupg.html/index.html.  Standard man pages for all components are
92 provided as well.  An online version of the manual is available at
93 https://gnupg.org/documentation/manuals/gnupg/ .  A version of the
94 manual pertaining to the current development snapshot is at
95 https://gnupg.org/documentation/manuals/gnupg-devel/ .
96
97
98 GNUPG 1.4 AND GNUPG 2.0
99 =======================
100
101 GnuPG 2.0 is a newer version of GnuPG with additional support for
102 S/MIME.  It has a different design philosophy that splits
103 functionality up into several modules.  Both versions may be installed
104 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
105 In fact, the gpg version from GnuPG 1.4 is able to make use of the
106 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
107 caching.  The advantage of GnuPG 1.4 is its smaller size and no
108 dependency on other modules at run and build time.
109
110
111 HOW TO GET MORE INFORMATION
112 ===========================
113
114 The primary WWW page is "https://gnupg.org"
115            or using TOR "http://ic6au7wa3f6naxjq.onion"
116 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
117
118 See https://gnupg.org/download/mirrors.html for a list of mirrors and
119 use them if possible.  You may also find GnuPG mirrored on some of the
120 regular GNU mirrors.
121
122 We have some mailing lists dedicated to GnuPG:
123
124    gnupg-announce@gnupg.org   For important announcements like new
125                               versions and such stuff.  This is a
126                               moderated list and has very low traffic.
127                               Do not post to this list.
128
129    gnupg-users@gnupg.org      For general user discussion and
130                               help (English).
131
132    gnupg-de@gnupg.org         German speaking counterpart of
133                               gnupg-users.
134
135    gnupg-ru@gnupg.org         Russian speaking counterpart of
136                               gnupg-users.
137
138    gnupg-devel@gnupg.org      GnuPG developers main forum.
139
140 You subscribe to one of the list by sending mail with a subject of
141 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
142 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
143 lists is available at <https://gnupg.org/documentation/mailing-lists.html>.
144
145 Please direct bug reports to http://bugs.gnupg.org or post them direct
146 to the mailing list <gnupg-devel@gnupg.org>.
147
148 Please direct questions about GnuPG to the users mailing list or one
149 of the pgp newsgroups; please do not direct questions to one of the
150 authors directly as we are busy working on improvements and bug fixes.
151 The English and German mailing lists are watched by the authors and we
152 try to answer questions when time allows us to do so.
153
154 Commercial grade support for GnuPG is available; for a listing of
155 offers see https://gnupg.org/service.html .  Maintaining and
156 improving GnuPG is costly.  For more than a decade, g10 Code GmbH, a
157 German company owned and headed by GnuPG's principal author Werner
158 Koch, is bearing the majority of these costs.  To help them carry on
159 this work, they need your support.  See https://gnupg.org/donate/ .
160
161
162   This file is Free Software; as a special exception the authors gives
163   unlimited permission to copy and/or distribute it, with or without
164   modifications, as long as this notice is preserved. For conditions
165   of the whole package, please see the file COPYING.  This file is
166   distributed in the hope that it will be useful, but WITHOUT ANY
167   WARRANTY, to the extent permitted by law; without even the implied
168   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.