Skip to content

Commit c333af9

Browse files
progvalprogval
committed
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.
1 parent 0572d49 commit c333af9

17 files changed

+399
-386
lines changed

‎man/limnoria-adduser.1

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-adduser.1
3+
.\"
4+
.TH LIMNORIA-ADDUSER 1 "APRIL 2005"
5+
.SH NAME
6+
limnoria-adduser \- Adds a user to a Limnoria users.conf file
7+
.SH SYNOPSIS
8+
.B limnoria-adduser
9+
.RI [ options ] " users.conf
10+
.SH DESCRIPTION
11+
.B limnoria-adduser
12+
adds a user to the specified users.conf file.
13+
.SH OPTIONS
14+
.TP
15+
.B \-\^\-version
16+
Show version of program.
17+
.TP
18+
.BR \-h ", " \-\^\-help
19+
Show summary of options.
20+
.TP
21+
.BR \-u " NAME" "\fR,\fP \-\^\-username=" NAME
22+
Specifies the username to use for the new user.
23+
.TP
24+
.BR \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
25+
Specifies the password to use for the new user.
26+
.TP
27+
.BR \-c " CAPABILITY" "\fR,\fP \-\^\-capability=" CAPABILITY
28+
Capability the user should have; this option may be given
29+
multiple times.
30+
.SH "SEE ALSO"
31+
.IR python (1),
32+
.IR limnoria (1),
33+
.IR limnoria-test (1),
34+
.IR limnoria-botchk (1),
35+
.IR limnoria-wizard (1),
36+
.IR limnoria-plugin-doc (1),
37+
.IR limnoria-plugin-create (1)
38+
.SH AUTHOR
39+
This manual page was originally written by James McCoy
40+
<vega dot james at gmail dot com>. Permission is granted to copy,
41+
distribute and/or modify this document under the terms of the Limnoria
42+
license, a BSD-style license.

‎man/limnoria-botchk.1

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-botchk.1
3+
.\"
4+
.TH LIMNORIA-BOTCHK 1 "APRIL 2005"
5+
.SH NAME
6+
limnoria-botchk \- A script to start Limnoria if it's not already running.
7+
.SH SYNOPSIS
8+
.B limnoria-botchk
9+
.RI [ options ]
10+
.SH DESCRIPTION
11+
.B limnoria-botchk
12+
is a script that will start Limnoria if it detects that one is not currently
13+
running. This can be useful for scheduling
14+
.IR limnoria (1)
15+
to run via
16+
.IR cron (8).
17+
.SH OPTIONS
18+
.TP
19+
.BR \-h ", " \-\^\-help
20+
Show summary of options.
21+
.TP
22+
.BR \-v ", " \-\^\-verbose
23+
Use verbose output when running the script.
24+
.TP
25+
.BI \-\^\-botdir= BOTDIR
26+
Determines which directory the bot be started in.
27+
.TP
28+
.BI \-\^\-pidfile= PIDFILE
29+
Specifies the name of the pidfile to look for. This should be relative
30+
to the given botdir.
31+
.TP
32+
.BI \-\^\-limnoria= LIMNORIA
33+
Specifies the location of
34+
.IR limnoria (1).
35+
If this is not given, it is assumed that
36+
.IR limnoria (1)
37+
is in the user's $PATH.
38+
.TP
39+
.BI \-\^\-conffile= CONFFILE
40+
Specifies the path to the bot's configuration file. This will be used
41+
when (re)starting the bot.
42+
.SH "SEE ALSO"
43+
.IR python (1),
44+
.IR limnoria (1),
45+
.IR limnoria-test (1),
46+
.IR limnoria-wizard (1),
47+
.IR limnoria-adduser (1),
48+
.IR limnoria-plugin-doc (1),
49+
.IR limnoria-plugin-create (1)
50+
.SH AUTHOR
51+
This manual page was originally written by James McCoy
52+
<vega dot james at gmail dot com>. Permission is granted to copy,
53+
distribute and/or modify this document under the terms of the Limnoria
54+
license, a BSD-style license.

‎man/limnoria-plugin-create.1

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-plugin-create.1
3+
.\"
4+
.TH LIMNORIA-PLUGIN-CREATE 1 "APRIL 2005"
5+
.SH NAME
6+
limnoria-plugin-create \- A wizard for creating Limnoria plugins
7+
.SH SYNOPSIS
8+
.B limnoria-plugin-create
9+
.RI [ options ]
10+
.SH DESCRIPTION
11+
.B limnoria-plugin-create
12+
is a wizard that creates a template python source file for a new
13+
.IR limnoria (1)
14+
plugin.
15+
.SH OPTIONS
16+
.TP
17+
.B \-\^\-version
18+
Show version of program.
19+
.TP
20+
.BR \-h ", " \-\^\-help
21+
Show summary of options.
22+
.TP
23+
.BI \-n " NAME" "\fR,\fP \-\^\-name=" NAME
24+
Sets the name for the plugin.
25+
.TP
26+
.BR \-t ", " \-\^\-thread
27+
Makes the plugin threaded.
28+
.TP
29+
.BI \-\^\-real\-name= REALNAME
30+
Specify what real name the copyright is assigned to.
31+
.SH "SEE ALSO"
32+
.IR python (1),
33+
.IR limnoria (1),
34+
.IR limnoria-test (1),
35+
.IR limnoria-botchk (1),
36+
.IR limnoria-wizard (1),
37+
.IR limnoria-adduser (1),
38+
.IR limnoria-plugin-doc (1)
39+
.SH AUTHOR
40+
This manual page was originally written by James McCoy
41+
<vega dot james at gmail dot com>. Permission is granted to copy,
42+
distribute and/or modify this document under the terms of the Limnoria
43+
license, a BSD-style license.

‎man/limnoria-plugin-doc.1

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-plugin-doc.1
3+
.\"
4+
.TH LIMNORIA-PLUGIN-DOC 1 "May 2009"
5+
.SH NAME
6+
limnoria-plugin-doc \- Generates the documentation for a Limnoria plugin
7+
.SH SYNOPSIS
8+
.B limnoria-plugin-doc
9+
.RI [ options ]
10+
.SH DESCRIPTION
11+
.B limnoria-plugin-doc
12+
is used to generate documentation (StructuredText or reStructuredText format)
13+
for a
14+
.IR limnoria (1)
15+
plugin.
16+
.SH OPTIONS
17+
.TP
18+
.B \-\^\-version
19+
Show version of program.
20+
.TP
21+
.BR \-h ", " \-\^\-help
22+
Show summary of options.
23+
.TP
24+
.BR \-c ", " \-\^\-clean
25+
Clean the various data/conf/log directories after generating the docs.
26+
.TP
27+
.BR \-o ", " \-\^\-output\-dir= \fIOUTPUTDIR
28+
Specifies the directory in which to write the documentation for the plugin.
29+
.TP
30+
.BR \-f ", " \-\^\-format= \fIFORMAT
31+
Specifies which output format to use. Choices are 'rst' or 'stx'.
32+
.TP
33+
.BI \-\^\-plugins\-dir= PLUGINSDIRS
34+
Looks in the given directory for plugins and generates documentation for all of
35+
them.
36+
.SH "SEE ALSO"
37+
.IR python (1),
38+
.IR limnoria (1),
39+
.IR limnoria-test (1),
40+
.IR limnoria-botchk (1),
41+
.IR limnoria-wizard (1),
42+
.IR limnoria-adduser (1),
43+
.IR limnoria-plugin-create (1)
44+
.SH AUTHOR
45+
This manual page was originally written by James McCoy
46+
<vega dot james at gmail dot com>. Permission is granted to copy,
47+
distribute and/or modify this document under the terms of the Limnoria
48+
license, a BSD-style license.

‎man/limnoria-reset-password.1

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-reset-password.1
3+
.\"
4+
.TH LIMNORIA-RESET-PASSWORD 1 "JUNE 2022"
5+
.SH NAME
6+
limnoria-reset-password \- Changes a user's password in a Limnoria users.conf file
7+
.SH SYNOPSIS
8+
.B limnoria-reset-password
9+
.RI [ options ] " users.conf
10+
.SH DESCRIPTION
11+
.B limnoria-reset-password
12+
changes a user's password in a Limnoria users.conf file
13+
.SH OPTIONS
14+
.TP
15+
.B \-\^\-version
16+
Show version of program.
17+
.TP
18+
.BR \-h ", " \-\^\-help
19+
Show summary of options.
20+
.TP
21+
.BR \-u " NAME" "\fR,\fP \-\^\-username=" NAME
22+
Specifies the username to use for the new user.
23+
.TP
24+
.BR \-p " PASSWORD" "\fR,\fP \-\^\-password=" PASSWORD
25+
Specifies the new password to use for the new user.
26+
.SH "SEE ALSO"
27+
.IR python (1),
28+
.IR limnoria (1),
29+
.IR limnoria-adduser (1)
30+
.SH AUTHOR
31+
This manual page was originally written by Valentin Lorentz
32+
<progval plus limnoria at progval dot net>. Permission is granted to copy,
33+
distribute and/or modify this document under the terms of the Limnoria
34+
license, a BSD-style license.
35+

‎man/limnoria-test.1

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-test.1
3+
.\"
4+
.TH LIMNORIA-TEST 1 "OCTOBER 2005"
5+
.SH NAME
6+
limnoria-test \- Runs the test suite for a Limnoria plugin
7+
.SH SYNOPSIS
8+
.B limnoria-test
9+
.RI [ options ] " plugins
10+
.SH DESCRIPTION
11+
.B limnoria-test
12+
Runs the test suite for a Limnoria plugin
13+
.SH OPTIONS
14+
.TP
15+
.B \-\^\-version
16+
Show version of program.
17+
.TP
18+
.BR \-h ", " \-\^\-help
19+
Show summary of options.
20+
.TP
21+
.BR \-c ", " \-\^\-clean
22+
Cleans the various data/conf/logs directories before running tests.
23+
.TP
24+
.BR \-t " TIMEOUT" "\fR,\fP \-\^\-timeout=" TIMEOUT
25+
Specifies the timeout for tests to return responses.
26+
.TP
27+
.BR \-v ", " \-\^\-verbose
28+
Sets the verbose flag, logging extra information about each test that runs.
29+
.TP
30+
.BR \-\^\-no\-network
31+
Prevents the network-based tests from being run.
32+
.TP
33+
.BR \-\^\-trace
34+
Traces all calls made. Unless you're really in a pinch, you probably
35+
shouldn't do this; it results in copious amounts of output.
36+
.TP
37+
.BR "\fR,\fP \-\^\-plugins\-dir=" PLUGINSDIR
38+
Looks in the given directory for plugins and loads the tests for all of them.
39+
.SH "SEE ALSO"
40+
.IR python (1),
41+
.IR limnoria (1),
42+
.IR limnoria-botchk (1),
43+
.IR limnoria-wizard (1),
44+
.IR limnoria-adduser (1),
45+
.IR limnoria-plugin-doc (1),
46+
.IR limnoria-plugin-create (1)
47+
.SH AUTHOR
48+
This manual page was originally written by James McCoy
49+
<vega dot james at gmail dot com>. Permission is granted to copy,
50+
distribute and/or modify this document under the terms of the Limnoria
51+
license, a BSD-style license.

‎man/limnoria-wizard.1

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria-wizard.1
3+
.\"
4+
.TH LIMNORIA-WIZARD 1 "SEPTEMBER 2004"
5+
.SH NAME
6+
limnoria-wizard \- A wizard for creating Limnoria configuration files
7+
.SH SYNOPSIS
8+
.B limnoria-wizard
9+
.RI [ options ]
10+
.SH DESCRIPTION
11+
.B limnoria-wizard
12+
is an in-depth wizard that provides a nice user interface for creating
13+
configuration files for
14+
.IR limnoria (1).
15+
.SH OPTIONS
16+
.TP
17+
.B \-\^\-version
18+
Show version of program.
19+
.TP
20+
.BR \-h ", " \-\^\-help
21+
Show summary of options.
22+
.TP
23+
.B \-\^\-allow\-root
24+
Determines whether the wizard will be allowed to run as root. You do not
25+
want this. Do not do it. Even if you think you want it, you do not.
26+
.TP
27+
.B \-\^\-no\-network
28+
Determines whether the wizard will be allowed to run without a network
29+
connection.
30+
.SH "SEE ALSO"
31+
.IR python (1),
32+
.IR limnoria (1),
33+
.IR limnoria-test (1),
34+
.IR limnoria-botchk (1),
35+
.IR limnoria-adduser (1),
36+
.IR limnoria-plugin-doc (1),
37+
.IR limnoria-plugin-create (1)
38+
.SH AUTHOR
39+
This manual page was originally written by James McCoy
40+
<vega dot james at gmail dot com>. Permission is granted to copy,
41+
distribute and/or modify this document under the terms of the Limnoria
42+
license, a BSD-style license.

‎man/limnoria.1

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
.\" Process this file with
2+
.\" groff -man -Tascii limnoria.1
3+
.\"
4+
.TH LIMNORIA 1 "JULY 2009"
5+
.SH NAME
6+
limnoria - A robust and user friendly Python IRC bot
7+
.SH SYNOPSIS
8+
.B limnoria
9+
.RI [ options ] " configFile
10+
.SH DESCRIPTION
11+
.B Limnoria
12+
is a robust, user-friendly, and programmer-friendly Python IRC bot.
13+
It aims to be an adequate replacement for most existing IRC bots. It
14+
includes a very flexible and powerful ACL system for controlling access
15+
to commands, as well as more than 50 builtin plugins providing around
16+
400 actual commands.
17+
.SH OPTIONS
18+
.TP
19+
.B \-\^\-version
20+
Show version of program.
21+
.TP
22+
.BR \-h ", " \-\^\-help
23+
Show summary of options.
24+
.TP
25+
.BR \-P ", " \-\^\-profile
26+
Enable profiling.
27+
.TP
28+
.BI \-n " NICK" "\fR,\fP \-\^\-nick=" NICK
29+
Nick the bot should use.
30+
.TP
31+
.BI \-u " USER" "\fR,\fP \-\^\-user=" USER
32+
Full username the bot should use.
33+
.TP
34+
.BI \-i " IDENT" "\fR,\fP \-\^\-ident=" IDENT
35+
Ident the bot should use.
36+
.TP
37+
.BR \-d ", " \-\^\-daemon
38+
Determines whether the bot will daemonize. This is a no-op on
39+
non-POSIX systems.
40+
.TP
41+
.B \-\^\-allow\-default\-owner
42+
Determines whether the bot will allow its defaultCapabilities not to
43+
include "\-owner", thus giving all users the owner capability by
44+
default. This is dumb, hence we require a command-line option to
45+
enable it.
46+
.TP
47+
.B \-\^\-allow\-root
48+
Determines whether the bot will be allowed to run as root. You do not
49+
want this. Do not do it. Even if you think you want it, you do not.
50+
.TP
51+
.B \-\^\-debug
52+
Determines whether some extra debugging stuff will be logged by this
53+
script.
54+
.SH "SEE ALSO"
55+
.IR python (1),
56+
.IR limnoria-test (1),
57+
.IR limnoria-botchk (1),
58+
.IR limnoria-wizard (1),
59+
.IR limnoria-adduser (1),
60+
.IR limnoria-plugin-doc (1),
61+
.IR limnoria-plugin-create (1)
62+
.SH AUTHOR
63+
This manual page was originally written by James McCoy
64+
<vega dot james at gmail dot com>. Permission is granted to copy,
65+
distribute and/or modify this document under the terms of the Limnoria
66+
license, a BSD-style license.

0 commit comments

Comments
 (0)