diff --git a/docs/man/supybot-adduser.1 b/docs/man/supybot-adduser.1 new file mode 100644 index 000000000..f360adc79 --- /dev/null +++ b/docs/man/supybot-adduser.1 @@ -0,0 +1,43 @@ +.\" Process this file with +.\" groff -man -Tascii supybot-adduser.1 +.\" +.TH SUPYBOT\-ADDUSER 1 "SEPTEMBER 2004" +.SH NAME +supybot\-adduser \- Adds a user to a Supybot users.conf file +.SH SYNOPSIS +.B supybot\-adduser +.RI [ options ] " users.conf +.SH DESCRIPTION +.B +supybot\-adduser +adds a user to the specified users.conf file. +.SH OPTIONS +.TP +.B \-\^\-version +Show version of program. +.TP +.BR \-h ", " \-\^\-help +Show summary of options. +.TP +.BR \-u " NAME" "\fR,\fP \-\^\-username=" NAME +Specifies the username to use for the new user. +.TP +.BR \-x ", " \-\^\-hashed +Hash encrypt the password. +.TP +.BR \-n ", " \-\^\-plain +Store the password in plain text. +.TP +.BR \-c " CAPABILITY" "\fR,\fP \-\^\-capability=" CAPABILITY +Capability the user should have; this option may be given +multiple times. +.SH "SEE ALSO" +.IR python (1), +.IR supybot (1), +.IR supybot\-wizard (1), +.IR supybot\-newplugin (1) +.SH AUTHOR +This manual page was originally written by James Vega +. Permission is granted to copy, +distribute and/or modify this document under the terms of the Supybot +license, a BSD\-style license. diff --git a/docs/man/supybot-newplugin.1 b/docs/man/supybot-newplugin.1 new file mode 100644 index 000000000..25dedbd7f --- /dev/null +++ b/docs/man/supybot-newplugin.1 @@ -0,0 +1,41 @@ +.\" Process this file with +.\" groff -man -Tascii supybot-newplugin.1 +.\" +.TH SUPYBOT\-NEWPLUGIN 1 "SEPTEMBER 2004" +.SH NAME +supybot\-newplugin \- A wizard for creating Supybot plugins +.SH SYNOPSIS +.B supybot\-newplugin +.RI [ options ] +.SH DESCRIPTION +.B +supybot\-newplugin +is a wizard that creates a template python source file for a new +.IR supybot (1) +plugin. +.SH OPTIONS +.TP +.B \-\^\-version +Show version of program. +.TP +.BR \-h ", " \-\^\-help +Show summary of options. +.TP +.BR \-r ", " \-\^\-regexp +Uses a regexp\-based callback. +.TP +.BI \-n " NAME" "\fR,\fP \-\^\-name=" NAME +Sets the name for the plugin. +.TP +.BR \-t ", " \-\^\-thread +Makes the plugin threaded. +.SH "SEE ALSO" +.IR python (1), +.IR supybot (1), +.IR supybot\-wizard (1), +.IR supybot\-adduser (1), +.SH AUTHOR +This manual page was originally written by James Vega +. Permission is granted to copy, +distribute and/or modify this document under the terms of the Supybot +license, a BSD\-style license. diff --git a/docs/man/supybot-wizard.1 b/docs/man/supybot-wizard.1 new file mode 100644 index 000000000..b5c2d3b7c --- /dev/null +++ b/docs/man/supybot-wizard.1 @@ -0,0 +1,40 @@ +.\" Process this file with +.\" groff -man -Tascii supybot-wizard.1 +.\" +.TH SUPYBOT\-WIZARD 1 "SEPTEMBER 2004" +.SH NAME +supybot\-wizard \- A wizard for creating Supybot configuration files +.SH SYNOPSIS +.B supybot\-wizard +.RI [ options ] +.SH DESCRIPTION +.B +supybot\-wizard +is an in\-depth wizard that provides a nice user interface for creating +configuration files for +.IR supybot (1). +.SH OPTIONS +.TP +.B \-\^\-version +Show version of program. +.TP +.BR \-h ", " \-\^\-help +Show summary of options. +.TP +.B \-\^\-allow\-root +Determines whether the wizard 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 \-\^\-no\-network +Determines whether the wizard will be allowed to run without a network +connection. +.SH "SEE ALSO" +.IR python (1), +.IR supybot (1), +.IR supybot\-adduser (1), +.IR supybot\-newplugin (1) +.SH AUTHOR +This manual page was originally written by James Vega +. Permission is granted to copy, +distribute and/or modify this document under the terms of the Supybot +license, a BSD\-style license. diff --git a/docs/man/supybot.1 b/docs/man/supybot.1 new file mode 100644 index 000000000..a6312187e --- /dev/null +++ b/docs/man/supybot.1 @@ -0,0 +1,68 @@ +.\" Process this file with +.\" groff -man -Tascii supybot.1 +.\" +.TH SUPYBOT 1 "SEPTEMBER 2004" +.SH NAME +supybot \- A robust and user friendly Python IRC bot +.SH SYNOPSIS +.B supybot +.RI [ options ] " configFile +.SH DESCRIPTION +.B +Supybot +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 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 +.B \-O +Optimizes asserts out of the code; \-O0 optimizes asserts and uses +.IR psyco . +.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 +Determines whether the bot will daemonize. This is a no\-op on +non\-POSIX systems. +.TP +.B \-\^\-allow\-default\-owner +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 to +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), +.IR supybot\-wizard (1), +.IR supybot\-adduser (1), +.IR supybot\-newplugin (1) +.SH AUTHOR +This manual page was originally written by James Vega +. Permission is granted to copy, +distribute and/or modify this document under the terms of the Supybot +license, a BSD\-style license.