372d84aa482d537328e520ce663ab8baacb0e161
[gnupg.git] / README
1                        The GNU Privacy Guard 2
2                       =========================
3                              Version 2.1
4
5    THIS IS A DEVELOPMENT VERSION AND NOT INTENDED FOR REGULAR USE.
6
7           Copyright 1997-1998, 2013-2014 Werner Koch
8           Copyright 1998-2013 Free Software Foundation, Inc.
9
10
11 INTRODUCTION
12 ============
13
14 GnuPG is a tool for secure communication and data storage.  It can be
15 used to encrypt data and to create digital signatures.  It includes an
16 advanced key management facility and is compliant with the proposed
17 OpenPGP Internet standard as described in RFC4880 and the S/MIME
18 standard as described by several RFCs.
19
20 GnuPG is distributed under the terms of the GNU General Public
21 License.  See the file COPYING for details.  GnuPG works best on
22 GNU/Linux or *BSD systems.  Most other Unices are also supported but
23 are not as well tested as the Free Unices.
24
25 GnuPG-2 is the stable version of GnuPG integrating support for OpenPGP
26 and S/MIME.  It does not conflict with an installed 1.4 OpenPGP-only
27 version.
28
29
30 BUILD INSTRUCTIONS
31 ==================
32
33 GnuPG 2.1 depends on the following packages:
34
35   npth         (ftp://ftp.gnupg.org/gcrypt/npth/)
36   libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
37   libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
38   libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
39   libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
40
41 You should get the latest versions of course, the GnuPG configure
42 script complains if a version is not sufficient.
43
44 For some advanced features several other libraries are required.  The
45 configure script prints diagnostic messages if one of these libraries
46 is not available and a feature will not be available..
47
48 You also need the Pinentry package for most functions of GnuPG;
49 however it is not a build requirement.  Pinentry is available at
50 ftp://ftp.gnupg.org/gcrypt/pinentry/ .
51
52 After building and installing the above packages in the order as given
53 above, you may continue with GnuPG installation (you may also just try
54 to build GnuPG to see whether your already installed versions are
55 sufficient).
56
57 As with all packages, you just have to do
58
59  ./configure
60  make
61  make install
62
63 (Before doing install you might need to become root.)
64
65 If everything succeeds, you have a working GnuPG with support for
66 OpenPGP, S/MIME, ssh-agent, and smartcards.  Note that there is no
67 binary gpg but a gpg2 so that this package won't conflict with a GnuPG
68 1.4 installation.  gpg2 behaves just like gpg.
69
70 In case of problem please ask on the gnupg-users@gnupg.org mailing
71 list for advise.
72
73 Instruction on how to build for Windows can be found in the file
74 doc/HACKING in the section "How to build an installer for Windows".
75 This requires some experience as developer.
76
77 Note that the PKITS tests are always skipped unless you copy the PKITS
78 test data file into the tests/pkits directory.  There is no need to
79 run these test and some of them may even fail because the test scripts
80 are not yet complete.
81
82 You may run
83
84   gpgconf --list-dirs
85
86 to view the default directories used by GnuPG.
87
88 To quickly build all required software without installing it, the
89 Speedo method may be used:
90
91   make -f build-aux/speedo.mk  native
92
93 This method downloads all required libraries and does a native build
94 of GnuPG to PLAY/inst/.  GNU make is required and you need to set
95 LD_LIBRARY_PATH to $(pwd)/PLAY/inst/lib.
96
97
98 MIGRATION FROM 1.4 or 2.0 to 2.1
99 ================================
100
101 The major change in 2.1 is gpg-agent taking care of the OpenPGP secret
102 keys (those managed by GPG).  The former file "secring.gpg" will not
103 be used anymore.  Newly generated keys are stored in the agent's key
104 store directory "~/.gnupg/private-keys-v1.d/".  The first time gpg
105 needs a secret key it checks whether a "secring.gpg" exists and
106 copies them to the new store.  The old secring.gpg is kept for use by
107 older versions of gpg.
108
109 Note that gpg-agent now uses a fixed socket by default.  All tools
110 will start the gpg-agent as needed.  In general there is no more need
111 to set the GPG_AGENT_INFO environment variable.  The SSH_AUTH_SOCK
112 environment variable should be set to a fixed value.
113
114 GPG's smartcard commands --card-edit and --card-status as well as some
115 of the card related sub-commands of --edit-key are not yet fully
116 supported.  However, signing and decryption with a smartcard does
117 work.
118
119 The Dirmngr is now part of GnuPG proper and also used to access
120 OpenPGP keyservers.  The directroy layout of Dirmngr changed to make
121 use of the GnuPG directories.  Dirmngr is started by gpg or gpgsm as
122 needed needed. There is no more need to install a separate dirmngr
123 package.
124
125
126
127 DOCUMENTATION
128 =============
129
130 The complete documentation is in the texinfo manual named
131 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
132 copy of the manual, change to the "doc" directory and enter "make pdf"
133 For a HTML version enter "make html" and point your browser to
134 gnupg.html/index.html.  Standard man pages for all components are
135 provided as well.  An online version of the manual is available at
136 http://www.gnupg.org/documentation/manuals/gnupg/ .  A version of the
137 manual pertaining to the current development snapshot is at
138 http://www.gnupg.org/documentation/manuals/gnupg-devel/ .
139
140
141 GNUPG 1.4 AND GNUPG 2.0
142 =======================
143
144 GnuPG 2.0 is a newer version of GnuPG with additional support for
145 S/MIME.  It has a different design philosophy that splits
146 functionality up into several modules.  Both versions may be installed
147 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
148 In fact, the gpg version from GnuPG 1.4 is able to make use of the
149 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
150 caching.  The advantage of GnuPG 1.4 is its smaller size and no
151 dependency on other modules at run and build time.
152
153
154 HOW TO GET MORE INFORMATION
155 ===========================
156
157 The primary WWW page is "https://www.gnupg.org"
158            or using TOR "http://ic6au7wa3f6naxjq.onion"
159 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
160
161 See https://www.gnupg.org/download/mirrors.html for a list of mirrors
162 and use them if possible.  You may also find GnuPG mirrored on some of
163 the regular GNU mirrors.
164
165 We have some mailing lists dedicated to GnuPG:
166
167    gnupg-announce@gnupg.org   For important announcements like new
168                               versions and such stuff.  This is a
169                               moderated list and has very low traffic.
170                               Do not post to this list.
171
172    gnupg-users@gnupg.org      For general user discussion and
173                               help (English).
174
175    gnupg-de@gnupg.org         German speaking counterpart of
176                               gnupg-users.
177
178    gnupg-ru@gnupg.org         Russian speaking counterpart of
179                               gnupg-users.
180
181    gnupg-devel@gnupg.org      GnuPG developers main forum.
182
183 You subscribe to one of the list by sending mail with a subject of
184 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
185 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
186 lists are available at http://www.gnupg.org/documentation/mailing-lists.html
187
188 Please direct bug reports to http://bugs.gnupg.org or post them direct
189 to the mailing list <gnupg-devel@gnupg.org>.
190
191 Please direct questions about GnuPG to the users mailing list or one
192 of the pgp newsgroups; please do not direct questions to one of the
193 authors directly as we are busy working on improvements and bug fixes.
194 The English and German mailing lists are watched by the authors and we
195 try to answer questions when time allows us to do so.
196
197 Commercial grade support for GnuPG is available; for a listing of
198 offers see https://www.gnupg.org/service.html .  Maintaining and
199 improving GnuPG is costly.  Since 2001, g10 Code GmbH, a German
200 company owned and headed by GnuPG's principal author Werner Koch, is
201 bearing the majority of these costs.  To help them carry on this work,
202 they need your support.  See https://gnupg.org/donate/ .
203
204   This file is Free Software; as a special exception the authors gives
205   unlimited permission to copy and/or distribute it, with or without
206   modifications, as long as this notice is preserved. For conditions
207   of the whole package, please see the file COPYING.  This file is
208   distributed in the hope that it will be useful, but WITHOUT ANY
209   WARRANTY, to the extent permitted by law; without even the implied
210   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.