Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-26 20:59:27 +01:00
Code Issues Projects Releases Wiki Activity

Some more man page updates.

Browse Source
This commit is contained in:
James Vega 2005-04-04 04:58:26 +00:00
parent e691c94ba2
commit 27d835e1f6
5 changed files with 62 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/man/supybot-adduser.1
View File

@ -1,15 +1,14 @@
.\" Process this file with .\" Process this file with
.\" groff -man -Tascii supybot-adduser.1 .\" groff -man -Tascii supybot-adduser.1
.\" .\"
.TH SUPYBOT\-ADDUSER 1 "APRIL 2005" .TH SUPYBOT-ADDUSER 1 "APRIL 2005"
.SH NAME .SH NAME
supybot\-adduser \- Adds a user to a Supybot users.conf file supybot-adduser \- Adds a user to a Supybot users.conf file
.SH SYNOPSIS .SH SYNOPSIS
.B supybot\-adduser .B supybot-adduser
.RI [ options ] " users.conf .RI [ options ] " users.conf
.SH DESCRIPTION .SH DESCRIPTION
.B .B supybot-adduser
supybot\-adduser
adds a user to the specified users.conf file. adds a user to the specified users.conf file.
.SH OPTIONS .SH OPTIONS
.TP .TP
@ -37,13 +36,13 @@ multiple times.
.SH "SEE ALSO" .SH "SEE ALSO"
.IR python (1), .IR python (1),
.IR supybot (1), .IR supybot (1),
.IR supybot\-test (1), .IR supybot-test (1),
.IR supybot\-botchk (1), .IR supybot-botchk (1),
.IR supybot\-wizard (1), .IR supybot-wizard (1),
.IR supybot\-plugin\-doc (1), .IR supybot-plugin-doc (1),
.IR supybot\-plugin\-create (1) .IR supybot-plugin-create (1)
.SH AUTHOR .SH AUTHOR
This manual page was originally written by James Vega This manual page was originally written by James Vega
<vega dot james at gmail dot com>. Permission is granted to copy, <vega dot james at gmail dot com>. Permission is granted to copy,
distribute and/or modify this document under the terms of the Supybot distribute and/or modify this document under the terms of the Supybot
license, a BSD\-style license. license, a BSD-style license.

35
docs/man/supybot-botchk.1
View File

@ -1,18 +1,17 @@
.\" Process this file with .\" Process this file with
.\" groff -man -Tascii supybot-botchk.1 .\" groff -man -Tascii supybot-botchk.1
.\" .\"
.TH SUPYBOT\-BOTCHK 1 "APRIL 2005" .TH SUPYBOT-BOTCHK 1 "APRIL 2005"
.SH NAME .SH NAME
supybot\-botchk \- A script to start Supybot if it's not already running. supybot-botchk \- A script to start Supybot if it's not already running.
.SH SYNOPSIS .SH SYNOPSIS
.B supybot\-botchk .B supybot-botchk
.RI [ options ] .RI [ options ]
.SH DESCRIPTION .SH DESCRIPTION
.B .B supybot-botchk
supybot\-botchk
is a script that will start Supybot if it detects that one is not currently is a script that will start Supybot if it detects that one is not currently
running. This can be useful for scheduling running. This can be useful for scheduling
.IR supybot .IR supybot (1)
to run via to run via
.IR cron (8). .IR cron (8).
.SH OPTIONS .SH OPTIONS
@ -23,33 +22,33 @@ Show summary of options.
.BR \-v ", " \-\^\-verbose .BR \-v ", " \-\^\-verbose
Use verbose output when running the script. Use verbose output when running the script.
.TP .TP
.BI \-\^\-botdir=" BOTDIR .BI \-\^\-botdir= BOTDIR
Determines which directory the bot be started in. Determines which directory the bot be started in.
.TP .TP
.BI \-\^\-pidfile=" PIDFILE .BI \-\^\-pidfile= PIDFILE
Specifies the name of the pidfile to look for. This should be relative Specifies the name of the pidfile to look for. This should be relative
to the given botdir. to the given botdir.
.TP .TP
.BI \-\^\-supybot=" SUPYBOT .BI \-\^\-supybot= SUPYBOT
Specifies the location of Specifies the location of
.IR supybot (1). .IR supybot (1).
If this is not given, it is assumed that If this is not given, it is assumed that
.IR supybot (1) .IR supybot (1)
is in the user's $PATH. is in the user's $PATH.
.TP .TP
.BI \-\^\-conffile=" CONFFILE .BI \-\^\-conffile= CONFFILE
Specifies the path to the bot's configuration file. This will be used Specifies the path to the bot's configuration file. This will be used
when (re)starting the bot. when (re)starting the bot.
.SH "SEE ALSO" .SH "SEE ALSO"
.IR python (1), .IR python (1),
.IR supybot (1), .IR supybot (1),
.IR supybot\-test (1), .IR supybot-test (1),
.IR supybot\-wizard (1), .IR supybot-wizard (1),
.IR supybot\-adduser (1), .IR supybot-adduser (1),
.IR supybot\-plugin\-doc (1), .IR supybot-plugin-doc (1),
.IR supybot\-plugin\-create (1) .IR supybot-plugin-create (1)
.SH AUTHOR .SH AUTHOR
This manual page was originally written by James Vega This manual page was originally written by James Vega
<vega dot james at gmail dot com>. Permission is granted to copy, <vega dot james at gmail dot com>. Permission is granted to copy,
distribute and/or modify this document under the terms of the Supybot distribute and/or modify this document under the terms of the Supybot
license, a BSD\-style license. license, a BSD-style license.

23
docs/man/supybot-plugin-create.1
View File

@ -1,15 +1,14 @@
.\" Process this file with .\" Process this file with
.\" groff -man -Tascii supybot-plugin-create.1 .\" groff -man -Tascii supybot-plugin-create.1
.\" .\"
.TH SUPYBOT\-PLUGIN\-CREATE 1 "APRIL 2005" .TH SUPYBOT-PLUGIN-CREATE 1 "APRIL 2005"
.SH NAME .SH NAME
supybot\-plugin\-create \- A wizard for creating Supybot plugins supybot-plugin-create \- A wizard for creating Supybot plugins
.SH SYNOPSIS .SH SYNOPSIS
.B supybot\-plugin\-create .B supybot-plugin-create
.RI [ options ] .RI [ options ]
.SH DESCRIPTION .SH DESCRIPTION
.B .B supybot-plugin-create
supybot\-plugin\-create
is a wizard that creates a template python source file for a new is a wizard that creates a template python source file for a new
.IR supybot (1) .IR supybot (1)
plugin. plugin.
@ -27,18 +26,18 @@ Sets the name for the plugin.
.BR \-t ", " \-\^\-thread .BR \-t ", " \-\^\-thread
Makes the plugin threaded. Makes the plugin threaded.
.TP .TP
.BI \-\^\-real-name=" REALNAME .BI \-\^\-real\-name= REALNAME
Specify what real name the copyright is assigned to. Specify what real name the copyright is assigned to.
.SH "SEE ALSO" .SH "SEE ALSO"
.IR python (1), .IR python (1),
.IR supybot (1), .IR supybot (1),
.IR supybot\-test (1), .IR supybot-test (1),
.IR supybot\-botchk (1), .IR supybot-botchk (1),
.IR supybot\-wizard (1), .IR supybot-wizard (1),
.IR supybot\-adduser (1), .IR supybot-adduser (1),
.IR supybot\-plugin\-doc (1) .IR supybot-plugin-doc (1)
.SH AUTHOR .SH AUTHOR
This manual page was originally written by James Vega This manual page was originally written by James Vega
<vega dot james at gmail dot com>. Permission is granted to copy, <vega dot james at gmail dot com>. Permission is granted to copy,
distribute and/or modify this document under the terms of the Supybot distribute and/or modify this document under the terms of the Supybot
license, a BSD\-style license. license, a BSD-style license.

23
docs/man/supybot-wizard.1
View File

@ -1,16 +1,15 @@
.\" Process this file with .\" Process this file with
.\" groff -man -Tascii supybot-wizard.1 .\" groff -man -Tascii supybot-wizard.1
.\" .\"
.TH SUPYBOT\-WIZARD 1 "SEPTEMBER 2004" .TH SUPYBOT-WIZARD 1 "SEPTEMBER 2004"
.SH NAME .SH NAME
supybot\-wizard \- A wizard for creating Supybot configuration files supybot-wizard \- A wizard for creating Supybot configuration files
.SH SYNOPSIS .SH SYNOPSIS
.B supybot\-wizard .B supybot-wizard
.RI [ options ] .RI [ options ]
.SH DESCRIPTION .SH DESCRIPTION
.B .B supybot-wizard
supybot\-wizard is an in-depth wizard that provides a nice user interface for creating
is an in\-depth wizard that provides a nice user interface for creating
configuration files for configuration files for
.IR supybot (1). .IR supybot (1).
.SH OPTIONS .SH OPTIONS
@ -31,13 +30,13 @@ connection.
.SH "SEE ALSO" .SH "SEE ALSO"
.IR python (1), .IR python (1),
.IR supybot (1), .IR supybot (1),
.IR supybot\-test (1), .IR supybot-test (1),
.IR supybot\-botchk (1), .IR supybot-botchk (1),
.IR supybot\-adduser (1), .IR supybot-adduser (1),
.IR supybot\-plugin\-doc (1), .IR supybot-plugin-doc (1),
.IR supybot\-plugin\-create (1) .IR supybot-plugin-create (1)
.SH AUTHOR .SH AUTHOR
This manual page was originally written by James Vega This manual page was originally written by James Vega
<vega dot james at gmail dot com>. Permission is granted to copy, <vega dot james at gmail dot com>. Permission is granted to copy,
distribute and/or modify this document under the terms of the Supybot distribute and/or modify this document under the terms of the Supybot
license, a BSD\-style license. license, a BSD-style license.

27
docs/man/supybot.1
View File

@ -8,9 +8,8 @@ supybot \- A robust and user friendly Python IRC bot
.B supybot .B supybot
.RI [ options ] " configFile .RI [ options ] " configFile
.SH DESCRIPTION .SH DESCRIPTION
.B .B Supybot
Supybot is a robust, user-friendly, and programmer-friendly Python IRC bot.
is a robust, user\-friendly, and programmer\-friendly Python IRC bot.
It aims to be an adequate replacement for most existing IRC bots. It It aims to be an adequate replacement for most existing IRC bots. It
includes a very flexible and powerful ACL system for controlling access includes a very flexible and powerful ACL system for controlling access
to commands, as well as more than 50 builtin plugins providing around to commands, as well as more than 50 builtin plugins providing around
@ -40,13 +39,13 @@ Full username the bot should use.
Ident the bot should use. Ident the bot should use.
.TP .TP
.BR \-d ", " \-\^\-daemon .BR \-d ", " \-\^\-daemon
Determines whether the bot will daemonize. This is a no\-op on Determines whether the bot will daemonize. This is a no-op on
non\-POSIX systems. non-POSIX systems.
.TP .TP
.B \-\^\-allow\-default\-owner .B \-\^\-allow\-default\-owner
Determines whether the bot will allow its defaultCapabilities not to Determines whether the bot will allow its defaultCapabilities not to
include "\-owner", thus giving all users the owner capability by include "-owner", thus giving all users the owner capability by
default. This is dumb, hence we require a command\-line option to default. This is dumb, hence we require a command-line option to
enable it. enable it.
.TP .TP
.B \-\^\-allow\-root .B \-\^\-allow\-root
@ -58,14 +57,14 @@ Determines whether some extra debugging stuff will be logged by this
script. script.
.SH "SEE ALSO" .SH "SEE ALSO"
.IR python (1), .IR python (1),
.IR supybot\-test (1), .IR supybot-test (1),
.IR supybot\-botchk (1), .IR supybot-botchk (1),
.IR supybot\-wizard (1), .IR supybot-wizard (1),
.IR supybot\-adduser (1), .IR supybot-adduser (1),
.IR supybot\-plugin\-doc (1), .IR supybot-plugin-doc (1),
.IR supybot\-plugin\-create (1) .IR supybot-plugin-create (1)
.SH AUTHOR .SH AUTHOR
This manual page was originally written by James Vega This manual page was originally written by James Vega
<vega dot james at gmail dot com>. Permission is granted to copy, <vega dot james at gmail dot com>. Permission is granted to copy,
distribute and/or modify this document under the terms of the Supybot distribute and/or modify this document under the terms of the Supybot
license, a BSD\-style license. license, a BSD-style license.