mirror of https://github.com/Mikaela/Limnoria.git
Commit the proper supybot.1
This commit is contained in:
James Vega
parent
23397b44b4
commit
020b672c14
|
|
@ -1,127 +1,72 @@
|
||||||
.\" $Header$
|
.\" Process this file with
|
||||||
|
.\" groff -man -Tascii supybot.1
|
||||||
.\"
|
.\"
|
||||||
.\" transcript compatibility for postscript use.
|
.TH SUPYBOT 1 "SEPTEMBER 2004"
|
||||||
.\"
|
.SH NAME
|
||||||
.\" synopsis: .P! <file.ps>
|
supybot \- A robust and user friendly Python IRC bot
|
||||||
.\"
|
.SH SYNOPSIS
|
||||||
.de P!
|
.B supybot
|
||||||
.fl
|
.RI [ options ] " configFile
|
||||||
\!!1 setgray
|
.SH DESCRIPTION
|
||||||
.fl
|
.B
|
||||||
\\&.\"
|
Supybot
|
||||||
.fl
|
is a robust, user\-friendly, and programmer\-friendly Python IRC bot.
|
||||||
\!!0 setgray
|
It aims to be an adequate replacement for most existing IRC bots. It
|
||||||
.fl \" force out current output buffer
|
includes a very flexible and powerful ACL system for controlling access
|
||||||
\!!save /psv exch def currentpoint translate 0 0 moveto
|
to commands, as well as more than 50 builtin plugins providing around
|
||||||
\!!/showpage{}def
|
400 actual commands.
|
||||||
.fl \" prolog
|
.SH OPTIONS
|
||||||
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
|
.TP
|
||||||
\!!psv restore
|
.B \-\^\-version
|
||||||
.
|
Show version of program.
|
||||||
.de pF
|
.TP
|
||||||
.ie \\*(f1 .ds f1 \\n(.f
|
.BR \-h ", " \-\^\-help
|
||||||
.el .ie \\*(f2 .ds f2 \\n(.f
|
Show summary of options.
|
||||||
.el .ie \\*(f3 .ds f3 \\n(.f
|
.TP
|
||||||
.el .ie \\*(f4 .ds f4 \\n(.f
|
.BR \-P ", " \-\^\-profile
|
||||||
.el .tm ? font overflow
|
Enable profiling.
|
||||||
.ft \\$1
|
.TP
|
||||||
..
|
.B \-O
|
||||||
.de fP
|
Optimizes asserts out of the code; \-O0 optimizes asserts and uses
|
||||||
.ie !\\*(f4 \{\
|
.IR psyco .
|
||||||
. ft \\*(f4
|
.TP
|
||||||
. ds f4\"
|
.BI \-n " NICK" "\fR,\fP \-\^\-nick=" NICK
|
||||||
' br \}
|
Nick the bot should use.
|
||||||
.el .ie !\\*(f3 \{\
|
.TP
|
||||||
. ft \\*(f3
|
.BI \-u " USER" "\fR,\fP \-\^\-user=" USER
|
||||||
. ds f3\"
|
Full username the bot should use.
|
||||||
' br \}
|
.TP
|
||||||
.el .ie !\\*(f2 \{\
|
.BI \-i " IDENT" "\fR,\fP \-\^\-ident=" IDENT
|
||||||
. ft \\*(f2
|
Ident the bot should use.
|
||||||
. ds f2\"
|
.TP
|
||||||
' br \}
|
.BR \-d ", " \-\^\-daemon
|
||||||
.el .ie !\\*(f1 \{\
|
Determines whether the bot will daemonize. This is a no\-op on
|
||||||
. ft \\*(f1
|
non\-POSIX systems.
|
||||||
. ds f1\"
|
.TP
|
||||||
' br \}
|
.B \-\^\-allow\-eval
|
||||||
.el .tm ? font underflow
|
Determines whether the bot will allow the evaluation of arbitrary
|
||||||
..
|
Python code.
|
||||||
.ds f1\"
|
.TP
|
||||||
.ds f2\"
|
.B \-\^\-allow\-default\-owner
|
||||||
.ds f3\"
|
Determines whether the bot will allow its defaultCapabilities not to
|
||||||
.ds f4\"
|
include "\-owner", thus giving all users the owner capability by
|
||||||
'\" t
|
default. This is dumb, hence we require a command\-line option to
|
||||||
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
|
enable it.
|
||||||
.TH "SUPYBOT" "1"
|
.TP
|
||||||
.SH "NAME"
|
.B \-\^\-allow\-root
|
||||||
supybot \(em A robust and user friendly Python IRC bot
|
Determines whether the bot will be allowed to run as root. You do not
|
||||||
.SH "SYNOPSIS"
|
want this. Do not do it. Even if you think you want it, you do not.
|
||||||
.PP
|
.TP
|
||||||
\fBsupybot\fR [\fBoptions\fP] \fIconfigFile\fR
|
.B \-\^\-debug
|
||||||
.SH "DESCRIPTION"
|
Determines whether some extra debugging stuff will be logged by this
|
||||||
.PP
|
script.
|
||||||
\fBsupybot\fR is a robust, user\-friendly,
|
.SH "SEE ALSO"
|
||||||
and programmer\-friendly Python IRC bot. It aims to be an adequate
|
.IR python (1),
|
||||||
replacement for most existing IRC bots. It includes a very
|
.IR supybot\-wizard (1),
|
||||||
flexible and poerful ACL system for controlling access to
|
.IR supybot\-adduser (1),
|
||||||
commands, as well as more than 50 builtin plugins providing
|
.IR supybot\-newplugin (1)
|
||||||
around 400 actual commands.
|
.SH AUTHOR
|
||||||
|
This manual page was originally written by James Vega
|
||||||
.SH "OPTIONS"
|
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||||
.PP
|
distribute and/or modify this document under the terms of the Supybot
|
||||||
These programs follow the usual GNU command line syntax,
|
license, a BSD\-style license.
|
||||||
with long options starting with two dashes (\`\-\'). A summary of
|
|
||||||
options is included below.
|
|
||||||
|
|
||||||
.IP "\fB\-\-version\fP" 10
|
|
||||||
Show version of program.
|
|
||||||
.IP "\fB\-h\fP \fB\-\-help\fP " 10
|
|
||||||
Show summary of options.
|
|
||||||
.IP "\fB\-P\fP \fB\-\-profile\fP " 10
|
|
||||||
Enable profiling.
|
|
||||||
.IP "\fB\-O\fP" 10
|
|
||||||
Optimizes asserts out of the code; \-O0 optimizes asserts
|
|
||||||
and uses psyco.
|
|
||||||
|
|
||||||
.IP "\fB\-nNICK\fP \fB\-\-nick=NICK\fP " 10
|
|
||||||
Nick the bot should use.
|
|
||||||
.IP "\fB\-uUSER\fP \fB\-\-user=USER\fP " 10
|
|
||||||
Full username the bot should use.
|
|
||||||
.IP "\fB\-iIDENT\fP \fB\-\-ident=IDENT\fP " 10
|
|
||||||
Ident the bot should use.
|
|
||||||
.IP "\fB\-d\fP \fB\-\-daemon\fP " 10
|
|
||||||
Determines whether the bot will daemonize. This is a
|
|
||||||
no-op on non-POSIX systems.
|
|
||||||
|
|
||||||
.IP "\fB\-\-allow-eval\fP" 10
|
|
||||||
Determines whether the bot will allow the evaluation
|
|
||||||
of arbitrary Python code.
|
|
||||||
|
|
||||||
.IP "\fB\-\-allow-default-owner\fP" 10
|
|
||||||
Determines whether the bot will allow its defaultCapabilities
|
|
||||||
not to include "-owner", thus giving all users the owner capability
|
|
||||||
by default. This is dumb, hence we require a command-line option.
|
|
||||||
|
|
||||||
.IP "\fB\-\-allow-root\fP" 10
|
|
||||||
Determines whether the bot will be allowed to run as root. You
|
|
||||||
don't want this. Don't do it. Even if you think you want it, you don't.
|
|
||||||
|
|
||||||
.IP "\fB\-\-debug\fP" 10
|
|
||||||
Determines whether some extra debugging stuff will be logged by
|
|
||||||
this script.
|
|
||||||
|
|
||||||
.SH "SEE ALSO"
|
|
||||||
.PP
|
|
||||||
python (1), supybot-wizard (1), supybot-adduser (1),
|
|
||||||
supybot\-newplugin (1).
|
|
||||||
.SH "AUTHOR"
|
|
||||||
.PP
|
|
||||||
This manual page was originally written by Jonathan Hseu vomjom@debian.org for
|
|
||||||
the \fBDebian\fP system (but may be used by others). Permission is
|
|
||||||
granted to copy, distribute and/or modify this document under
|
|
||||||
the terms of the Supybot license, a BSD\-style license.
|
|
||||||
|
|
||||||
.PP
|
|
||||||
On Debian systems with Supybot installed, the complete text
|
|
||||||
of the Supybot license can be found in /usr/share/doc/supybot/LICENSE
|
|
||||||
|
|
||||||
.\" created by instant / docbook-to-man, Mon 13 Sep 2004, 13:44
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue