Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-15 07:04:53 +01:00
Code Issues Projects Releases Wiki Activity
notwritableirc
Limnoria/plugins/NickAuth/README.rst

56 lines
1.5 KiB
ReStructuredText
Raw Permalink Normal View History

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-NickAuth:
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.
supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc.
2021-04-05 22:56:40 +02:00
.. _commands-NickAuth:
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
Commands
--------
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-nickauth-auth:
supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc.
2021-04-05 22:56:40 +02:00
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
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.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-nickauth-nick.add:
supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc.
2021-04-05 22:56:40 +02:00
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
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.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-nickauth-nick.list:
supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc.
2021-04-05 22:56:40 +02:00
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
nick list [<network>] [<user>]
Lists nicks of the <user> on the network. <network> defaults to the current network.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _command-nickauth-nick.remove:
supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc.
2021-04-05 22:56:40 +02:00
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
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.
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _conf-NickAuth:
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
Configuration
-------------
all plugins: regenerate READMEs
2021-04-17 20:09:33 +02:00
.. _conf-supybot.plugins.NickAuth.public:
all plugins: regenerate READMEs
2021-04-22 00:29:15 +02:00
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
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.
Reference in New Issue Copy Permalink