~ibid-core/ibid/trunk

« back to all changes in this revision

Viewing changes to docs/manpages/ibid-factpack.1.rst

  • Committer: Tarmac
  • Author(s): Stefano Rivera
  • Date: 2012-07-31 09:51:02 UTC
  • mfrom: (1043.2.4 sphinxdoc-man)
  • Revision ID: tarmac-20120731095102-ok97by9518vw2bum
Move manpages into Sphinx docs
Author: Stefano Rivera
Merge Request: http://code.launchpad.net/~stefanor/ibid/sphinxdoc-man/+merge/88115
Approved by: Keegan Carruthers-Smith, Jonathan Hitchcock
Fixes LP: #

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
% IBID-FACTPACK(1) Ibid Multi-protocol Bot | Ibid 0.1
2
 
% Stefano Rivera
3
 
% March 2010
4
 
 
5
 
# NAME
6
 
 
7
 
ibid-factpack - Factoid-package management utility for Ibid
8
 
 
9
 
# SYNOPSIS
10
 
 
11
 
**ibid-factpack** [**-s**] *factpack-file*  
12
 
**ibid-factpack** **-r** [**-f**] *factpack-name*  
13
 
**ibid-factpack** **-h**
14
 
 
15
 
# DESCRIPTION
16
 
 
17
 
This utility is for adding and removing sets of packaged factoids, known as
18
 
factpacks, from your Ibid's factoid database.
 
1
===============
 
2
 ibid-factpack
 
3
===============
 
4
 
 
5
SYNOPSIS
 
6
========
 
7
 
 
8
| ``ibid-factpack`` [``-s``] *factpack-file*
 
9
| ``ibid-factpack`` ``-r`` [``-f``] *factpack-name*
 
10
| ``ibid-factpack`` ``-h``
 
11
 
 
12
DESCRIPTION
 
13
===========
 
14
 
 
15
This utility is for adding and removing sets of packaged factoids, known
 
16
as factpacks, from your Ibid's factoid database.
19
17
 
20
18
The default mode is factpack loading.
21
19
The *factpack-file* specified is loaded into the bot's database.
22
 
Should the pack contain any facts with the same name as an existing fact in the
23
 
bot's database, loading will be aborted, unless the *-s* option is supplied.
24
 
 
25
 
Factpacks can be gzipped if the filename ends with **.gz**.
26
 
 
27
 
When invoked with the **-r** option, the named factpack (original import
 
20
Should the pack contain any facts with the same name as an existing fact
 
21
in the bot's database, loading will be aborted, unless the ``-s`` option
 
22
is supplied.
 
23
 
 
24
Factpacks can be gzipped if the filename ends with ``.gz``.
 
25
 
 
26
When invoked with the ``-r`` option, the named factpack (original import
28
27
filename minus the extension) will be removed from the bot.
29
 
If any of the facts contained in that pack were modified while loaded in the
30
 
bot, unloading will be aborted, unless the **-f** option is supplied.
31
 
 
32
 
# OPTIONS
33
 
 
34
 
**-r**, **-\-remove**
35
 
:       Remove the named factpack, rather than importing.
36
 
 
37
 
**-f**, **-\-force**
38
 
:       Force removal, if facts in the factpack were modified by users.
39
 
 
40
 
**-s**, **-\-skip**
41
 
:       Skip facts that clash with existing factoids, during import.
42
 
 
43
 
**-h**, **-\-help**
44
 
:       Show a help message and exit.
45
 
 
46
 
# FACTPACKS
 
28
If any of the facts contained in that pack were modified while loaded in
 
29
the bot, unloading will be aborted, unless the ``-f`` option is
 
30
supplied.
 
31
 
 
32
OPTIONS
 
33
=======
 
34
 
 
35
-r, --remove
 
36
   Remove the named factpack, rather than importing.
 
37
 
 
38
-f, --force
 
39
   Force removal, if facts in the factpack were modified by users.
 
40
 
 
41
-s, --skip
 
42
   Skip facts that clash with existing factoids, during import.
 
43
 
 
44
-h, --help
 
45
   Show a help message and exit.
 
46
 
 
47
FACTPACKS
 
48
=========
47
49
 
48
50
Factpacks are JSON-encoded text files containing a list of facts.
49
51
Each fact is a tuple of two lists: fact-names, fact-values.
50
52
The same substitutions are available as in normal online Factoids.
51
53
 
52
 
## Example:
53
 
 
54
 
        [
55
 
         [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
56
 
         [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
57
 
        ]
58
 
 
59
 
# FILES
60
 
 
61
 
*ibid.ini*
62
 
:       Locates the database to act upon by looking for the
63
 
        [**databases**].**ibid** value in the bot configuration file in the current
64
 
        directory.
65
 
 
66
 
# SEE ALSO
67
 
 
68
 
`ibid` (1),
69
 
`ibid.ini` (5),
 
54
Example:
 
55
--------
 
56
::
 
57
 
 
58
   [
 
59
    [["Hello", "Hi"], ["<reply> Hi There", "<action> waves"]],
 
60
    [["Bye"], ["<reply> kbye $who", "<reply> Cheers"]]
 
61
   ]
 
62
 
 
63
FILES
 
64
=====
 
65
 
 
66
ibid.ini
 
67
   Locates the database to act upon by looking for the
 
68
   [**databases**].\ **ibid** value in the bot configuration file in the
 
69
   current directory.
 
70
 
 
71
SEE ALSO
 
72
========
 
73
 
 
74
``ibid``\ (1),
 
75
``ibid.ini``\ (5),
70
76
http://ibid.omnia.za.net/
 
77
 
 
78
.. vi: set et sta sw=3 ts=3: