doc fixes
[gnupg.git] / README
1                    The GNU Privacy Guard 2
2                   =========================
3                        Version 1.9.x
4
5
6 GnuPG 1.9 is the future version of GnuPG; it is based on some gnupg-1.3
7 code and the previous newpg package.  It will eventually lead to a
8 GnuPG 2.0 release.  Note that GnuPG 1.4 and 1.9 are not always in sync
9 and thus features and bug fixes done in 1.4 are not necessary
10 available in 1.9.
11
12 You should use this GnuPG version if you want to use the gpg-agent or
13 gpgsm (the S/MIME variant of gpg).  Note that the gpg-agent is also
14 helpful when using the standard gpg versions (1.4.x) the old 1.2.x).
15 There are no problems installing 1.4 and 1.9 alongside; in fact we
16 suggest to do this.
17
18
19 BUILD INSTRUCTIONS
20 ==================
21
22 GnuPG 1.9 depends on the following packages:
23
24   libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
25   libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
26   libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
27   libassuan    (ftp://ftp.gnupg.org/gcrypt/alpha/libassuan/)
28   
29 You also need the pinentry package for most function of GnuPG; however
30 it is not a build requirement.  pinentry is available at
31 ftp://ftp.gnupg.org/gcrypt/pinentry/ .
32
33 You should get the latest versions of course, the GnuPG configure
34 script complains if a version is not sufficient.
35
36 After building and installing the above packages in the order as given
37 above, you may now continue with GnuPG installation (you may also just
38 try to build GnuPG to see whether your already installed versions are
39 sufficient).
40
41 As with all packages, you just have to do
42
43  ./configure
44  make
45  make install
46
47 (Before doing install you might need to become root.)
48
49 If everything succeeds, you have a working GnuPG with support for
50 S/MIME and smartcards.  Note that there is no binary gpg but a gpg2 so
51 that this package won't conflict with a GnuPG 1.4 installation. gpg2
52 behaves just like gpg.
53
54 In case of problem please ask on gnupg-users@gnupg.org for advise.  Note
55 that this release is only expected to build on GNU and *BSD systems.
56
57
58
59 DOCUMENTATION
60 ==================
61
62 The complete documentation is in the texinfo manual named
63 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
64 copy of the manual, change to the "doc" directory and enter "make
65 gnupg.pdf".  For a HTML version enter "make gnupg.html" and point your
66 browser to gnupg.html/index.html.  Standard man pages for all
67 components are provided as well.
68