Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 10:39:22 +01:00
Code Issues Projects Releases Wiki Activity
cd02444f87
Limnoria/plugins/Internet/README.rst

42 lines
938 B
ReStructuredText
Raw 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-Internet:
Documentation for the Internet plugin for Supybot
=================================================
Purpose
-------
This plugin provides commands to transform domains into IP addresses and IP addresses to domains.
It can also search WHOIS information and return hexips.
Usage
-----
Provides commands to query DNS, search WHOIS databases,
and convert IPs to hex.
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-Internet:
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
--------
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
.. _command-Internet-dns:
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
dns <host|ip>
Returns the ip of <host> or the reverse DNS hostname of <ip>.
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
.. _command-Internet-hexip:
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
hexip <ip>
Returns the hexadecimal IP for that IP.
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
.. _command-Internet-whois:
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
whois <domain>
Returns WHOIS information on the registration of <domain>.
Configuration
-------------
supybot.plugins.Internet.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