833af36b08
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.
1.3 KiB
Documentation for the NickAuth plugin for Supybot
Purpose
Support authentication based on nicks and network services.
Usage
This plugin allows users to use their network services account to authenticate to the bot.
They first have to use
@nickauth nick add <the nick> while being identified
to the bot and then use @auth when they want to identify to
the bot.
Commands
- auth takes no argument
-
Tries to authenticate you using network services. If you get no reply, it means you are not authenticated to the network services.
- nick add [<network>] <user> <nick>
-
Add <nick> to the list of nicks owned by the <user> on the <network>. You have to register this nick to the network services to be authenticated. <network> defaults to the current network.
- nick list [<network>] [<user>]
-
Lists nicks of the <user> on the network. <network> defaults to the current network.
- nick remove [<network>] <user> <nick>
-
Remove <nick> from the list of nicks owned by the <user> on the <network>. <network> defaults to the current network.
Configuration
- supybot.plugins.NickAuth.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.