Limnoria/plugins/GPG/README.rst

.. _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
--------
key add <key id> <key server>
  Add a GPG key to your account.

key list takes no arguments
  List your GPG keys.

key remove <fingerprint>
  Remove a GPG key from your account.

signing auth <url>
  Check the GPG signature at the <url> and authenticates you if the key used is associated to a user.

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.
all plugins: auto-generate READMEs Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason. 2021-04-05 17:29:49 +02:00			`.. _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`
			`--------`
			`key add <key id> <key server>`
			`Add a GPG key to your account.`

			`key list takes no arguments`
			`List your GPG keys.`

			`key remove <fingerprint>`
			`Remove a GPG key from your account.`

			`signing auth <url>`
			`Check the GPG signature at the <url> and authenticates you if the key used is associated to a user.`

			`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.`