Revision: 2190 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=2190&view=re... Author: alvesh88 Date: 2011-09-01 17:57:49 +0000 (Thu, 01 Sep 2011) Log Message: ----------- Adding documentation for GeanyPG
Added Paths: ----------- trunk/geany-plugins/geanypg/doc/ trunk/geany-plugins/geanypg/doc/geanypg.html
Added: trunk/geany-plugins/geanypg/doc/geanypg.html =================================================================== --- trunk/geany-plugins/geanypg/doc/geanypg.html (rev 0) +++ trunk/geany-plugins/geanypg/doc/geanypg.html 2011-09-01 17:57:49 UTC (rev 2190) @@ -0,0 +1,97 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<html> +<head> +<title>GnuPG plugin for Geany - Introduction</title> +</head> +<body style="margin: 32px 25% 24px 5%"> +<hr><h2>GnuPG encryption plugin for the Geany IDE</h2><hr> +<p> +This is a plugin for the <a href="http://www.geany.org/">Geany</a> IDE + to provide <a href="http://gnupg.org/">GnuPG</a> encryption. +</p><p> +<h4>Installation</h4> +This plugin is distributed with geany-plugins, to install check the +documentation of the geany-plugins release.<br> +Like all plugins GeanyPG can be activated via the Tools > Plugin +Manager dialog. +</p><p> +<h4>Using GeanyPG</h4> +Once the plugin has been activated a new sub-menu named `GeanyPG' will appear in the Tools menu.<br> +This sub-menu contains the following options: +<ul> + <li>Encrypt</li> + <li>Sign</li> + <li>Decrypt / Verify</li> + <li>Verify detached signature</li> +</ul> +</p><p> +<h5>Encryption</h5> +To encrypt a file, simply choose Encrypt from the menu. A dialog will +open allowing you to select any recipients. At the bottom of the dialog +you also have to option to choose a key to sign the text with (Default +is None). +</p><p> +When you press Ok, a few things can happen. If you haven't selected any +recipients a new dialog will open asking you if you want to use a +symmetric cipher. If you choose yes you will be asked for a passphrase +that will be used to encrypt the text.</p><p> +What happens when you have selected one or more recipients, or entered +a passphrase for a symmetric cipher, depends on whether any text was +selected. If you have selected text, <b>only</b> the selected text will +be encrypted, otherwise the whole file will be encrypted.<br> +Of course, if you have chosen to sign the text as well, you will first +be asked for the passphrase of the selected private key. +</p><p> +<h5>Signing without encrypting</h5> +To sign some text without also encrypting it, choose Sign from the menu. +You will be asked which private key you want to use and to enter the +passphrase for that key.<br> +Like when encrypting the text, if you have selected anything, only the +selected text will be signed. Otherwise the whole file will be signed. +</p><p> +<h5>Decrypting and Verifying</h5> +To decrypt a file or verify an inline signature just select the GPG +code and choose Decrypt / Verify from the menu. When decrypting you +will of course be asked to enter a passphrase. +</p><p> +<h5>Verifying detached signatures</h5> +To verify a detached signature choose the last option from the menu. A +dialog will open where you can select a .sig or .asc file with a +detached signature. +</p><p> +<h4>Development</h4> +You can checkout the current source code from the Subversion repository +at Sourceforge.net.<br><br> +Get the code from:<br> +<tt>svn checkout +http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-p... +</tt><br><br> +If you want to create a patch, please respect the license of GeanyPG as +well as intellectual property of third parties. Patches that should be +included to the default distribution must be licensed under the same +conditions as GeanyPG by the copyright owner (GPL2+). + +</p><p> +<h4>Known issues</h4> +At the moment, the use of pinentry is only supported on unix-like +systems. On Windows gpg-agent has to be used. +</p><p> +For more recent information all reported issues will be tracked at +<a href="http://sourceforge.net/tracker/?group_id=222729"> +http://sourceforge.net/tracker/?group_id=222729</a> +</p><p> +<h4>License</h4> +GeanyPG and all its parts is distributed under the terms of the +GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any +later version. A copy of this license can be found in the file COPYING +included with the source code of this program. If not, you will be +able to get a copy by contacting the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +</p><p> +<h4>Bugs, questions</h4> +If you found any bugs or want to provide a patch, please contact Hans +Alves (alves(dot)h88(at)gmail(dot)com). +</p> +</body> +</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.