~ibid-core/ibid/trunk

« back to all changes in this revision

Viewing changes to docs/manpages/ibid-plugin.1.rst

  • Committer: Tarmac
  • Author(s): Stefano Rivera
  • Date: 2012-07-31 09:51:02 UTC
  • mfrom: (1043.2.4 sphinxdoc-man)
  • Revision ID: tarmac-20120731095102-ok97by9518vw2bum
Move manpages into Sphinx docs
Author: Stefano Rivera
Merge Request: http://code.launchpad.net/~stefanor/ibid/sphinxdoc-man/+merge/88115
Approved by: Keegan Carruthers-Smith, Jonathan Hitchcock
Fixes LP: #

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
% IBID-PLUGIN(1) Ibid Multi-protocol Bot | Ibid 0.1
2
 
% Stefano Rivera
3
 
% March 2010
4
 
 
5
 
# NAME
6
 
 
7
 
ibid-plugin \- Plugin testing developer environment for Ibid
8
 
 
9
 
# SYNOPSIS
10
 
 
11
 
**ibid-plugin** [*options*...] [*plugin*[**-**]|_plugin_**.**_Processor_[**-**]...]
12
 
 
13
 
# DESCRIPTION
14
 
 
15
 
This utility is for testing Ibid plugins without the full bot environment.
16
 
This means testing can be performed offline and without loading all the
17
 
available plugins.
 
1
=============
 
2
 ibid-plugin
 
3
=============
 
4
 
 
5
SYNOPSIS
 
6
========
 
7
 
 
8
``ibid-plugin`` [*options*...] [*plugin*\ [``-``]|\ *plugin*\ ``.``\ *Processor*\ [``-``]...]
 
9
 
 
10
DESCRIPTION
 
11
===========
 
12
 
 
13
This utility is for testing Ibid plugins without the full bot
 
14
environment.  This means testing can be performed offline and without
 
15
loading all the available plugins.
18
16
 
19
17
This should be run in a configured Ibid bot directory.
20
18
 
21
19
All the listed plugins and Processors will be loaded on start-up.
22
20
Naming a plugin loads the complete plugin.
23
 
Suffixing a **-** to the name, ignores that plugin or Processor instead of
24
 
loading it.
25
 
 
26
 
# OPTIONS
27
 
 
28
 
**-c**, **-\-configured**
29
 
:       Load all configured plugins, instead of only the core and requested
30
 
        plugins.
31
 
 
32
 
**-o**, **-\-only**
33
 
:       Don't load the Ibid core plugins, only the plugins requested.
34
 
        Note that without the **core** plugin to pre- and post-process events, most
35
 
        other plugins won't function correctly.
36
 
 
37
 
**-p**, **-\-public**
38
 
:       By default, **ibid-plugin** emulates a private conversation with the bot.
39
 
        With this option, the conversation is considered to be public and the
40
 
        bot will have to be addressed to provoke a response.
41
 
 
42
 
**-v**, **-\-verbose**
43
 
:       Increase verbosity.
44
 
        The final form of each *Event* object will be displayed before any
45
 
        responses.
46
 
 
47
 
**-h**, **-\-help**
48
 
Show a help message and exit.
49
 
 
50
 
# FILES
51
 
 
52
 
*ibid.ini*
53
 
:       Locates the database to act upon by looking for the
54
 
        [**databases**].**ibid** value in the bot configuration file in the current
55
 
        directory.
56
 
 
57
 
# BUGS
58
 
 
59
 
**ibid-plugin** doesn't emulate a complete Ibid environment, and will ignore
60
 
all of the following:
61
 
 
62
 
* Delayed and periodically executed functions.
63
 
* Messages to alternate sources.
64
 
* Messages directly dispatched, rather than added to responses.
65
 
* Permissions. All permissions are granted to the user.
66
 
 
67
 
# SEE ALSO
68
 
`ibid` (1),
69
 
`ibid.ini` (5),
70
 
`ibid-setup` (1),
 
21
Suffixing a ``-`` to the name, ignores that plugin or Processor instead
 
22
of loading it.
 
23
 
 
24
OPTIONS
 
25
=======
 
26
 
 
27
-c, --configured
 
28
   Load all configured plugins, instead of only the core and requested
 
29
   plugins.
 
30
 
 
31
-o, --only
 
32
   Don't load the Ibid core plugins, only the plugins requested.
 
33
   Note that without the **core** plugin to pre- and post-process
 
34
   events, most other plugins won't function correctly.
 
35
 
 
36
-p, --public
 
37
   By default, **ibid-plugin** emulates a private conversation with the
 
38
   bot.
 
39
   With this option, the conversation is considered to be public and the
 
40
   bot will have to be addressed to provoke a response.
 
41
 
 
42
-v, --verbose
 
43
   Increase verbosity.
 
44
   The final form of each *Event* object will be displayed before any
 
45
   responses.
 
46
 
 
47
-h, --help
 
48
   Show a help message and exit.
 
49
 
 
50
FILES
 
51
=====
 
52
 
 
53
ibid.ini
 
54
   Locates the database to act upon by looking for the
 
55
   [**databases**].\ **ibid** value in the bot configuration file in the
 
56
   current directory.
 
57
 
 
58
BUGS
 
59
====
 
60
 
 
61
**ibid-plugin** doesn't emulate a complete Ibid environment, and will
 
62
ignore all of the following:
 
63
 
 
64
 * Delayed and periodically executed functions.
 
65
 * Messages to alternate sources.
 
66
 * Messages directly dispatched, rather than added to responses.
 
67
 * Permissions. All permissions are granted to the user.
 
68
 
 
69
SEE ALSO
 
70
========
 
71
 
 
72
``ibid``\ (1),
 
73
``ibid.ini``\ (5),
 
74
``ibid-setup``\ (1),
71
75
http://ibid.omnia.za.net/
 
76
 
 
77
.. vi: set et sta sw=3 ts=3: