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