0df53a839653d8ad89532bca8da098692cc6eef5
[gnupg-doc.git] / web / documentation / howtos.org
1 #+TITLE: GnuPG - HOWTOs
2 #+STARTUP: showall
3 #+SETUPFILE: "../share/setup.inc"
4
5
6 * HOWTOs
7
8   There are several HOWTOs available.
9
10 ** GnuPG MiniHOWTO
11
12    You may get the best overview about the GnuPG system by reading the
13    mini HOWTO available in several formats:
14
15 -  as on-line browsable HTML files (
16    [[../howtos/ca/GPGMiniHowto.html][ca]] ·
17    [[../howtos/de/index.html][de]] ·
18    [[http://www.dewinter.com/gnupg_howto/english/GPGMiniHowto.html][en]] ·
19    [[http://www.dewinter.com/gnupg_howto/spanish/index.html][es]] ·
20    [[../howtos/fr/index.html][fr]] ·
21    [[../howtos/it/GPGMiniHowto.html][it]] ·
22    [[../howtos/tr/GPGMinikNasil.html][tr]] ·
23    [[../howtos/vn/index.htm][vn]] ·
24    [[../howtos/zh/index.html][zh]] )
25 -  as one big HTML file (
26    [[../howtos/ca/GPGMiniHowto_big.html][ca]] ·
27    [[../howtos/it/GPGMiniHowto_big.html][it]] )
28 -  as PDF (
29    [[../howtos/ca/GPGMiniHowto.pdf][ca]] ·
30    [[../howtos/de/GPGMiniHowto.pdf][de]] ·
31    [[../howtos/it/GPGMiniHowto.pdf][it]] ·
32    [[../howtos/vn/GPGMiniHowto.pdf][vn]] )
33 -  in postscript format (
34    [[../howtos/ca/GPGMiniHowto.ps][ca]] ·
35    [[http://www.dewinter.com/gnupg_howto/english/GPGMiniHowto.ps][en]] ·
36    [[../howtos/de/GPGMiniHowto.ps][de]] )
37 -  as DVI file ( [[../howtos/ca/GPGMiniHowto.dvi][ca]] )
38 -  in RTF format ( [[../howtos/ca/GPGMiniHowto.rtf][ca]] )
39 -  as plain text (
40    [[../howtos/ca/GPGMiniHowto.txt][ca]] ·
41    [[http://www.dewinter.com/gnupg_howto/english/GPGMiniHowto.txt][en]] ·
42    [[../howtos/it/GPGMiniHowto.txt][it]] )
43 -  as SGML (
44    [[../howtos/ca/GPGMiniHowto.sgml][ca]] ·
45    [[../howtos/de/GPGMiniHowto.sgml][de]] ·
46    [[http://www.dewinter.com/gnupg_howto/english/GPGMiniHowto.sgml][en]] ·
47    [[../howtos/it/GPGMiniHowto.sgml][it]] ·
48    [[../howtos/tr/GPGMinikNasil.sgml.gz][tr]] )
49 -  as gzipped tarball of them all ( [[../howtos/ca/GPGMiniHowto.tar.gz][ca]] )
50
51
52 ** GnuPG SmartcardHOWTO
53
54    GnuPG supports the use of smartcards.  This HOWTO explains how to
55    install and work with these cards.
56
57    - as on-line browsable HTML files ( [[../howtos/card-howto/en/smartcard-howto.html][en]] )
58    - as one big HTML file ( [[../howtos/card-howto/en/smartcard-howto-single.html][en]] )
59    - as plain text ( [[../howtos/card-howto/en/smartcard-howto.txt][en]] )
60
61    This smartcard howto is also available in the [[../download/git.org][source repository]].
62
63 ** GnuPG Keysigning Party HOWTO
64
65    Once you get familiar with GnuPG's mechanisms, you surely wouldn't
66    miss one of its funnest (and useful) aspects: to meet your Internet
67    buddies and get your key signed by as many of them as possible.
68
69    But having to check tens or even hundreds of keys at a meeting may
70    become quite frustrating. Here it is where this HOWTO by V. Alex
71    Brennen comes in handy. It is a guide to understanding and
72    organizing a PGP keysigning party. Keysigning parties help build
73    and strengthen the web of trust which serves to make the use of
74    GnuPG more secure.
75
76    This HOWTO is available:
77
78    -  as an on-line browsable set of HTML files (
79    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.de.html][de]] ·
80    [[http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html][en]] ·
81    [[../howtos/es/gpg-party.html][es]] ·
82    [[../howtos/it/keysigning_party.html][it]] ·
83    [[http://www.cypherpunks.ru/KSP.html][ru]] ·
84    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.si.html][si]] ·
85    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.zh-TW.html.big5][zh-TW.big5]] ·
86    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.zh-TW.html.euc-tw][zh-TW.euc-tw]] )
87
88 ** Mutt-GnuPG HOWTO
89
90    Firstly, because everyone should be using encryption and signatures
91    in their email. Secondly, because there are absolutely no reason
92    for you not to be using PGP-compatible software. Thirdly, because
93    documentation is mostly geared toward someone who is already
94    familiar with PGP.  Fourtly, because we like to promote both GnuPG
95    and Mutt as free software project, for use in everyday
96    communications. Lastly, because Justin R.  Miller likes writing
97    tutorials.
98
99    For all these reasons, you can find below a link to Justin's HOWTO
100    on how to send and receive cryptographically signed and/or
101    encrypted email with GnuPG and the [[http://www.mutt.org/][Mutt mail reader]].
102
103    This HOWTO is available:
104
105    -  as plain text ( [[http://codesorcery.net/old/mutt/][en]] )
106
107 ** PHP-GnuPG HOWTO
108
109    With the preponderance of javascript based OpenPGP solutions to
110    various functions on the web, the desire to perform certain types
111    of server side functions on a PHP driven website also has its
112    merits.
113
114    While PHP support for GPGME is either lacking, or too arcane for
115    most developers to decipher, or both; Piotr Masełkowski at
116    [[https://maslosoft.com/][Maslosoft]] has an alternative guide using the CLI programs.
117
118    This HOWTO is available:
119
120    -  as an online HTML article ( [[https://maslosoft.com/blog/2017/09/12/using-gpg-with-php-on-server/][en]] )
121
122 ** GPGME Python Bindings HOWTO
123
124    Written "in house" by the GnuPG Project core team, the GPGME Python
125    Bindings HOWTO provides detailed instructions and examples for
126    using the Python bindings of the GPGME API with Python 3 code.
127
128    This HOWTO is available:
129
130    -  in its original Emacs Org Mode source form in the GPGME repository ( [[https://dev.gnupg.org/source/gpgme/browse/master/lang/python/docs/GPGMEpythonHOWTOen.org][en]] )
131    -  as a single HTML file ( [[http://files.au.adversary.org/crypto/GPGMEpythonHOWTOen.html][en]] )
132    -  as a single HTML file with dark background and light text ( [[http://files.au.adversary.org/crypto/GPGMEpythonHOWTOen-dark.html][en]] )