File: errbot.1

package info (click to toggle)
errbot 6.2.0%2Bds-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 3,796 kB
  • sloc: python: 11,557; makefile: 164; sh: 97
file content (67 lines) | stat: -rw-r--r-- 2,229 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH ERRBOT "1" "January 2024" "Errbot version 6.2.0" "User Commands"
.SH NAME
Errbot \- Chatbot designed to be simple to extend with plugins written in Python
.SH DESCRIPTION
usage: errbot [\-h] [\-c CONFIG] [\-v | \fB\-r\fR [RESTORE] | \fB\-l\fR | \fB\-\-new\-plugin\fR
.IP
[NEW_PLUGIN] | \fB\-i\fR [INIT] | \fB\-\-storage\-set\fR STORAGE_SET |
\fB\-\-storage\-merge\fR STORAGE_MERGE | \fB\-\-storage\-get\fR STORAGE_GET | \fB\-T\fR |
\fB\-G]\fR [\-d] [\-p PIDFILE]
.PP
The main entry point of the errbot.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-c\fR CONFIG, \fB\-\-config\fR CONFIG
Full path to your config.py (default: config.py in
current working directory).
.TP
\fB\-v\fR, \fB\-\-version\fR
show program's version number and exit
.TP
\fB\-r\fR [RESTORE], \fB\-\-restore\fR [RESTORE]
restore a bot from backup.py (default: backup.py from
the bot data directory)
.TP
\fB\-l\fR, \fB\-\-list\fR
list all available backends
.TP
\fB\-\-new\-plugin\fR [NEW_PLUGIN]
create a new plugin in the specified directory
.TP
\fB\-i\fR [INIT], \fB\-\-init\fR [INIT]
Initialize a simple bot minimal configuration in the
optionally given directory (otherwise it will be the
working directory). This will create a data
subdirectory for the bot data dir and a plugins
directory for your plugin development with an example
in it to get you started.
.TP
\fB\-\-storage\-set\fR STORAGE_SET
DANGER: Delete the given storage namespace and set the
python dictionary expression passed on stdin.
.TP
\fB\-\-storage\-merge\fR STORAGE_MERGE
DANGER: Merge in the python dictionary expression
passed on stdin into the given storage namespace.
.TP
\fB\-\-storage\-get\fR STORAGE_GET
Dump the given storage namespace in a format
compatible for \fB\-\-storage\-set\fR and \fB\-\-storage\-merge\fR.
.TP
\fB\-T\fR, \fB\-\-text\fR
force local text backend
.TP
\fB\-G\fR, \fB\-\-graphic\fR
force local graphical backend
.SS "optional daemonization arguments:"
.TP
\fB\-d\fR, \fB\-\-daemon\fR
Detach the process from the console
.TP
\fB\-p\fR PIDFILE, \fB\-\-pidfile\fR PIDFILE
Specify the pid file for the daemon (default: current
bot data directory)