50ccdb182f60c30a3a2b4741cb3f8b9eb034b001
[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 ** Web Key Directory Installation HOWTO
64
65    We are working on a HOTWO for the Web Key Directory.  For now
66    please consult the [[https://wiki.gnupg.org/WKD][Wiki]].
67
68 ** GnuPG Keysigning Party HOWTO
69
70    Once you get familiar with GnuPG's mechanisms, you surely wouldn't
71    miss one of its funnest (and useful) aspects: to meet your Internet
72    buddies and get your key signed by as many of them as possible.
73
74    But having to check tens or even hundreds of keys at a meeting may
75    become quite frustrating. Here it is where this HOWTO by V. Alex
76    Brennen comes in handy. It is a guide to understanding and
77    organizing a PGP keysigning party. Keysigning parties help build
78    and strengthen the web of trust which serves to make the use of
79    GnuPG more secure.
80
81    This HOWTO is available:
82
83    -  as an on-line browsable set of HTML files (
84    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.de.html][de]] ·
85    [[http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html][en]] ·
86    [[../howtos/es/gpg-party.html][es]] ·
87    [[../howtos/it/keysigning_party.html][it]] ·
88    [[http://www.cypherpunks.ru/KSP.html][ru]] ·
89    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.si.html][si]] ·
90    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.zh-TW.html.big5][zh-TW.big5]] ·
91    [[http://www.cryptnet.net/fdp/crypto/gpg-party/gpg-party.zh-TW.html.euc-tw][zh-TW.euc-tw]] )
92
93 ** Mutt-GnuPG HOWTO
94
95    Firstly, because everyone should be using encryption and signatures
96    in their email. Secondly, because there are absolutely no reason
97    for you not to be using PGP-compatible software. Thirdly, because
98    documentation is mostly geared toward someone who is already
99    familiar with PGP.  Fourtly, because we like to promote both GnuPG
100    and Mutt as free software project, for use in everyday
101    communications. Lastly, because Justin R.  Miller likes writing
102    tutorials.
103
104    For all these reasons, you can find below a link to Justin's HOWTO
105    on how to send and receive cryptographically signed and/or
106    encrypted email with GnuPG and the [[http://www.mutt.org/][Mutt mail reader]].
107
108    This HOWTO is available:
109
110    -  as plain text ( [[http://codesorcery.net/old/mutt/][en]] )
111
112 ** PHP-GnuPG HOWTO
113
114    With the preponderance of javascript based OpenPGP solutions to
115    various functions on the web, the desire to perform certain types
116    of server side functions on a PHP driven website also has its
117    merits.
118
119    While PHP support for GPGME is either lacking, or too arcane for
120    most developers to decipher, or both; Piotr Masełkowski at
121    [[https://maslosoft.com/][Maslosoft]] has an alternative guide using the CLI programs.
122
123    This HOWTO is available:
124
125    -  as an online HTML article ( [[https://maslosoft.com/blog/2017/09/12/using-gpg-with-php-on-server/][en]] )
126
127 ** GPGME Python Bindings HOWTO
128
129    Written "in house" by the GnuPG Project core team, the GPGME Python
130    Bindings HOWTO provides detailed instructions and examples for
131    using the Python bindings of the GPGME API with Python 3 code.
132
133    This HOWTO is available:
134
135    -  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]] )
136    -  as a single HTML file ( [[http://files.au.adversary.org/crypto/GPGMEpythonHOWTOen.html][en]] )
137    -  as a single HTML file with dark background and light text ( [[http://files.au.adversary.org/crypto/GPGMEpythonHOWTOen-dark.html][en]] )