Merge lp:~stefanor/ibid/pandoc-man-511899 into lp:~ibid-core/ibid/old-trunk-1.6

[Stefano Rivera]

Convert manpages to Markdown and generate with pandoc

[lp:~stefanor/ibid/pandoc-man-511899]

913. By Stefano Rivera on 2010-03-20

Correct spelling

914. By Stefano Rivera on 2010-03-20

Escape -- to prevent rendering as dash

[Max Rabkin (max-rabkin)]

Approved once the double-hyphen issue is fixed.

review: Approve

[Jonathan Hitchcock (vhata)]

review: Approve

[Keegan Carruthers-Smith (keegan-csmith)]

I thought pandoc supported restructured text? Is it not more consistent to stick with rst?

[Stefano Rivera (stefanor)]

> I thought pandoc supported restructured text? Is it not more consistent to
> stick with rst?

Yes, that was my original intention. However it doesn't seem to support building the man-page header fields when converting from rst to nroff.
I switched and also noted that markdown would be conciser than the equivalent rst, which was enough to convince me to stick with it.

[Michael Gorven (mgorven)]

 review approve

review: Approve

=== added file 'man/Makefile'
--- man/Makefile	1970-01-01 00:00:00 +0000
+++ man/Makefile	2010-03-20 10:39:26 +0000
@@ -0,0 +1,13 @@
+MANPAGES=$(patsubst %.md,%,$(wildcard *.md))
+
+all: $(MANPAGES)
+
+clean:
+	rm -f $(MANPAGES)
+
+%: %.md
+# Incorrect escaping in code blocks:
+# http://code.google.com/p/pandoc/issues/detail?id=223
+	pandoc -s -t man $< | sed -e '/^[^.]/ s/\\"/"/g' > $@
+
+.PHONY: all clean

=== added file 'man/README'
--- man/README	1970-01-01 00:00:00 +0000
+++ man/README	2010-03-20 10:39:26 +0000
@@ -0,0 +1,4 @@
+All files in this directory are:
+
+Copyright (c) 2010, Stefano Rivera
+Released under terms of the MIT/X/Expat Licence. See COPYING for details.

=== renamed file 'man/ibid-db.1' => 'man/ibid-db.1.md'
--- man/ibid-db.1	2010-03-08 20:27:21 +0000
+++ man/ibid-db.1.md	2010-03-20 10:39:26 +0000
@@ -1,59 +1,64 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-DB "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-db \- Database management utility for Ibid
-.SH SYNOPSIS
-.B ibid-db command
-.RI [ options ...]
-.SH DESCRIPTION
-This utility is for offline management of your Ibid bot's database.
-Used for import, export, and upgrades.
-.P
+% IBID-DB(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-db - Database management utility for Ibid
+
+# SYNOPSIS
+
+**ibid-db** *command* [*options*...]
+
+# DESCRIPTION
+
+This utility is for offline management of your Ibid bot's database.  Used for
+import, export, and upgrades.
+
 The export format is DBMS-agnostic and can be used to migrate between different
 databases.
-.SH COMMANDS
-.TP
-\fB\-e\fR \fIFILE\fR, \fB\-\-export\fR=\fIFILE\fR
-Export DB contents to \fIFILE\fR.
-Export format is JSON.
-.IP
-FILE can be \fB\-\fR for stdin/stdout or can end in \fB.gz\fR for automatic
-gzip compression.
-.TP
-\fB\-i\fR \fIFILE\fR, \fB\-\-import\fR=\fIFILE\fR
-Import DB contents from \fIFILE\fR as exported by this utility.
-.IP
-FILE can be \fB\-\fR for stdin/stdout or can end in \fB.gz\fR for automatic
-gzip compression.
-.IP
-.B Note:
-The DB must be empty first.
-.TP
-\fB\-u\fR, \fB\-\-upgrade\fR
-Upgrade DB schema to the latest version.
-You need to run this after upgrading your bot.
-.IP
-.B Note:
-You should backup first.
-.SH OPTIONS
-.TP
-\fB\-\-version\fR
-Show the program's version and exit.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Show a help message and exit.
-.TP
-\fB\-v\fR, \fB\-\-verbose\fR
-Turn on debugging output to stderr.
-.SH FILES
-.TP
-.I ibid.ini
-Locates the database to act upon by looking for the \fB[databases].ibid\fR value
-in the bot configuration file in the current directory.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid.ini (5),
-.BR ibid-setup (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+# COMMANDS
+
+**-e** *FILE*, **-\-export**=*FILE*
+:	Export DB contents to *FILE*.
+	Export format is JSON.
+	*FILE* can be **-** for *stdout* or can end in **.gz** for automatic gzip
+	compression.
+
+**-i** *FILE*, **-\-import**=*FILE*
+:	Import DB contents from *FILE* as exported by this utility.
+	*FILE* can be **-** for *stdin* or can end in **.gz** for automatic gzip
+	compression.
+
+:	**Note:** The DB must be empty first.
+
+**-u**, **-\-upgrade**
+:	Upgrade DB schema to the latest version.
+	You need to run this after upgrading your bot.
+
+:	**Note:** You should backup first.
+
+# OPTIONS
+
+**-\-version**
+:	Show the program's version and exit.
+
+**-h**, **-\-help**
+:	Show a help message and exit.
+
+**-v**, **-\-verbose**
+:	Turn on debugging output to stderr.
+
+# FILES
+
+*ibid.ini*
+:	Locates the database to act upon by looking for the
+	[**databases**].**ibid** value in the bot configuration file in the current
+	directory.
+
+# SEE ALSO
+`ibid` (1),
+`ibid.ini` (5),
+`ibid-setup` (1),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid-factpack.1' => 'man/ibid-factpack.1.md'
--- man/ibid-factpack.1	2010-03-08 20:27:21 +0000
+++ man/ibid-factpack.1.md	2010-03-20 10:39:26 +0000
@@ -1,65 +1,70 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-FACTPACK "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-factpack \- Factoid-package management utility for Ibid
-.SH SYNOPSIS
-.B ibid-factpack
-.RB [ -s ]
-.I factpack-file
-.br
-.B ibid-factpack -r
-.RB [ -f ]
-.I factpack-name
-.br
-.B ibid-factpack -h
-.SH DESCRIPTION
+% IBID-FACTPACK(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-factpack - Factoid-package management utility for Ibid
+
+# SYNOPSIS
+
+**ibid-factpack** [**-s**] *factpack-file*  
+**ibid-factpack** **-r** [**-f**] *factpack-name*  
+**ibid-factpack** **-h**
+
+# DESCRIPTION
+
 This utility is for adding and removing sets of packaged factoids, known as
 factpacks, from your Ibid's factoid database.
-.P
+
 The default mode is factpack loading.
-The \fIfactpack-file\fR specified is loaded into the bot's database.
+The *factpack-file* specified is loaded into the bot's database.
 Should the pack contain any facts with the same name as an existing fact in the
-bot's database, loading will be aborted, unless the \fB-s\fR option is
-supplied.
-.P
-Factpacks can be gzipped if the filename ends with \fB\.gz\fR.
-.P
-When invoked with the \fB-r\fR option, the named factpack (original import
+bot's database, loading will be aborted, unless the *-s* option is supplied.
+
+Factpacks can be gzipped if the filename ends with **.gz**.
+
+When invoked with the **-r** option, the named factpack (original import
 filename minus the extension) will be removed from the bot.
 If any of the facts contained in that pack were modified while loaded in the
-bot, unloading will be aborted, unless the \fB-f\fR option is supplied.
-.SH OPTIONS
-.TP
-\fB\-r\fR, \fB\-\-remove\fR
-Remove the named factpack, rather than importing.
-.TP
-\fB\-f\fR, \fB\-\-force\fR
-Force removal, if facts in the factpack were modified by users.
-.TP
-\fB\-s\fR, \fB\-\-skip\fR
-Skip facts that clash with existing factoids, during import.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Show a help message and exit.
-.SH FACTPACKS
+bot, unloading will be aborted, unless the **-f** option is supplied.
+
+# OPTIONS
+
+**-r**, **-\-remove**
+:	Remove the named factpack, rather than importing.
+
+**-f**, **-\-force**
+:	Force removal, if facts in the factpack were modified by users.
+
+**-s**, **-\-skip**
+:	Skip facts that clash with existing factoids, during import.
+
+**-h**, **-\-help**
+:	Show a help message and exit.
+
+# FACTPACKS
+
 Factpacks are JSON-encoded text files containing a list of facts.
 Each fact is a tuple of two lists: fact-names, fact-values.
 The same substitutions are available as in normal online Factoids.
-.SS Example:
-.nf
-[
- [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
- [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
-]
-.fi
-.SH FILES
-.TP
-.I ibid.ini
-Locates the database to act upon by looking for the \fB[databases].ibid\fR value
-in the bot configuration file in the current directory.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid.ini (5),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+## Example:
+
+	[
+	 [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
+	 [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
+	]
+
+# FILES
+
+*ibid.ini*
+:	Locates the database to act upon by looking for the
+	[**databases**].**ibid** value in the bot configuration file in the current
+	directory.
+
+# SEE ALSO
+
+`ibid` (1),
+`ibid.ini` (5),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid-knab-import.1' => 'man/ibid-knab-import.1.md'
--- man/ibid-knab-import.1	2010-03-08 20:27:21 +0000
+++ man/ibid-knab-import.1.md	2010-03-20 10:39:26 +0000
@@ -1,44 +1,50 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-DB "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-knab-import \- Knab->Ibid Import utility
-.SH SYNOPSIS
-.B ibid-knab-import
-.I knab-sa-url
-.I source
-.RI [ config-file ]
-.SH DESCRIPTION
-This utility imports users, last seen information, factoids, and URLs
-from a Knab bot's database into an Ibid.
-.P
+% IBID-KNAB-IMPORT(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-knab-import - Knab->Ibid Import utility
+
+# SYNOPSIS
+
+**ibid-knab-import** *knab-sa-url* *source* [*config-file*]
+
+# DESCRIPTION
+
+This utility imports users, last seen information, factoids, and URLs from a
+Knab bot's database into an Ibid.
+
 For best results, import directly into a brand new, clean Ibid install.
-.P
+
 On import, strings are converted to Unicode, guessing UTF-8 and falling back to
 detection.
-.SH OPTIONS
-.TP
-.I knab-sa-url
-The SQLAlchemy URI for the Knab's database.
-The format is
-.BI mysql:// user : pass @ hostname / dbname
-.TP
-.I source
-The name in the Ibid bot for the source that the Knab was previously connected to.
-.TP
-.I config-file
-If supplied, this is configuration file is used for locating the Ibid's
-database rather than \fBibid.ini\fR.
-.SH FILES
-.TP
-.I ibid.ini
-Locates the database to act upon by looking for the \fB[databases].ibid\fR value
-in the bot configuration file in the current directory.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid.ini (5),
-.BR ibid-setup (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/ ,
-.UR http://knab.omnia.za.net/
-.BR http://knab.omnia.za.net/
+
+# OPTIONS
+
+*knab-sa-url*
+:	The SQLAlchemy URI for the Knab's database.
+	The format is **mysql://**_user_**:**_pass_**@**_hostname_**/**_dbname_
+
+*source*
+:	The name in the Ibid bot for the source that the Knab was previously
+	connected to.
+
+*config-file*
+:	If supplied, this is configuration file is used for locating the Ibid's
+	database rather than **ibid.ini**.
+
+# FILES
+
+*ibid.ini*
+:	Locates the database to act upon by looking for the
+	[**databases**].**ibid** value in the bot configuration file in the current
+	directory.
+
+# SEE ALSO
+
+`ibid` (1),
+`ibid.ini` (5),
+`ibid-setup` (1),
+http://ibid.omnia.za.net/,
+http://knab.omnia.za.net/

=== renamed file 'man/ibid-memgraph.1' => 'man/ibid-memgraph.1.md'
--- man/ibid-memgraph.1	2010-03-08 20:27:21 +0000
+++ man/ibid-memgraph.1.md	2010-03-20 10:39:26 +0000
@@ -1,39 +1,44 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-MEMGRAPH "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-memgraph \- Memory usage graph generation utility for Ibid
-.SH SYNOPSIS
-.B ibid-memgraph
-.RB [ options ...]
-.I logfile
-.br
-.B ibid-memgraph -h
-.SH DESCRIPTION
+% IBID-MEMGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-memgraph - Memory usage graph generation utility for Ibid
+
+# SYNOPSIS
+
+**ibid-memgraph** [*options*...] *logfile*  
+**ibid-memgraph** **-h**
+
+# DESCRIPTION
+
 This utility is for graphing memory usage from an Ibid bot configured to
 log such usage.
-.P
+
 Matplotlib is required for graphing.
-.SH OPTIONS
-.TP
-\fB\-o\fR \fIFILE\fR, \fB\-\-output\fR=\fIFILE\fR
-Output to \fIFILE\fR instead of displaying interactive graph GUI.
-\fIFILE\fR can be any format supported by Matplotlib, detected by the file
-extension.
-.TP
-\fB\-d\fR \fIDPI\fR, \fB\-\-dpi\fR=\fIDPI\fR
-When outputting in raster formats, use \fIDPI\fR output DPI.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Show a help message and exit.
-.SH FILES
-.TP
-.I logfile
-A log file generated by loading the \fBmemory\fR plugin into Ibid, which will
-periodically log memory usage.
-It can be gzip compressed, if the filename ends in \fB.gz\fR.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid-objgraph (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+# OPTIONS
+
+**-o** *FILE*, **-\-output**=*FILE*
+:	Output to *FILE* instead of displaying interactive graph GUI.
+	*FILE* can be any format supported by Matplotlib, detected by the file
+	extension.
+
+**-d** *DPI*, **-\-dpi**=*DPI*
+	When outputting in raster formats, use *DPI* output DPI.
+
+**-h**, **-\-help**
+	Show a help message and exit.
+
+# FILES
+
+*logfile*
+:	A log file generated by loading the **memory** plugin into Ibid, which will
+	periodically log memory usage.
+	It can be gzip compressed, if the filename ends in **.gz**.
+
+# SEE ALSO
+`ibid` (1),
+`ibid-objgraph` (1),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid-objgraph.1' => 'man/ibid-objgraph.1.md'
--- man/ibid-objgraph.1	2010-03-08 20:27:21 +0000
+++ man/ibid-objgraph.1.md	2010-03-20 10:39:26 +0000
@@ -1,50 +1,51 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-OBJGRAPH "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-objgraph \- Memory usage graph generation utility for Ibid
-.SH SYNOPSIS
-.B ibid-objgraph
-.RB [ options ...]
-.IR "logfile type" ...
-.br
-.B ibid-objgraph
-.BI "-e " TIME
-.RB [ options ...]
-.I logfile
-.br
-.B ibid-objgraph -h
-.SH DESCRIPTION
+% IBID-OBJGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-objgraph - Memory usage graph generation utility for Ibid
+
+# SYNOPSIS
+
+**ibid-objgraph** [*options*...] *logfile* *type*...  
+**ibid-objgraph** [*options*...] **-e** *TIME* *logfile*  
+**ibid-objgraph** **-h**
+
+# DESCRIPTION
+
 This utility is for graphing object-type usage from an Ibid bot
 configured to log such usage.
-.P
+
 Matplotlib is required for graphing.
-.SH OPTIONS
-.TP
-\fB\-e\fR \fITIME\fR, \fB\-\-examine\fR=\fITIME\fR
-Examine the object usage at time \fITIME\fR, and print a sorted list of type
-statistics at that time.
-This function can be useful in determining which types to graph, when chasing
-down a detected leak.
-.TP
-\fB\-o\fR \fIFILE\fR, \fB\-\-output\fR=\fIFILE\fR
-Output to \fIFILE\fR instead of displaying interactive graph GUI.
-\fIFILE\fR can be any format supported by Matplotlib, detected by the file
-extension.
-.TP
-\fB\-d\fR \fIDPI\fR, \fB\-\-dpi\fR=\fIDPI\fR
-When outputting in raster formats, use \fIDPI\fR output DPI.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Show a help message and exit.
-.SH FILES
-.TP
-.I logfile
-A log file generated by loading the \fBmemory\fR plugin into Ibid, which will
-periodically log object usage.
-It can be gzip compressed, if the filename ends in \fB.gz\fR.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid-memgraph (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+# OPTIONS
+
+**-e** *TIME*, **-\-examine**=*TIME*
+:	Examine the object usage at time *TIME*, and print a sorted list of type
+	statistics at that time.
+	This function can be useful in determining which types to graph, when
+	chasing down a detected leak.
+
+**-o** *FILE*, **-\-output**=*FILE*
+:	Output to *FILE* instead of displaying interactive graph GUI.
+	*FILE* can be any format supported by Matplotlib, detected by the file
+	extension.
+
+**-d** *DPI*, **-\-dpi**=*DPI*
+:	When outputting in raster formats, use *DPI* output DPI.
+
+**-h**, **-\-help**
+	Show a help message and exit.
+
+# FILES
+
+*logfile*
+:	A log file generated by loading the **memory** plugin into Ibid, which will
+	periodically log object usage.
+	It can be gzip compressed, if the filename ends in **.gz**.
+
+# SEE ALSO
+`ibid` (1),
+`ibid-memgraph` (1),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid-pb-client.1' => 'man/ibid-pb-client.1.md'
--- man/ibid-pb-client.1	2010-03-08 20:27:21 +0000
+++ man/ibid-pb-client.1.md	2010-03-20 10:39:26 +0000
@@ -1,54 +1,50 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-PB-CLIENT "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-pb-client \- RPC Client for Ibid
-.SH SYNOPSIS
-.B ibid-pb-client
-.RI [ options ...]
-.BI message " message"
-.br
-.B ibid-pb-client
-.RI [ options ...]
-.BI plugin " feature method"
-.RI [ parameter ...]
-.br
-.B ibid-pb-client -h
-.SH DESCRIPTION
+% IBID-PB-CLIENT(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-pb-client - RPC Client for Ibid
+
+# SYNOPSIS
+
+**ibid-pb-client** [*options*...] **message** *message*  
+**ibid-pb-client** [*options*...] **plugin** *feature* *method* [*parameter*...]  
+**ibid-pb-client** **-h**
+
+# DESCRIPTION
+
 This utility is for passing events to a running Ibid bot, or executing
 RPC-exposed functions remotely.
-.P
-It communicates with the \fBpb\fR source on the Ibid.
-.P
-.I message
-is a text message as could be sent to the bot by an IM source.
+
+It communicates with the **pb** source on the Ibid.
+
+*message* is a text message as could be sent to the bot by an IM source.
 The message is processed normally by the bot.
-.P
-.I feature
-is the name of the feature to invoke exposed method \fImethod\fR on,
+
+*feature* is the name of the feature to invoke exposed method **method** on,
 directly.
-.IR parameter s
-are passed directly to the method.
-They can be specified positionally or by key, using the same syntax as
-Python:
-.IR key = value .
+*parameter*s are passed directly to the method.
+They can be specified positionally or by key, using the same syntax as Python:
+_key_**=**_value_.
 They may be encoded in JSON, if not valid JSON they will be treated as
 strings.
-.P
+
 The output is a JSON-encoded response.
-.SH OPTIONS
-.TP
-\fB\-s\fR \fIHOSTNAME\fR, \fB\-\-server\fR=\fISERVER\fR
-Connect to the Ibid running on \fISERVER\fR, by default it connects to
-\fIlocalhost\fR.
-.TP
-\fB\-p\fR \fIFILE\fR, \fB\-\-port\fR=\fIPORT\fR
-Connect to the \fBpb\fR source running on port \fIPORT\fR, by default
-8789.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Show a help message and exit.
-.SH SEE ALSO
-.BR ibid (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+# OPTIONS
+
+**-s** *SERVER*, **-\-server**=*SERVER*
+:	Connect to the Ibid running on *SERVER*, by default it connects to
+	*localhost*.
+
+**-p** *PORT*, **-\-port**=*PORT*
+:	Connect to the **pb** source running on port *PORT*, by default 8789.
+
+**-h**, **-\-help**
+:	Show a help message and exit.
+
+# SEE ALSO
+
+`ibid` (1),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid-plugin.1' => 'man/ibid-plugin.1.md'
--- man/ibid-plugin.1	2010-03-08 20:27:21 +0000
+++ man/ibid-plugin.1.md	2010-03-20 10:39:26 +0000
@@ -1,71 +1,71 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-PLUGIN "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
+% IBID-PLUGIN(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
 ibid-plugin \- Plugin testing developer environment for Ibid
-.SH SYNOPSIS
-.B ibid-plugin
-.RI [ options ...]
-.RI [ plugin\fR[\fB- ]| plugin\fB.\fIProcessor [\fB-\fR]...]
-.SH DESCRIPTION
-This utility is for testing Ibid plugins without the full bot
-environment.
+
+# SYNOPSIS
+
+**ibid-plugin** [*options*...] [*plugin*[**-**]|_plugin_**.**_Processor_[**-**]...]
+
+# DESCRIPTION
+
+This utility is for testing Ibid plugins without the full bot environment.
 This means testing can be performed offline and without loading all the
 available plugins.
-.P
+
 This should be run in a configured Ibid bot directory.
-.P
+
 All the listed plugins and Processors will be loaded on start-up.
 Naming a plugin loads the complete plugin.
-Suffixing a \fB-\fR to the name, ignores that plugin or Processor
-instead of loading it.
-.SH OPTIONS
-.TP
-\fB\-c\fR, \fB\-\-configured\fR
-Load all configured plugins, instead of only the core and requested
-plugins.
-.TP
-\fB\-o\fR, \fB\-\-only\fR
-Don't load the Ibid core plugins, only the plugins requested.
-Note that without the \fBcore\fR plugin to pre- and post-process events,
-most other plugins won't function correctly.
-.TP
-\fB\-p\fR, \fB\-\-public\fR
-By default, \fBibid-plugin\fR emulates a private conversation with the
-bot.
-With this option, the conversation is considered to be public and the
-bot will have to be addressed to provoke a response.
-.TP
-\fB\-v\fR, \fB\-\-verbose\fR
-Increase verbosity.
-The final form of each \fIEvent\fR object will be displayed before any responses.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
+Suffixing a **-** to the name, ignores that plugin or Processor instead of
+loading it.
+
+# OPTIONS
+
+**-c**, **-\-configured**
+:	Load all configured plugins, instead of only the core and requested
+	plugins.
+
+**-o**, **-\-only**
+:	Don't load the Ibid core plugins, only the plugins requested.
+	Note that without the **core** plugin to pre- and post-process events, most
+	other plugins won't function correctly.
+
+**-p**, **-\-public**
+:	By default, **ibid-plugin** emulates a private conversation with the bot.
+	With this option, the conversation is considered to be public and the
+	bot will have to be addressed to provoke a response.
+
+**-v**, **-\-verbose**
+:	Increase verbosity.
+	The final form of each *Event* object will be displayed before any
+	responses.
+
+**-h**, **-\-help**
 Show a help message and exit.
-.SH FILES
-.TP
-.I ibid.ini
-Locates the database to act upon by looking for the \fB[databases].ibid\fR value
-in the bot configuration file in the current directory.
-.SH BUGS
-\fBibid-plugin\fR doesn't emulate a complete Ibid environment, and will
-ignore all of the following:
-.TP
-*
-Delayed and periodically executed functions.
-.TP
-*
-Messages to alternate sources.
-.TP
-*
-Messages directly dispatched, rather than added to responses.
-.TP
-*
-Permissions.
-All permissions are granted to the user.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid.ini (5),
-.BR ibid-setup (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+# FILES
+
+*ibid.ini*
+:	Locates the database to act upon by looking for the
+	[**databases**].**ibid** value in the bot configuration file in the current
+	directory.
+
+# BUGS
+
+**ibid-plugin** doesn't emulate a complete Ibid environment, and will ignore
+all of the following:
+
+* Delayed and periodically executed functions.
+* Messages to alternate sources.
+* Messages directly dispatched, rather than added to responses.
+* Permissions. All permissions are granted to the user.
+
+# SEE ALSO
+`ibid` (1),
+`ibid.ini` (5),
+`ibid-setup` (1),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid-setup.1' => 'man/ibid-setup.1.md'
--- man/ibid-setup.1	2010-03-08 20:27:21 +0000
+++ man/ibid-setup.1.md	2010-03-20 10:39:26 +0000
@@ -1,33 +1,36 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID-SETUP "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid-setup \- Create a basic configuration file and database for an Ibid
-bot
-.SH SYNOPSIS
-.B ibid-setup
-.SH DESCRIPTION
-This program sets up everything that a new Ibid bot needs before it can
-run.
+% IBID-SETUP(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid-setup - Create a basic configuration file and database for an Ibid bot
+
+# SYNOPSIS
+
+**ibid-setup**
+
+# DESCRIPTION
+
+This program sets up everything that a new Ibid bot needs before it can run.
 It asks a series of questions about the new bot, and writes out a basic
-configuration file -
-.BR ibid.ini (5)
-- to the current directory.
-It also creates a database for the bot, by default a SQLite database in
-the current directory.
-.P
-This should be run in the directory which will become the new Ibid bot's
-base.
-.P
-Should there be an existing \fBibid.ini\fR in the current directory, it
-will be used, and the only questions asked will be for adding an
-administrative user. These can safely be skipped with a \fB^C\fR.
-.SH FILES
-.TP
-.I ibid.ini
-The Ibid bot's configuration file, will be created if it doesn't exist.
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid.ini (5),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+configuration file - `ibid.ini` (5) - to the current directory.
+It also creates a database for the bot, by default a SQLite database in the
+current directory.
+
+This should be run in the directory which will become the new Ibid bot's base.
+
+Should there be an existing **ibid.ini** in the current directory, it will be
+used, and the only questions asked will be for adding an administrative user.
+These can safely be skipped with a **^C**.
+
+# FILES
+
+*ibid.ini*
+:	The Ibid bot's configuration file, will be created if it doesn't exist.
+
+# SEE ALSO
+
+`ibid` (1),
+`ibid.ini` (5),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid.1' => 'man/ibid.1.md'
--- man/ibid.1	2010-03-08 20:27:21 +0000
+++ man/ibid.1.md	2010-03-20 10:39:26 +0000
@@ -1,32 +1,41 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid \- Run an Ibid bot
-.SH SYNOPSIS
-.B ibid
-.RI [ config-file ]
-.SH DESCRIPTION
+% IBID(1) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid - Run an Ibid bot
+
+# SYNOPSIS
+
+**ibid** [*config-file*]
+
+# DESCRIPTION
+
 This runs an Ibid bot in the foreground.
-.P
-There should there be an existing \fBibid.ini\fR (created by
-.BR ibid-setup (1))
+
+There should there be an existing **ibid.ini** (created by
+`ibid-setup` (1))
 in the current directory or one should be provided on the command line.
-.P
-Where possible, you should run \fBtwistd \-n ibid\fR instead of this
+
+Where possible, you should run **twistd -n ibid** instead of this
 program, as otherwise some classes of errors go unreported.
-.RB "See " BUGS .
-.SH BUGS
+See **BUGS**.
+
+# BUGS
+
 Exceptions in twisted callbacks can go unnoticed in this program.
 That has no harmful effects, but the developers may miss out on some
 good bug reports.
-.SH FILES
-.TP
-.I ibid.ini
-The Ibid bot's configuration file, will be created if it doesn't exist.
-.SH SEE ALSO
-.BR ibid.ini (5),
-.BR ibid-setup (1),
-.BR twistd (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+# FILES
+
+*ibid.ini*
+:	The Ibid bot's configuration file, will be created if it doesn't exist.
+
+# SEE ALSO
+
+`ibid.ini` (5),
+`ibid-setup` (1),
+`twistd` (1),
+http://ibid.omnia.za.net/

=== renamed file 'man/ibid.ini.5' => 'man/ibid.ini.5.md'
--- man/ibid.ini.5	2010-03-08 20:27:21 +0000
+++ man/ibid.ini.5.md	2010-03-20 10:39:26 +0000
@@ -1,113 +1,119 @@
-.\" Copyright (c) 2010, Stefano Rivera
-.\" Released under terms of the MIT/X/Expat Licence. See COPYING for details.
-.TH IBID.INI "5" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot"
-.SH NAME
-ibid.ini \- Configuration file for Ibid
-.SH DESCRIPTION
+% IBID.INI(5) Ibid Multi-protocol Bot | Ibid 0.1
+% Stefano Rivera
+% March 2010
+
+# NAME
+
+ibid.ini - Configuration file for Ibid
+
+# DESCRIPTION
+
 ibid.ini contains all the configuration for an Ibid bot.
-.P
+
 A complete description of the contents of this file is out of the scope of this
 manpage.
-For more details see the Ibid documentation:
-.UR http://ibid.omnia.za.net/docs/
-.BR http://ibid.omnia.za.net/docs/
-.P
-Lines beginning with \fB#\fR are considered to be comments and ignored.
-To use a \fB#\fR symbol in an option (e.g. an IRC channel name), quote the
-option with double-quotes, e.g.
-.BR channels = """#ibid"","
-.P
+For more details see the Ibid documentation: http://ibid.omnia.za.net/docs/
+
+Lines beginning with **#** are considered to be comments and ignored.
+To use a **#** symbol in an option (e.g. an IRC channel name), quote the
+option with double-quotes, e.g. **channels**=**"#ibid",**
+
 This file will be written to by the bot when configuration settings are
 altered online.
 It can also be edited manually and a running bot told to
-\fB"reload config"\fR.
+**"reload config"**.
 Manual edits and comments will be preserved when the bot modifies its
 own configuration, provided that they have not been edited since bot
 start-up or the last config reload.
-.SH SECTIONS
-.SS auth
+
+# SECTIONS
+
+## auth
+
 Settings related to permissions and authentication.
-Permissions listed in \fBauth.permissions\fR are granted to all users unless
+Permissions listed in **auth**.**permissions** are granted to all users unless
 revoked by source or account.
-.SS sources
+
+## sources
+
 Sources are Ibid connections to an IM service.
 They range from IRC networks to the bot's built-in HTTP server.
-.P
+
 Each source is configured in a section named after the source.
 The source name will define the driver that the source should use, unless a
-\fBtype\fR option is provided.
-.P
+**type** option is provided.
+
 Sources can be disabled by setting
-.BR disabled = True .
-.SS plugins
+**disabled**=**True**.
+
+## plugins
+
 Plugin configuration.
 Each plugin is configured within a section named after the plugin.
-.P
-.TP
-.B cachedir
-The directory that temporary files (such as downloaded data), useful to be the
-bot but expendable, is stored in.
-.TP
-.B core.autoload
-If \fBTrue\fR, all plugins not explicitly ignored will be loaded.
-(Note that some plugins mark themselves as non-auto-loadable).
-Defaults to \fBTrue\fR.
-.TP
-.B core.load
-The list of plugins (or \fBplugin\fR.\fBProcessor\fRs) to load.
-.TP
-.B core.noload
-The list of plugins (or \fBplugin\fR.\fBProcessor\fRs) to ignore and not load.
-.TP
-.B core.names
-The names that the bot should respond to.
-.TP
-.B core.ignore
-Nicks that the bot should completely ignore (e.g. other bots).
-.SH EXAMPLE
-.nf
-botname = joebot
-logging = logging.ini
-
-[auth]
-    methods = password,
-    timeout = 300
-    permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse
-
-[sources]
-    [[telnet]]
-    [[timer]]
-    [[http]]
-        url = http://joebot.example.com
-    [[smtp]]
-    [[pb]]
-    [[atrum]]
-        channels = "#ibid",
-        nick = $botname
-        type = irc
-        auth = hostmask, nickserv
-        server = irc.atrum.org
-
-[plugins]
-    cachedir = /tmp/ibid
-    [[core]]
-        names = $botname, bot, ant
-        ignore = ,
-
-[databases]
-    ibid = sqlite:///ibid.db
-.fi
-.SH FILES
-.TP
-.I logging.ini
-A standard Python \fBlogging.config\fR configuration file describing
-loggers, handlers, and formatters for log messages.
-See
-.UR http://docs.python.org/library/logging.html
-.BR http://docs.python.org/library/logging.html
-.SH SEE ALSO
-.BR ibid (1),
-.BR ibid.ini (5),
-.BR twistd (1),
-.UR http://ibid.omnia.za.net/
-.BR http://ibid.omnia.za.net/
+
+**cachedir**
+:	The directory that temporary files (such as downloaded data), useful to be
+	the bot but expendable, is stored in.
+
+**core**.**autoload**
+:	If **True**, all plugins not explicitly ignored will be loaded.
+	(Note that some plugins mark themselves as non-auto-loadable).
+	Defaults to **True**.
+
+**core**.**load**
+:	The list of plugins (or **plugin**.**Processor**s) to load.
+
+**core**.**noload**
+:	The list of plugins (or **plugin**.**Processor**s) to ignore and not load.
+
+**core**.**names**
+:	The names that the bot should respond to.
+
+**core**.**ignore**
+:	Nicks that the bot should completely ignore (e.g. other bots).
+
+# EXAMPLE
+
+	botname = joebot
+	logging = logging.ini
+
+	[auth]
+	    methods = password,
+	    timeout = 300
+	    permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse
+
+	[sources]
+	    [[telnet]]
+	    [[timer]]
+	    [[http]]
+	        url = http://joebot.example.com
+	    [[smtp]]
+	    [[pb]]
+	    [[atrum]]
+	        channels = "#ibid",
+	        nick = $botname
+	        type = irc
+	        auth = hostmask, nickserv
+	        server = irc.atrum.org
+
+	[plugins]
+	    cachedir = /tmp/ibid
+	    [[core]]
+	        names = $botname, bot, ant
+	        ignore = ,
+
+	[databases]
+	    ibid = sqlite:///ibid.db
+
+# FILES
+
+*logging*.*ini*
+:	A standard Python **logging**.**config** configuration file describing
+	loggers, handlers, and formatters for log messages.
+	See http://docs.python.org/library/logging.html
+
+# SEE ALSO
+`ibid` (1),
+`ibid.ini` (5),
+`twistd` (1),
+http://ibid.omnia.za.net/