Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-02 17:29:22 +01:00
Code Issues Projects Releases Wiki Activity

Commit the proper supybot.1

Browse Source
This commit is contained in:
James Vega 2004-09-20 15:59:56 +00:00
parent 23397b44b4
commit 020b672c14
1 changed files with 71 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

183
docs/man/supybot.1
View File

@ -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
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "SUPYBOT" "1"
.SH "NAME"
supybot \(em A robust and user friendly Python IRC bot
.SH "SYNOPSIS"
.PP
\fBsupybot\fR [\fBoptions\fP] \fIconfigFile\fR
.SH "DESCRIPTION"
.PP
\fBsupybot\fR is a robust, user\-friendly,
and programmer\-friendly Python IRC bot. It aims to be an adequate
replacement for most existing IRC bots. It includes a very
flexible and poerful ACL system for controlling access to
commands, as well as more than 50 builtin plugins providing
around 400 actual commands.
.SH "OPTIONS"
.PP
These programs follow the usual GNU command line syntax,
with long options starting with two dashes (\`\-\'). A summary of
options is included below.
.IP "\fB\-\-version\fP" 10
Show version of program. Show version of program.
.IP "\fB\-h\fP \fB\-\-help\fP " 10 .TP
.BR \-h ", " \-\^\-help
Show summary of options. Show summary of options.
.IP "\fB\-P\fP \fB\-\-profile\fP " 10 .TP
.BR \-P ", " \-\^\-profile
Enable profiling. Enable profiling.
.IP "\fB\-O\fP" 10 .TP
Optimizes asserts out of the code; \-O0 optimizes asserts .B \-O
and uses psyco. Optimizes asserts out of the code; \-O0 optimizes asserts and uses
.IR psyco .
.IP "\fB\-nNICK\fP \fB\-\-nick=NICK\fP " 10 .TP
.BI \-n " NICK" "\fR,\fP \-\^\-nick=" NICK
Nick the bot should use. Nick the bot should use.
.IP "\fB\-uUSER\fP \fB\-\-user=USER\fP " 10 .TP
.BI \-u " USER" "\fR,\fP \-\^\-user=" USER
Full username the bot should use. Full username the bot should use.
.IP "\fB\-iIDENT\fP \fB\-\-ident=IDENT\fP " 10 .TP
.BI \-i " IDENT" "\fR,\fP \-\^\-ident=" IDENT
Ident the bot should use. Ident the bot should use.
.IP "\fB\-d\fP \fB\-\-daemon\fP " 10 .TP
Determines whether the bot will daemonize. This is a .BR \-d ", " \-\^\-daemon
no-op on non-POSIX systems. Determines whether the bot will daemonize. This is a no\-op on
non\-POSIX systems.
.IP "\fB\-\-allow-eval\fP" 10 .TP
Determines whether the bot will allow the evaluation .B \-\^\-allow\-eval
of arbitrary Python code. Determines whether the bot will allow the evaluation of arbitrary
Python code.
.IP "\fB\-\-allow-default-owner\fP" 10 .TP
Determines whether the bot will allow its defaultCapabilities .B \-\^\-allow\-default\-owner
not to include "-owner", thus giving all users the owner capability Determines whether the bot will allow its defaultCapabilities not to
by default. This is dumb, hence we require a command-line option. include "\-owner", thus giving all users the owner capability by
default. This is dumb, hence we require a command\-line option to
.IP "\fB\-\-allow-root\fP" 10 enable it.
Determines whether the bot will be allowed to run as root. You .TP
don't want this. Don't do it. Even if you think you want it, you don't. .B \-\^\-allow\-root
Determines whether the bot will be allowed to run as root. You do not
.IP "\fB\-\-debug\fP" 10 want this. Do not do it. Even if you think you want it, you do not.
Determines whether some extra debugging stuff will be logged by .TP
this script. .B \-\^\-debug
Determines whether some extra debugging stuff will be logged by this
script.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .IR python (1),
python (1), supybot-wizard (1), supybot-adduser (1), .IR supybot\-wizard (1),
supybot\-newplugin (1). .IR supybot\-adduser (1),
.SH "AUTHOR" .IR supybot\-newplugin (1)
.PP .SH AUTHOR
This manual page was originally written by Jonathan Hseu vomjom@debian.org for This manual page was originally written by James Vega
the \fBDebian\fP system (but may be used by others). Permission is <vega dot james at gmail dot com>. Permission is granted to copy,
granted to copy, distribute and/or modify this document under distribute and/or modify this document under the terms of the Supybot
the terms of the Supybot license, a BSD\-style license. 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