← Back to branch summary

~ibid-core/ibid/trunk

« back to all changes in this revision

Viewing changes to docs/manpages/ibid-pb-client.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:
docs/manpages/ibid-pb-client.1.rst
1
 
% IBID-PB-CLIENT(1) Ibid Multi-protocol Bot | Ibid 0.1
2
 
% Stefano Rivera
3
 
% March 2010
4
 
 
5
 
# NAME
6
 
 
7
 
ibid-pb-client - RPC Client for Ibid
8
 
 
9
 
# SYNOPSIS
10
 
 
11
 
**ibid-pb-client** [*options*...] **message** *message*  
12
 
**ibid-pb-client** [*options*...] **plugin** *feature* *method* [*parameter*...]  
13
 
**ibid-pb-client** **-h**
14
 
 
15
 
# DESCRIPTION
 
1
================
 
2
 ibid-pb-client
 
3
================
 
4
 
 
5
SYNOPSIS
 
6
========
 
7
 
 
8
| ``ibid-pb-client`` [*options*...] ``message`` *message*
 
9
| ``ibid-pb-client`` [*options*...] ``plugin`` *feature* *method* [*parameter*...]
 
10
| ``ibid-pb-client`` ``-h``
 
11
 
 
12
DESCRIPTION
 
13
===========
16
14
 
17
15
This utility is for passing events to a running Ibid bot, or executing
18
16
RPC-exposed functions remotely.
22
20
*message* is a text message as could be sent to the bot by an IM source.
23
21
The message is processed normally by the bot.
24
22
 
25
 
*feature* is the name of the feature to invoke exposed method **method** on,
26
 
directly.
27
 
*parameter*s are passed directly to the method.
28
 
They can be specified positionally or by key, using the same syntax as Python:
29
 
_key_**=**_value_.
 
23
*feature* is the name of the feature to invoke exposed method *method*
 
24
on, directly.
 
25
*parameter*\ s are passed directly to the method.
 
26
They can be specified positionally or by key, using the same syntax as
 
27
Python: *key*\ ``=``\ *value*.
30
28
They may be encoded in JSON, if not valid JSON they will be treated as
31
29
strings.
32
30
 
33
31
The output is a JSON-encoded response.
34
32
 
35
 
# OPTIONS
36
 
 
37
 
**-s** *SERVER*, **-\-server**=*SERVER*
38
 
:       Connect to the Ibid running on *SERVER*, by default it connects to
39
 
        *localhost*.
40
 
 
41
 
**-p** *PORT*, **-\-port**=*PORT*
42
 
:       Connect to the **pb** source running on port *PORT*, by default 8789.
43
 
 
44
 
**-h**, **-\-help**
45
 
:       Show a help message and exit.
46
 
 
47
 
# SEE ALSO
48
 
 
49
 
`ibid` (1),
 
33
OPTIONS
 
34
=======
 
35
 
 
36
-s SERVER, --server=SERVER
 
37
   Connect to the Ibid running on *SERVER*, by default it connects to
 
38
   *localhost*.
 
39
 
 
40
-p PORT, --port=PORT
 
41
   Connect to the **pb** source running on port *PORT*, by default 8789.
 
42
 
 
43
-h, --help
 
44
   Show a help message and exit.
 
45
 
 
46
SEE ALSO
 
47
========
 
48
 
 
49
``ibid``\ (1),
50
50
http://ibid.omnia.za.net/
 
51
 
 
52
.. vi: set et sta sw=3 ts=3: