1
=== modified file 'docs/Makefile'
2
--- docs/Makefile	2009-08-14 08:43:15 +0000
3
+++ docs/Makefile	2012-01-10 20:45:34 +0000
4
@@ -5,84 +5,126 @@
5
5
SPHINXOPTS    =
5
SPHINXOPTS    =
6
6
SPHINXBUILD   = sphinx-build
6
SPHINXBUILD   = sphinx-build
7
7
PAPER         =
7
PAPER         =
8
8
BUILDDIR      = _build
9
8
9
10
9
# Internal variables.
10
# Internal variables.
11
10
PAPEROPT_a4     = -D latex_paper_size=a4
11
PAPEROPT_a4     = -D latex_paper_size=a4
12
11
PAPEROPT_letter = -D latex_paper_size=letter
12
PAPEROPT_letter = -D latex_paper_size=letter
14
12
ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
15
13
14
17
14
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
15
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
18
15
16
19
16
help:
17
help:
20
17
	@echo "Please use \`make <target>' where <target> is one of"
18
	@echo "Please use \`make <target>' where <target> is one of"
31
18
	@echo "  html      to make standalone HTML files"
19
	@echo "  html       to make standalone HTML files"
32
19
	@echo "  dirhtml   to make HTML files named index.html in directories"
20
	@echo "  dirhtml    to make HTML files named index.html in directories"
33
20
	@echo "  pickle    to make pickle files"
21
	@echo "  singlehtml to make a single large HTML file"
34
21
	@echo "  json      to make JSON files"
22
	@echo "  pickle     to make pickle files"
35
22
	@echo "  htmlhelp  to make HTML files and a HTML help project"
23
	@echo "  json       to make JSON files"
36
23
	@echo "  qthelp    to make HTML files and a qthelp project"
24
	@echo "  htmlhelp   to make HTML files and a HTML help project"
37
24
	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
25
	@echo "  qthelp     to make HTML files and a qthelp project"
38
25
	@echo "  changes   to make an overview of all changed/added/deprecated items"
26
	@echo "  devhelp    to make HTML files and a Devhelp project"
39
26
	@echo "  linkcheck to check all external links for integrity"
27
	@echo "  epub       to make an epub"
40
27
	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
28
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
41
29
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
42
30
	@echo "  text       to make text files"
43
31
	@echo "  man        to make man pages"
44
32
	@echo "  changes    to make an overview of all changed/added/deprecated items"
45
33
	@echo "  linkcheck  to check all external links for integrity"
46
34
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
47
28
35
48
29
clean:
36
clean:
50
30
	-rm -rf _build/*
37
	-rm -rf $(BUILDDIR)/*
51
31
38
52
32
html:
39
html:
54
33
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
40
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
55
34
	@echo
41
	@echo
57
35
	@echo "Build finished. The HTML pages are in _build/html."
42
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
36
43
59
37
dirhtml:
44
dirhtml:
63
38
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
45
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64
39
	@echo
46
	@echo
65
40
	@echo "Build finished. The HTML pages are in _build/dirhtml."
47
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
48
67
49
singlehtml:
68
50
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69
51
	@echo
70
52
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
71
41
53
72
42
pickle:
54
pickle:
74
43
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
55
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
75
44
	@echo
56
	@echo
76
45
	@echo "Build finished; now you can process the pickle files."
57
	@echo "Build finished; now you can process the pickle files."
77
46
58
78
47
json:
59
json:
80
48
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
60
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
81
49
	@echo
61
	@echo
82
50
	@echo "Build finished; now you can process the JSON files."
62
	@echo "Build finished; now you can process the JSON files."
83
51
63
84
52
htmlhelp:
64
htmlhelp:
86
53
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
65
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
87
54
	@echo
66
	@echo
88
55
	@echo "Build finished; now you can run HTML Help Workshop with the" \
67
	@echo "Build finished; now you can run HTML Help Workshop with the" \
90
56
	      ".hhp project file in _build/htmlhelp."
68
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
91
57
69
92
58
qthelp:
70
qthelp:
94
59
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
71
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
95
60
	@echo
72
	@echo
96
61
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
73
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
101
62
	      ".qhcp project file in _build/qthelp, like this:"
74
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
102
63
	@echo "# qcollectiongenerator _build/qthelp/Ibid.qhcp"
75
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Ibid.qhcp"
103
64
	@echo "To view the help file:"
76
	@echo "To view the help file:"
104
65
	@echo "# assistant -collectionFile _build/qthelp/Ibid.qhc"
77
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Ibid.qhc"
105
78
106
79
devhelp:
107
80
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
108
81
	@echo
109
82
	@echo "Build finished."
110
83
	@echo "To view the help file:"
111
84
	@echo "# mkdir -p $$HOME/.local/share/devhelp/Ibid"
112
85
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ibid"
113
86
	@echo "# devhelp"
114
87
115
88
epub:
116
89
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
117
90
	@echo
118
91
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
119
66
92
120
67
latex:
93
latex:
126
68
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
94
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127
69
	@echo
95
	@echo
128
70
	@echo "Build finished; the LaTeX files are in _build/latex."
96
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
129
71
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
97
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
130
72
	      "run these through (pdf)latex."
98
	      "(use \`make latexpdf' here to do that automatically)."
131
99
132
100
latexpdf:
133
101
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
134
102
	@echo "Running LaTeX files through pdflatex..."
135
103
	$(MAKE) -C $(BUILDDIR)/latex all-pdf
136
104
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
137
105
138
106
text:
139
107
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
140
108
	@echo
141
109
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
142
110
143
111
man:
144
112
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
145
113
	@echo
146
114
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
147
73
115
148
74
changes:
116
changes:
150
75
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
117
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
151
76
	@echo
118
	@echo
153
77
	@echo "The overview file is in _build/changes."
119
	@echo "The overview file is in $(BUILDDIR)/changes."
154
78
120
155
79
linkcheck:
121
linkcheck:
157
80
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
122
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
158
81
	@echo
123
	@echo
159
82
	@echo "Link check complete; look for any errors in the above output " \
124
	@echo "Link check complete; look for any errors in the above output " \
161
83
	      "or in _build/linkcheck/output.txt."
125
	      "or in $(BUILDDIR)/linkcheck/output.txt."
162
84
126
163
85
doctest:
127
doctest:
165
86
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
128
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166
87
	@echo "Testing of doctests in the sources finished, look at the " \
129
	@echo "Testing of doctests in the sources finished, look at the " \
168
88
	      "results in _build/doctest/output.txt."
130
	      "results in $(BUILDDIR)/doctest/output.txt."
169
89
131
170
=== modified file 'docs/conf.py'
171
--- docs/conf.py	2011-02-26 16:48:17 +0000
172
+++ docs/conf.py	2012-01-10 20:45:34 +0000
173
@@ -45,7 +45,8 @@
174
45
45
175
46
# General information about the project.
46
# General information about the project.
176
47
project = u'Ibid'
47
project = u'Ibid'
178
48
copyright = u'2008-2011, The Ibid Developers'
48
AUTHORS = u'The Ibid Developers'
179
49
copyright = u'2008-2012, %s' % AUTHORS
180
49
50
181
50
# The version info for the project you're documenting, acts as replacement for
51
# The version info for the project you're documenting, acts as replacement for
182
51
# |version| and |release|, also used in various other places throughout the
52
# |version| and |release|, also used in various other places throughout the
183
@@ -180,7 +181,7 @@
184
180
# (source start file, target name, title, author, documentclass [howto/manual]).
181
# (source start file, target name, title, author, documentclass [howto/manual]).
185
181
latex_documents = [
182
latex_documents = [
186
182
  ('index', 'Ibid.tex', u'Ibid Documentation',
183
  ('index', 'Ibid.tex', u'Ibid Documentation',
188
183
   u'The Ibid Developers', 'manual'),
184
   AUTHORS, 'manual'),
189
184
]
185
]
190
185
186
191
186
# The name of an image file (relative to this directory) to place at the top of
187
# The name of an image file (relative to this directory) to place at the top of
192
@@ -200,6 +201,32 @@
193
200
# If false, no module index is generated.
201
# If false, no module index is generated.
194
201
#latex_use_modindex = True
202
#latex_use_modindex = True
195
202
203
196
204
# -- Options for manpages ------------------------------------------------------
197
205
198
206
man_pages = [
199
207
    ('manpages/ibid.1', 'ibid', u'Run an Ibid bot', AUTHORS, 1),
200
208
    ('manpages/ibid-db.1', 'ibid-db', u'Database management utility for Ibid',
201
209
     AUTHORS, 1),
202
210
    ('manpages/ibid-factpack.1', 'ibid-factpack',
203
211
     u'Factoid-package management utility for Ibid', AUTHORS, 1),
204
212
    ('manpages/ibid.ini.5', 'ibid.ini', u'Configuration file for Ibid',
205
213
     AUTHORS, 5),
206
214
    ('manpages/ibid-knab-import.1', 'ibid-knab-import',
207
215
     u'Knab->Ibid Import utility', AUTHORS, 1),
208
216
    ('manpages/ibid-memgraph.1', 'ibid-memgraph',
209
217
     u'Memory usage graph generation utility for Ibid', AUTHORS, 1),
210
218
    ('manpages/ibid-objgraph.1', 'ibid-objgraph',
211
219
     u'Memory usage graph generation utility for Ibid', AUTHORS, 1),
212
220
    ('manpages/ibid-pb-client.1', 'ibid-pb-client', 'RPC Client for Ibid',
213
221
     AUTHORS, 1),
214
222
    ('manpages/ibid-plugin.1', 'ibid-plugin',
215
223
     u'Plugin testing developer environment for Ibid', AUTHORS, 1),
216
224
    ('manpages/ibid-setup.1', 'ibid-setup',
217
225
     u'Create a basic configuration file and database for an Ibid bot',
218
226
     AUTHORS, 1),
219
227
]
220
228
221
229
222
203
# -- Options for extensions ----------------------------------------------------
230
# -- Options for extensions ----------------------------------------------------
223
204
231
224
205
# pre-1.0 mode intersphinx:
232
# pre-1.0 mode intersphinx:
225
206
233
226
=== modified file 'docs/index.rst'
227
--- docs/index.rst	2011-02-23 22:47:27 +0000
228
+++ docs/index.rst	2012-01-10 20:45:34 +0000
229
@@ -10,6 +10,7 @@
230
10
   plugins
10
   plugins
231
11
   tutorial
11
   tutorial
232
12
   contributing
12
   contributing
233
13
   manpages/index
234
13
   api/index
14
   api/index
235
14
   changes
15
   changes
236
15
16
237
16
17
238
=== renamed directory 'man' => 'docs/manpages'
239
=== renamed file 'man/ibid-db.1.md' => 'docs/manpages/ibid-db.1.rst'
240
--- man/ibid-db.1.md	2010-03-20 10:37:24 +0000
241
+++ docs/manpages/ibid-db.1.rst	2012-01-10 20:45:34 +0000
242
@@ -1,64 +1,68 @@
306
1
% IBID-DB(1) Ibid Multi-protocol Bot | Ibid 0.1
1
=========
307
2
% Stefano Rivera
2
 ibid-db
308
3
% March 2010
3
=========
309
4
4
310
5
# NAME
5
SYNOPSIS
311
6
6
========
312
7
ibid-db - Database management utility for Ibid
7
313
8
8
``ibid-db`` *command* [*options*...]
314
9
# SYNOPSIS
9
315
10
10
DESCRIPTION
316
11
**ibid-db** *command* [*options*...]
11
===========
317
12
12
318
13
# DESCRIPTION
13
This utility is for offline management of your Ibid bot's database.
319
14
14
Used for import, export, and upgrades.
320
15
This utility is for offline management of your Ibid bot's database.  Used for
15
321
16
import, export, and upgrades.
16
The export format is DBMS-agnostic and can be used to migrate between
322
17
17
different databases.
323
18
The export format is DBMS-agnostic and can be used to migrate between different
18
324
19
databases.
19
COMMANDS
325
20
20
========
326
21
# COMMANDS
21
327
22
22
-e FILE, --export=FILE
328
23
**-e** *FILE*, **-\-export**=*FILE*
23
   Export DB contents to *FILE*.
329
24
:	Export DB contents to *FILE*.
24
   Export format is JSON.
330
25
	Export format is JSON.
25
   *FILE* can be ``-`` for *stdout* or can end in ``.gz`` for automatic
331
26
	*FILE* can be **-** for *stdout* or can end in **.gz** for automatic gzip
26
   gzip compression.
332
27
	compression.
27
333
28
28
-i FILE, --import=FILE
334
29
**-i** *FILE*, **-\-import**=*FILE*
29
   Import DB contents from *FILE* as exported by this utility.
335
30
:	Import DB contents from *FILE* as exported by this utility.
30
   *FILE* can be ``-`` for *stdin* or can end in ``.gz`` for automatic
336
31
	*FILE* can be **-** for *stdin* or can end in **.gz** for automatic gzip
31
   gzip compression.
337
32
	compression.
32
338
33
33
   **Note:** The DB must be empty first.
339
34
:	**Note:** The DB must be empty first.
34
340
35
35
-u, --upgrade
341
36
**-u**, **-\-upgrade**
36
   Upgrade DB schema to the latest version.
342
37
:	Upgrade DB schema to the latest version.
37
   You need to run this after upgrading your bot.
343
38
	You need to run this after upgrading your bot.
38
344
39
39
   **Note:** You should backup first.
345
40
:	**Note:** You should backup first.
40
346
41
41
OPTIONS
347
42
# OPTIONS
42
=======
348
43
43
349
44
**-\-version**
44
--version
350
45
:	Show the program's version and exit.
45
   Show the program's version and exit.
351
46
46
352
47
**-h**, **-\-help**
47
-h, --help
353
48
:	Show a help message and exit.
48
   Show a help message and exit.
354
49
49
355
50
**-v**, **-\-verbose**
50
-v, --verbose
356
51
:	Turn on debugging output to stderr.
51
   Turn on debugging output to stderr.
357
52
52
358
53
# FILES
53
FILES
359
54
54
=====
360
55
*ibid.ini*
55
361
56
:	Locates the database to act upon by looking for the
56
ibid.ini
362
57
	[**databases**].**ibid** value in the bot configuration file in the current
57
   Locates the database to act upon by looking for the
363
58
	directory.
58
   [**databases**].\ **ibid** value in the bot configuration file in the
364
59
59
   current directory.
365
60
# SEE ALSO
60
366
61
`ibid` (1),
61
SEE ALSO
367
62
`ibid.ini` (5),
62
========
368
63
`ibid-setup` (1),
63
``ibid``\ (1),
369
64
``ibid.ini``\ (5),
370
65
``ibid-setup``\ (1),
371
64
http://ibid.omnia.za.net/
66
http://ibid.omnia.za.net/
372
67
373
68
.. vi: set et sta sw=3 ts=3:
374
65
69
375
=== renamed file 'man/ibid-factpack.1.md' => 'docs/manpages/ibid-factpack.1.rst'
376
--- man/ibid-factpack.1.md	2010-03-20 10:37:24 +0000
377
+++ docs/manpages/ibid-factpack.1.rst	2012-01-10 20:45:34 +0000
378
@@ -1,70 +1,78 @@
397
1
% IBID-FACTPACK(1) Ibid Multi-protocol Bot | Ibid 0.1
1
===============
398
2
% Stefano Rivera
2
 ibid-factpack
399
3
% March 2010
3
===============
400
4
4
401
5
# NAME
5
SYNOPSIS
402
6
6
========
403
7
ibid-factpack - Factoid-package management utility for Ibid
7
404
8
8
| ``ibid-factpack`` [``-s``] *factpack-file*
405
9
# SYNOPSIS
9
| ``ibid-factpack`` ``-r`` [``-f``] *factpack-name*
406
10
10
| ``ibid-factpack`` ``-h``
407
11
**ibid-factpack** [**-s**] *factpack-file*  
11
408
12
**ibid-factpack** **-r** [**-f**] *factpack-name*  
12
DESCRIPTION
409
13
**ibid-factpack** **-h**
13
===========
410
14
14
411
15
# DESCRIPTION
15
This utility is for adding and removing sets of packaged factoids, known
412
16
16
as factpacks, from your Ibid's factoid database.
395
17
This utility is for adding and removing sets of packaged factoids, known as
396
18
factpacks, from your Ibid's factoid database.
413
19
17
414
20
The default mode is factpack loading.
18
The default mode is factpack loading.
415
21
The *factpack-file* specified is loaded into the bot's database.
19
The *factpack-file* specified is loaded into the bot's database.
422
22
Should the pack contain any facts with the same name as an existing fact in the
20
Should the pack contain any facts with the same name as an existing fact
423
23
bot's database, loading will be aborted, unless the *-s* option is supplied.
21
in the bot's database, loading will be aborted, unless the ``-s`` option
424
24
22
is supplied.
425
25
Factpacks can be gzipped if the filename ends with **.gz**.
23
426
26
24
Factpacks can be gzipped if the filename ends with ``.gz``.
427
27
When invoked with the **-r** option, the named factpack (original import
25
428
26
When invoked with the ``-r`` option, the named factpack (original import
429
28
filename minus the extension) will be removed from the bot.
27
filename minus the extension) will be removed from the bot.
448
29
If any of the facts contained in that pack were modified while loaded in the
28
If any of the facts contained in that pack were modified while loaded in
449
30
bot, unloading will be aborted, unless the **-f** option is supplied.
29
the bot, unloading will be aborted, unless the ``-f`` option is
450
31
30
supplied.
451
32
# OPTIONS
31
452
33
32
OPTIONS
453
34
**-r**, **-\-remove**
33
=======
454
35
:	Remove the named factpack, rather than importing.
34
455
36
35
-r, --remove
456
37
**-f**, **-\-force**
36
   Remove the named factpack, rather than importing.
457
38
:	Force removal, if facts in the factpack were modified by users.
37
458
39
38
-f, --force
459
40
**-s**, **-\-skip**
39
   Force removal, if facts in the factpack were modified by users.
460
41
:	Skip facts that clash with existing factoids, during import.
40
461
42
41
-s, --skip
462
43
**-h**, **-\-help**
42
   Skip facts that clash with existing factoids, during import.
463
44
:	Show a help message and exit.
43
464
45
44
-h, --help
465
46
# FACTPACKS
45
   Show a help message and exit.
466
46
467
47
FACTPACKS
468
48
=========
469
47
49
470
48
Factpacks are JSON-encoded text files containing a list of facts.
50
Factpacks are JSON-encoded text files containing a list of facts.
471
49
Each fact is a tuple of two lists: fact-names, fact-values.
51
Each fact is a tuple of two lists: fact-names, fact-values.
472
50
The same substitutions are available as in normal online Factoids.
52
The same substitutions are available as in normal online Factoids.
473
51
53
492
52
## Example:
54
Example:
493
53
55
--------
494
54
	[
56
::
495
55
	 [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
57
496
56
	 [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
58
   [
497
57
	]
59
    [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
498
58
60
    [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
499
59
# FILES
61
   ]
500
60
62
501
61
*ibid.ini*
63
FILES
502
62
:	Locates the database to act upon by looking for the
64
=====
503
63
	[**databases**].**ibid** value in the bot configuration file in the current
65
504
64
	directory.
66
ibid.ini
505
65
67
   Locates the database to act upon by looking for the
506
66
# SEE ALSO
68
   [**databases**].\ **ibid** value in the bot configuration file in the
507
67
69
   current directory.
508
68
`ibid` (1),
70
509
69
`ibid.ini` (5),
71
SEE ALSO
510
72
========
511
73
512
74
``ibid``\ (1),
513
75
``ibid.ini``\ (5),
514
70
http://ibid.omnia.za.net/
76
http://ibid.omnia.za.net/
515
77
516
78
.. vi: set et sta sw=3 ts=3:
517
71
79
518
=== renamed file 'man/ibid-knab-import.1.md' => 'docs/manpages/ibid-knab-import.1.rst'
519
--- man/ibid-knab-import.1.md	2010-03-20 10:37:01 +0000
520
+++ docs/manpages/ibid-knab-import.1.rst	2012-01-10 20:45:34 +0000
521
@@ -1,50 +1,54 @@
538
1
% IBID-KNAB-IMPORT(1) Ibid Multi-protocol Bot | Ibid 0.1
1
==================
539
2
% Stefano Rivera
2
 ibid-knab-import
540
3
% March 2010
3
==================
541
4
4
542
5
# NAME
5
SYNOPSIS
543
6
6
========
544
7
ibid-knab-import - Knab->Ibid Import utility
7
545
8
8
``ibid-knab-import`` *knab-sa-url* *source* [*config-file*]
546
9
# SYNOPSIS
9
547
10
10
DESCRIPTION
548
11
**ibid-knab-import** *knab-sa-url* *source* [*config-file*]
11
===========
549
12
12
550
13
# DESCRIPTION
13
This utility imports users, last seen information, factoids, and URLs
551
14
14
from a Knab bot's database into an Ibid.
536
15
This utility imports users, last seen information, factoids, and URLs from a
537
16
Knab bot's database into an Ibid.
552
17
15
553
18
For best results, import directly into a brand new, clean Ibid install.
16
For best results, import directly into a brand new, clean Ibid install.
554
19
17
584
20
On import, strings are converted to Unicode, guessing UTF-8 and falling back to
18
On import, strings are converted to Unicode, guessing UTF-8 and falling
585
21
detection.
19
back to detection.
586
22
20
587
23
# OPTIONS
21
OPTIONS
588
24
22
=======
589
25
*knab-sa-url*
23
590
26
:	The SQLAlchemy URI for the Knab's database.
24
knab-sa-url
591
27
	The format is **mysql://**_user_**:**_pass_**@**_hostname_**/**_dbname_
25
   The SQLAlchemy URI for the Knab's database.
592
28
26
   The format is
593
29
*source*
27
   ``mysql://``\ *user*\ ``:``\ *pass*\ ``@``\ *hostname*\ ``/``\ *dbname*
594
30
:	The name in the Ibid bot for the source that the Knab was previously
28
595
31
	connected to.
29
source
596
32
30
   The name in the Ibid bot for the source that the Knab was previously
597
33
*config-file*
31
   connected to.
598
34
:	If supplied, this is configuration file is used for locating the Ibid's
32
599
35
	database rather than **ibid.ini**.
33
config-file
600
36
34
   If supplied, this is configuration file is used for locating the
601
37
# FILES
35
   Ibid's database rather than ``ibid.ini``.
602
38
36
603
39
*ibid.ini*
37
FILES
604
40
:	Locates the database to act upon by looking for the
38
=====
605
41
	[**databases**].**ibid** value in the bot configuration file in the current
39
606
42
	directory.
40
ibid.ini
607
43
41
   Locates the database to act upon by looking for the
608
44
# SEE ALSO
42
   [**databases**].\ **ibid** value in the bot configuration file in the
609
45
43
   current directory.
610
46
`ibid` (1),
44
611
47
`ibid.ini` (5),
45
SEE ALSO
612
48
`ibid-setup` (1),
46
========
613
47
614
48
``ibid``\ (1),
615
49
``ibid.ini``\ (5),
616
50
``ibid-setup``\ (1),
617
49
http://ibid.omnia.za.net/,
51
http://ibid.omnia.za.net/,
618
50
http://knab.omnia.za.net/
52
http://knab.omnia.za.net/
619
53
620
54
.. vi: set et sta sw=3 ts=3:
621
51
55
622
=== renamed file 'man/ibid-memgraph.1.md' => 'docs/manpages/ibid-memgraph.1.rst'
623
--- man/ibid-memgraph.1.md	2010-03-20 10:37:24 +0000
624
+++ docs/manpages/ibid-memgraph.1.rst	2012-01-10 20:45:34 +0000
625
@@ -1,44 +1,48 @@
640
1
% IBID-MEMGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
1
===============
641
2
% Stefano Rivera
2
 ibid-memgraph
642
3
% March 2010
3
===============
643
4
4
644
5
# NAME
5
SYNOPSIS
645
6
6
========
646
7
ibid-memgraph - Memory usage graph generation utility for Ibid
7
647
8
8
| ``ibid-memgraph`` [*options*...] *logfile*
648
9
# SYNOPSIS
9
| ``ibid-memgraph`` ``-h``
649
10
10
650
11
**ibid-memgraph** [*options*...] *logfile*  
11
DESCRIPTION
651
12
**ibid-memgraph** **-h**
12
===========
638
13
639
14
# DESCRIPTION
652
15
13
653
16
This utility is for graphing memory usage from an Ibid bot configured to
14
This utility is for graphing memory usage from an Ibid bot configured to
654
17
log such usage.
15
log such usage.
655
18
16
656
19
Matplotlib is required for graphing.
17
Matplotlib is required for graphing.
657
20
18
681
21
# OPTIONS
19
OPTIONS
682
22
20
=======
683
23
**-o** *FILE*, **-\-output**=*FILE*
21
684
24
:	Output to *FILE* instead of displaying interactive graph GUI.
22
-o FILE, --output=FILE
685
25
	*FILE* can be any format supported by Matplotlib, detected by the file
23
   Output to *FILE* instead of displaying interactive graph GUI.
686
26
	extension.
24
   *FILE* can be any format supported by Matplotlib, detected by the
687
27
25
   file extension.
688
28
**-d** *DPI*, **-\-dpi**=*DPI*
26
689
29
	When outputting in raster formats, use *DPI* output DPI.
27
-d DPI, --dpi=DPI
690
30
28
   When outputting in raster formats, use *DPI* output DPI.
691
31
**-h**, **-\-help**
29
692
32
	Show a help message and exit.
30
-h, --help
693
33
31
   Show a help message and exit.
694
34
# FILES
32
695
35
33
FILES
696
36
*logfile*
34
=====
697
37
:	A log file generated by loading the **memory** plugin into Ibid, which will
35
698
38
	periodically log memory usage.
36
logfile
699
39
	It can be gzip compressed, if the filename ends in **.gz**.
37
   A log file generated by loading the **memory** plugin into Ibid,
700
40
38
   which will periodically log memory usage.
701
41
# SEE ALSO
39
   It can be gzip compressed, if the filename ends in ``.gz``.
702
42
`ibid` (1),
40
703
43
`ibid-objgraph` (1),
41
SEE ALSO
704
42
========
705
43
706
44
``ibid``\ (1),
707
45
``ibid-objgraph``\ (1),
708
44
http://ibid.omnia.za.net/
46
http://ibid.omnia.za.net/
709
47
710
48
.. vi: set et sta sw=3 ts=3:
711
45
49
712
=== renamed file 'man/ibid-objgraph.1.md' => 'docs/manpages/ibid-objgraph.1.rst'
713
--- man/ibid-objgraph.1.md	2010-03-20 10:37:24 +0000
714
+++ docs/manpages/ibid-objgraph.1.rst	2012-01-10 20:45:34 +0000
715
@@ -1,51 +1,55 @@
731
1
% IBID-OBJGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
1
===============
732
2
% Stefano Rivera
2
 ibid-objgraph
733
3
% March 2010
3
===============
734
4
4
735
5
# NAME
5
SYNOPSIS
736
6
6
========
737
7
ibid-objgraph - Memory usage graph generation utility for Ibid
7
738
8
8
| ``ibid-objgraph`` [*options*...] *logfile* *type*...
739
9
# SYNOPSIS
9
| ``ibid-objgraph`` [*options*...] ``-e`` *TIME* *logfile*
740
10
10
| ``ibid-objgraph`` ``-h``
741
11
**ibid-objgraph** [*options*...] *logfile* *type*...  
11
742
12
**ibid-objgraph** [*options*...] **-e** *TIME* *logfile*  
12
DESCRIPTION
743
13
**ibid-objgraph** **-h**
13
===========
729
14
730
15
# DESCRIPTION
744
16
14
745
17
This utility is for graphing object-type usage from an Ibid bot
15
This utility is for graphing object-type usage from an Ibid bot
746
18
configured to log such usage.
16
configured to log such usage.
747
19
17
748
20
Matplotlib is required for graphing.
18
Matplotlib is required for graphing.
749
21
19
770
22
# OPTIONS
20
OPTIONS
771
23
21
=======
772
24
**-e** *TIME*, **-\-examine**=*TIME*
22
773
25
:	Examine the object usage at time *TIME*, and print a sorted list of type
23
-e TIME, --examine=TIME
774
26
	statistics at that time.
24
   Examine the object usage at time *TIME*, and print a sorted list of
775
27
	This function can be useful in determining which types to graph, when
25
   type statistics at that time.
776
28
	chasing down a detected leak.
26
   This function can be useful in determining which types to graph, when
777
29
27
   chasing down a detected leak.
778
30
**-o** *FILE*, **-\-output**=*FILE*
28
779
31
:	Output to *FILE* instead of displaying interactive graph GUI.
29
-o FILE, --output=FILE
780
32
	*FILE* can be any format supported by Matplotlib, detected by the file
30
   Output to *FILE* instead of displaying interactive graph GUI.
781
33
	extension.
31
   *FILE* can be any format supported by Matplotlib, detected by the
782
34
32
   file extension.
783
35
**-d** *DPI*, **-\-dpi**=*DPI*
33
784
36
:	When outputting in raster formats, use *DPI* output DPI.
34
-d DPI, --dpi=DPI
785
37
35
   When outputting in raster formats, use *DPI* output DPI.
786
38
**-h**, **-\-help**
36
787
39
	Show a help message and exit.
37
-h, --help
788
40
38
   Show a help message and exit.
789
41
# FILES
39
790
40
FILES
791
41
=====
792
42
42
793
43
*logfile*
43
*logfile*
801
44
:	A log file generated by loading the **memory** plugin into Ibid, which will
44
   A log file generated by loading the **memory** plugin into Ibid,
802
45
	periodically log object usage.
45
   which will periodically log object usage.
803
46
	It can be gzip compressed, if the filename ends in **.gz**.
46
   It can be gzip compressed, if the filename ends in ``.gz``.
804
47
47
805
48
# SEE ALSO
48
SEE ALSO
806
49
`ibid` (1),
49
========
807
50
`ibid-memgraph` (1),
50
808
51
``ibid``\ (1),
809
52
``ibid-memgraph``\ (1),
810
51
http://ibid.omnia.za.net/
53
http://ibid.omnia.za.net/
811
54
812
55
.. vi: set et sta sw=3 ts=3:
813
52
56
814
=== renamed file 'man/ibid-pb-client.1.md' => 'docs/manpages/ibid-pb-client.1.rst'
815
--- man/ibid-pb-client.1.md	2010-03-20 10:37:24 +0000
816
+++ docs/manpages/ibid-pb-client.1.rst	2012-01-10 20:45:34 +0000
817
@@ -1,18 +1,16 @@
833
1
% IBID-PB-CLIENT(1) Ibid Multi-protocol Bot | Ibid 0.1
1
================
834
2
% Stefano Rivera
2
 ibid-pb-client
835
3
% March 2010
3
================
836
4
4
837
5
# NAME
5
SYNOPSIS
838
6
6
========
839
7
ibid-pb-client - RPC Client for Ibid
7
840
8
8
| ``ibid-pb-client`` [*options*...] ``message`` *message*
841
9
# SYNOPSIS
9
| ``ibid-pb-client`` [*options*...] ``plugin`` *feature* *method* [*parameter*...]
842
10
10
| ``ibid-pb-client`` ``-h``
843
11
**ibid-pb-client** [*options*...] **message** *message*  
11
844
12
**ibid-pb-client** [*options*...] **plugin** *feature* *method* [*parameter*...]  
12
DESCRIPTION
845
13
**ibid-pb-client** **-h**
13
===========
831
14
832
15
# DESCRIPTION
846
16
14
847
17
This utility is for passing events to a running Ibid bot, or executing
15
This utility is for passing events to a running Ibid bot, or executing
848
18
RPC-exposed functions remotely.
16
RPC-exposed functions remotely.
849
@@ -22,29 +20,33 @@
850
22
*message* is a text message as could be sent to the bot by an IM source.
20
*message* is a text message as could be sent to the bot by an IM source.
851
23
The message is processed normally by the bot.
21
The message is processed normally by the bot.
852
24
22
858
25
*feature* is the name of the feature to invoke exposed method **method** on,
23
*feature* is the name of the feature to invoke exposed method *method*
859
26
directly.
24
on, directly.
860
27
*parameter*s are passed directly to the method.
25
*parameter*\ s are passed directly to the method.
861
28
They can be specified positionally or by key, using the same syntax as Python:
26
They can be specified positionally or by key, using the same syntax as
862
29
_key_**=**_value_.
27
Python: *key*\ ``=``\ *value*.
863
30
They may be encoded in JSON, if not valid JSON they will be treated as
28
They may be encoded in JSON, if not valid JSON they will be treated as
864
31
strings.
29
strings.
865
32
30
866
33
The output is a JSON-encoded response.
31
The output is a JSON-encoded response.
867
34
32
883
35
# OPTIONS
33
OPTIONS
884
36
34
=======
885
37
**-s** *SERVER*, **-\-server**=*SERVER*
35
886
38
:	Connect to the Ibid running on *SERVER*, by default it connects to
36
-s SERVER, --server=SERVER
887
39
	*localhost*.
37
   Connect to the Ibid running on *SERVER*, by default it connects to
888
40
38
   *localhost*.
889
41
**-p** *PORT*, **-\-port**=*PORT*
39
890
42
:	Connect to the **pb** source running on port *PORT*, by default 8789.
40
-p PORT, --port=PORT
891
43
41
   Connect to the **pb** source running on port *PORT*, by default 8789.
892
44
**-h**, **-\-help**
42
893
45
:	Show a help message and exit.
43
-h, --help
894
46
44
   Show a help message and exit.
895
47
# SEE ALSO
45
896
48
46
SEE ALSO
897
49
`ibid` (1),
47
========
898
48
899
49
``ibid``\ (1),
900
50
http://ibid.omnia.za.net/
50
http://ibid.omnia.za.net/
901
51
902
52
.. vi: set et sta sw=3 ts=3:
903
51
53
904
=== renamed file 'man/ibid-plugin.1.md' => 'docs/manpages/ibid-plugin.1.rst'
905
--- man/ibid-plugin.1.md	2010-03-20 10:37:24 +0000
906
+++ docs/manpages/ibid-plugin.1.rst	2012-01-10 20:45:34 +0000
907
@@ -1,71 +1,77 @@
925
1
% IBID-PLUGIN(1) Ibid Multi-protocol Bot | Ibid 0.1
1
=============
926
2
% Stefano Rivera
2
 ibid-plugin
927
3
% March 2010
3
=============
928
4
4
929
5
# NAME
5
SYNOPSIS
930
6
6
========
931
7
ibid-plugin \- Plugin testing developer environment for Ibid
7
932
8
8
``ibid-plugin`` [*options*...] [*plugin*\ [``-``]|\ *plugin*\ ``.``\ *Processor*\ [``-``]...]
933
9
# SYNOPSIS
9
934
10
10
DESCRIPTION
935
11
**ibid-plugin** [*options*...] [*plugin*[**-**]|_plugin_**.**_Processor_[**-**]...]
11
===========
936
12
12
937
13
# DESCRIPTION
13
This utility is for testing Ibid plugins without the full bot
938
14
14
environment.  This means testing can be performed offline and without
939
15
This utility is for testing Ibid plugins without the full bot environment.
15
loading all the available plugins.
923
16
This means testing can be performed offline and without loading all the
924
17
available plugins.
940
18
16
941
19
This should be run in a configured Ibid bot directory.
17
This should be run in a configured Ibid bot directory.
942
20
18
943
21
All the listed plugins and Processors will be loaded on start-up.
19
All the listed plugins and Processors will be loaded on start-up.
944
22
Naming a plugin loads the complete plugin.
20
Naming a plugin loads the complete plugin.
993
23
Suffixing a **-** to the name, ignores that plugin or Processor instead of
21
Suffixing a ``-`` to the name, ignores that plugin or Processor instead
994
24
loading it.
22
of loading it.
995
25
23
996
26
# OPTIONS
24
OPTIONS
997
27
25
=======
998
28
**-c**, **-\-configured**
26
999
29
:	Load all configured plugins, instead of only the core and requested
27
-c, --configured
1000
30
	plugins.
28
   Load all configured plugins, instead of only the core and requested
1001
31
29
   plugins.
1002
32
**-o**, **-\-only**
30
1003
33
:	Don't load the Ibid core plugins, only the plugins requested.
31
-o, --only
1004
34
	Note that without the **core** plugin to pre- and post-process events, most
32
   Don't load the Ibid core plugins, only the plugins requested.
1005
35
	other plugins won't function correctly.
33
   Note that without the **core** plugin to pre- and post-process
1006
36
34
   events, most other plugins won't function correctly.
1007
37
**-p**, **-\-public**
35
1008
38
:	By default, **ibid-plugin** emulates a private conversation with the bot.
36
-p, --public
1009
39
	With this option, the conversation is considered to be public and the
37
   By default, **ibid-plugin** emulates a private conversation with the
1010
40
	bot will have to be addressed to provoke a response.
38
   bot.
1011
41
39
   With this option, the conversation is considered to be public and the
1012
42
**-v**, **-\-verbose**
40
   bot will have to be addressed to provoke a response.
1013
43
:	Increase verbosity.
41
1014
44
	The final form of each *Event* object will be displayed before any
42
-v, --verbose
1015
45
	responses.
43
   Increase verbosity.
1016
46
44
   The final form of each *Event* object will be displayed before any
1017
47
**-h**, **-\-help**
45
   responses.
1018
48
Show a help message and exit.
46
1019
49
47
-h, --help
1020
50
# FILES
48
   Show a help message and exit.
1021
51
49
1022
52
*ibid.ini*
50
FILES
1023
53
:	Locates the database to act upon by looking for the
51
=====
1024
54
	[**databases**].**ibid** value in the bot configuration file in the current
52
1025
55
	directory.
53
ibid.ini
1026
56
54
   Locates the database to act upon by looking for the
1027
57
# BUGS
55
   [**databases**].\ **ibid** value in the bot configuration file in the
1028
58
56
   current directory.
1029
59
**ibid-plugin** doesn't emulate a complete Ibid environment, and will ignore
57
1030
60
all of the following:
58
BUGS
1031
61
59
====
1032
62
* Delayed and periodically executed functions.
60
1033
63
* Messages to alternate sources.
61
**ibid-plugin** doesn't emulate a complete Ibid environment, and will
1034
64
* Messages directly dispatched, rather than added to responses.
62
ignore all of the following:
1035
65
* Permissions. All permissions are granted to the user.
63
1036
66
64
 * Delayed and periodically executed functions.
1037
67
# SEE ALSO
65
 * Messages to alternate sources.
1038
68
`ibid` (1),
66
 * Messages directly dispatched, rather than added to responses.
1039
69
`ibid.ini` (5),
67
 * Permissions. All permissions are granted to the user.
1040
70
`ibid-setup` (1),
68
1041
69
SEE ALSO
1042
70
========
1043
71
1044
72
``ibid``\ (1),
1045
73
``ibid.ini``\ (5),
1046
74
``ibid-setup``\ (1),
1047
71
http://ibid.omnia.za.net/
75
http://ibid.omnia.za.net/
1048
76
1049
77
.. vi: set et sta sw=3 ts=3:
1050
72
78
1051
=== renamed file 'man/ibid-setup.1.md' => 'docs/manpages/ibid-setup.1.rst'
1052
--- man/ibid-setup.1.md	2010-03-15 20:23:11 +0000
1053
+++ docs/manpages/ibid-setup.1.rst	2012-01-10 20:45:34 +0000
1054
@@ -1,36 +1,40 @@
1064
1
% IBID-SETUP(1) Ibid Multi-protocol Bot | Ibid 0.1
1
============
1065
2
% Stefano Rivera
2
 ibid-setup
1066
3
% March 2010
3
============
1067
4
4
1068
5
# NAME
5
SYNOPSIS
1069
6
6
========
1061
7
ibid-setup - Create a basic configuration file and database for an Ibid bot
1062
8
1063
9
# SYNOPSIS
1070
10
7
1071
11
**ibid-setup**
8
**ibid-setup**
1072
12
9
1074
13
# DESCRIPTION
10
DESCRIPTION
1075
11
===========
1076
14
12
1077
15
This program sets up everything that a new Ibid bot needs before it can run.
13
This program sets up everything that a new Ibid bot needs before it can run.
1078
16
It asks a series of questions about the new bot, and writes out a basic
14
It asks a series of questions about the new bot, and writes out a basic
1098
17
configuration file - `ibid.ini` (5) - to the current directory.
15
configuration file - ``ibid.ini``\ (5) - to the current directory.
1099
18
It also creates a database for the bot, by default a SQLite database in the
16
It also creates a database for the bot, by default a SQLite database in
1100
19
current directory.
17
the current directory.
1101
20
18
1102
21
This should be run in the directory which will become the new Ibid bot's base.
19
This should be run in the directory which will become the new Ibid bot's
1103
22
20
base.
1104
23
Should there be an existing **ibid.ini** in the current directory, it will be
21
1105
24
used, and the only questions asked will be for adding an administrative user.
22
Should there be an existing ``ibid.ini`` in the current directory, it
1106
25
These can safely be skipped with a **^C**.
23
will be used, and the only questions asked will be for adding an
1107
26
24
administrative user.
1108
27
# FILES
25
These can safely be skipped with a ``^C``.
1109
28
26
1110
29
*ibid.ini*
27
FILES
1111
30
:	The Ibid bot's configuration file, will be created if it doesn't exist.
28
=====
1112
31
29
1113
32
# SEE ALSO
30
ibid.ini
1114
33
31
   The Ibid bot's configuration file, will be created if it doesn't exist.
1115
34
`ibid` (1),
32
1116
35
`ibid.ini` (5),
33
SEE ALSO
1117
34
========
1118
35
1119
36
``ibid``\ (1),
1120
37
``ibid.ini``\ (5),
1121
36
http://ibid.omnia.za.net/
38
http://ibid.omnia.za.net/
1122
39
1123
40
.. vi: set et sta sw=3 ts=3:
1124
37
41
1125
=== renamed file 'man/ibid.1.md' => 'docs/manpages/ibid.1.rst'
1126
--- man/ibid.1.md	2010-03-15 20:23:11 +0000
1127
+++ docs/manpages/ibid.1.rst	2012-01-10 20:45:34 +0000
1128
@@ -1,41 +1,44 @@
1142
1
% IBID(1) Ibid Multi-protocol Bot | Ibid 0.1
1
======
1143
2
% Stefano Rivera
2
 ibid
1144
3
% March 2010
3
======
1145
4
4
1146
5
# NAME
5
SYNOPSIS
1147
6
6
========
1148
7
ibid - Run an Ibid bot
7
1149
8
8
``ibid`` [*config-file*]
1150
9
# SYNOPSIS
9
1151
10
10
DESCRIPTION
1152
11
**ibid** [*config-file*]
11
===========
1140
12
1141
13
# DESCRIPTION
1153
14
12
1154
15
This runs an Ibid bot in the foreground.
13
This runs an Ibid bot in the foreground.
1155
16
14
1158
17
There should there be an existing **ibid.ini** (created by
15
There should there be an existing ``ibid.ini`` (created by
1159
18
`ibid-setup` (1))
16
``ibid-setup``\ (1))
1160
19
in the current directory or one should be provided on the command line.
17
in the current directory or one should be provided on the command line.
1161
20
18
1163
21
Where possible, you should run **twistd -n ibid** instead of this
19
Where possible, you should run ``twistd -n ibid`` instead of this
1164
22
program, as otherwise some classes of errors go unreported.
20
program, as otherwise some classes of errors go unreported.
1165
23
See **BUGS**.
21
See **BUGS**.
1166
24
22
1168
25
# BUGS
23
BUGS
1169
24
====
1170
26
25
1171
27
Exceptions in twisted callbacks can go unnoticed in this program.
26
Exceptions in twisted callbacks can go unnoticed in this program.
1172
28
That has no harmful effects, but the developers may miss out on some
27
That has no harmful effects, but the developers may miss out on some
1173
29
good bug reports.
28
good bug reports.
1174
30
29
1176
31
# FILES
30
FILES
1177
31
=====
1178
32
32
1179
33
*ibid.ini*
33
*ibid.ini*
1187
34
:	The Ibid bot's configuration file, will be created if it doesn't exist.
34
   The Ibid bot's configuration file, will be created if it doesn't exist.
1188
35
35
1189
36
# SEE ALSO
36
SEE ALSO
1190
37
37
========
1191
38
`ibid.ini` (5),
38
1192
39
`ibid-setup` (1),
39
``ibid.ini``\ (5),
1193
40
`twistd` (1),
40
``ibid-setup``\ (1),
1194
41
``twistd``\ (1),
1195
41
http://ibid.omnia.za.net/
42
http://ibid.omnia.za.net/
1196
43
1197
44
.. vi: set et sta sw=3 ts=3:
1198
42
45
1199
=== renamed file 'man/ibid.ini.5.md' => 'docs/manpages/ibid.ini.5.rst'
1200
--- man/ibid.ini.5.md	2011-06-13 11:51:01 +0000
1201
+++ docs/manpages/ibid.ini.5.rst	2012-01-10 20:45:34 +0000
1202
@@ -1,119 +1,130 @@
1222
1
% IBID.INI(5) Ibid Multi-protocol Bot | Ibid 0.1
1
==========
1223
2
% Stefano Rivera
2
 ibid.ini
1224
3
% March 2010
3
==========
1225
4
4
1226
5
# NAME
5
NAME
1227
6
6
====
1228
7
ibid.ini - Configuration file for Ibid
7
1229
8
8
DESCRIPTION
1230
9
# DESCRIPTION
9
===========
1231
10
10
1232
11
ibid.ini contains all the configuration for an Ibid bot.
11
``ibid.ini`` contains all the configuration for an Ibid bot.
1233
12
12
1234
13
A complete description of the contents of this file is out of the scope of this
13
A complete description of the contents of this file is out of the scope
1235
14
manpage.
14
of this manpage.
1236
15
For more details see the Ibid documentation: http://ibid.omnia.za.net/docs/
15
For more details see the Ibid HTML documentation:
1237
16
16
http://ibid.omnia.za.net/docs/
1238
17
Lines beginning with **#** are considered to be comments and ignored.
17
1239
18
To use a **#** symbol in an option (e.g. an IRC channel name), quote the
18
Lines beginning with ``#`` are considered to be comments and ignored.
1240
19
option with double-quotes, e.g. **channels**=**"#ibid",**
19
To use a ``#`` symbol in an option (e.g. an IRC channel name), quote the
1241
20
option with double-quotes, e.g. ``channels = "#ibid",``
1242
20
21
1243
21
This file will be written to by the bot when configuration settings are
22
This file will be written to by the bot when configuration settings are
1244
22
altered online.
23
altered online.
1245
23
It can also be edited manually and a running bot told to
24
It can also be edited manually and a running bot told to
1247
24
**"reload config"**.
25
``reload config``.
1248
25
Manual edits and comments will be preserved when the bot modifies its
26
Manual edits and comments will be preserved when the bot modifies its
1249
26
own configuration, provided that they have not been edited since bot
27
own configuration, provided that they have not been edited since bot
1250
27
start-up or the last config reload.
28
start-up or the last config reload.
1251
28
29
1253
29
# SECTIONS
30
SECTIONS
1254
31
========
1255
30
32
1257
31
## auth
33
auth
1258
34
----
1259
32
35
1260
33
Settings related to permissions and authentication.
36
Settings related to permissions and authentication.
1263
34
Permissions listed in **auth**.**permissions** are granted to all users unless
37
Permissions listed in **auth**.\ **permissions** are granted to all
1264
35
revoked by source or account.
38
users unless revoked by source or account.
1265
36
39
1267
37
## sources
40
sources
1268
41
-------
1269
38
42
1270
39
Sources are Ibid connections to an IM service.
43
Sources are Ibid connections to an IM service.
1271
40
They range from IRC networks to the bot's built-in HTTP server.
44
They range from IRC networks to the bot's built-in HTTP server.
1272
41
45
1273
42
Each source is configured in a section named after the source.
46
Each source is configured in a section named after the source.
1276
43
The source name will define the driver that the source should use, unless a
47
The source name will define the driver that the source should use,
1277
44
**type** option is provided.
48
unless a ``type`` option is provided.
1278
45
49
1279
46
Sources can be disabled by setting
50
Sources can be disabled by setting
1281
47
**disabled**=**True**.
51
``disabled = True``.
1282
48
52
1284
49
## plugins
53
plugins
1285
54
-------
1286
50
55
1287
51
Plugin configuration.
56
Plugin configuration.
1288
52
Each plugin is configured within a section named after the plugin.
57
Each plugin is configured within a section named after the plugin.
1289
53
58
1355
54
**cachedir**
59
cachedir
1356
55
:	The directory that temporary files (such as downloaded data), useful to be
60
   The directory that temporary files (such as downloaded data), useful
1357
56
	the bot but expendable, is stored in.
61
   to be the bot but expendable, is stored in.
1358
57
62
1359
58
**autoload**
63
autoload
1360
59
:	If **True**, all plugins not explicitly ignored will be loaded.
64
   If ``True``, all plugins not explicitly ignored will be loaded.
1361
60
	(Note that some plugins mark themselves as non-auto-loadable).
65
   (Note that some plugins mark themselves as non-auto-loadable).
1362
61
	Defaults to **True**.
66
   Defaults to ``True``.
1363
62
67
1364
63
**load**
68
load
1365
64
:	The list of plugins (or **plugin**.**Processor**s) to load.
69
   The list of plugins (or **plugin**.\ **Processor**\ s) to load.
1366
65
70
1367
66
**noload**
71
noload
1368
67
:	The list of plugins (or **plugin**.**Processor**s) to ignore and not load.
72
   The list of plugins (or **plugin**.\ **Processor**\ s) to ignore and
1369
68
73
   not load.
1370
69
**core**.**names**
74
1371
70
:	The names that the bot should respond to.
75
core.names
1372
71
76
   The names that the bot should respond to.
1373
72
**core**.**ignore**
77
1374
73
:	Nicks that the bot should completely ignore (e.g. other bots).
78
core.ignore
1375
74
79
   Nicks that the bot should completely ignore (e.g. other bots).
1376
75
# EXAMPLE
80
1377
76
81
EXAMPLE
1378
77
	botname = joebot
82
=======
1379
78
	logging = logging.ini
83
::
1380
79
84
1381
80
	[auth]
85
   botname = joebot
1382
81
	    methods = password,
86
   logging = logging.ini
1383
82
	    timeout = 300
87
1384
83
	    permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse
88
   [auth]
1385
84
89
       methods = password,
1386
85
	[sources]
90
       timeout = 300
1387
86
	    [[telnet]]
91
       permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse
1388
87
	    [[timer]]
92
1389
88
	    [[http]]
93
   [sources]
1390
89
	        url = http://joebot.example.com
94
       [[telnet]]
1391
90
	    [[smtp]]
95
       [[timer]]
1392
91
	    [[pb]]
96
       [[http]]
1393
92
	    [[atrum]]
97
           url = http://joebot.example.com
1394
93
	        channels = "#ibid",
98
       [[smtp]]
1395
94
	        nick = $botname
99
       [[pb]]
1396
95
	        type = irc
100
       [[atrum]]
1397
96
	        auth = hostmask, nickserv
101
           channels = "#ibid",
1398
97
	        server = irc.atrum.org
102
           nick = $botname
1399
98
103
           type = irc
1400
99
	[plugins]
104
           auth = hostmask, nickserv
1401
100
	    cachedir = /tmp/ibid
105
           server = irc.atrum.org
1402
101
	    [[core]]
106
1403
102
	        names = $botname, bot, ant
107
   [plugins]
1404
103
	        ignore = ,
108
       cachedir = /tmp/ibid
1405
104
109
       [[core]]
1406
105
	[databases]
110
           names = $botname, bot, ant
1407
106
	    ibid = sqlite:///ibid.db
111
           ignore = ,
1408
107
112
1409
108
# FILES
113
   [databases]
1410
109
114
       ibid = sqlite:///ibid.db
1411
110
*logging*.*ini*
115
1412
111
:	A standard Python **logging**.**config** configuration file describing
116
FILES
1413
112
	loggers, handlers, and formatters for log messages.
117
=====
1414
113
	See http://docs.python.org/library/logging.html
118
1415
114
119
logging.ini
1416
115
# SEE ALSO
120
   A standard Python **logging**.\ **config** configuration file describing
1417
116
`ibid` (1),
121
   loggers, handlers, and formatters for log messages.
1418
117
`ibid.ini` (5),
122
   See http://docs.python.org/library/logging.html
1419
118
`twistd` (1),
123
1420
124
SEE ALSO
1421
125
========
1422
126
1423
127
``ibid``\ (1),
1424
119
http://ibid.omnia.za.net/
128
http://ibid.omnia.za.net/
1425
129
1426
130
.. vi: set et sta sw=3 ts=3:
1427
120
131
1428
=== added file 'docs/manpages/index.rst'
1429
--- docs/manpages/index.rst	1970-01-01 00:00:00 +0000
1430
+++ docs/manpages/index.rst	2012-01-10 20:45:34 +0000
1431
@@ -0,0 +1,18 @@
1432
1
Command line utility Reference
1433
2
==============================
1434
3
1435
4
.. toctree::
1436
5
   :maxdepth: 2
1437
6
1438
7
   ibid-db.1
1439
8
   ibid-factpack.1
1440
9
   ibid-knab-import.1
1441
10
   ibid-memgraph.1
1442
11
   ibid-objgraph.1
1443
12
   ibid-pb-client.1
1444
13
   ibid-plugin.1
1445
14
   ibid-setup.1
1446
15
   ibid.1
1447
16
   ibid.ini.5
1448
17
1449
18
.. vi: set et sta sw=3 ts=3:
1450
0
19
1451
=== removed file 'man/Makefile'
1452
--- man/Makefile	2010-03-15 20:23:11 +0000
1453
+++ man/Makefile	1970-01-01 00:00:00 +0000
1454
@@ -1,13 +0,0 @@
1455
1
MANPAGES=$(patsubst %.md,%,$(wildcard *.md))
1456
2
1457
3
all: $(MANPAGES)
1458
4
1459
5
clean:
1460
6
	rm -f $(MANPAGES)
1461
7
1462
8
%: %.md
1463
9
# Incorrect escaping in code blocks:
1464
10
# http://code.google.com/p/pandoc/issues/detail?id=223
1465
11
	pandoc -s -t man $< | sed -e '/^[^.]/ s/\\"/"/g' > $@
1466
12
1467
13
.PHONY: all clean
1468
14
0
1469
=== removed file 'man/README'
1470
--- man/README	2010-03-15 20:23:11 +0000
1471
+++ man/README	1970-01-01 00:00:00 +0000
1472
@@ -1,4 +0,0 @@
1473
1
All files in this directory are:
1474
2
1475
3
Copyright (c) 2010, Stefano Rivera
1476
4
Released under terms of the MIT/X/Expat Licence. See COPYING for details.
Status:	Merged
Approved by:	Stefano Rivera on 2012-07-31
Approved revision:	1047
Merged at revision:	1051
Proposed branch:	lp:~stefanor/ibid/sphinxdoc-man
Merge into:	lp:ibid
Diff against target:	1476 lines (+673/-552) 16 files modified docs/Makefile (+80/-38) docs/conf.py (+29/-2) docs/index.rst (+1/-0) docs/manpages/ibid-db.1.rst (+67/-63) docs/manpages/ibid-factpack.1.rst (+68/-60) docs/manpages/ibid-knab-import.1.rst (+49/-45) docs/manpages/ibid-memgraph.1.rst (+41/-37) docs/manpages/ibid-objgraph.1.rst (+46/-42) docs/manpages/ibid-pb-client.1.rst (+37/-35) docs/manpages/ibid-plugin.1.rst (+71/-65) docs/manpages/ibid-setup.1.rst (+33/-29) docs/manpages/ibid.1.rst (+28/-25) docs/manpages/ibid.ini.5.rst (+105/-94) docs/manpages/index.rst (+18/-0) man/Makefile (+0/-13) man/README (+0/-4)
To merge this branch:	bzr merge lp:~stefanor/ibid/sphinxdoc-man
Related bugs:	Link a bug report
Reviewer	Date Requested	Status
Keegan Carruthers-Smith		Approve on 2012-07-31
Jonathan Hitchcock	2012-01-10	Approve on 2012-07-31
Review via email: mp+88115@code.launchpad.net