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