Merge lp:~stefanor/ibid/sphinxdoc-man into lp:ibid

Proposed by Stefano Rivera on 2012-01-10
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
Reviewer Review Type 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

Commit message

Move manpages into Sphinx docs

Description of the change

Sphinx 1.0 can build manpages. Rather nicely too.

To post a comment you must log in.
Jonathan Hitchcock (vhata) :
review: Approve
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
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 SPHINXOPTS =
6 SPHINXBUILD = sphinx-build
7 PAPER =
8+BUILDDIR = _build
9
10 # Internal variables.
11 PAPEROPT_a4 = -D latex_paper_size=a4
12 PAPEROPT_letter = -D latex_paper_size=letter
13-ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
15
16-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
17+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
18
19 help:
20 @echo "Please use \`make <target>' where <target> is one of"
21- @echo " html to make standalone HTML files"
22- @echo " dirhtml to make HTML files named index.html in directories"
23- @echo " pickle to make pickle files"
24- @echo " json to make JSON files"
25- @echo " htmlhelp to make HTML files and a HTML help project"
26- @echo " qthelp to make HTML files and a qthelp project"
27- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
28- @echo " changes to make an overview of all changed/added/deprecated items"
29- @echo " linkcheck to check all external links for integrity"
30- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
31+ @echo " html to make standalone HTML files"
32+ @echo " dirhtml to make HTML files named index.html in directories"
33+ @echo " singlehtml to make a single large HTML file"
34+ @echo " pickle to make pickle files"
35+ @echo " json to make JSON files"
36+ @echo " htmlhelp to make HTML files and a HTML help project"
37+ @echo " qthelp to make HTML files and a qthelp project"
38+ @echo " devhelp to make HTML files and a Devhelp project"
39+ @echo " epub to make an epub"
40+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
41+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
42+ @echo " text to make text files"
43+ @echo " man to make man pages"
44+ @echo " changes to make an overview of all changed/added/deprecated items"
45+ @echo " linkcheck to check all external links for integrity"
46+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
47
48 clean:
49- -rm -rf _build/*
50+ -rm -rf $(BUILDDIR)/*
51
52 html:
53- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
54+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
55 @echo
56- @echo "Build finished. The HTML pages are in _build/html."
57+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
59 dirhtml:
60- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
61- @echo
62- @echo "Build finished. The HTML pages are in _build/dirhtml."
63+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64+ @echo
65+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66+
67+singlehtml:
68+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69+ @echo
70+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
71
72 pickle:
73- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
74+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
75 @echo
76 @echo "Build finished; now you can process the pickle files."
77
78 json:
79- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
80+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
81 @echo
82 @echo "Build finished; now you can process the JSON files."
83
84 htmlhelp:
85- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
86+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
87 @echo
88 @echo "Build finished; now you can run HTML Help Workshop with the" \
89- ".hhp project file in _build/htmlhelp."
90+ ".hhp project file in $(BUILDDIR)/htmlhelp."
91
92 qthelp:
93- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
94+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
95 @echo
96 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
97- ".qhcp project file in _build/qthelp, like this:"
98- @echo "# qcollectiongenerator _build/qthelp/Ibid.qhcp"
99- @echo "To view the help file:"
100- @echo "# assistant -collectionFile _build/qthelp/Ibid.qhc"
101+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
102+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Ibid.qhcp"
103+ @echo "To view the help file:"
104+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Ibid.qhc"
105+
106+devhelp:
107+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
108+ @echo
109+ @echo "Build finished."
110+ @echo "To view the help file:"
111+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Ibid"
112+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ibid"
113+ @echo "# devhelp"
114+
115+epub:
116+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
117+ @echo
118+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
119
120 latex:
121- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
122- @echo
123- @echo "Build finished; the LaTeX files are in _build/latex."
124- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
125- "run these through (pdf)latex."
126+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127+ @echo
128+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
129+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
130+ "(use \`make latexpdf' here to do that automatically)."
131+
132+latexpdf:
133+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
134+ @echo "Running LaTeX files through pdflatex..."
135+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
136+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
137+
138+text:
139+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
140+ @echo
141+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
142+
143+man:
144+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
145+ @echo
146+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
147
148 changes:
149- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
150+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
151 @echo
152- @echo "The overview file is in _build/changes."
153+ @echo "The overview file is in $(BUILDDIR)/changes."
154
155 linkcheck:
156- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
157+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
158 @echo
159 @echo "Link check complete; look for any errors in the above output " \
160- "or in _build/linkcheck/output.txt."
161+ "or in $(BUILDDIR)/linkcheck/output.txt."
162
163 doctest:
164- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
165+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166 @echo "Testing of doctests in the sources finished, look at the " \
167- "results in _build/doctest/output.txt."
168+ "results in $(BUILDDIR)/doctest/output.txt."
169
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
175 # General information about the project.
176 project = u'Ibid'
177-copyright = u'2008-2011, The Ibid Developers'
178+AUTHORS = u'The Ibid Developers'
179+copyright = u'2008-2012, %s' % AUTHORS
180
181 # The version info for the project you're documenting, acts as replacement for
182 # |version| and |release|, also used in various other places throughout the
183@@ -180,7 +181,7 @@
184 # (source start file, target name, title, author, documentclass [howto/manual]).
185 latex_documents = [
186 ('index', 'Ibid.tex', u'Ibid Documentation',
187- u'The Ibid Developers', 'manual'),
188+ AUTHORS, 'manual'),
189 ]
190
191 # The name of an image file (relative to this directory) to place at the top of
192@@ -200,6 +201,32 @@
193 # If false, no module index is generated.
194 #latex_use_modindex = True
195
196+# -- Options for manpages ------------------------------------------------------
197+
198+man_pages = [
199+ ('manpages/ibid.1', 'ibid', u'Run an Ibid bot', AUTHORS, 1),
200+ ('manpages/ibid-db.1', 'ibid-db', u'Database management utility for Ibid',
201+ AUTHORS, 1),
202+ ('manpages/ibid-factpack.1', 'ibid-factpack',
203+ u'Factoid-package management utility for Ibid', AUTHORS, 1),
204+ ('manpages/ibid.ini.5', 'ibid.ini', u'Configuration file for Ibid',
205+ AUTHORS, 5),
206+ ('manpages/ibid-knab-import.1', 'ibid-knab-import',
207+ u'Knab->Ibid Import utility', AUTHORS, 1),
208+ ('manpages/ibid-memgraph.1', 'ibid-memgraph',
209+ u'Memory usage graph generation utility for Ibid', AUTHORS, 1),
210+ ('manpages/ibid-objgraph.1', 'ibid-objgraph',
211+ u'Memory usage graph generation utility for Ibid', AUTHORS, 1),
212+ ('manpages/ibid-pb-client.1', 'ibid-pb-client', 'RPC Client for Ibid',
213+ AUTHORS, 1),
214+ ('manpages/ibid-plugin.1', 'ibid-plugin',
215+ u'Plugin testing developer environment for Ibid', AUTHORS, 1),
216+ ('manpages/ibid-setup.1', 'ibid-setup',
217+ u'Create a basic configuration file and database for an Ibid bot',
218+ AUTHORS, 1),
219+]
220+
221+
222 # -- Options for extensions ----------------------------------------------------
223
224 # pre-1.0 mode intersphinx:
225
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 plugins
231 tutorial
232 contributing
233+ manpages/index
234 api/index
235 changes
236
237
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 @@
243-% IBID-DB(1) Ibid Multi-protocol Bot | Ibid 0.1
244-% Stefano Rivera
245-% March 2010
246-
247-# NAME
248-
249-ibid-db - Database management utility for Ibid
250-
251-# SYNOPSIS
252-
253-**ibid-db** *command* [*options*...]
254-
255-# DESCRIPTION
256-
257-This utility is for offline management of your Ibid bot's database. Used for
258-import, export, and upgrades.
259-
260-The export format is DBMS-agnostic and can be used to migrate between different
261-databases.
262-
263-# COMMANDS
264-
265-**-e** *FILE*, **-\-export**=*FILE*
266-: Export DB contents to *FILE*.
267- Export format is JSON.
268- *FILE* can be **-** for *stdout* or can end in **.gz** for automatic gzip
269- compression.
270-
271-**-i** *FILE*, **-\-import**=*FILE*
272-: Import DB contents from *FILE* as exported by this utility.
273- *FILE* can be **-** for *stdin* or can end in **.gz** for automatic gzip
274- compression.
275-
276-: **Note:** The DB must be empty first.
277-
278-**-u**, **-\-upgrade**
279-: Upgrade DB schema to the latest version.
280- You need to run this after upgrading your bot.
281-
282-: **Note:** You should backup first.
283-
284-# OPTIONS
285-
286-**-\-version**
287-: Show the program's version and exit.
288-
289-**-h**, **-\-help**
290-: Show a help message and exit.
291-
292-**-v**, **-\-verbose**
293-: Turn on debugging output to stderr.
294-
295-# FILES
296-
297-*ibid.ini*
298-: Locates the database to act upon by looking for the
299- [**databases**].**ibid** value in the bot configuration file in the current
300- directory.
301-
302-# SEE ALSO
303-`ibid` (1),
304-`ibid.ini` (5),
305-`ibid-setup` (1),
306+=========
307+ ibid-db
308+=========
309+
310+SYNOPSIS
311+========
312+
313+``ibid-db`` *command* [*options*...]
314+
315+DESCRIPTION
316+===========
317+
318+This utility is for offline management of your Ibid bot's database.
319+Used for import, export, and upgrades.
320+
321+The export format is DBMS-agnostic and can be used to migrate between
322+different databases.
323+
324+COMMANDS
325+========
326+
327+-e FILE, --export=FILE
328+ Export DB contents to *FILE*.
329+ Export format is JSON.
330+ *FILE* can be ``-`` for *stdout* or can end in ``.gz`` for automatic
331+ gzip compression.
332+
333+-i FILE, --import=FILE
334+ Import DB contents from *FILE* as exported by this utility.
335+ *FILE* can be ``-`` for *stdin* or can end in ``.gz`` for automatic
336+ gzip compression.
337+
338+ **Note:** The DB must be empty first.
339+
340+-u, --upgrade
341+ Upgrade DB schema to the latest version.
342+ You need to run this after upgrading your bot.
343+
344+ **Note:** You should backup first.
345+
346+OPTIONS
347+=======
348+
349+--version
350+ Show the program's version and exit.
351+
352+-h, --help
353+ Show a help message and exit.
354+
355+-v, --verbose
356+ Turn on debugging output to stderr.
357+
358+FILES
359+=====
360+
361+ibid.ini
362+ Locates the database to act upon by looking for the
363+ [**databases**].\ **ibid** value in the bot configuration file in the
364+ current directory.
365+
366+SEE ALSO
367+========
368+``ibid``\ (1),
369+``ibid.ini``\ (5),
370+``ibid-setup``\ (1),
371 http://ibid.omnia.za.net/
372+
373+.. vi: set et sta sw=3 ts=3:
374
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 @@
379-% IBID-FACTPACK(1) Ibid Multi-protocol Bot | Ibid 0.1
380-% Stefano Rivera
381-% March 2010
382-
383-# NAME
384-
385-ibid-factpack - Factoid-package management utility for Ibid
386-
387-# SYNOPSIS
388-
389-**ibid-factpack** [**-s**] *factpack-file*
390-**ibid-factpack** **-r** [**-f**] *factpack-name*
391-**ibid-factpack** **-h**
392-
393-# DESCRIPTION
394-
395-This utility is for adding and removing sets of packaged factoids, known as
396-factpacks, from your Ibid's factoid database.
397+===============
398+ ibid-factpack
399+===============
400+
401+SYNOPSIS
402+========
403+
404+| ``ibid-factpack`` [``-s``] *factpack-file*
405+| ``ibid-factpack`` ``-r`` [``-f``] *factpack-name*
406+| ``ibid-factpack`` ``-h``
407+
408+DESCRIPTION
409+===========
410+
411+This utility is for adding and removing sets of packaged factoids, known
412+as factpacks, from your Ibid's factoid database.
413
414 The default mode is factpack loading.
415 The *factpack-file* specified is loaded into the bot's database.
416-Should the pack contain any facts with the same name as an existing fact in the
417-bot's database, loading will be aborted, unless the *-s* option is supplied.
418-
419-Factpacks can be gzipped if the filename ends with **.gz**.
420-
421-When invoked with the **-r** option, the named factpack (original import
422+Should the pack contain any facts with the same name as an existing fact
423+in the bot's database, loading will be aborted, unless the ``-s`` option
424+is supplied.
425+
426+Factpacks can be gzipped if the filename ends with ``.gz``.
427+
428+When invoked with the ``-r`` option, the named factpack (original import
429 filename minus the extension) will be removed from the bot.
430-If any of the facts contained in that pack were modified while loaded in the
431-bot, unloading will be aborted, unless the **-f** option is supplied.
432-
433-# OPTIONS
434-
435-**-r**, **-\-remove**
436-: Remove the named factpack, rather than importing.
437-
438-**-f**, **-\-force**
439-: Force removal, if facts in the factpack were modified by users.
440-
441-**-s**, **-\-skip**
442-: Skip facts that clash with existing factoids, during import.
443-
444-**-h**, **-\-help**
445-: Show a help message and exit.
446-
447-# FACTPACKS
448+If any of the facts contained in that pack were modified while loaded in
449+the bot, unloading will be aborted, unless the ``-f`` option is
450+supplied.
451+
452+OPTIONS
453+=======
454+
455+-r, --remove
456+ Remove the named factpack, rather than importing.
457+
458+-f, --force
459+ Force removal, if facts in the factpack were modified by users.
460+
461+-s, --skip
462+ Skip facts that clash with existing factoids, during import.
463+
464+-h, --help
465+ Show a help message and exit.
466+
467+FACTPACKS
468+=========
469
470 Factpacks are JSON-encoded text files containing a list of facts.
471 Each fact is a tuple of two lists: fact-names, fact-values.
472 The same substitutions are available as in normal online Factoids.
473
474-## Example:
475-
476- [
477- [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
478- [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
479- ]
480-
481-# FILES
482-
483-*ibid.ini*
484-: Locates the database to act upon by looking for the
485- [**databases**].**ibid** value in the bot configuration file in the current
486- directory.
487-
488-# SEE ALSO
489-
490-`ibid` (1),
491-`ibid.ini` (5),
492+Example:
493+--------
494+::
495+
496+ [
497+ [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
498+ [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
499+ ]
500+
501+FILES
502+=====
503+
504+ibid.ini
505+ Locates the database to act upon by looking for the
506+ [**databases**].\ **ibid** value in the bot configuration file in the
507+ current directory.
508+
509+SEE ALSO
510+========
511+
512+``ibid``\ (1),
513+``ibid.ini``\ (5),
514 http://ibid.omnia.za.net/
515+
516+.. vi: set et sta sw=3 ts=3:
517
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 @@
522-% IBID-KNAB-IMPORT(1) Ibid Multi-protocol Bot | Ibid 0.1
523-% Stefano Rivera
524-% March 2010
525-
526-# NAME
527-
528-ibid-knab-import - Knab->Ibid Import utility
529-
530-# SYNOPSIS
531-
532-**ibid-knab-import** *knab-sa-url* *source* [*config-file*]
533-
534-# DESCRIPTION
535-
536-This utility imports users, last seen information, factoids, and URLs from a
537-Knab bot's database into an Ibid.
538+==================
539+ ibid-knab-import
540+==================
541+
542+SYNOPSIS
543+========
544+
545+``ibid-knab-import`` *knab-sa-url* *source* [*config-file*]
546+
547+DESCRIPTION
548+===========
549+
550+This utility imports users, last seen information, factoids, and URLs
551+from a Knab bot's database into an Ibid.
552
553 For best results, import directly into a brand new, clean Ibid install.
554
555-On import, strings are converted to Unicode, guessing UTF-8 and falling back to
556-detection.
557-
558-# OPTIONS
559-
560-*knab-sa-url*
561-: The SQLAlchemy URI for the Knab's database.
562- The format is **mysql://**_user_**:**_pass_**@**_hostname_**/**_dbname_
563-
564-*source*
565-: The name in the Ibid bot for the source that the Knab was previously
566- connected to.
567-
568-*config-file*
569-: If supplied, this is configuration file is used for locating the Ibid's
570- database rather than **ibid.ini**.
571-
572-# FILES
573-
574-*ibid.ini*
575-: Locates the database to act upon by looking for the
576- [**databases**].**ibid** value in the bot configuration file in the current
577- directory.
578-
579-# SEE ALSO
580-
581-`ibid` (1),
582-`ibid.ini` (5),
583-`ibid-setup` (1),
584+On import, strings are converted to Unicode, guessing UTF-8 and falling
585+back to detection.
586+
587+OPTIONS
588+=======
589+
590+knab-sa-url
591+ The SQLAlchemy URI for the Knab's database.
592+ The format is
593+ ``mysql://``\ *user*\ ``:``\ *pass*\ ``@``\ *hostname*\ ``/``\ *dbname*
594+
595+source
596+ The name in the Ibid bot for the source that the Knab was previously
597+ connected to.
598+
599+config-file
600+ If supplied, this is configuration file is used for locating the
601+ Ibid's database rather than ``ibid.ini``.
602+
603+FILES
604+=====
605+
606+ibid.ini
607+ Locates the database to act upon by looking for the
608+ [**databases**].\ **ibid** value in the bot configuration file in the
609+ current directory.
610+
611+SEE ALSO
612+========
613+
614+``ibid``\ (1),
615+``ibid.ini``\ (5),
616+``ibid-setup``\ (1),
617 http://ibid.omnia.za.net/,
618 http://knab.omnia.za.net/
619+
620+.. vi: set et sta sw=3 ts=3:
621
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 @@
626-% IBID-MEMGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
627-% Stefano Rivera
628-% March 2010
629-
630-# NAME
631-
632-ibid-memgraph - Memory usage graph generation utility for Ibid
633-
634-# SYNOPSIS
635-
636-**ibid-memgraph** [*options*...] *logfile*
637-**ibid-memgraph** **-h**
638-
639-# DESCRIPTION
640+===============
641+ ibid-memgraph
642+===============
643+
644+SYNOPSIS
645+========
646+
647+| ``ibid-memgraph`` [*options*...] *logfile*
648+| ``ibid-memgraph`` ``-h``
649+
650+DESCRIPTION
651+===========
652
653 This utility is for graphing memory usage from an Ibid bot configured to
654 log such usage.
655
656 Matplotlib is required for graphing.
657
658-# OPTIONS
659-
660-**-o** *FILE*, **-\-output**=*FILE*
661-: Output to *FILE* instead of displaying interactive graph GUI.
662- *FILE* can be any format supported by Matplotlib, detected by the file
663- extension.
664-
665-**-d** *DPI*, **-\-dpi**=*DPI*
666- When outputting in raster formats, use *DPI* output DPI.
667-
668-**-h**, **-\-help**
669- Show a help message and exit.
670-
671-# FILES
672-
673-*logfile*
674-: A log file generated by loading the **memory** plugin into Ibid, which will
675- periodically log memory usage.
676- It can be gzip compressed, if the filename ends in **.gz**.
677-
678-# SEE ALSO
679-`ibid` (1),
680-`ibid-objgraph` (1),
681+OPTIONS
682+=======
683+
684+-o FILE, --output=FILE
685+ Output to *FILE* instead of displaying interactive graph GUI.
686+ *FILE* can be any format supported by Matplotlib, detected by the
687+ file extension.
688+
689+-d DPI, --dpi=DPI
690+ When outputting in raster formats, use *DPI* output DPI.
691+
692+-h, --help
693+ Show a help message and exit.
694+
695+FILES
696+=====
697+
698+logfile
699+ A log file generated by loading the **memory** plugin into Ibid,
700+ which will periodically log memory usage.
701+ It can be gzip compressed, if the filename ends in ``.gz``.
702+
703+SEE ALSO
704+========
705+
706+``ibid``\ (1),
707+``ibid-objgraph``\ (1),
708 http://ibid.omnia.za.net/
709+
710+.. vi: set et sta sw=3 ts=3:
711
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 @@
716-% IBID-OBJGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
717-% Stefano Rivera
718-% March 2010
719-
720-# NAME
721-
722-ibid-objgraph - Memory usage graph generation utility for Ibid
723-
724-# SYNOPSIS
725-
726-**ibid-objgraph** [*options*...] *logfile* *type*...
727-**ibid-objgraph** [*options*...] **-e** *TIME* *logfile*
728-**ibid-objgraph** **-h**
729-
730-# DESCRIPTION
731+===============
732+ ibid-objgraph
733+===============
734+
735+SYNOPSIS
736+========
737+
738+| ``ibid-objgraph`` [*options*...] *logfile* *type*...
739+| ``ibid-objgraph`` [*options*...] ``-e`` *TIME* *logfile*
740+| ``ibid-objgraph`` ``-h``
741+
742+DESCRIPTION
743+===========
744
745 This utility is for graphing object-type usage from an Ibid bot
746 configured to log such usage.
747
748 Matplotlib is required for graphing.
749
750-# OPTIONS
751-
752-**-e** *TIME*, **-\-examine**=*TIME*
753-: Examine the object usage at time *TIME*, and print a sorted list of type
754- statistics at that time.
755- This function can be useful in determining which types to graph, when
756- chasing down a detected leak.
757-
758-**-o** *FILE*, **-\-output**=*FILE*
759-: Output to *FILE* instead of displaying interactive graph GUI.
760- *FILE* can be any format supported by Matplotlib, detected by the file
761- extension.
762-
763-**-d** *DPI*, **-\-dpi**=*DPI*
764-: When outputting in raster formats, use *DPI* output DPI.
765-
766-**-h**, **-\-help**
767- Show a help message and exit.
768-
769-# FILES
770+OPTIONS
771+=======
772+
773+-e TIME, --examine=TIME
774+ Examine the object usage at time *TIME*, and print a sorted list of
775+ type statistics at that time.
776+ This function can be useful in determining which types to graph, when
777+ chasing down a detected leak.
778+
779+-o FILE, --output=FILE
780+ Output to *FILE* instead of displaying interactive graph GUI.
781+ *FILE* can be any format supported by Matplotlib, detected by the
782+ file extension.
783+
784+-d DPI, --dpi=DPI
785+ When outputting in raster formats, use *DPI* output DPI.
786+
787+-h, --help
788+ Show a help message and exit.
789+
790+FILES
791+=====
792
793 *logfile*
794-: A log file generated by loading the **memory** plugin into Ibid, which will
795- periodically log object usage.
796- It can be gzip compressed, if the filename ends in **.gz**.
797-
798-# SEE ALSO
799-`ibid` (1),
800-`ibid-memgraph` (1),
801+ A log file generated by loading the **memory** plugin into Ibid,
802+ which will periodically log object usage.
803+ It can be gzip compressed, if the filename ends in ``.gz``.
804+
805+SEE ALSO
806+========
807+
808+``ibid``\ (1),
809+``ibid-memgraph``\ (1),
810 http://ibid.omnia.za.net/
811+
812+.. vi: set et sta sw=3 ts=3:
813
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 @@
818-% IBID-PB-CLIENT(1) Ibid Multi-protocol Bot | Ibid 0.1
819-% Stefano Rivera
820-% March 2010
821-
822-# NAME
823-
824-ibid-pb-client - RPC Client for Ibid
825-
826-# SYNOPSIS
827-
828-**ibid-pb-client** [*options*...] **message** *message*
829-**ibid-pb-client** [*options*...] **plugin** *feature* *method* [*parameter*...]
830-**ibid-pb-client** **-h**
831-
832-# DESCRIPTION
833+================
834+ ibid-pb-client
835+================
836+
837+SYNOPSIS
838+========
839+
840+| ``ibid-pb-client`` [*options*...] ``message`` *message*
841+| ``ibid-pb-client`` [*options*...] ``plugin`` *feature* *method* [*parameter*...]
842+| ``ibid-pb-client`` ``-h``
843+
844+DESCRIPTION
845+===========
846
847 This utility is for passing events to a running Ibid bot, or executing
848 RPC-exposed functions remotely.
849@@ -22,29 +20,33 @@
850 *message* is a text message as could be sent to the bot by an IM source.
851 The message is processed normally by the bot.
852
853-*feature* is the name of the feature to invoke exposed method **method** on,
854-directly.
855-*parameter*s are passed directly to the method.
856-They can be specified positionally or by key, using the same syntax as Python:
857-_key_**=**_value_.
858+*feature* is the name of the feature to invoke exposed method *method*
859+on, directly.
860+*parameter*\ s are passed directly to the method.
861+They can be specified positionally or by key, using the same syntax as
862+Python: *key*\ ``=``\ *value*.
863 They may be encoded in JSON, if not valid JSON they will be treated as
864 strings.
865
866 The output is a JSON-encoded response.
867
868-# OPTIONS
869-
870-**-s** *SERVER*, **-\-server**=*SERVER*
871-: Connect to the Ibid running on *SERVER*, by default it connects to
872- *localhost*.
873-
874-**-p** *PORT*, **-\-port**=*PORT*
875-: Connect to the **pb** source running on port *PORT*, by default 8789.
876-
877-**-h**, **-\-help**
878-: Show a help message and exit.
879-
880-# SEE ALSO
881-
882-`ibid` (1),
883+OPTIONS
884+=======
885+
886+-s SERVER, --server=SERVER
887+ Connect to the Ibid running on *SERVER*, by default it connects to
888+ *localhost*.
889+
890+-p PORT, --port=PORT
891+ Connect to the **pb** source running on port *PORT*, by default 8789.
892+
893+-h, --help
894+ Show a help message and exit.
895+
896+SEE ALSO
897+========
898+
899+``ibid``\ (1),
900 http://ibid.omnia.za.net/
901+
902+.. vi: set et sta sw=3 ts=3:
903
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 @@
908-% IBID-PLUGIN(1) Ibid Multi-protocol Bot | Ibid 0.1
909-% Stefano Rivera
910-% March 2010
911-
912-# NAME
913-
914-ibid-plugin \- Plugin testing developer environment for Ibid
915-
916-# SYNOPSIS
917-
918-**ibid-plugin** [*options*...] [*plugin*[**-**]|_plugin_**.**_Processor_[**-**]...]
919-
920-# DESCRIPTION
921-
922-This utility is for testing Ibid plugins without the full bot environment.
923-This means testing can be performed offline and without loading all the
924-available plugins.
925+=============
926+ ibid-plugin
927+=============
928+
929+SYNOPSIS
930+========
931+
932+``ibid-plugin`` [*options*...] [*plugin*\ [``-``]|\ *plugin*\ ``.``\ *Processor*\ [``-``]...]
933+
934+DESCRIPTION
935+===========
936+
937+This utility is for testing Ibid plugins without the full bot
938+environment. This means testing can be performed offline and without
939+loading all the available plugins.
940
941 This should be run in a configured Ibid bot directory.
942
943 All the listed plugins and Processors will be loaded on start-up.
944 Naming a plugin loads the complete plugin.
945-Suffixing a **-** to the name, ignores that plugin or Processor instead of
946-loading it.
947-
948-# OPTIONS
949-
950-**-c**, **-\-configured**
951-: Load all configured plugins, instead of only the core and requested
952- plugins.
953-
954-**-o**, **-\-only**
955-: Don't load the Ibid core plugins, only the plugins requested.
956- Note that without the **core** plugin to pre- and post-process events, most
957- other plugins won't function correctly.
958-
959-**-p**, **-\-public**
960-: By default, **ibid-plugin** emulates a private conversation with the bot.
961- With this option, the conversation is considered to be public and the
962- bot will have to be addressed to provoke a response.
963-
964-**-v**, **-\-verbose**
965-: Increase verbosity.
966- The final form of each *Event* object will be displayed before any
967- responses.
968-
969-**-h**, **-\-help**
970-Show a help message and exit.
971-
972-# FILES
973-
974-*ibid.ini*
975-: Locates the database to act upon by looking for the
976- [**databases**].**ibid** value in the bot configuration file in the current
977- directory.
978-
979-# BUGS
980-
981-**ibid-plugin** doesn't emulate a complete Ibid environment, and will ignore
982-all of the following:
983-
984-* Delayed and periodically executed functions.
985-* Messages to alternate sources.
986-* Messages directly dispatched, rather than added to responses.
987-* Permissions. All permissions are granted to the user.
988-
989-# SEE ALSO
990-`ibid` (1),
991-`ibid.ini` (5),
992-`ibid-setup` (1),
993+Suffixing a ``-`` to the name, ignores that plugin or Processor instead
994+of loading it.
995+
996+OPTIONS
997+=======
998+
999+-c, --configured
1000+ Load all configured plugins, instead of only the core and requested
1001+ plugins.
1002+
1003+-o, --only
1004+ Don't load the Ibid core plugins, only the plugins requested.
1005+ Note that without the **core** plugin to pre- and post-process
1006+ events, most other plugins won't function correctly.
1007+
1008+-p, --public
1009+ By default, **ibid-plugin** emulates a private conversation with the
1010+ bot.
1011+ With this option, the conversation is considered to be public and the
1012+ bot will have to be addressed to provoke a response.
1013+
1014+-v, --verbose
1015+ Increase verbosity.
1016+ The final form of each *Event* object will be displayed before any
1017+ responses.
1018+
1019+-h, --help
1020+ Show a help message and exit.
1021+
1022+FILES
1023+=====
1024+
1025+ibid.ini
1026+ Locates the database to act upon by looking for the
1027+ [**databases**].\ **ibid** value in the bot configuration file in the
1028+ current directory.
1029+
1030+BUGS
1031+====
1032+
1033+**ibid-plugin** doesn't emulate a complete Ibid environment, and will
1034+ignore all of the following:
1035+
1036+ * Delayed and periodically executed functions.
1037+ * Messages to alternate sources.
1038+ * Messages directly dispatched, rather than added to responses.
1039+ * Permissions. All permissions are granted to the user.
1040+
1041+SEE ALSO
1042+========
1043+
1044+``ibid``\ (1),
1045+``ibid.ini``\ (5),
1046+``ibid-setup``\ (1),
1047 http://ibid.omnia.za.net/
1048+
1049+.. vi: set et sta sw=3 ts=3:
1050
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 @@
1055-% IBID-SETUP(1) Ibid Multi-protocol Bot | Ibid 0.1
1056-% Stefano Rivera
1057-% March 2010
1058-
1059-# NAME
1060-
1061-ibid-setup - Create a basic configuration file and database for an Ibid bot
1062-
1063-# SYNOPSIS
1064+============
1065+ ibid-setup
1066+============
1067+
1068+SYNOPSIS
1069+========
1070
1071 **ibid-setup**
1072
1073-# DESCRIPTION
1074+DESCRIPTION
1075+===========
1076
1077 This program sets up everything that a new Ibid bot needs before it can run.
1078 It asks a series of questions about the new bot, and writes out a basic
1079-configuration file - `ibid.ini` (5) - to the current directory.
1080-It also creates a database for the bot, by default a SQLite database in the
1081-current directory.
1082-
1083-This should be run in the directory which will become the new Ibid bot's base.
1084-
1085-Should there be an existing **ibid.ini** in the current directory, it will be
1086-used, and the only questions asked will be for adding an administrative user.
1087-These can safely be skipped with a **^C**.
1088-
1089-# FILES
1090-
1091-*ibid.ini*
1092-: The Ibid bot's configuration file, will be created if it doesn't exist.
1093-
1094-# SEE ALSO
1095-
1096-`ibid` (1),
1097-`ibid.ini` (5),
1098+configuration file - ``ibid.ini``\ (5) - to the current directory.
1099+It also creates a database for the bot, by default a SQLite database in
1100+the current directory.
1101+
1102+This should be run in the directory which will become the new Ibid bot's
1103+base.
1104+
1105+Should there be an existing ``ibid.ini`` in the current directory, it
1106+will be used, and the only questions asked will be for adding an
1107+administrative user.
1108+These can safely be skipped with a ``^C``.
1109+
1110+FILES
1111+=====
1112+
1113+ibid.ini
1114+ The Ibid bot's configuration file, will be created if it doesn't exist.
1115+
1116+SEE ALSO
1117+========
1118+
1119+``ibid``\ (1),
1120+``ibid.ini``\ (5),
1121 http://ibid.omnia.za.net/
1122+
1123+.. vi: set et sta sw=3 ts=3:
1124
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 @@
1129-% IBID(1) Ibid Multi-protocol Bot | Ibid 0.1
1130-% Stefano Rivera
1131-% March 2010
1132-
1133-# NAME
1134-
1135-ibid - Run an Ibid bot
1136-
1137-# SYNOPSIS
1138-
1139-**ibid** [*config-file*]
1140-
1141-# DESCRIPTION
1142+======
1143+ ibid
1144+======
1145+
1146+SYNOPSIS
1147+========
1148+
1149+``ibid`` [*config-file*]
1150+
1151+DESCRIPTION
1152+===========
1153
1154 This runs an Ibid bot in the foreground.
1155
1156-There should there be an existing **ibid.ini** (created by
1157-`ibid-setup` (1))
1158+There should there be an existing ``ibid.ini`` (created by
1159+``ibid-setup``\ (1))
1160 in the current directory or one should be provided on the command line.
1161
1162-Where possible, you should run **twistd -n ibid** instead of this
1163+Where possible, you should run ``twistd -n ibid`` instead of this
1164 program, as otherwise some classes of errors go unreported.
1165 See **BUGS**.
1166
1167-# BUGS
1168+BUGS
1169+====
1170
1171 Exceptions in twisted callbacks can go unnoticed in this program.
1172 That has no harmful effects, but the developers may miss out on some
1173 good bug reports.
1174
1175-# FILES
1176+FILES
1177+=====
1178
1179 *ibid.ini*
1180-: The Ibid bot's configuration file, will be created if it doesn't exist.
1181-
1182-# SEE ALSO
1183-
1184-`ibid.ini` (5),
1185-`ibid-setup` (1),
1186-`twistd` (1),
1187+ The Ibid bot's configuration file, will be created if it doesn't exist.
1188+
1189+SEE ALSO
1190+========
1191+
1192+``ibid.ini``\ (5),
1193+``ibid-setup``\ (1),
1194+``twistd``\ (1),
1195 http://ibid.omnia.za.net/
1196+
1197+.. vi: set et sta sw=3 ts=3:
1198
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 @@
1203-% IBID.INI(5) Ibid Multi-protocol Bot | Ibid 0.1
1204-% Stefano Rivera
1205-% March 2010
1206-
1207-# NAME
1208-
1209-ibid.ini - Configuration file for Ibid
1210-
1211-# DESCRIPTION
1212-
1213-ibid.ini contains all the configuration for an Ibid bot.
1214-
1215-A complete description of the contents of this file is out of the scope of this
1216-manpage.
1217-For more details see the Ibid documentation: http://ibid.omnia.za.net/docs/
1218-
1219-Lines beginning with **#** are considered to be comments and ignored.
1220-To use a **#** symbol in an option (e.g. an IRC channel name), quote the
1221-option with double-quotes, e.g. **channels**=**"#ibid",**
1222+==========
1223+ ibid.ini
1224+==========
1225+
1226+NAME
1227+====
1228+
1229+DESCRIPTION
1230+===========
1231+
1232+``ibid.ini`` contains all the configuration for an Ibid bot.
1233+
1234+A complete description of the contents of this file is out of the scope
1235+of this manpage.
1236+For more details see the Ibid HTML documentation:
1237+http://ibid.omnia.za.net/docs/
1238+
1239+Lines beginning with ``#`` are considered to be comments and ignored.
1240+To use a ``#`` symbol in an option (e.g. an IRC channel name), quote the
1241+option with double-quotes, e.g. ``channels = "#ibid",``
1242
1243 This file will be written to by the bot when configuration settings are
1244 altered online.
1245 It can also be edited manually and a running bot told to
1246-**"reload config"**.
1247+``reload config``.
1248 Manual edits and comments will be preserved when the bot modifies its
1249 own configuration, provided that they have not been edited since bot
1250 start-up or the last config reload.
1251
1252-# SECTIONS
1253+SECTIONS
1254+========
1255
1256-## auth
1257+auth
1258+----
1259
1260 Settings related to permissions and authentication.
1261-Permissions listed in **auth**.**permissions** are granted to all users unless
1262-revoked by source or account.
1263+Permissions listed in **auth**.\ **permissions** are granted to all
1264+users unless revoked by source or account.
1265
1266-## sources
1267+sources
1268+-------
1269
1270 Sources are Ibid connections to an IM service.
1271 They range from IRC networks to the bot's built-in HTTP server.
1272
1273 Each source is configured in a section named after the source.
1274-The source name will define the driver that the source should use, unless a
1275-**type** option is provided.
1276+The source name will define the driver that the source should use,
1277+unless a ``type`` option is provided.
1278
1279 Sources can be disabled by setting
1280-**disabled**=**True**.
1281+``disabled = True``.
1282
1283-## plugins
1284+plugins
1285+-------
1286
1287 Plugin configuration.
1288 Each plugin is configured within a section named after the plugin.
1289
1290-**cachedir**
1291-: The directory that temporary files (such as downloaded data), useful to be
1292- the bot but expendable, is stored in.
1293-
1294-**autoload**
1295-: If **True**, all plugins not explicitly ignored will be loaded.
1296- (Note that some plugins mark themselves as non-auto-loadable).
1297- Defaults to **True**.
1298-
1299-**load**
1300-: The list of plugins (or **plugin**.**Processor**s) to load.
1301-
1302-**noload**
1303-: The list of plugins (or **plugin**.**Processor**s) to ignore and not load.
1304-
1305-**core**.**names**
1306-: The names that the bot should respond to.
1307-
1308-**core**.**ignore**
1309-: Nicks that the bot should completely ignore (e.g. other bots).
1310-
1311-# EXAMPLE
1312-
1313- botname = joebot
1314- logging = logging.ini
1315-
1316- [auth]
1317- methods = password,
1318- timeout = 300
1319- permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse
1320-
1321- [sources]
1322- [[telnet]]
1323- [[timer]]
1324- [[http]]
1325- url = http://joebot.example.com
1326- [[smtp]]
1327- [[pb]]
1328- [[atrum]]
1329- channels = "#ibid",
1330- nick = $botname
1331- type = irc
1332- auth = hostmask, nickserv
1333- server = irc.atrum.org
1334-
1335- [plugins]
1336- cachedir = /tmp/ibid
1337- [[core]]
1338- names = $botname, bot, ant
1339- ignore = ,
1340-
1341- [databases]
1342- ibid = sqlite:///ibid.db
1343-
1344-# FILES
1345-
1346-*logging*.*ini*
1347-: A standard Python **logging**.**config** configuration file describing
1348- loggers, handlers, and formatters for log messages.
1349- See http://docs.python.org/library/logging.html
1350-
1351-# SEE ALSO
1352-`ibid` (1),
1353-`ibid.ini` (5),
1354-`twistd` (1),
1355+cachedir
1356+ The directory that temporary files (such as downloaded data), useful
1357+ to be the bot but expendable, is stored in.
1358+
1359+autoload
1360+ If ``True``, all plugins not explicitly ignored will be loaded.
1361+ (Note that some plugins mark themselves as non-auto-loadable).
1362+ Defaults to ``True``.
1363+
1364+load
1365+ The list of plugins (or **plugin**.\ **Processor**\ s) to load.
1366+
1367+noload
1368+ The list of plugins (or **plugin**.\ **Processor**\ s) to ignore and
1369+ not load.
1370+
1371+core.names
1372+ The names that the bot should respond to.
1373+
1374+core.ignore
1375+ Nicks that the bot should completely ignore (e.g. other bots).
1376+
1377+EXAMPLE
1378+=======
1379+::
1380+
1381+ botname = joebot
1382+ logging = logging.ini
1383+
1384+ [auth]
1385+ methods = password,
1386+ timeout = 300
1387+ permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse
1388+
1389+ [sources]
1390+ [[telnet]]
1391+ [[timer]]
1392+ [[http]]
1393+ url = http://joebot.example.com
1394+ [[smtp]]
1395+ [[pb]]
1396+ [[atrum]]
1397+ channels = "#ibid",
1398+ nick = $botname
1399+ type = irc
1400+ auth = hostmask, nickserv
1401+ server = irc.atrum.org
1402+
1403+ [plugins]
1404+ cachedir = /tmp/ibid
1405+ [[core]]
1406+ names = $botname, bot, ant
1407+ ignore = ,
1408+
1409+ [databases]
1410+ ibid = sqlite:///ibid.db
1411+
1412+FILES
1413+=====
1414+
1415+logging.ini
1416+ A standard Python **logging**.\ **config** configuration file describing
1417+ loggers, handlers, and formatters for log messages.
1418+ See http://docs.python.org/library/logging.html
1419+
1420+SEE ALSO
1421+========
1422+
1423+``ibid``\ (1),
1424 http://ibid.omnia.za.net/
1425+
1426+.. vi: set et sta sw=3 ts=3:
1427
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+Command line utility Reference
1433+==============================
1434+
1435+.. toctree::
1436+ :maxdepth: 2
1437+
1438+ ibid-db.1
1439+ ibid-factpack.1
1440+ ibid-knab-import.1
1441+ ibid-memgraph.1
1442+ ibid-objgraph.1
1443+ ibid-pb-client.1
1444+ ibid-plugin.1
1445+ ibid-setup.1
1446+ ibid.1
1447+ ibid.ini.5
1448+
1449+.. vi: set et sta sw=3 ts=3:
1450
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-MANPAGES=$(patsubst %.md,%,$(wildcard *.md))
1456-
1457-all: $(MANPAGES)
1458-
1459-clean:
1460- rm -f $(MANPAGES)
1461-
1462-%: %.md
1463-# Incorrect escaping in code blocks:
1464-# http://code.google.com/p/pandoc/issues/detail?id=223
1465- pandoc -s -t man $< | sed -e '/^[^.]/ s/\\"/"/g' > $@
1466-
1467-.PHONY: all clean
1468
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-All files in this directory are:
1474-
1475-Copyright (c) 2010, Stefano Rivera
1476-Released under terms of the MIT/X/Expat Licence. See COPYING for details.

Subscribers

People subscribed via source and target branches

to all changes: