Merge lp:~stefanor/ibid/pandoc-man-511899 into lp:~ibid-core/ibid/old-trunk-1.6
- pandoc-man-511899
- Merge into old-trunk-1.6
Proposed by
Stefano Rivera
Status: | Merged | ||||
---|---|---|---|---|---|
Approved by: | Stefano Rivera | ||||
Approved revision: | 914 | ||||
Merged at revision: | 915 | ||||
Proposed branch: | lp:~stefanor/ibid/pandoc-man-511899 | ||||
Merge into: | lp:~ibid-core/ibid/old-trunk-1.6 | ||||
Diff against target: |
1173 lines (+554/-501) 12 files modified
man/Makefile (+13/-0) man/README (+4/-0) man/ibid-db.1.md (+62/-57) man/ibid-factpack.1.md (+61/-56) man/ibid-knab-import.1.md (+47/-41) man/ibid-memgraph.1.md (+41/-36) man/ibid-objgraph.1.md (+48/-47) man/ibid-pb-client.1.md (+43/-47) man/ibid-plugin.1.md (+64/-64) man/ibid-setup.1.md (+35/-32) man/ibid.1.md (+35/-26) man/ibid.ini.5.md (+101/-95) |
||||
To merge this branch: | bzr merge lp:~stefanor/ibid/pandoc-man-511899 | ||||
Related bugs: |
|
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Michael Gorven | Approve | ||
Jonathan Hitchcock | Approve | ||
Max Rabkin | Approve | ||
Review via email: mp+21400@code.launchpad.net |
Commit message
Convert manpages to Markdown and generate with pandoc
Description of the change
To post a comment you must log in.
- 913. By Stefano Rivera
-
Correct spelling
- 914. By Stefano Rivera
-
Escape -- to prevent rendering as dash
Revision history for this message
Jonathan Hitchcock (vhata) : | # |
review:
Approve
Revision history for this message
Keegan Carruthers-Smith (keegan-csmith) wrote : | # |
I thought pandoc supported restructured text? Is it not more consistent to stick with rst?
Revision history for this message
Stefano Rivera (stefanor) wrote : | # |
> 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.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === added file 'man/Makefile' | |||
2 | --- man/Makefile 1970-01-01 00:00:00 +0000 | |||
3 | +++ man/Makefile 2010-03-20 10:39:26 +0000 | |||
4 | @@ -0,0 +1,13 @@ | |||
5 | 1 | MANPAGES=$(patsubst %.md,%,$(wildcard *.md)) | ||
6 | 2 | |||
7 | 3 | all: $(MANPAGES) | ||
8 | 4 | |||
9 | 5 | clean: | ||
10 | 6 | rm -f $(MANPAGES) | ||
11 | 7 | |||
12 | 8 | %: %.md | ||
13 | 9 | # Incorrect escaping in code blocks: | ||
14 | 10 | # http://code.google.com/p/pandoc/issues/detail?id=223 | ||
15 | 11 | pandoc -s -t man $< | sed -e '/^[^.]/ s/\\"/"/g' > $@ | ||
16 | 12 | |||
17 | 13 | .PHONY: all clean | ||
18 | 0 | 14 | ||
19 | === added file 'man/README' | |||
20 | --- man/README 1970-01-01 00:00:00 +0000 | |||
21 | +++ man/README 2010-03-20 10:39:26 +0000 | |||
22 | @@ -0,0 +1,4 @@ | |||
23 | 1 | All files in this directory are: | ||
24 | 2 | |||
25 | 3 | Copyright (c) 2010, Stefano Rivera | ||
26 | 4 | Released under terms of the MIT/X/Expat Licence. See COPYING for details. | ||
27 | 0 | 5 | ||
28 | === renamed file 'man/ibid-db.1' => 'man/ibid-db.1.md' | |||
29 | --- man/ibid-db.1 2010-03-08 20:27:21 +0000 | |||
30 | +++ man/ibid-db.1.md 2010-03-20 10:39:26 +0000 | |||
31 | @@ -1,59 +1,64 @@ | |||
44 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-DB(1) Ibid Multi-protocol Bot | Ibid 0.1 |
45 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
46 | 3 | .TH IBID-DB "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
47 | 4 | .SH NAME | 4 | |
48 | 5 | ibid-db \- Database management utility for Ibid | 5 | # NAME |
49 | 6 | .SH SYNOPSIS | 6 | |
50 | 7 | .B ibid-db command | 7 | ibid-db - Database management utility for Ibid |
51 | 8 | .RI [ options ...] | 8 | |
52 | 9 | .SH DESCRIPTION | 9 | # SYNOPSIS |
53 | 10 | This utility is for offline management of your Ibid bot's database. | 10 | |
54 | 11 | Used for import, export, and upgrades. | 11 | **ibid-db** *command* [*options*...] |
55 | 12 | .P | 12 | |
56 | 13 | # DESCRIPTION | ||
57 | 14 | |||
58 | 15 | This utility is for offline management of your Ibid bot's database. Used for | ||
59 | 16 | import, export, and upgrades. | ||
60 | 17 | |||
61 | 13 | The export format is DBMS-agnostic and can be used to migrate between different | 18 | The export format is DBMS-agnostic and can be used to migrate between different |
62 | 14 | databases. | 19 | databases. |
108 | 15 | .SH COMMANDS | 20 | |
109 | 16 | .TP | 21 | # COMMANDS |
110 | 17 | \fB\-e\fR \fIFILE\fR, \fB\-\-export\fR=\fIFILE\fR | 22 | |
111 | 18 | Export DB contents to \fIFILE\fR. | 23 | **-e** *FILE*, **-\-export**=*FILE* |
112 | 19 | Export format is JSON. | 24 | : Export DB contents to *FILE*. |
113 | 20 | .IP | 25 | Export format is JSON. |
114 | 21 | FILE can be \fB\-\fR for stdin/stdout or can end in \fB.gz\fR for automatic | 26 | *FILE* can be **-** for *stdout* or can end in **.gz** for automatic gzip |
115 | 22 | gzip compression. | 27 | compression. |
116 | 23 | .TP | 28 | |
117 | 24 | \fB\-i\fR \fIFILE\fR, \fB\-\-import\fR=\fIFILE\fR | 29 | **-i** *FILE*, **-\-import**=*FILE* |
118 | 25 | Import DB contents from \fIFILE\fR as exported by this utility. | 30 | : Import DB contents from *FILE* as exported by this utility. |
119 | 26 | .IP | 31 | *FILE* can be **-** for *stdin* or can end in **.gz** for automatic gzip |
120 | 27 | FILE can be \fB\-\fR for stdin/stdout or can end in \fB.gz\fR for automatic | 32 | compression. |
121 | 28 | gzip compression. | 33 | |
122 | 29 | .IP | 34 | : **Note:** The DB must be empty first. |
123 | 30 | .B Note: | 35 | |
124 | 31 | The DB must be empty first. | 36 | **-u**, **-\-upgrade** |
125 | 32 | .TP | 37 | : Upgrade DB schema to the latest version. |
126 | 33 | \fB\-u\fR, \fB\-\-upgrade\fR | 38 | You need to run this after upgrading your bot. |
127 | 34 | Upgrade DB schema to the latest version. | 39 | |
128 | 35 | You need to run this after upgrading your bot. | 40 | : **Note:** You should backup first. |
129 | 36 | .IP | 41 | |
130 | 37 | .B Note: | 42 | # OPTIONS |
131 | 38 | You should backup first. | 43 | |
132 | 39 | .SH OPTIONS | 44 | **-\-version** |
133 | 40 | .TP | 45 | : Show the program's version and exit. |
134 | 41 | \fB\-\-version\fR | 46 | |
135 | 42 | Show the program's version and exit. | 47 | **-h**, **-\-help** |
136 | 43 | .TP | 48 | : Show a help message and exit. |
137 | 44 | \fB\-h\fR, \fB\-\-help\fR | 49 | |
138 | 45 | Show a help message and exit. | 50 | **-v**, **-\-verbose** |
139 | 46 | .TP | 51 | : Turn on debugging output to stderr. |
140 | 47 | \fB\-v\fR, \fB\-\-verbose\fR | 52 | |
141 | 48 | Turn on debugging output to stderr. | 53 | # FILES |
142 | 49 | .SH FILES | 54 | |
143 | 50 | .TP | 55 | *ibid.ini* |
144 | 51 | .I ibid.ini | 56 | : Locates the database to act upon by looking for the |
145 | 52 | Locates the database to act upon by looking for the \fB[databases].ibid\fR value | 57 | [**databases**].**ibid** value in the bot configuration file in the current |
146 | 53 | in the bot configuration file in the current directory. | 58 | directory. |
147 | 54 | .SH SEE ALSO | 59 | |
148 | 55 | .BR ibid (1), | 60 | # SEE ALSO |
149 | 56 | .BR ibid.ini (5), | 61 | `ibid` (1), |
150 | 57 | .BR ibid-setup (1), | 62 | `ibid.ini` (5), |
151 | 58 | .UR http://ibid.omnia.za.net/ | 63 | `ibid-setup` (1), |
152 | 59 | .BR http://ibid.omnia.za.net/ | 64 | http://ibid.omnia.za.net/ |
153 | 60 | 65 | ||
154 | === renamed file 'man/ibid-factpack.1' => 'man/ibid-factpack.1.md' | |||
155 | --- man/ibid-factpack.1 2010-03-08 20:27:21 +0000 | |||
156 | +++ man/ibid-factpack.1.md 2010-03-20 10:39:26 +0000 | |||
157 | @@ -1,65 +1,70 @@ | |||
174 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-FACTPACK(1) Ibid Multi-protocol Bot | Ibid 0.1 |
175 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
176 | 3 | .TH IBID-FACTPACK "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
177 | 4 | .SH NAME | 4 | |
178 | 5 | ibid-factpack \- Factoid-package management utility for Ibid | 5 | # NAME |
179 | 6 | .SH SYNOPSIS | 6 | |
180 | 7 | .B ibid-factpack | 7 | ibid-factpack - Factoid-package management utility for Ibid |
181 | 8 | .RB [ -s ] | 8 | |
182 | 9 | .I factpack-file | 9 | # SYNOPSIS |
183 | 10 | .br | 10 | |
184 | 11 | .B ibid-factpack -r | 11 | **ibid-factpack** [**-s**] *factpack-file* |
185 | 12 | .RB [ -f ] | 12 | **ibid-factpack** **-r** [**-f**] *factpack-name* |
186 | 13 | .I factpack-name | 13 | **ibid-factpack** **-h** |
187 | 14 | .br | 14 | |
188 | 15 | .B ibid-factpack -h | 15 | # DESCRIPTION |
189 | 16 | .SH DESCRIPTION | 16 | |
190 | 17 | This utility is for adding and removing sets of packaged factoids, known as | 17 | This utility is for adding and removing sets of packaged factoids, known as |
191 | 18 | factpacks, from your Ibid's factoid database. | 18 | factpacks, from your Ibid's factoid database. |
193 | 19 | .P | 19 | |
194 | 20 | The default mode is factpack loading. | 20 | The default mode is factpack loading. |
196 | 21 | The \fIfactpack-file\fR specified is loaded into the bot's database. | 21 | The *factpack-file* specified is loaded into the bot's database. |
197 | 22 | Should the pack contain any facts with the same name as an existing fact in the | 22 | Should the pack contain any facts with the same name as an existing fact in the |
204 | 23 | bot's database, loading will be aborted, unless the \fB-s\fR option is | 23 | bot's database, loading will be aborted, unless the *-s* option is supplied. |
205 | 24 | supplied. | 24 | |
206 | 25 | .P | 25 | Factpacks can be gzipped if the filename ends with **.gz**. |
207 | 26 | Factpacks can be gzipped if the filename ends with \fB\.gz\fR. | 26 | |
208 | 27 | .P | 27 | When invoked with the **-r** option, the named factpack (original import |
203 | 28 | When invoked with the \fB-r\fR option, the named factpack (original import | ||
209 | 29 | filename minus the extension) will be removed from the bot. | 28 | filename minus the extension) will be removed from the bot. |
210 | 30 | If any of the facts contained in that pack were modified while loaded in the | 29 | If any of the facts contained in that pack were modified while loaded in the |
226 | 31 | bot, unloading will be aborted, unless the \fB-f\fR option is supplied. | 30 | bot, unloading will be aborted, unless the **-f** option is supplied. |
227 | 32 | .SH OPTIONS | 31 | |
228 | 33 | .TP | 32 | # OPTIONS |
229 | 34 | \fB\-r\fR, \fB\-\-remove\fR | 33 | |
230 | 35 | Remove the named factpack, rather than importing. | 34 | **-r**, **-\-remove** |
231 | 36 | .TP | 35 | : Remove the named factpack, rather than importing. |
232 | 37 | \fB\-f\fR, \fB\-\-force\fR | 36 | |
233 | 38 | Force removal, if facts in the factpack were modified by users. | 37 | **-f**, **-\-force** |
234 | 39 | .TP | 38 | : Force removal, if facts in the factpack were modified by users. |
235 | 40 | \fB\-s\fR, \fB\-\-skip\fR | 39 | |
236 | 41 | Skip facts that clash with existing factoids, during import. | 40 | **-s**, **-\-skip** |
237 | 42 | .TP | 41 | : Skip facts that clash with existing factoids, during import. |
238 | 43 | \fB\-h\fR, \fB\-\-help\fR | 42 | |
239 | 44 | Show a help message and exit. | 43 | **-h**, **-\-help** |
240 | 45 | .SH FACTPACKS | 44 | : Show a help message and exit. |
241 | 45 | |||
242 | 46 | # FACTPACKS | ||
243 | 47 | |||
244 | 46 | Factpacks are JSON-encoded text files containing a list of facts. | 48 | Factpacks are JSON-encoded text files containing a list of facts. |
245 | 47 | Each fact is a tuple of two lists: fact-names, fact-values. | 49 | Each fact is a tuple of two lists: fact-names, fact-values. |
246 | 48 | The same substitutions are available as in normal online Factoids. | 50 | The same substitutions are available as in normal online Factoids. |
264 | 49 | .SS Example: | 51 | |
265 | 50 | .nf | 52 | ## Example: |
266 | 51 | [ | 53 | |
267 | 52 | [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]], | 54 | [ |
268 | 53 | [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]] | 55 | [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]], |
269 | 54 | ] | 56 | [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]] |
270 | 55 | .fi | 57 | ] |
271 | 56 | .SH FILES | 58 | |
272 | 57 | .TP | 59 | # FILES |
273 | 58 | .I ibid.ini | 60 | |
274 | 59 | Locates the database to act upon by looking for the \fB[databases].ibid\fR value | 61 | *ibid.ini* |
275 | 60 | in the bot configuration file in the current directory. | 62 | : Locates the database to act upon by looking for the |
276 | 61 | .SH SEE ALSO | 63 | [**databases**].**ibid** value in the bot configuration file in the current |
277 | 62 | .BR ibid (1), | 64 | directory. |
278 | 63 | .BR ibid.ini (5), | 65 | |
279 | 64 | .UR http://ibid.omnia.za.net/ | 66 | # SEE ALSO |
280 | 65 | .BR http://ibid.omnia.za.net/ | 67 | |
281 | 68 | `ibid` (1), | ||
282 | 69 | `ibid.ini` (5), | ||
283 | 70 | http://ibid.omnia.za.net/ | ||
284 | 66 | 71 | ||
285 | === renamed file 'man/ibid-knab-import.1' => 'man/ibid-knab-import.1.md' | |||
286 | --- man/ibid-knab-import.1 2010-03-08 20:27:21 +0000 | |||
287 | +++ man/ibid-knab-import.1.md 2010-03-20 10:39:26 +0000 | |||
288 | @@ -1,44 +1,50 @@ | |||
303 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-KNAB-IMPORT(1) Ibid Multi-protocol Bot | Ibid 0.1 |
304 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
305 | 3 | .TH IBID-DB "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
306 | 4 | .SH NAME | 4 | |
307 | 5 | ibid-knab-import \- Knab->Ibid Import utility | 5 | # NAME |
308 | 6 | .SH SYNOPSIS | 6 | |
309 | 7 | .B ibid-knab-import | 7 | ibid-knab-import - Knab->Ibid Import utility |
310 | 8 | .I knab-sa-url | 8 | |
311 | 9 | .I source | 9 | # SYNOPSIS |
312 | 10 | .RI [ config-file ] | 10 | |
313 | 11 | .SH DESCRIPTION | 11 | **ibid-knab-import** *knab-sa-url* *source* [*config-file*] |
314 | 12 | This utility imports users, last seen information, factoids, and URLs | 12 | |
315 | 13 | from a Knab bot's database into an Ibid. | 13 | # DESCRIPTION |
316 | 14 | .P | 14 | |
317 | 15 | This utility imports users, last seen information, factoids, and URLs from a | ||
318 | 16 | Knab bot's database into an Ibid. | ||
319 | 17 | |||
320 | 15 | For best results, import directly into a brand new, clean Ibid install. | 18 | For best results, import directly into a brand new, clean Ibid install. |
322 | 16 | .P | 19 | |
323 | 17 | On import, strings are converted to Unicode, guessing UTF-8 and falling back to | 20 | On import, strings are converted to Unicode, guessing UTF-8 and falling back to |
324 | 18 | detection. | 21 | detection. |
351 | 19 | .SH OPTIONS | 22 | |
352 | 20 | .TP | 23 | # OPTIONS |
353 | 21 | .I knab-sa-url | 24 | |
354 | 22 | The SQLAlchemy URI for the Knab's database. | 25 | *knab-sa-url* |
355 | 23 | The format is | 26 | : The SQLAlchemy URI for the Knab's database. |
356 | 24 | .BI mysql:// user : pass @ hostname / dbname | 27 | The format is **mysql://**_user_**:**_pass_**@**_hostname_**/**_dbname_ |
357 | 25 | .TP | 28 | |
358 | 26 | .I source | 29 | *source* |
359 | 27 | The name in the Ibid bot for the source that the Knab was previously connected to. | 30 | : The name in the Ibid bot for the source that the Knab was previously |
360 | 28 | .TP | 31 | connected to. |
361 | 29 | .I config-file | 32 | |
362 | 30 | If supplied, this is configuration file is used for locating the Ibid's | 33 | *config-file* |
363 | 31 | database rather than \fBibid.ini\fR. | 34 | : If supplied, this is configuration file is used for locating the Ibid's |
364 | 32 | .SH FILES | 35 | database rather than **ibid.ini**. |
365 | 33 | .TP | 36 | |
366 | 34 | .I ibid.ini | 37 | # FILES |
367 | 35 | Locates the database to act upon by looking for the \fB[databases].ibid\fR value | 38 | |
368 | 36 | in the bot configuration file in the current directory. | 39 | *ibid.ini* |
369 | 37 | .SH SEE ALSO | 40 | : Locates the database to act upon by looking for the |
370 | 38 | .BR ibid (1), | 41 | [**databases**].**ibid** value in the bot configuration file in the current |
371 | 39 | .BR ibid.ini (5), | 42 | directory. |
372 | 40 | .BR ibid-setup (1), | 43 | |
373 | 41 | .UR http://ibid.omnia.za.net/ | 44 | # SEE ALSO |
374 | 42 | .BR http://ibid.omnia.za.net/ , | 45 | |
375 | 43 | .UR http://knab.omnia.za.net/ | 46 | `ibid` (1), |
376 | 44 | .BR http://knab.omnia.za.net/ | 47 | `ibid.ini` (5), |
377 | 48 | `ibid-setup` (1), | ||
378 | 49 | http://ibid.omnia.za.net/, | ||
379 | 50 | http://knab.omnia.za.net/ | ||
380 | 45 | 51 | ||
381 | === renamed file 'man/ibid-memgraph.1' => 'man/ibid-memgraph.1.md' | |||
382 | --- man/ibid-memgraph.1 2010-03-08 20:27:21 +0000 | |||
383 | +++ man/ibid-memgraph.1.md 2010-03-20 10:39:26 +0000 | |||
384 | @@ -1,39 +1,44 @@ | |||
397 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-MEMGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1 |
398 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
399 | 3 | .TH IBID-MEMGRAPH "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
400 | 4 | .SH NAME | 4 | |
401 | 5 | ibid-memgraph \- Memory usage graph generation utility for Ibid | 5 | # NAME |
402 | 6 | .SH SYNOPSIS | 6 | |
403 | 7 | .B ibid-memgraph | 7 | ibid-memgraph - Memory usage graph generation utility for Ibid |
404 | 8 | .RB [ options ...] | 8 | |
405 | 9 | .I logfile | 9 | # SYNOPSIS |
406 | 10 | .br | 10 | |
407 | 11 | .B ibid-memgraph -h | 11 | **ibid-memgraph** [*options*...] *logfile* |
408 | 12 | .SH DESCRIPTION | 12 | **ibid-memgraph** **-h** |
409 | 13 | |||
410 | 14 | # DESCRIPTION | ||
411 | 15 | |||
412 | 13 | This utility is for graphing memory usage from an Ibid bot configured to | 16 | This utility is for graphing memory usage from an Ibid bot configured to |
413 | 14 | log such usage. | 17 | log such usage. |
415 | 15 | .P | 18 | |
416 | 16 | Matplotlib is required for graphing. | 19 | Matplotlib is required for graphing. |
440 | 17 | .SH OPTIONS | 20 | |
441 | 18 | .TP | 21 | # OPTIONS |
442 | 19 | \fB\-o\fR \fIFILE\fR, \fB\-\-output\fR=\fIFILE\fR | 22 | |
443 | 20 | Output to \fIFILE\fR instead of displaying interactive graph GUI. | 23 | **-o** *FILE*, **-\-output**=*FILE* |
444 | 21 | \fIFILE\fR can be any format supported by Matplotlib, detected by the file | 24 | : Output to *FILE* instead of displaying interactive graph GUI. |
445 | 22 | extension. | 25 | *FILE* can be any format supported by Matplotlib, detected by the file |
446 | 23 | .TP | 26 | extension. |
447 | 24 | \fB\-d\fR \fIDPI\fR, \fB\-\-dpi\fR=\fIDPI\fR | 27 | |
448 | 25 | When outputting in raster formats, use \fIDPI\fR output DPI. | 28 | **-d** *DPI*, **-\-dpi**=*DPI* |
449 | 26 | .TP | 29 | When outputting in raster formats, use *DPI* output DPI. |
450 | 27 | \fB\-h\fR, \fB\-\-help\fR | 30 | |
451 | 28 | Show a help message and exit. | 31 | **-h**, **-\-help** |
452 | 29 | .SH FILES | 32 | Show a help message and exit. |
453 | 30 | .TP | 33 | |
454 | 31 | .I logfile | 34 | # FILES |
455 | 32 | A log file generated by loading the \fBmemory\fR plugin into Ibid, which will | 35 | |
456 | 33 | periodically log memory usage. | 36 | *logfile* |
457 | 34 | It can be gzip compressed, if the filename ends in \fB.gz\fR. | 37 | : A log file generated by loading the **memory** plugin into Ibid, which will |
458 | 35 | .SH SEE ALSO | 38 | periodically log memory usage. |
459 | 36 | .BR ibid (1), | 39 | It can be gzip compressed, if the filename ends in **.gz**. |
460 | 37 | .BR ibid-objgraph (1), | 40 | |
461 | 38 | .UR http://ibid.omnia.za.net/ | 41 | # SEE ALSO |
462 | 39 | .BR http://ibid.omnia.za.net/ | 42 | `ibid` (1), |
463 | 43 | `ibid-objgraph` (1), | ||
464 | 44 | http://ibid.omnia.za.net/ | ||
465 | 40 | 45 | ||
466 | === renamed file 'man/ibid-objgraph.1' => 'man/ibid-objgraph.1.md' | |||
467 | --- man/ibid-objgraph.1 2010-03-08 20:27:21 +0000 | |||
468 | +++ man/ibid-objgraph.1.md 2010-03-20 10:39:26 +0000 | |||
469 | @@ -1,50 +1,51 @@ | |||
487 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-OBJGRAPH(1) Ibid Multi-protocol Bot | Ibid 0.1 |
488 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
489 | 3 | .TH IBID-OBJGRAPH "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
490 | 4 | .SH NAME | 4 | |
491 | 5 | ibid-objgraph \- Memory usage graph generation utility for Ibid | 5 | # NAME |
492 | 6 | .SH SYNOPSIS | 6 | |
493 | 7 | .B ibid-objgraph | 7 | ibid-objgraph - Memory usage graph generation utility for Ibid |
494 | 8 | .RB [ options ...] | 8 | |
495 | 9 | .IR "logfile type" ... | 9 | # SYNOPSIS |
496 | 10 | .br | 10 | |
497 | 11 | .B ibid-objgraph | 11 | **ibid-objgraph** [*options*...] *logfile* *type*... |
498 | 12 | .BI "-e " TIME | 12 | **ibid-objgraph** [*options*...] **-e** *TIME* *logfile* |
499 | 13 | .RB [ options ...] | 13 | **ibid-objgraph** **-h** |
500 | 14 | .I logfile | 14 | |
501 | 15 | .br | 15 | # DESCRIPTION |
502 | 16 | .B ibid-objgraph -h | 16 | |
486 | 17 | .SH DESCRIPTION | ||
503 | 18 | This utility is for graphing object-type usage from an Ibid bot | 17 | This utility is for graphing object-type usage from an Ibid bot |
504 | 19 | configured to log such usage. | 18 | configured to log such usage. |
506 | 20 | .P | 19 | |
507 | 21 | Matplotlib is required for graphing. | 20 | Matplotlib is required for graphing. |
537 | 22 | .SH OPTIONS | 21 | |
538 | 23 | .TP | 22 | # OPTIONS |
539 | 24 | \fB\-e\fR \fITIME\fR, \fB\-\-examine\fR=\fITIME\fR | 23 | |
540 | 25 | Examine the object usage at time \fITIME\fR, and print a sorted list of type | 24 | **-e** *TIME*, **-\-examine**=*TIME* |
541 | 26 | statistics at that time. | 25 | : Examine the object usage at time *TIME*, and print a sorted list of type |
542 | 27 | This function can be useful in determining which types to graph, when chasing | 26 | statistics at that time. |
543 | 28 | down a detected leak. | 27 | This function can be useful in determining which types to graph, when |
544 | 29 | .TP | 28 | chasing down a detected leak. |
545 | 30 | \fB\-o\fR \fIFILE\fR, \fB\-\-output\fR=\fIFILE\fR | 29 | |
546 | 31 | Output to \fIFILE\fR instead of displaying interactive graph GUI. | 30 | **-o** *FILE*, **-\-output**=*FILE* |
547 | 32 | \fIFILE\fR can be any format supported by Matplotlib, detected by the file | 31 | : Output to *FILE* instead of displaying interactive graph GUI. |
548 | 33 | extension. | 32 | *FILE* can be any format supported by Matplotlib, detected by the file |
549 | 34 | .TP | 33 | extension. |
550 | 35 | \fB\-d\fR \fIDPI\fR, \fB\-\-dpi\fR=\fIDPI\fR | 34 | |
551 | 36 | When outputting in raster formats, use \fIDPI\fR output DPI. | 35 | **-d** *DPI*, **-\-dpi**=*DPI* |
552 | 37 | .TP | 36 | : When outputting in raster formats, use *DPI* output DPI. |
553 | 38 | \fB\-h\fR, \fB\-\-help\fR | 37 | |
554 | 39 | Show a help message and exit. | 38 | **-h**, **-\-help** |
555 | 40 | .SH FILES | 39 | Show a help message and exit. |
556 | 41 | .TP | 40 | |
557 | 42 | .I logfile | 41 | # FILES |
558 | 43 | A log file generated by loading the \fBmemory\fR plugin into Ibid, which will | 42 | |
559 | 44 | periodically log object usage. | 43 | *logfile* |
560 | 45 | It can be gzip compressed, if the filename ends in \fB.gz\fR. | 44 | : A log file generated by loading the **memory** plugin into Ibid, which will |
561 | 46 | .SH SEE ALSO | 45 | periodically log object usage. |
562 | 47 | .BR ibid (1), | 46 | It can be gzip compressed, if the filename ends in **.gz**. |
563 | 48 | .BR ibid-memgraph (1), | 47 | |
564 | 49 | .UR http://ibid.omnia.za.net/ | 48 | # SEE ALSO |
565 | 50 | .BR http://ibid.omnia.za.net/ | 49 | `ibid` (1), |
566 | 50 | `ibid-memgraph` (1), | ||
567 | 51 | http://ibid.omnia.za.net/ | ||
568 | 51 | 52 | ||
569 | === renamed file 'man/ibid-pb-client.1' => 'man/ibid-pb-client.1.md' | |||
570 | --- man/ibid-pb-client.1 2010-03-08 20:27:21 +0000 | |||
571 | +++ man/ibid-pb-client.1.md 2010-03-20 10:39:26 +0000 | |||
572 | @@ -1,54 +1,50 @@ | |||
590 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-PB-CLIENT(1) Ibid Multi-protocol Bot | Ibid 0.1 |
591 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
592 | 3 | .TH IBID-PB-CLIENT "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
593 | 4 | .SH NAME | 4 | |
594 | 5 | ibid-pb-client \- RPC Client for Ibid | 5 | # NAME |
595 | 6 | .SH SYNOPSIS | 6 | |
596 | 7 | .B ibid-pb-client | 7 | ibid-pb-client - RPC Client for Ibid |
597 | 8 | .RI [ options ...] | 8 | |
598 | 9 | .BI message " message" | 9 | # SYNOPSIS |
599 | 10 | .br | 10 | |
600 | 11 | .B ibid-pb-client | 11 | **ibid-pb-client** [*options*...] **message** *message* |
601 | 12 | .RI [ options ...] | 12 | **ibid-pb-client** [*options*...] **plugin** *feature* *method* [*parameter*...] |
602 | 13 | .BI plugin " feature method" | 13 | **ibid-pb-client** **-h** |
603 | 14 | .RI [ parameter ...] | 14 | |
604 | 15 | .br | 15 | # DESCRIPTION |
605 | 16 | .B ibid-pb-client -h | 16 | |
589 | 17 | .SH DESCRIPTION | ||
606 | 18 | This utility is for passing events to a running Ibid bot, or executing | 17 | This utility is for passing events to a running Ibid bot, or executing |
607 | 19 | RPC-exposed functions remotely. | 18 | RPC-exposed functions remotely. |
613 | 20 | .P | 19 | |
614 | 21 | It communicates with the \fBpb\fR source on the Ibid. | 20 | It communicates with the **pb** source on the Ibid. |
615 | 22 | .P | 21 | |
616 | 23 | .I message | 22 | *message* is a text message as could be sent to the bot by an IM source. |
612 | 24 | is a text message as could be sent to the bot by an IM source. | ||
617 | 25 | The message is processed normally by the bot. | 23 | The message is processed normally by the bot. |
621 | 26 | .P | 24 | |
622 | 27 | .I feature | 25 | *feature* is the name of the feature to invoke exposed method **method** on, |
620 | 28 | is the name of the feature to invoke exposed method \fImethod\fR on, | ||
623 | 29 | directly. | 26 | directly. |
629 | 30 | .IR parameter s | 27 | *parameter*s are passed directly to the method. |
630 | 31 | are passed directly to the method. | 28 | They can be specified positionally or by key, using the same syntax as Python: |
631 | 32 | They can be specified positionally or by key, using the same syntax as | 29 | _key_**=**_value_. |
627 | 33 | Python: | ||
628 | 34 | .IR key = value . | ||
632 | 35 | They may be encoded in JSON, if not valid JSON they will be treated as | 30 | They may be encoded in JSON, if not valid JSON they will be treated as |
633 | 36 | strings. | 31 | strings. |
635 | 37 | .P | 32 | |
636 | 38 | The output is a JSON-encoded response. | 33 | The output is a JSON-encoded response. |
653 | 39 | .SH OPTIONS | 34 | |
654 | 40 | .TP | 35 | # OPTIONS |
655 | 41 | \fB\-s\fR \fIHOSTNAME\fR, \fB\-\-server\fR=\fISERVER\fR | 36 | |
656 | 42 | Connect to the Ibid running on \fISERVER\fR, by default it connects to | 37 | **-s** *SERVER*, **-\-server**=*SERVER* |
657 | 43 | \fIlocalhost\fR. | 38 | : Connect to the Ibid running on *SERVER*, by default it connects to |
658 | 44 | .TP | 39 | *localhost*. |
659 | 45 | \fB\-p\fR \fIFILE\fR, \fB\-\-port\fR=\fIPORT\fR | 40 | |
660 | 46 | Connect to the \fBpb\fR source running on port \fIPORT\fR, by default | 41 | **-p** *PORT*, **-\-port**=*PORT* |
661 | 47 | 8789. | 42 | : Connect to the **pb** source running on port *PORT*, by default 8789. |
662 | 48 | .TP | 43 | |
663 | 49 | \fB\-h\fR, \fB\-\-help\fR | 44 | **-h**, **-\-help** |
664 | 50 | Show a help message and exit. | 45 | : Show a help message and exit. |
665 | 51 | .SH SEE ALSO | 46 | |
666 | 52 | .BR ibid (1), | 47 | # SEE ALSO |
667 | 53 | .UR http://ibid.omnia.za.net/ | 48 | |
668 | 54 | .BR http://ibid.omnia.za.net/ | 49 | `ibid` (1), |
669 | 50 | http://ibid.omnia.za.net/ | ||
670 | 55 | 51 | ||
671 | === renamed file 'man/ibid-plugin.1' => 'man/ibid-plugin.1.md' | |||
672 | --- man/ibid-plugin.1 2010-03-08 20:27:21 +0000 | |||
673 | +++ man/ibid-plugin.1.md 2010-03-20 10:39:26 +0000 | |||
674 | @@ -1,71 +1,71 @@ | |||
679 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-PLUGIN(1) Ibid Multi-protocol Bot | Ibid 0.1 |
680 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
681 | 3 | .TH IBID-PLUGIN "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
682 | 4 | .SH NAME | 4 | |
683 | 5 | # NAME | ||
684 | 6 | |||
685 | 5 | ibid-plugin \- Plugin testing developer environment for Ibid | 7 | ibid-plugin \- Plugin testing developer environment for Ibid |
693 | 6 | .SH SYNOPSIS | 8 | |
694 | 7 | .B ibid-plugin | 9 | # SYNOPSIS |
695 | 8 | .RI [ options ...] | 10 | |
696 | 9 | .RI [ plugin\fR[\fB- ]| plugin\fB.\fIProcessor [\fB-\fR]...] | 11 | **ibid-plugin** [*options*...] [*plugin*[**-**]|_plugin_**.**_Processor_[**-**]...] |
697 | 10 | .SH DESCRIPTION | 12 | |
698 | 11 | This utility is for testing Ibid plugins without the full bot | 13 | # DESCRIPTION |
699 | 12 | environment. | 14 | |
700 | 15 | This utility is for testing Ibid plugins without the full bot environment. | ||
701 | 13 | This means testing can be performed offline and without loading all the | 16 | This means testing can be performed offline and without loading all the |
702 | 14 | available plugins. | 17 | available plugins. |
704 | 15 | .P | 18 | |
705 | 16 | This should be run in a configured Ibid bot directory. | 19 | This should be run in a configured Ibid bot directory. |
707 | 17 | .P | 20 | |
708 | 18 | All the listed plugins and Processors will be loaded on start-up. | 21 | All the listed plugins and Processors will be loaded on start-up. |
709 | 19 | Naming a plugin loads the complete plugin. | 22 | Naming a plugin loads the complete plugin. |
734 | 20 | Suffixing a \fB-\fR to the name, ignores that plugin or Processor | 23 | Suffixing a **-** to the name, ignores that plugin or Processor instead of |
735 | 21 | instead of loading it. | 24 | loading it. |
736 | 22 | .SH OPTIONS | 25 | |
737 | 23 | .TP | 26 | # OPTIONS |
738 | 24 | \fB\-c\fR, \fB\-\-configured\fR | 27 | |
739 | 25 | Load all configured plugins, instead of only the core and requested | 28 | **-c**, **-\-configured** |
740 | 26 | plugins. | 29 | : Load all configured plugins, instead of only the core and requested |
741 | 27 | .TP | 30 | plugins. |
742 | 28 | \fB\-o\fR, \fB\-\-only\fR | 31 | |
743 | 29 | Don't load the Ibid core plugins, only the plugins requested. | 32 | **-o**, **-\-only** |
744 | 30 | Note that without the \fBcore\fR plugin to pre- and post-process events, | 33 | : Don't load the Ibid core plugins, only the plugins requested. |
745 | 31 | most other plugins won't function correctly. | 34 | Note that without the **core** plugin to pre- and post-process events, most |
746 | 32 | .TP | 35 | other plugins won't function correctly. |
747 | 33 | \fB\-p\fR, \fB\-\-public\fR | 36 | |
748 | 34 | By default, \fBibid-plugin\fR emulates a private conversation with the | 37 | **-p**, **-\-public** |
749 | 35 | bot. | 38 | : By default, **ibid-plugin** emulates a private conversation with the bot. |
750 | 36 | With this option, the conversation is considered to be public and the | 39 | With this option, the conversation is considered to be public and the |
751 | 37 | bot will have to be addressed to provoke a response. | 40 | bot will have to be addressed to provoke a response. |
752 | 38 | .TP | 41 | |
753 | 39 | \fB\-v\fR, \fB\-\-verbose\fR | 42 | **-v**, **-\-verbose** |
754 | 40 | Increase verbosity. | 43 | : Increase verbosity. |
755 | 41 | The final form of each \fIEvent\fR object will be displayed before any responses. | 44 | The final form of each *Event* object will be displayed before any |
756 | 42 | .TP | 45 | responses. |
757 | 43 | \fB\-h\fR, \fB\-\-help\fR | 46 | |
758 | 47 | **-h**, **-\-help** | ||
759 | 44 | Show a help message and exit. | 48 | Show a help message and exit. |
787 | 45 | .SH FILES | 49 | |
788 | 46 | .TP | 50 | # FILES |
789 | 47 | .I ibid.ini | 51 | |
790 | 48 | Locates the database to act upon by looking for the \fB[databases].ibid\fR value | 52 | *ibid.ini* |
791 | 49 | in the bot configuration file in the current directory. | 53 | : Locates the database to act upon by looking for the |
792 | 50 | .SH BUGS | 54 | [**databases**].**ibid** value in the bot configuration file in the current |
793 | 51 | \fBibid-plugin\fR doesn't emulate a complete Ibid environment, and will | 55 | directory. |
794 | 52 | ignore all of the following: | 56 | |
795 | 53 | .TP | 57 | # BUGS |
796 | 54 | * | 58 | |
797 | 55 | Delayed and periodically executed functions. | 59 | **ibid-plugin** doesn't emulate a complete Ibid environment, and will ignore |
798 | 56 | .TP | 60 | all of the following: |
799 | 57 | * | 61 | |
800 | 58 | Messages to alternate sources. | 62 | * Delayed and periodically executed functions. |
801 | 59 | .TP | 63 | * Messages to alternate sources. |
802 | 60 | * | 64 | * Messages directly dispatched, rather than added to responses. |
803 | 61 | Messages directly dispatched, rather than added to responses. | 65 | * Permissions. All permissions are granted to the user. |
804 | 62 | .TP | 66 | |
805 | 63 | * | 67 | # SEE ALSO |
806 | 64 | Permissions. | 68 | `ibid` (1), |
807 | 65 | All permissions are granted to the user. | 69 | `ibid.ini` (5), |
808 | 66 | .SH SEE ALSO | 70 | `ibid-setup` (1), |
809 | 67 | .BR ibid (1), | 71 | http://ibid.omnia.za.net/ |
783 | 68 | .BR ibid.ini (5), | ||
784 | 69 | .BR ibid-setup (1), | ||
785 | 70 | .UR http://ibid.omnia.za.net/ | ||
786 | 71 | .BR http://ibid.omnia.za.net/ | ||
810 | 72 | 72 | ||
811 | === renamed file 'man/ibid-setup.1' => 'man/ibid-setup.1.md' | |||
812 | --- man/ibid-setup.1 2010-03-08 20:27:21 +0000 | |||
813 | +++ man/ibid-setup.1.md 2010-03-20 10:39:26 +0000 | |||
814 | @@ -1,33 +1,36 @@ | |||
826 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID-SETUP(1) Ibid Multi-protocol Bot | Ibid 0.1 |
827 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
828 | 3 | .TH IBID-SETUP "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
829 | 4 | .SH NAME | 4 | |
830 | 5 | ibid-setup \- Create a basic configuration file and database for an Ibid | 5 | # NAME |
831 | 6 | bot | 6 | |
832 | 7 | .SH SYNOPSIS | 7 | ibid-setup - Create a basic configuration file and database for an Ibid bot |
833 | 8 | .B ibid-setup | 8 | |
834 | 9 | .SH DESCRIPTION | 9 | # SYNOPSIS |
835 | 10 | This program sets up everything that a new Ibid bot needs before it can | 10 | |
836 | 11 | run. | 11 | **ibid-setup** |
837 | 12 | |||
838 | 13 | # DESCRIPTION | ||
839 | 14 | |||
840 | 15 | This program sets up everything that a new Ibid bot needs before it can run. | ||
841 | 12 | It asks a series of questions about the new bot, and writes out a basic | 16 | It asks a series of questions about the new bot, and writes out a basic |
863 | 13 | configuration file - | 17 | configuration file - `ibid.ini` (5) - to the current directory. |
864 | 14 | .BR ibid.ini (5) | 18 | It also creates a database for the bot, by default a SQLite database in the |
865 | 15 | - to the current directory. | 19 | current directory. |
866 | 16 | It also creates a database for the bot, by default a SQLite database in | 20 | |
867 | 17 | the current directory. | 21 | This should be run in the directory which will become the new Ibid bot's base. |
868 | 18 | .P | 22 | |
869 | 19 | This should be run in the directory which will become the new Ibid bot's | 23 | Should there be an existing **ibid.ini** in the current directory, it will be |
870 | 20 | base. | 24 | used, and the only questions asked will be for adding an administrative user. |
871 | 21 | .P | 25 | These can safely be skipped with a **^C**. |
872 | 22 | Should there be an existing \fBibid.ini\fR in the current directory, it | 26 | |
873 | 23 | will be used, and the only questions asked will be for adding an | 27 | # FILES |
874 | 24 | administrative user. These can safely be skipped with a \fB^C\fR. | 28 | |
875 | 25 | .SH FILES | 29 | *ibid.ini* |
876 | 26 | .TP | 30 | : The Ibid bot's configuration file, will be created if it doesn't exist. |
877 | 27 | .I ibid.ini | 31 | |
878 | 28 | The Ibid bot's configuration file, will be created if it doesn't exist. | 32 | # SEE ALSO |
879 | 29 | .SH SEE ALSO | 33 | |
880 | 30 | .BR ibid (1), | 34 | `ibid` (1), |
881 | 31 | .BR ibid.ini (5), | 35 | `ibid.ini` (5), |
882 | 32 | .UR http://ibid.omnia.za.net/ | 36 | http://ibid.omnia.za.net/ |
862 | 33 | .BR http://ibid.omnia.za.net/ | ||
883 | 34 | 37 | ||
884 | === renamed file 'man/ibid.1' => 'man/ibid.1.md' | |||
885 | --- man/ibid.1 2010-03-08 20:27:21 +0000 | |||
886 | +++ man/ibid.1.md 2010-03-20 10:39:26 +0000 | |||
887 | @@ -1,32 +1,41 @@ | |||
897 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID(1) Ibid Multi-protocol Bot | Ibid 0.1 |
898 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
899 | 3 | .TH IBID "1" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
900 | 4 | .SH NAME | 4 | |
901 | 5 | ibid \- Run an Ibid bot | 5 | # NAME |
902 | 6 | .SH SYNOPSIS | 6 | |
903 | 7 | .B ibid | 7 | ibid - Run an Ibid bot |
904 | 8 | .RI [ config-file ] | 8 | |
905 | 9 | .SH DESCRIPTION | 9 | # SYNOPSIS |
906 | 10 | |||
907 | 11 | **ibid** [*config-file*] | ||
908 | 12 | |||
909 | 13 | # DESCRIPTION | ||
910 | 14 | |||
911 | 10 | This runs an Ibid bot in the foreground. | 15 | This runs an Ibid bot in the foreground. |
915 | 11 | .P | 16 | |
916 | 12 | There should there be an existing \fBibid.ini\fR (created by | 17 | There should there be an existing **ibid.ini** (created by |
917 | 13 | .BR ibid-setup (1)) | 18 | `ibid-setup` (1)) |
918 | 14 | in the current directory or one should be provided on the command line. | 19 | in the current directory or one should be provided on the command line. |
921 | 15 | .P | 20 | |
922 | 16 | Where possible, you should run \fBtwistd \-n ibid\fR instead of this | 21 | Where possible, you should run **twistd -n ibid** instead of this |
923 | 17 | program, as otherwise some classes of errors go unreported. | 22 | program, as otherwise some classes of errors go unreported. |
926 | 18 | .RB "See " BUGS . | 23 | See **BUGS**. |
927 | 19 | .SH BUGS | 24 | |
928 | 25 | # BUGS | ||
929 | 26 | |||
930 | 20 | Exceptions in twisted callbacks can go unnoticed in this program. | 27 | Exceptions in twisted callbacks can go unnoticed in this program. |
931 | 21 | That has no harmful effects, but the developers may miss out on some | 28 | That has no harmful effects, but the developers may miss out on some |
932 | 22 | good bug reports. | 29 | good bug reports. |
943 | 23 | .SH FILES | 30 | |
944 | 24 | .TP | 31 | # FILES |
945 | 25 | .I ibid.ini | 32 | |
946 | 26 | The Ibid bot's configuration file, will be created if it doesn't exist. | 33 | *ibid.ini* |
947 | 27 | .SH SEE ALSO | 34 | : The Ibid bot's configuration file, will be created if it doesn't exist. |
948 | 28 | .BR ibid.ini (5), | 35 | |
949 | 29 | .BR ibid-setup (1), | 36 | # SEE ALSO |
950 | 30 | .BR twistd (1), | 37 | |
951 | 31 | .UR http://ibid.omnia.za.net/ | 38 | `ibid.ini` (5), |
952 | 32 | .BR http://ibid.omnia.za.net/ | 39 | `ibid-setup` (1), |
953 | 40 | `twistd` (1), | ||
954 | 41 | http://ibid.omnia.za.net/ | ||
955 | 33 | 42 | ||
956 | === renamed file 'man/ibid.ini.5' => 'man/ibid.ini.5.md' | |||
957 | --- man/ibid.ini.5 2010-03-08 20:27:21 +0000 | |||
958 | +++ man/ibid.ini.5.md 2010-03-20 10:39:26 +0000 | |||
959 | @@ -1,113 +1,119 @@ | |||
966 | 1 | .\" Copyright (c) 2010, Stefano Rivera | 1 | % IBID.INI(5) Ibid Multi-protocol Bot | Ibid 0.1 |
967 | 2 | .\" Released under terms of the MIT/X/Expat Licence. See COPYING for details. | 2 | % Stefano Rivera |
968 | 3 | .TH IBID.INI "5" "March 2010" "Ibid 0.1" "Ibid - Multi-protocol Bot" | 3 | % March 2010 |
969 | 4 | .SH NAME | 4 | |
970 | 5 | ibid.ini \- Configuration file for Ibid | 5 | # NAME |
971 | 6 | .SH DESCRIPTION | 6 | |
972 | 7 | ibid.ini - Configuration file for Ibid | ||
973 | 8 | |||
974 | 9 | # DESCRIPTION | ||
975 | 10 | |||
976 | 7 | ibid.ini contains all the configuration for an Ibid bot. | 11 | ibid.ini contains all the configuration for an Ibid bot. |
978 | 8 | .P | 12 | |
979 | 9 | 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 of this |
980 | 10 | manpage. | 14 | manpage. |
990 | 11 | For more details see the Ibid documentation: | 15 | For more details see the Ibid documentation: http://ibid.omnia.za.net/docs/ |
991 | 12 | .UR http://ibid.omnia.za.net/docs/ | 16 | |
992 | 13 | .BR http://ibid.omnia.za.net/docs/ | 17 | Lines beginning with **#** are considered to be comments and ignored. |
993 | 14 | .P | 18 | To use a **#** symbol in an option (e.g. an IRC channel name), quote the |
994 | 15 | Lines beginning with \fB#\fR are considered to be comments and ignored. | 19 | option with double-quotes, e.g. **channels**=**"#ibid",** |
995 | 16 | To use a \fB#\fR symbol in an option (e.g. an IRC channel name), quote the | 20 | |
987 | 17 | option with double-quotes, e.g. | ||
988 | 18 | .BR channels = """#ibid""," | ||
989 | 19 | .P | ||
996 | 20 | This file will be written to by the bot when configuration settings are | 21 | This file will be written to by the bot when configuration settings are |
997 | 21 | altered online. | 22 | altered online. |
998 | 22 | It can also be edited manually and a running bot told to | 23 | It can also be edited manually and a running bot told to |
1000 | 23 | \fB"reload config"\fR. | 24 | **"reload config"**. |
1001 | 24 | Manual edits and comments will be preserved when the bot modifies its | 25 | Manual edits and comments will be preserved when the bot modifies its |
1002 | 25 | own configuration, provided that they have not been edited since bot | 26 | own configuration, provided that they have not been edited since bot |
1003 | 26 | start-up or the last config reload. | 27 | start-up or the last config reload. |
1006 | 27 | .SH SECTIONS | 28 | |
1007 | 28 | .SS auth | 29 | # SECTIONS |
1008 | 30 | |||
1009 | 31 | ## auth | ||
1010 | 32 | |||
1011 | 29 | Settings related to permissions and authentication. | 33 | Settings related to permissions and authentication. |
1013 | 30 | Permissions listed in \fBauth.permissions\fR are granted to all users unless | 34 | Permissions listed in **auth**.**permissions** are granted to all users unless |
1014 | 31 | revoked by source or account. | 35 | revoked by source or account. |
1016 | 32 | .SS sources | 36 | |
1017 | 37 | ## sources | ||
1018 | 38 | |||
1019 | 33 | Sources are Ibid connections to an IM service. | 39 | Sources are Ibid connections to an IM service. |
1020 | 34 | They range from IRC networks to the bot's built-in HTTP server. | 40 | They range from IRC networks to the bot's built-in HTTP server. |
1022 | 35 | .P | 41 | |
1023 | 36 | Each source is configured in a section named after the source. | 42 | Each source is configured in a section named after the source. |
1024 | 37 | The source name will define the driver that the source should use, unless a | 43 | The source name will define the driver that the source should use, unless a |
1027 | 38 | \fBtype\fR option is provided. | 44 | **type** option is provided. |
1028 | 39 | .P | 45 | |
1029 | 40 | Sources can be disabled by setting | 46 | Sources can be disabled by setting |
1032 | 41 | .BR disabled = True . | 47 | **disabled**=**True**. |
1033 | 42 | .SS plugins | 48 | |
1034 | 49 | ## plugins | ||
1035 | 50 | |||
1036 | 43 | Plugin configuration. | 51 | Plugin configuration. |
1037 | 44 | Each plugin is configured within a section named after the plugin. | 52 | Each plugin is configured within a section named after the plugin. |
1107 | 45 | .P | 53 | |
1108 | 46 | .TP | 54 | **cachedir** |
1109 | 47 | .B cachedir | 55 | : The directory that temporary files (such as downloaded data), useful to be |
1110 | 48 | The directory that temporary files (such as downloaded data), useful to be the | 56 | the bot but expendable, is stored in. |
1111 | 49 | bot but expendable, is stored in. | 57 | |
1112 | 50 | .TP | 58 | **core**.**autoload** |
1113 | 51 | .B core.autoload | 59 | : If **True**, all plugins not explicitly ignored will be loaded. |
1114 | 52 | If \fBTrue\fR, all plugins not explicitly ignored will be loaded. | 60 | (Note that some plugins mark themselves as non-auto-loadable). |
1115 | 53 | (Note that some plugins mark themselves as non-auto-loadable). | 61 | Defaults to **True**. |
1116 | 54 | Defaults to \fBTrue\fR. | 62 | |
1117 | 55 | .TP | 63 | **core**.**load** |
1118 | 56 | .B core.load | 64 | : The list of plugins (or **plugin**.**Processor**s) to load. |
1119 | 57 | The list of plugins (or \fBplugin\fR.\fBProcessor\fRs) to load. | 65 | |
1120 | 58 | .TP | 66 | **core**.**noload** |
1121 | 59 | .B core.noload | 67 | : The list of plugins (or **plugin**.**Processor**s) to ignore and not load. |
1122 | 60 | The list of plugins (or \fBplugin\fR.\fBProcessor\fRs) to ignore and not load. | 68 | |
1123 | 61 | .TP | 69 | **core**.**names** |
1124 | 62 | .B core.names | 70 | : The names that the bot should respond to. |
1125 | 63 | The names that the bot should respond to. | 71 | |
1126 | 64 | .TP | 72 | **core**.**ignore** |
1127 | 65 | .B core.ignore | 73 | : Nicks that the bot should completely ignore (e.g. other bots). |
1128 | 66 | Nicks that the bot should completely ignore (e.g. other bots). | 74 | |
1129 | 67 | .SH EXAMPLE | 75 | # EXAMPLE |
1130 | 68 | .nf | 76 | |
1131 | 69 | botname = joebot | 77 | botname = joebot |
1132 | 70 | logging = logging.ini | 78 | logging = logging.ini |
1133 | 71 | 79 | ||
1134 | 72 | [auth] | 80 | [auth] |
1135 | 73 | methods = password, | 81 | methods = password, |
1136 | 74 | timeout = 300 | 82 | timeout = 300 |
1137 | 75 | permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse | 83 | permissions = +factoid, +karma, +sendmemo, +recvmemo, +feeds, +publicresponse |
1138 | 76 | 84 | ||
1139 | 77 | [sources] | 85 | [sources] |
1140 | 78 | [[telnet]] | 86 | [[telnet]] |
1141 | 79 | [[timer]] | 87 | [[timer]] |
1142 | 80 | [[http]] | 88 | [[http]] |
1143 | 81 | url = http://joebot.example.com | 89 | url = http://joebot.example.com |
1144 | 82 | [[smtp]] | 90 | [[smtp]] |
1145 | 83 | [[pb]] | 91 | [[pb]] |
1146 | 84 | [[atrum]] | 92 | [[atrum]] |
1147 | 85 | channels = "#ibid", | 93 | channels = "#ibid", |
1148 | 86 | nick = $botname | 94 | nick = $botname |
1149 | 87 | type = irc | 95 | type = irc |
1150 | 88 | auth = hostmask, nickserv | 96 | auth = hostmask, nickserv |
1151 | 89 | server = irc.atrum.org | 97 | server = irc.atrum.org |
1152 | 90 | 98 | ||
1153 | 91 | [plugins] | 99 | [plugins] |
1154 | 92 | cachedir = /tmp/ibid | 100 | cachedir = /tmp/ibid |
1155 | 93 | [[core]] | 101 | [[core]] |
1156 | 94 | names = $botname, bot, ant | 102 | names = $botname, bot, ant |
1157 | 95 | ignore = , | 103 | ignore = , |
1158 | 96 | 104 | ||
1159 | 97 | [databases] | 105 | [databases] |
1160 | 98 | ibid = sqlite:///ibid.db | 106 | ibid = sqlite:///ibid.db |
1161 | 99 | .fi | 107 | |
1162 | 100 | .SH FILES | 108 | # FILES |
1163 | 101 | .TP | 109 | |
1164 | 102 | .I logging.ini | 110 | *logging*.*ini* |
1165 | 103 | A standard Python \fBlogging.config\fR configuration file describing | 111 | : A standard Python **logging**.**config** configuration file describing |
1166 | 104 | loggers, handlers, and formatters for log messages. | 112 | loggers, handlers, and formatters for log messages. |
1167 | 105 | See | 113 | See http://docs.python.org/library/logging.html |
1168 | 106 | .UR http://docs.python.org/library/logging.html | 114 | |
1169 | 107 | .BR http://docs.python.org/library/logging.html | 115 | # SEE ALSO |
1170 | 108 | .SH SEE ALSO | 116 | `ibid` (1), |
1171 | 109 | .BR ibid (1), | 117 | `ibid.ini` (5), |
1172 | 110 | .BR ibid.ini (5), | 118 | `twistd` (1), |
1173 | 111 | .BR twistd (1), | 119 | http://ibid.omnia.za.net/ |
1105 | 112 | .UR http://ibid.omnia.za.net/ | ||
1106 | 113 | .BR http://ibid.omnia.za.net/ |
Approved once the double-hyphen issue is fixed.