2005-04-03 16:35:54 +02:00
|
|
|
.\" Process this file with
|
|
|
|
|
.\" groff -man -Tascii supybot.1
|
|
|
|
|
.\"
|
2005-04-04 05:14:35 +02:00
|
|
|
.TH SUPYBOT 1 "APRIL 2005"
|
2005-04-03 16:35:54 +02:00
|
|
|
.SH NAME
|
|
|
|
|
supybot \- A robust and user friendly Python IRC bot
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B supybot
|
|
|
|
|
.RI [ options ] " configFile
|
|
|
|
|
.SH DESCRIPTION
|
2005-04-04 06:58:26 +02:00
|
|
|
.B Supybot
|
|
|
|
|
is a robust, user-friendly, and programmer-friendly Python IRC bot.
|
2005-04-03 16:35:54 +02:00
|
|
|
It aims to be an adequate replacement for most existing IRC bots. It
|
|
|
|
|
includes a very flexible and powerful ACL system for controlling access
|
|
|
|
|
to commands, as well as more than 50 builtin plugins providing around
|
|
|
|
|
400 actual commands.
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
.B \-\^\-version
|
|
|
|
|
Show version of program.
|
|
|
|
|
.TP
|
|
|
|
|
.BR \-h ", " \-\^\-help
|
|
|
|
|
Show summary of options.
|
|
|
|
|
.TP
|
|
|
|
|
.BR \-P ", " \-\^\-profile
|
|
|
|
|
Enable profiling.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-n " NICK" "\fR,\fP \-\^\-nick=" NICK
|
|
|
|
|
Nick the bot should use.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-u " USER" "\fR,\fP \-\^\-user=" USER
|
|
|
|
|
Full username the bot should use.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-i " IDENT" "\fR,\fP \-\^\-ident=" IDENT
|
|
|
|
|
Ident the bot should use.
|
|
|
|
|
.TP
|
|
|
|
|
.BR \-d ", " \-\^\-daemon
|
2005-04-04 06:58:26 +02:00
|
|
|
Determines whether the bot will daemonize. This is a no-op on
|
|
|
|
|
non-POSIX systems.
|
2005-04-03 16:35:54 +02:00
|
|
|
.TP
|
|
|
|
|
.B \-\^\-allow\-default\-owner
|
|
|
|
|
Determines whether the bot will allow its defaultCapabilities not to
|
2005-04-04 06:58:26 +02:00
|
|
|
include "-owner", thus giving all users the owner capability by
|
|
|
|
|
default. This is dumb, hence we require a command-line option to
|
2005-04-03 16:35:54 +02:00
|
|
|
enable it.
|
|
|
|
|
.TP
|
|
|
|
|
.B \-\^\-allow\-root
|
|
|
|
|
Determines whether the bot will be allowed to run as root. You do not
|
|
|
|
|
want this. Do not do it. Even if you think you want it, you do not.
|
|
|
|
|
.TP
|
|
|
|
|
.B \-\^\-debug
|
|
|
|
|
Determines whether some extra debugging stuff will be logged by this
|
|
|
|
|
script.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.IR python (1),
|
2005-04-04 06:58:26 +02:00
|
|
|
.IR supybot-test (1),
|
|
|
|
|
.IR supybot-botchk (1),
|
|
|
|
|
.IR supybot-wizard (1),
|
|
|
|
|
.IR supybot-adduser (1),
|
|
|
|
|
.IR supybot-plugin-doc (1),
|
|
|
|
|
.IR supybot-plugin-create (1)
|
2005-04-03 16:35:54 +02:00
|
|
|
.SH AUTHOR
|
|
|
|
|
This manual page was originally written by James Vega
|
|
|
|
|
<vega dot james at gmail dot com>. Permission is granted to copy,
|
|
|
|
|
distribute and/or modify this document under the terms of the Supybot
|
2005-04-04 06:58:26 +02:00
|
|
|
license, a BSD-style license.
|
