mirror of https://github.com/progval/Limnoria.git
Add alternative name 'limnoria-' in addition to 'supybot-*' for scripts
The 'supybot-*' variants will be deprecated in a year or two, to give distributions time to provide the new names before updating install/usage documentation.
This commit is contained in:
parent
0572d49988
commit
c333af9a44
|
|
@ -0,0 +1,42 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-adduser.1
|
||||
.\"
|
||||
.TH LIMNORIA-ADDUSER 1 "APRIL 2005"
|
||||
.SH NAME
|
||||
limnoria-adduser \- Adds a user to a Limnoria users.conf file
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-adduser
|
||||
.RI [ options ] " users.conf
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-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 \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
|
||||
Specifies the password to use for the new user.
|
||||
.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 limnoria (1),
|
||||
.IR limnoria-test (1),
|
||||
.IR limnoria-botchk (1),
|
||||
.IR limnoria-wizard (1),
|
||||
.IR limnoria-plugin-doc (1),
|
||||
.IR limnoria-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-botchk.1
|
||||
.\"
|
||||
.TH LIMNORIA-BOTCHK 1 "APRIL 2005"
|
||||
.SH NAME
|
||||
limnoria-botchk \- A script to start Limnoria if it's not already running.
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-botchk
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-botchk
|
||||
is a script that will start Limnoria if it detects that one is not currently
|
||||
running. This can be useful for scheduling
|
||||
.IR limnoria (1)
|
||||
to run via
|
||||
.IR cron (8).
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BR \-v ", " \-\^\-verbose
|
||||
Use verbose output when running the script.
|
||||
.TP
|
||||
.BI \-\^\-botdir= BOTDIR
|
||||
Determines which directory the bot be started in.
|
||||
.TP
|
||||
.BI \-\^\-pidfile= PIDFILE
|
||||
Specifies the name of the pidfile to look for. This should be relative
|
||||
to the given botdir.
|
||||
.TP
|
||||
.BI \-\^\-limnoria= LIMNORIA
|
||||
Specifies the location of
|
||||
.IR limnoria (1).
|
||||
If this is not given, it is assumed that
|
||||
.IR limnoria (1)
|
||||
is in the user's $PATH.
|
||||
.TP
|
||||
.BI \-\^\-conffile= CONFFILE
|
||||
Specifies the path to the bot's configuration file. This will be used
|
||||
when (re)starting the bot.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR limnoria (1),
|
||||
.IR limnoria-test (1),
|
||||
.IR limnoria-wizard (1),
|
||||
.IR limnoria-adduser (1),
|
||||
.IR limnoria-plugin-doc (1),
|
||||
.IR limnoria-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-plugin-create.1
|
||||
.\"
|
||||
.TH LIMNORIA-PLUGIN-CREATE 1 "APRIL 2005"
|
||||
.SH NAME
|
||||
limnoria-plugin-create \- A wizard for creating Limnoria plugins
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-plugin-create
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-plugin-create
|
||||
is a wizard that creates a template python source file for a new
|
||||
.IR limnoria (1)
|
||||
plugin.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-\^\-version
|
||||
Show version of program.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BI \-n " NAME" "\fR,\fP \-\^\-name=" NAME
|
||||
Sets the name for the plugin.
|
||||
.TP
|
||||
.BR \-t ", " \-\^\-thread
|
||||
Makes the plugin threaded.
|
||||
.TP
|
||||
.BI \-\^\-real\-name= REALNAME
|
||||
Specify what real name the copyright is assigned to.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR limnoria (1),
|
||||
.IR limnoria-test (1),
|
||||
.IR limnoria-botchk (1),
|
||||
.IR limnoria-wizard (1),
|
||||
.IR limnoria-adduser (1),
|
||||
.IR limnoria-plugin-doc (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-plugin-doc.1
|
||||
.\"
|
||||
.TH LIMNORIA-PLUGIN-DOC 1 "May 2009"
|
||||
.SH NAME
|
||||
limnoria-plugin-doc \- Generates the documentation for a Limnoria plugin
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-plugin-doc
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-plugin-doc
|
||||
is used to generate documentation (StructuredText or reStructuredText format)
|
||||
for a
|
||||
.IR limnoria (1)
|
||||
plugin.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-\^\-version
|
||||
Show version of program.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BR \-c ", " \-\^\-clean
|
||||
Clean the various data/conf/log directories after generating the docs.
|
||||
.TP
|
||||
.BR \-o ", " \-\^\-output\-dir= \fIOUTPUTDIR
|
||||
Specifies the directory in which to write the documentation for the plugin.
|
||||
.TP
|
||||
.BR \-f ", " \-\^\-format= \fIFORMAT
|
||||
Specifies which output format to use. Choices are 'rst' or 'stx'.
|
||||
.TP
|
||||
.BI \-\^\-plugins\-dir= PLUGINSDIRS
|
||||
Looks in the given directory for plugins and generates documentation for all of
|
||||
them.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR limnoria (1),
|
||||
.IR limnoria-test (1),
|
||||
.IR limnoria-botchk (1),
|
||||
.IR limnoria-wizard (1),
|
||||
.IR limnoria-adduser (1),
|
||||
.IR limnoria-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-reset-password.1
|
||||
.\"
|
||||
.TH LIMNORIA-RESET-PASSWORD 1 "JUNE 2022"
|
||||
.SH NAME
|
||||
limnoria-reset-password \- Changes a user's password in a Limnoria users.conf file
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-reset-password
|
||||
.RI [ options ] " users.conf
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-reset-password
|
||||
changes a user's password in a Limnoria 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 \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
|
||||
Specifies the new password to use for the new user.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR limnoria (1),
|
||||
.IR limnoria-adduser (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by Valentin Lorentz
|
||||
<progval plus limnoria at progval dot net>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-test.1
|
||||
.\"
|
||||
.TH LIMNORIA-TEST 1 "OCTOBER 2005"
|
||||
.SH NAME
|
||||
limnoria-test \- Runs the test suite for a Limnoria plugin
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-test
|
||||
.RI [ options ] " plugins
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-test
|
||||
Runs the test suite for a Limnoria plugin
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-\^\-version
|
||||
Show version of program.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BR \-c ", " \-\^\-clean
|
||||
Cleans the various data/conf/logs directories before running tests.
|
||||
.TP
|
||||
.BR \-t " TIMEOUT" "\fR,\fP \-\^\-timeout=" TIMEOUT
|
||||
Specifies the timeout for tests to return responses.
|
||||
.TP
|
||||
.BR \-v ", " \-\^\-verbose
|
||||
Sets the verbose flag, logging extra information about each test that runs.
|
||||
.TP
|
||||
.BR \-\^\-no\-network
|
||||
Prevents the network-based tests from being run.
|
||||
.TP
|
||||
.BR \-\^\-trace
|
||||
Traces all calls made. Unless you're really in a pinch, you probably
|
||||
shouldn't do this; it results in copious amounts of output.
|
||||
.TP
|
||||
.BR "\fR,\fP \-\^\-plugins\-dir=" PLUGINSDIR
|
||||
Looks in the given directory for plugins and loads the tests for all of them.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR limnoria (1),
|
||||
.IR limnoria-botchk (1),
|
||||
.IR limnoria-wizard (1),
|
||||
.IR limnoria-adduser (1),
|
||||
.IR limnoria-plugin-doc (1),
|
||||
.IR limnoria-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria-wizard.1
|
||||
.\"
|
||||
.TH LIMNORIA-WIZARD 1 "SEPTEMBER 2004"
|
||||
.SH NAME
|
||||
limnoria-wizard \- A wizard for creating Limnoria configuration files
|
||||
.SH SYNOPSIS
|
||||
.B limnoria-wizard
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B limnoria-wizard
|
||||
is an in-depth wizard that provides a nice user interface for creating
|
||||
configuration files for
|
||||
.IR limnoria (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 limnoria (1),
|
||||
.IR limnoria-test (1),
|
||||
.IR limnoria-botchk (1),
|
||||
.IR limnoria-adduser (1),
|
||||
.IR limnoria-plugin-doc (1),
|
||||
.IR limnoria-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii limnoria.1
|
||||
.\"
|
||||
.TH LIMNORIA 1 "JULY 2009"
|
||||
.SH NAME
|
||||
limnoria - A robust and user friendly Python IRC bot
|
||||
.SH SYNOPSIS
|
||||
.B limnoria
|
||||
.RI [ options ] " configFile
|
||||
.SH DESCRIPTION
|
||||
.B Limnoria
|
||||
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
|
||||
.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 limnoria-test (1),
|
||||
.IR limnoria-botchk (1),
|
||||
.IR limnoria-wizard (1),
|
||||
.IR limnoria-adduser (1),
|
||||
.IR limnoria-plugin-doc (1),
|
||||
.IR limnoria-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Limnoria
|
||||
license, a BSD-style license.
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot-adduser.1
|
||||
.\"
|
||||
.TH SUPYBOT-ADDUSER 1 "APRIL 2005"
|
||||
.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 \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
|
||||
Specifies the password to use for the new user.
|
||||
.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-test (1),
|
||||
.IR supybot-botchk (1),
|
||||
.IR supybot-wizard (1),
|
||||
.IR supybot-plugin-doc (1),
|
||||
.IR supybot-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-adduser.1
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot-botchk.1
|
||||
.\"
|
||||
.TH SUPYBOT-BOTCHK 1 "APRIL 2005"
|
||||
.SH NAME
|
||||
supybot-botchk \- A script to start Supybot if it's not already running.
|
||||
.SH SYNOPSIS
|
||||
.B supybot-botchk
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B supybot-botchk
|
||||
is a script that will start Supybot if it detects that one is not currently
|
||||
running. This can be useful for scheduling
|
||||
.IR supybot (1)
|
||||
to run via
|
||||
.IR cron (8).
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BR \-v ", " \-\^\-verbose
|
||||
Use verbose output when running the script.
|
||||
.TP
|
||||
.BI \-\^\-botdir= BOTDIR
|
||||
Determines which directory the bot be started in.
|
||||
.TP
|
||||
.BI \-\^\-pidfile= PIDFILE
|
||||
Specifies the name of the pidfile to look for. This should be relative
|
||||
to the given botdir.
|
||||
.TP
|
||||
.BI \-\^\-supybot= SUPYBOT
|
||||
Specifies the location of
|
||||
.IR supybot (1).
|
||||
If this is not given, it is assumed that
|
||||
.IR supybot (1)
|
||||
is in the user's $PATH.
|
||||
.TP
|
||||
.BI \-\^\-conffile= CONFFILE
|
||||
Specifies the path to the bot's configuration file. This will be used
|
||||
when (re)starting the bot.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR supybot (1),
|
||||
.IR supybot-test (1),
|
||||
.IR supybot-wizard (1),
|
||||
.IR supybot-adduser (1),
|
||||
.IR supybot-plugin-doc (1),
|
||||
.IR supybot-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-botchk.1
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot-plugin-create.1
|
||||
.\"
|
||||
.TH SUPYBOT-PLUGIN-CREATE 1 "APRIL 2005"
|
||||
.SH NAME
|
||||
supybot-plugin-create \- A wizard for creating Supybot plugins
|
||||
.SH SYNOPSIS
|
||||
.B supybot-plugin-create
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B supybot-plugin-create
|
||||
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
|
||||
.BI \-n " NAME" "\fR,\fP \-\^\-name=" NAME
|
||||
Sets the name for the plugin.
|
||||
.TP
|
||||
.BR \-t ", " \-\^\-thread
|
||||
Makes the plugin threaded.
|
||||
.TP
|
||||
.BI \-\^\-real\-name= REALNAME
|
||||
Specify what real name the copyright is assigned to.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR supybot (1),
|
||||
.IR supybot-test (1),
|
||||
.IR supybot-botchk (1),
|
||||
.IR supybot-wizard (1),
|
||||
.IR supybot-adduser (1),
|
||||
.IR supybot-plugin-doc (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-plugin-create.1
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot-plugin-doc.1
|
||||
.\"
|
||||
.TH SUPYBOT-PLUGIN-DOC 1 "May 2009"
|
||||
.SH NAME
|
||||
supybot-plugin-doc \- Generates the documentation for a Supybot plugin
|
||||
.SH SYNOPSIS
|
||||
.B supybot-plugin-doc
|
||||
.RI [ options ]
|
||||
.SH DESCRIPTION
|
||||
.B supybot-plugin-doc
|
||||
is used to generate documentation (StructuredText or reStructuredText format)
|
||||
for a
|
||||
.IR supybot (1)
|
||||
plugin.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-\^\-version
|
||||
Show version of program.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BR \-c ", " \-\^\-clean
|
||||
Clean the various data/conf/log directories after generating the docs.
|
||||
.TP
|
||||
.BR \-o ", " \-\^\-output\-dir= \fIOUTPUTDIR
|
||||
Specifies the directory in which to write the documentation for the plugin.
|
||||
.TP
|
||||
.BR \-f ", " \-\^\-format= \fIFORMAT
|
||||
Specifies which output format to use. Choices are 'rst' or 'stx'.
|
||||
.TP
|
||||
.BI \-\^\-plugins\-dir= PLUGINSDIRS
|
||||
Looks in the given directory for plugins and generates documentation for all of
|
||||
them.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR supybot (1),
|
||||
.IR supybot-test (1),
|
||||
.IR supybot-botchk (1),
|
||||
.IR supybot-wizard (1),
|
||||
.IR supybot-adduser (1),
|
||||
.IR supybot-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-plugin-doc.1
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot-reset-password.1
|
||||
.\"
|
||||
.TH SUPYBOT-RESET-PASSWORD 1 "JUNE 2022"
|
||||
.SH NAME
|
||||
supybot-reset-password \- Changes a user's password in a Supybot users.conf file
|
||||
.SH SYNOPSIS
|
||||
.B supybot-reset-password
|
||||
.RI [ options ] " users.conf
|
||||
.SH DESCRIPTION
|
||||
.B supybot-reset-password
|
||||
changes a user's password in a Supybot 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 \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
|
||||
Specifies the new password to use for the new user.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR supybot (1),
|
||||
.IR supybot-adduser (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by Valentin Lorentz
|
||||
<progval plus limnoria at progval dot net>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-reset-password.1
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot-test.1
|
||||
.\"
|
||||
.TH SUPYBOT-TEST 1 "OCTOBER 2005"
|
||||
.SH NAME
|
||||
supybot-test \- Runs the test suite for a Supybot plugin
|
||||
.SH SYNOPSIS
|
||||
.B supybot-test
|
||||
.RI [ options ] " plugins
|
||||
.SH DESCRIPTION
|
||||
.B supybot-test
|
||||
Runs the test suite for a Supybot plugin
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-\^\-version
|
||||
Show version of program.
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Show summary of options.
|
||||
.TP
|
||||
.BR \-c ", " \-\^\-clean
|
||||
Cleans the various data/conf/logs directories before running tests.
|
||||
.TP
|
||||
.BR \-t " TIMEOUT" "\fR,\fP \-\^\-timeout=" TIMEOUT
|
||||
Specifies the timeout for tests to return responses.
|
||||
.TP
|
||||
.BR \-v ", " \-\^\-verbose
|
||||
Sets the verbose flag, logging extra information about each test that runs.
|
||||
.TP
|
||||
.BR \-\^\-no\-network
|
||||
Prevents the network-based tests from being run.
|
||||
.TP
|
||||
.BR \-\^\-trace
|
||||
Traces all calls made. Unless you're really in a pinch, you probably
|
||||
shouldn't do this; it results in copious amounts of output.
|
||||
.TP
|
||||
.BR "\fR,\fP \-\^\-plugins\-dir=" PLUGINSDIR
|
||||
Looks in the given directory for plugins and loads the tests for all of them.
|
||||
.SH "SEE ALSO"
|
||||
.IR python (1),
|
||||
.IR supybot (1),
|
||||
.IR supybot-botchk (1),
|
||||
.IR supybot-wizard (1),
|
||||
.IR supybot-adduser (1),
|
||||
.IR supybot-plugin-doc (1),
|
||||
.IR supybot-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-test.1
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
.\" 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-test (1),
|
||||
.IR supybot-botchk (1),
|
||||
.IR supybot-adduser (1),
|
||||
.IR supybot-plugin-doc (1),
|
||||
.IR supybot-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria-wizard.1
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
.\" Process this file with
|
||||
.\" groff -man -Tascii supybot.1
|
||||
.\"
|
||||
.TH SUPYBOT 1 "JULY 2009"
|
||||
.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
|
||||
.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-test (1),
|
||||
.IR supybot-botchk (1),
|
||||
.IR supybot-wizard (1),
|
||||
.IR supybot-adduser (1),
|
||||
.IR supybot-plugin-doc (1),
|
||||
.IR supybot-plugin-create (1)
|
||||
.SH AUTHOR
|
||||
This manual page was originally written by James McCoy
|
||||
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the Supybot
|
||||
license, a BSD-style license.
|
||||
|
|
@ -0,0 +1 @@
|
|||
limnoria.1
|
||||
15
setup.py
15
setup.py
|
|
@ -217,15 +217,20 @@ setup(
|
|||
|
||||
entry_points={
|
||||
'console_scripts': [
|
||||
'supybot%s = supybot.scripts.limnoria%s:main'
|
||||
% (name, name.replace('-', '_'))
|
||||
'%s%s = supybot.scripts.limnoria%s:main'
|
||||
% (prefix, name, name.replace('-', '_'))
|
||||
for name in scripts
|
||||
for prefix in ('supybot', 'limnoria')
|
||||
]
|
||||
},
|
||||
|
||||
data_files=(
|
||||
[('share/man/man1', ['man/supybot%s.1' % name]) for name in scripts]
|
||||
),
|
||||
data_files=[
|
||||
('share/man/man1', [
|
||||
'man/%s%s.1' % (prefix, name)
|
||||
for name in scripts
|
||||
for prefix in ('supybot', 'limnoria')
|
||||
]),
|
||||
],
|
||||
)
|
||||
|
||||
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|
||||
|
|
|
|||
Loading…
Reference in New Issue