* gpg.texi (OpenPGP Options): Don't mention --no-sk-comment (doesn't
[gnupg.git] / README
bloba8ede935db49acb5a3f91dd1dbbafd09a287c5d6
1                        The GNU Privacy Guard 2
2                       =========================
3                              Version 2.0
5       Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
6         2006, 2007, 2008, 2009 Free Software Foundation, Inc.
9 INTRODUCTION
10 ============
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.
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.
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.
29 BUILD INSTRUCTIONS
30 ==================
32 GnuPG 2.0 depends on the following packages:
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/ .
43 You should get the latest versions of course, the GnuPG configure
44 script complains if a version is not sufficient.
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).
51 As with all packages, you just have to do
53  ./configure
54  make
55  make install
57 (Before doing install you might need to become root.)
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.
64 In case of problem please ask on gnupg-users@gnupg.org for advise.
66 Note that the PKITS tests are always skipped unless you copy the PKITS
67 test data file into the tests/pkits directory.
70 DOCUMENTATION
71 =============
73 The complete documentation is in the texinfo manual named
74 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
75 copy of the manual, change to the "doc" directory and enter "make pdf"
76 For a HTML version enter "make html" and point your browser to
77 gnupg.html/index.html.  Standard man pages for all components are
78 provided as well.  An online version of the manual is available at
79 http://www.gnupg.org/documentation/manuals/gnupg/ .  A version of the
80 manual pertaining to the current development snapshot is at
81 http://www.gnupg.org/documentation/manuals/gnupg-devel/ .
84 GNUPG 1.4 AND GNUPG 2.0
85 =======================
87 GnuPG 2.0 is a newer version of GnuPG with additional support for
88 S/MIME.  It has a different design philosophy that splits
89 functionality up into several modules.  Both versions may be installed
90 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
91 In fact, the gpg version from GnuPG 1.4 is able to make use of the
92 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
93 caching.  The advantage of GnuPG 1.4 is its smaller size and no
94 dependency on other modules at run and build time.
97 HOW TO GET MORE INFORMATION
98 ===========================
100 The primary WWW page is "http://www.gnupg.org"
101 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
103 See http://www.gnupg.org/download/mirrors.html for a list of mirrors
104 and use them if possible.  You may also find GnuPG mirrored on some of
105 the regular GNU mirrors.
107 We have some mailing lists dedicated to GnuPG:
108    
109    gnupg-announce@gnupg.org   For important announcements like new
110                               versions and such stuff.  This is a
111                               moderated list and has very low traffic.
112                               Do not post to this list.
114    gnupg-users@gnupg.org      For general user discussion and
115                               help (English).
117    gnupg-de@gnupg.org         German speaking counterpart of
118                               gnupg-users.
120    gnupg-ru@gnupg.org         Russian speaking counterpart of
121                               gnupg-users.
123    gnupg-devel@gnupg.org      GnuPG developers main forum.
125 You subscribe to one of the list by sending mail with a subject of
126 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
127 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
128 lists are available at http://www.gnupg.org/documentation/mailing-lists.html
130 Please direct bug reports to http://bugs.gnupg.org or post them direct
131 to the mailing list <gnupg-devel@gnupg.org>.
133 Please direct questions about GnuPG to the users mailing list or one
134 of the pgp newsgroups; please do not direct questions to one of the
135 authors directly as we are busy working on improvements and bug fixes.
136 The English and German mailing lists are watched by the authors and we
137 try to answer questions when time allows us to do so.
139 Commercial grade support for GnuPG is available; please see
140 http://www.gnupg.org/service.html .
143   This file is Free Software; as a special exception the authors gives
144   unlimited permission to copy and/or distribute it, with or without
145   modifications, as long as this notice is preserved. For conditions
146   of the whole package, please see the file COPYING.  This file is
147   distributed in the hope that it will be useful, but WITHOUT ANY
148   WARRANTY, to the extent permitted by law; without even the implied
149   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.