.. _plugin:fleet:

=====
FLEET
=====
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

description
-----------
| 

 
    The fleet makes it possible to run multiple bots in one running instance.
    It is a list of bots. This plugin provides commands to manipulate this list of bots.





| 

commands
--------
| 


    :commands in this plugin: fleet-avail .. fleet-enable .. fleet-save .. fleet-list .. fleet-add .. fleet-disconnect .. fleet-del .. fleet-cmnd .. fleet-disable .. fleet-connect

| 

1) *fleet-add .. [fleet_add]*

    :description:  arguments: <name> <type> <server>|<botjid> <nick>|<jabberpasswd> [<ircpass>] - add a newly created bot to the fleet. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-add_command`.

    :examples:

    ::

        <user> ;fleet-add local irc localhost fbftest
        <output> enabled and started local bot - fleet/local/config


2) *fleet-avail .. [handle_fleetavail]*

    :description:  no arguments - show available fleet bots. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-avail_command`.

    :examples:

    ::

        <user> ;fleet-avail
        <output> available bots: local


3) *fleet-cmnd .. [fleet_cmnd]*

    :description:  arguments: <botname> <cmndstring> - do cmnd on fleet bot(s). 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-cmnd_command`.

    :examples:

    ::

        <user> ;fleet-cmnd default-irc uptime

    ::

        <user> ;fleet-cmnd all uptime
        <output> fleet-cmnd <botname> <channel> <cmndstring>


4) *fleet-connect .. [handle_fleetconnect]*

    :description:  arguments: <botname> - connect a fleet bot to it's server. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-connect_command`.

    :examples:

    ::

        <user> ;fleet-connect test
        <output> can't connect test .. trying enable
        <output> can't make test bot


5) *fleet-del .. [handle_fleetdel]*

    :description:  arguments: <botname> - delete bot from fleet. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-del_command`.

    :examples:

    ::

        <user> ;fleet-del test
        <output> test delete failed


6) *fleet-disable .. [fleet_disable]*

    :description:  arguments: <list of botnames> - disable a fleet bot. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-disable_command`.

    :examples:

    ::

        <user> ;fleet-disable local
        <output> disabled local bot.


7) *fleet-disconnect .. [handle_fleetdisconnect]*

    :description:  arguments: <botname> - disconnect a fleet bot from server. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-disconnect_command`.

    :examples:

    ::

        <user> ;fleet-disconnect test
        <output> exiting test
        <output> can't stop test bot


8) *fleet-enable .. [fleet_enable]*

    :description:  arguments: <list of botnames> - enable a fleet bot. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-enable_command`.

    :examples:

    ::

        <user> ;fleet-enable local
        <output> enabled local bot


9) *fleet-list .. [handle_fleetlist]*

    :description:  no arguments - list bot names in fleet. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.core.fleet_fleet-list_command`.

    :examples:

    ::

        <user> ;fleet-list
        <output> fleet:


10) *fleet-save .. [handle_fleetsave]*

    :description:  save the fleet! 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.fleet_fleet-save_command`.

    :examples:

    ::

        <user> ;fleet-save
        <output> done - fleet-save