Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-23 11:09:23 +01:00
Code Issues Projects Releases Wiki Activity
63eb6672ea
Limnoria/plugins/Unix
History
Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices 
This commit reverts db7ef3f025
(though it keeps the year updates)

After discussion with several people, it seems better to mention
copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright
explains the issue of using VCSs to track copyright.

As db7ef3f025 only replaced mentions
of my name with 'The Limnoria Contributors', this commit only needs
to undo that + add one person who contributed to setup.py.
2021-10-17 09:57:55 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
config.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
messages.pot Unix: fix a typo in sysuname & sysuptime's command descriptions 2018-09-30 18:03:29 -07:00
plugin.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
test.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00

README.rst

Documentation for the Unix plugin for Supybot

Purpose

Provides commands available only on Unix.

Usage

Provides Utilities for Unix-like systems.

Commands

call <command to call with any arguments>

Calls any command available on the system, and returns its output. Requires owner capability. Note that being restricted to owner, this command does not do any sanity checking on input/output. So it is up to you to make sure you don't run anything that will spamify your channel or that will bring your machine to its knees.

crypt <password> [<salt>]

Returns the resulting of doing a crypt() on <password>. If <salt> is not given, uses a random salt. If running on a glibc2 system, prepending '$1$' to your salt will cause crypt to return an MD5sum based crypt rather than the standard DES based crypt.

errno <error number or code>

Returns the number of an errno code, or the errno code of a number.

fortune takes no arguments

Returns a fortune from the Unix fortune program.

pid takes no arguments

Returns the current pid of the process for this Supybot.

ping [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] [--4|--6] <host or ip>

Sends an ICMP echo request to the specified host. The arguments correspond with those listed in ping(8). --c is limited to 10 packets or less (default is 5). --i is limited to 5 or less. --W is limited to 10 or less. --4 and --6 can be used if and only if the system has a unified ping command.

ping6 [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] [--4|--6] <host or ip>

Sends an ICMP echo request to the specified host. The arguments correspond with those listed in ping(8). --c is limited to 10 packets or less (default is 5). --i is limited to 5 or less. --W is limited to 10 or less. --4 and --6 can be used if and only if the system has a unified ping command.

progstats takes no arguments

Returns various unix-y information on the running supybot process.

shell <command to call with any arguments>

Calls any command available on the system using the shell specified by the SHELL environment variable, and returns its output. Requires owner capability. Note that being restricted to owner, this command does not do any sanity checking on input/output. So it is up to you to make sure you don't run anything that will spamify your channel or that will bring your machine to its knees.

spell <word>

Returns the result of passing <word> to aspell/ispell. The results shown are sorted from best to worst in terms of being a likely match for the spelling of <word>.

sysuname takes no arguments

Returns the uname -a from the system the bot is running on.

sysuptime takes no arguments

Returns the uptime from the system the bot is running on.

wtf [is] <something>

Returns wtf <something> is. 'wtf' is a Unix command that first appeared in NetBSD 1.5. In most Unices, it's available in some sort of 'bsdgames' package.

Configuration

supybot.plugins.Unix.fortune

This is a group of:

supybot.plugins.Unix.fortune.command

This config variable defaults to "", is not network-specific, and is not channel-specific.

Determines what command will be called for the fortune command.

supybot.plugins.Unix.fortune.equal

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether fortune will give equal weight to the different fortune databases. If false, then larger databases will be given more weight. This sends the -e option to the fortune program.

supybot.plugins.Unix.fortune.files

This config variable defaults to " ", is network-specific, and is channel-specific.

Determines what specific file (if any) will be used with the fortune command; if none is given, the system-wide default will be used. Do note that this fortune file must be placed with the rest of your system's fortune files.

supybot.plugins.Unix.fortune.offensive

This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether fortune will retrieve offensive fortunes along with the normal fortunes. This sends the -a option to the fortune program.

supybot.plugins.Unix.fortune.short

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether only short fortunes will be used if possible. This sends the -s option to the fortune program.

supybot.plugins.Unix.ping

This is a group of:

supybot.plugins.Unix.ping.command

This config variable defaults to "/bin/ping", is not network-specific, and is not channel-specific.

Determines what command will be called for the ping command.

supybot.plugins.Unix.ping.defaultCount

This config variable defaults to "5", is not network-specific, and is not channel-specific.

Determines what ping and ping6 counts (-c) will default to.

supybot.plugins.Unix.ping6

This is a group of:

supybot.plugins.Unix.ping6.command

This config variable defaults to "/bin/ping6", is not network-specific, and is not channel-specific.

Determines what command will be called for the ping6 command.

supybot.plugins.Unix.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

supybot.plugins.Unix.spell

This is a group of:

supybot.plugins.Unix.spell.command

This config variable defaults to "/usr/bin/aspell", is not network-specific, and is not channel-specific.

Determines what command will be called for the spell command.

supybot.plugins.Unix.spell.language

This config variable defaults to "en", is not network-specific, and is not channel-specific.

Determines what aspell dictionary will be used for spell checking.

supybot.plugins.Unix.sysuname

This is a group of:

supybot.plugins.Unix.sysuname.command

This config variable defaults to "/bin/uname", is not network-specific, and is not channel-specific.

Determines what command will be called for the uname command.

supybot.plugins.Unix.sysuptime

This is a group of:

supybot.plugins.Unix.sysuptime.command

This config variable defaults to "/usr/bin/uptime", is not network-specific, and is not channel-specific.

Determines what command will be called for the uptime command.

supybot.plugins.Unix.wtf

This is a group of:

supybot.plugins.Unix.wtf.command

This config variable defaults to "", is not network-specific, and is not channel-specific.

Determines what command will be called for the wtf command.