README
1GeanyPG
2-------
3
4About
5------
6
7GeanyPG is a plugin for Geany that allows the user to encrypt, decrypt
8and verify signatures with GnuPG.
9
10Usage
11-----
12
13Install the plugin (https://plugins.geany.org/install.html) then
14load it in Geany's plugin manager and a new menu item in the Tools menu
15will appear.
16
17If any text is selected, only the selected text will be encrypted/
18signed/decrypted. When encrypting a message you can choose to sign at
19the same time.
20If a passphrase is needed, the GPGME library will decide how the user
21is prompted. Usually this will use gpg-agent. If gpg-agent is disabled,
22pinentry (see man 1 pinentry) will be used.
23
24Development
25-----------
26
27You can checkout the current source code from the git repository at
28github.com. Get the code by:
29
30git clone https://github.com/geany/geany-plugins.git
31
32If you want to create a patch, please respect the license of
33GeanyPG (GPLv2 or above) as well as intellectual property of
34third. Patches that should be included to the default distribution
35must be licensed under the same conditions as GeanyPG by the
36copyright owner.
37
38
39Known issues
40------------
41
42At the moment, the use of pinentry is only supported on unix-like
43systems. On Windows gpg-agent has to be used.
44
45For more recent information all reported issues will be tracked at
46https://github.com/geany/geany-plugins/issues
47
48
49License
50-------
51
52GeanyPG and all its parts is distributed under the terms of the
53GNU General Public License as published by the Free Software
54Foundation; either version 2 of the License, or (at your option) any
55later version. A copy of this license can be found in the file COPYING
56included with the source code of this program. If not, you will be
57able to get a copy by contacting the Free Software Foundation, Inc.,
5851 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
59
60
61Bugs, questions
62---------------
63
64If you found any bugs or want to provide a patch, please contact Hans
65Alves (alves(dot)h88(at)gmail(dot)com).
66