Limnoria/plugins/GPG/README.rst
Valentin Lorentz cd02444f87 supybot-plugin-doc: Add labels for all command and config variables
So they can be referenced from elsewhere in the doc.
2021-04-06 00:33:07 +02:00

50 lines
1020 B
ReStructuredText

.. _plugin-GPG:
Documentation for the GPG plugin for Supybot
============================================
Purpose
-------
GPG: Provides authentication based on GPG keys.
Usage
-----
Provides authentication based on GPG keys.
.. _commands-GPG:
Commands
--------
.. _command-GPG-key.add:
key add <key id> <key server>
Add a GPG key to your account.
.. _command-GPG-key.list:
key list takes no arguments
List your GPG keys.
.. _command-GPG-key.remove:
key remove <fingerprint>
Remove a GPG key from your account.
.. _command-GPG-signing.auth:
signing auth <url>
Check the GPG signature at the <url> and authenticates you if the key used is associated to a user.
.. _command-GPG-signing.gettoken:
signing gettoken takes no arguments
Send you a token that you'll have to sign with your key.
Configuration
-------------
supybot.plugins.GPG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.