.
[gnupg.git] / README
1                        The GNU Privacy Guard 2
2                       =========================
3                              Version 2.0
4
5          Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6               2005, 2006 Free Software Foundation, Inc.
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 RFC2440 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    (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.  Note
65 that this release is only expected to build on GNU and *BSD systems.
66
67
68
69 DOCUMENTATION
70 =============
71
72 The complete documentation is in the texinfo manual named
73 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
74 copy of the manual, change to the "doc" directory and enter "make
75 gnupg.pdf".  For a HTML version enter "make gnupg.html" and point your
76 browser to gnupg.html/index.html.  Standard man pages for all
77 components are provided as well.  Watch http://www.gnupg.org for
78 updated and new documentation.
79
80
81
82 GNUPG 1.4 AND GNUPG 2.0
83 =======================
84
85 GnuPG 2.0 is a newer version of GnuPG with additional support for
86 S/MIME.  It has a different design philosophy that splits
87 functionality up into several modules.  Both versions may be installed
88 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
89 In fact, the gpg version from GnuPG 1.4 is able to make use of the
90 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
91 caching.  The advantage of GnupG 1.4 is its smaller size and no
92 dependency on other modules at run and build time.
93
94
95 HOW TO GET MORE INFORMATION
96 ===========================
97
98 The primary WWW page is "http://www.gnupg.org"
99 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
100
101 See http://www.gnupg.org/download/mirrors.html for a list of mirrors
102 and use them if possible.  You may also find GnuPG mirrored on some of
103 the regular GNU mirrors.
104
105 We have some mailing lists dedicated to GnuPG:
106    
107    gnupg-announce@gnupg.org   For important announcements like new
108                               versions and such stuff.  This is a
109                               moderated list and has very low traffic.
110                               Do not post to this list.
111
112    gnupg-users@gnupg.org      For general user discussion and
113                               help (English).
114
115    gnupg-de@gnupg.org         German speaking counterpart of
116                               gnupg-users.
117
118    gnupg-ru@gnupg.org         Russian speaking counterpart of
119                               gnupg-users.
120
121    gnupg-devel@gnupg.org      GnuPG developers main forum.
122
123 You subscribe to one of the list by sending mail with a subject of
124 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
125 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
126 lists are available at http://www.gnupg.org/documentation/mailing-lists.html
127
128 Please direct bug reports to http://bugs.gnupg.org or post them direct
129 to the mailing list <gnupg-devel@gnupg.org>.
130
131 Please direct questions about GnuPG to the users mailing list or one
132 of the pgp newsgroups; please do not direct questions to one of the
133 authors directly as we are busy working on improvements and bug fixes.
134 The English and German mailing lists are watched by the authors and we
135 try to answer questions when time allows us to do so.
136
137 Commercial grade support for GnuPG is available; please see
138 http://www.gnupg.org/service.html .
139
140
141   This file is Free Software; as a special exception the authors gives
142   unlimited permission to copy and/or distribute it, with or without
143   modifications, as long as this notice is preserved. For conditions
144   of the whole package, please see the file COPYING.  This file is
145   distributed in the hope that it will be useful, but WITHOUT ANY
146   WARRANTY, to the extent permitted by law; without even the implied
147   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
148