.. _plugin-Unix:

Documentation for the Unix plugin for Supybot
=============================================

Purpose
-------

Provides commands available only on Unix.

Usage
-----

Provides Utilities for Unix-like systems.

.. _commands-Unix:

Commands
--------

.. _command-unix-call:

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

.. _command-unix-errno:

``errno <error number or code>``
  Returns the number of an errno code, or the errno code of a number.

.. _command-unix-fortune:

``fortune takes no arguments``
  Returns a fortune from the Unix fortune program.

.. _command-unix-pid:

``pid takes no arguments``
  Returns the current pid of the process for this Supybot.

.. _command-unix-ping:

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

.. _command-unix-ping6:

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

.. _command-unix-progstats:

``progstats takes no arguments``
  Returns various unix-y information on the running supybot process.

.. _command-unix-shell:

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

.. _command-unix-spell:

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

.. _command-unix-sysuname:

``sysuname takes no arguments``
  Returns the uname -a from the system the bot is running on.

.. _command-unix-sysuptime:

``sysuptime takes no arguments``
  Returns the uptime from the system the bot is running on.

.. _command-unix-wtf:

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

.. _conf-Unix:

Configuration
-------------

.. _conf-supybot.plugins.Unix.fortune:


supybot.plugins.Unix.fortune
  This is a group of:

  .. _conf-supybot.plugins.Unix.fortune.command:


  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.

  .. _conf-supybot.plugins.Unix.fortune.equal:


  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.

  .. _conf-supybot.plugins.Unix.fortune.files:


  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.

  .. _conf-supybot.plugins.Unix.fortune.offensive:


  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.

  .. _conf-supybot.plugins.Unix.fortune.short:


  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.

.. _conf-supybot.plugins.Unix.ping:


supybot.plugins.Unix.ping
  This is a group of:

  .. _conf-supybot.plugins.Unix.ping.command:


  supybot.plugins.Unix.ping.command
    This config variable defaults to "/usr/bin/ping", is not network-specific, and is not channel-specific.

    Determines what command will be called for the ping command.

  .. _conf-supybot.plugins.Unix.ping.defaultCount:


  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.

.. _conf-supybot.plugins.Unix.ping6:


supybot.plugins.Unix.ping6
  This is a group of:

  .. _conf-supybot.plugins.Unix.ping6.command:


  supybot.plugins.Unix.ping6.command
    This config variable defaults to "/usr/bin/ping6", is not network-specific, and is not channel-specific.

    Determines what command will be called for the ping6 command.

.. _conf-supybot.plugins.Unix.public:


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.

.. _conf-supybot.plugins.Unix.spell:


supybot.plugins.Unix.spell
  This is a group of:

  .. _conf-supybot.plugins.Unix.spell.command:


  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.

  .. _conf-supybot.plugins.Unix.spell.language:


  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.

.. _conf-supybot.plugins.Unix.sysuname:


supybot.plugins.Unix.sysuname
  This is a group of:

  .. _conf-supybot.plugins.Unix.sysuname.command:


  supybot.plugins.Unix.sysuname.command
    This config variable defaults to "/usr/bin/uname", is not network-specific, and is not channel-specific.

    Determines what command will be called for the uname command.

.. _conf-supybot.plugins.Unix.sysuptime:


supybot.plugins.Unix.sysuptime
  This is a group of:

  .. _conf-supybot.plugins.Unix.sysuptime.command:


  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.

.. _conf-supybot.plugins.Unix.wtf:


supybot.plugins.Unix.wtf
  This is a group of:

  .. _conf-supybot.plugins.Unix.wtf.command:


  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.

