pim/kleopatra/README.packagers

0001 Kleopatra packaging notes
0002 =========================
0003
0004 The build dependencies should be fairly straightforward (see CMakeLists.txt)
0005
0006 Runtime Dependencies
0007 ====================
0008
0009 Kleopatra is a GUI for GnuPG so it needs a working GnuPG setup.
0010
0011 - gnupg2
0012 -- gnupg-agent (part of gnupg2 sources)
0013 -- dirmngr (part of gnupg2 sources)
0014 -- gpgsm (part of gnupg2 sources)
0015
0016 - Pinentry (Qt / Gtk / Gnome)
0017
0018 - PaperKey (http://www.jabberwocky.com/software/paperkey/)
0019
0020 For Pinentry preferably pinentry-qt alternatively pinentry-gtk2 and
0021 pinentry-gnome also work. Pinentry-curses does not work for Kleopatra.
0022
0023 Kleopatra may work with gnupg 1, too but the selftest will
0024 warn about this and some functionality will be unavailable. It should
0025 depend on gnupg2. GnuPG 2.1.x is supported, too.
0026
0027 You can use Kleopatra's selftest to check your packaging it should
0028 show no errors.
0029
0030 PaperKey is not checked in selftest but users will get a warning
0031 and a failure if they try to "Print Secret Key" if paperkey is
0032 not installed.
0033
0034 Downstream Dependers
0035 ====================
0036
0037 - Dolphin
0038 Kleopatra provided crypto integration for Dolphin through installed
0039 desktop files. You might want to suggest / recommend it.
0040
0041 - Kontact / KMail / KDEPIM
0042 While Kontact / KMail crypto works without Kleopatra it should
0043 be installed with KMail as it provides Crypto Configuration GUI.
0044 It also provides Certificate Details. This should probably be
0045 recommended and part of a kdepim meta package.
0046
0047 - GnuPG itself
0048 GnuPG can, of course, be used without Kleopatra. In GUI
0049 environments you might want to weakly suggest Kleopatra as
0050 a GUI for GnuPG (especially GpgSM)