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