Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-30 06:49:24 +01:00
Code Issues Projects Releases Wiki Activity

The DocBook man pages that were being generated were crap, so I wrote our

Browse Source 
man pages from scratch.
This commit is contained in:
James Vega 2004-09-20 02:55:13 +00:00
parent 7f22a1c9b6
commit 48812da866
8 changed files with 139 additions and 1043 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

183
docs/DocBook/man/supybot-adduser.sgml
View File

@ -1,183 +0,0 @@
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Jonathan</firstname>">
<!ENTITY dhsurname "<surname>Hseu</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>August 27, 2004</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>vomjom@debian.org</email>">
<!ENTITY dhusername "Jonathan Hseu">
<!ENTITY dhucpackage "<refentrytitle>SUPYBOT-ADDUSER</refentrytitle>">
<!ENTITY dhpackage "supybot-adduser">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Adds a user to a Supybot configuration file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>options</option></arg>
<arg choice="req"><replaceable>users.conf</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> adds a user to a Supybot
configuration file.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-uNAME</option>
<option>--username=NAME</option>
</term>
<listitem>
<para>Username for the user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-pPASSWORD</option>
<option>--password=PASSWORD</option>
</term>
<listitem>
<para>Password for the user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option>
<option>--hashed</option>
</term>
<listitem>
<para>Hash encrypt the password.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>
<option>--plain</option>
</term>
<listitem>
<para>Store the password in plain text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-cCAPABILITY</option>
<option>--capability=CAPABILITY</option>
</term>
<listitem>
<para>Capability the user should have; this option may be
given multiple times</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>python (1), supybot-wizard (1), supybot (1),
supybot-newplugin (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was originally written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
</para>
<para>
On Debian systems with Supybot installed, the complete text
of the supybot license can be found in /usr/share/doc/supybot/LICENSE
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

165
docs/DocBook/man/supybot-newplugin.sgml
View File

@ -1,165 +0,0 @@
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Jonathan</firstname>">
<!ENTITY dhsurname "<surname>Hseu</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>August 27, 2004</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>vomjom@debian.org</email>">
<!ENTITY dhusername "Jonathan Hseu">
<!ENTITY dhucpackage "<refentrytitle>SUPYBOT-NEWPLUGIN</refentrytitle>">
<!ENTITY dhpackage "supybot-newplugin">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>A wizard for creating Supybot plugins</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>options</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> is a wizard that creates a template
python source file for a new plugin.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option>
<option>--regexp</option>
</term>
<listitem>
<para>Uses a regexp-based callback.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-nNAME</option>
<option>--name=NAME</option>
</term>
<listitem>
<para>Sets the name for the plugin.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--thread</option>
</term>
<listitem>
<para>Makes the plugin threaded.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>python (1), supybot-wizard (1), supybot-adduser (1),
supybot (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was originally written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
</para>
<para>
On Debian systems with Supybot installed, the complete text
of the supybot license can be found in /usr/share/doc/supybot/LICENSE
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

159
docs/DocBook/man/supybot-wizard.sgml
View File

@ -1,159 +0,0 @@
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Jonathan</firstname>">
<!ENTITY dhsurname "<surname>Hseu</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>August 27, 2004</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>vomjom@debian.org</email>">
<!ENTITY dhusername "Jonathan Hseu">
<!ENTITY dhucpackage "<refentrytitle>SUPYBOT-WIZARD</refentrytitle>">
<!ENTITY dhpackage "supybot-wizard">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>A wizard for creating configuration files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>options</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> is an in-depth wizard that provides
a nice user interface for creating configuration files for
<command>supybot</command>.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-root</option></term>
<listitem>
<para>Determines whether the wizard will be allowed to run
as root. You don't want this. Don't do it. Even if you
think you want it, you don't.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-network</option></term>
<listitem>
<para>Determines whether the wizard will be allowed to run
without a network connection.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>python (1), supybot (1), supybot-adduser (1),
supybot-newplugin (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was originally written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
</para>
<para>
On Debian systems with Supybot installed, the complete text
of the Supybot license can be found in /usr/share/doc/supybot/LICENSE
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

230
docs/DocBook/man/supybot.sgml
View File

@ -1,230 +0,0 @@
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Jonathan</firstname>">
<!ENTITY dhsurname "<surname>Hseu</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>August 27, 2004</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>vomjom@debian.org</email>">
<!ENTITY dhusername "Jonathan Hseu">
<!ENTITY dhucpackage "<refentrytitle>SUPYBOT</refentrytitle>">
<!ENTITY dhpackage "supybot">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>A robust and user friendly Python IRC bot</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>options</option></arg>
<arg choice="req"><replaceable>configFile</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> 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 poerful ACL system for controlling access to
commands, as well as more than 50 builtin plugins providing
around 400 actual commands.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.
</para>
<variablelist>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-P</option>
<option>--profile</option>
</term>
<listitem>
<para>Enable profiling.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-O</option></term>
<listitem>
<para>Optimizes asserts out of the code; -O0 optimizes asserts
and uses psyco.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-nNICK</option>
<option>--nick=NICK</option>
</term>
<listitem>
<para>Nick the bot should use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-uUSER</option>
<option>--user=USER</option>
</term>
<listitem>
<para>Full username the bot should use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-iIDENT</option>
<option>--ident=IDENT</option>
</term>
<listitem>
<para>Ident the bot should use. </para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option>
<option>--daemon</option>
</term>
<listitem>
<para>Determines whether the bot will daemonize. This is a
no-op on non-POSIX systems.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-eval</option></term>
<listitem>
<para>Determines whether the bot will allow the evaluation
of arbitrary Python code.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-default-owner</option></term>
<listitem>
<para>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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-root</option></term>
<listitem>
<para>Determines whether the bot will be allowed to run as root. You
don't want this. Don't do it. Even if you think you want it, you don't.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>Determines whether some extra debugging stuff will be logged by
this script.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>python (1), supybot-wizard (1), supybot-adduser (1),
supybot-newplugin (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was originally written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
</para>
<para>
On Debian systems with Supybot installed, the complete text
of the Supybot license can be found in /usr/share/doc/supybot/LICENSE
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

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

@ -1,99 +1,43 @@
.\" $Header$ .\" Process this file with
.\" groff -man -Tascii supybot-adduser.1
.\" .\"
.\" transcript compatibility for postscript use. .TH SUPYBOT\-ADDUSER 1 "SEPTEMBER 2004"
.\" .SH NAME
.\" synopsis: .P! <file.ps> supybot\-adduser \- Adds a user to a Supybot users.conf file
.\" .SH SYNOPSIS
.de P! .B supybot\-adduser
.fl .RI [ options ] users.conf
\!!1 setgray .SH DESCRIPTION
.fl .B
\\&.\" supybot\-adduser
.fl adds a user to the specified users.conf file.
\!!0 setgray .SH OPTIONS
.fl \" force out current output buffer .TP
\!!save /psv exch def currentpoint translate 0 0 moveto .B \-\^\-version
\!!/showpage{}def Show version of program.
.fl \" prolog .TP
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file .BR \-h ", " \-\^\-help
\!!psv restore Show summary of options.
. .TP
.de pF .BR \-u " NAME" \fR,\fP \-\^\-username= " NAME
.ie \\*(f1 .ds f1 \\n(.f Specifies the username to use for the new user.
.el .ie \\*(f2 .ds f2 \\n(.f .TP
.el .ie \\*(f3 .ds f3 \\n(.f .BR \-x ", " \-\^\-hashed
.el .ie \\*(f4 .ds f4 \\n(.f Hash encrypt the password.
.el .tm ? font overflow .TP
.ft \\$1 .BR \-n ", " \-\^\-plain
.. Store the password in plain text.
.de fP .TP
.ie !\\*(f4 \{\ .BR \-c " CAPABILITY" \fR,\fP \-\^\-capability= " CAPABILITY
. ft \\*(f4 Capability the user should have; this option may be given
. ds f4\" multiple times.
' br \} .SH "SEE ALSO"
.el .ie !\\*(f3 \{\ .IR python (1),
. ft \\*(f3 .IR supybot (1),
. ds f3\" .IR supybot\-wizard (1),
' br \} .IR supybot\-newplugin (1)
.el .ie !\\*(f2 \{\ .SH AUTHOR
. ft \\*(f2 This manual page was originally written by James Vega
. ds f2\" <vega dot james at gmail dot com>. Permission is granted to copy,
' br \} distribute and/or modify this document under the terms of the Supybot
.el .ie !\\*(f1 \{\ license, a BSD\-style license.
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "SUPYBOT-ADDUSER" "1"
.SH "NAME"
supybot-adduser \(em Adds a user to a Supybot configuration file
.SH "SYNOPSIS"
.PP
\fBsupybot-adduser\fR [\fB\options\fP] \fIusers.conf\fR
.SH "DESCRIPTION"
.PP
\fBsupybot-adduser\fR adds a user to a Supybot
configuration file.
.SH "OPTIONS"
.PP
These programs follow the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.
.IP "\fB\--version\fP " 10
Show version of program.
.IP "\fB\-h\fP \fB\--help\fP " 10
Show summary of options.
.IP "\fB\-uNAME\fP \fB\--username=NAME\fP " 10
Username for the user.
.IP "\fB\-pPASSWORD\fP \fB\--password=PASSWORD\fP " 10
Password for the user.
.IP "\fB\-x\fP \fB\--hashed\fP " 10
Hash encrypt the password.
.IP "\fB\-n\fP \fB\--plain\fP " 10
Store the password in plain text.
.IP "\fB\-cCAPABILITY\fP \fB\--capability=CAPABILITY\fP " 10
Capability the user should have; this option may be
given multiple times
.SH "SEE ALSO"
.PP
python (1), supybot-wizard (1), supybot (1),
supybot-newplugin (1).
.SH "AUTHOR"
.PP
This manual page was originally written by Jonathan Hseu vomjom@debian.org for
the \fBDebian\fP system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
.PP
On Debian systems with Supybot installed, the complete text
of the supybot license can be found in /usr/share/doc/supybot/LICENSE
.\" created by instant / docbook-to-man, Mon 13 Sep 2004, 13:44

133
docs/man/supybot-newplugin.1
View File

@ -1,94 +1,41 @@
.\" $Header$ .\" Process this file with
.\" groff -man -Tascii supybot-newplugin.1
.\" .\"
.\" transcript compatibility for postscript use. .TH SUPYBOT\-NEWPLUGIN 1 "SEPTEMBER 2004"
.\" .SH NAME
.\" synopsis: .P! <file.ps> supybot\-newplugin \- A wizard for creating Supybot plugins
.\" .SH SYNOPSIS
.de P! .B supybot\-newplugin
.fl .RI [ options ]
\!!1 setgray .SH DESCRIPTION
.fl .B
\\&.\" supybot\-newplugin
.fl is a wizard that creates a template python source file for a new
\!!0 setgray .IR supybot (1)
.fl \" force out current output buffer plugin.
\!!save /psv exch def currentpoint translate 0 0 moveto .SH OPTIONS
\!!/showpage{}def .TP
.fl \" prolog .B \-\^\-version
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file Show version of program.
\!!psv restore .TP
. .BR \-h ", " \-\^\-help
.de pF Show summary of options.
.ie \\*(f1 .ds f1 \\n(.f .TP
.el .ie \\*(f2 .ds f2 \\n(.f .BR \-r ", " \-\^\-regexp
.el .ie \\*(f3 .ds f3 \\n(.f Uses a regexp\-based callback.
.el .ie \\*(f4 .ds f4 \\n(.f .TP
.el .tm ? font overflow .BI \-n " NAME" "\fR,\fP \-\^\-name=" NAME
.ft \\$1 Sets the name for the plugin.
.. .TP
.de fP .BR \-t ", " \-\^\-thread
.ie !\\*(f4 \{\ Makes the plugin threaded.
. ft \\*(f4 .SH "SEE ALSO"
. ds f4\" .IR python (1),
' br \} .IR supybot (1),
.el .ie !\\*(f3 \{\ .IR supybot\-wizard (1),
. ft \\*(f3 .IR supybot\-adduser (1),
. ds f3\" .SH AUTHOR
' br \} This manual page was originally written by James Vega
.el .ie !\\*(f2 \{\ <vega dot james at gmail dot com>. Permission is granted to copy,
. ft \\*(f2 distribute and/or modify this document under the terms of the Supybot
. ds f2\" license, a BSD\-style license.
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "SUPYBOT-NEWPLUGIN" "1"
.SH "NAME"
supybot-newplugin \(em A wizard for creating Supybot plugins
.SH "SYNOPSIS"
.PP
\fBsupybot-newplugin\fR [\fB\options\fP]
.SH "DESCRIPTION"
.PP
\fBsupybot-newplugin\fR is a wizard that creates a template
python source file for a new plugin.
.SH "OPTIONS"
.PP
These programs follow the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.
.IP "\fB\--version\fP " 10
Show version of program.
.IP "\fB\-h\fP \fB\--help\fP " 10
Show summary of options.
.IP "\fB\-r\fP \fB\--regexp\fP " 10
Uses a regexp-based callback.
.IP "\fB\-nNAME\fP \fB\--name=NAME\fP " 10
Sets the name for the plugin.
.IP "\fB\-t\fP \fB\--thread\fP " 10
Makes the plugin threaded.
.SH "SEE ALSO"
.PP
python (1), supybot-wizard (1), supybot-adduser (1),
supybot (1).
.SH "AUTHOR"
.PP
This manual page was originally written by Jonathan Hseu vomjom@debian.org for
the \fBDebian\fP system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
.PP
On Debian systems with Supybot installed, the complete text
of the supybot license can be found in /usr/share/doc/supybot/LICENSE
.\" created by instant / docbook-to-man, Mon 13 Sep 2004, 13:44

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

@ -1,98 +1,40 @@
.\" $Header$ .\" Process this file with
.\" groff -man -Tascii supybot-wizard.1
.\" .\"
.\" transcript compatibility for postscript use. .TH SUPYBOT\-WIZARD 1 "SEPTEMBER 2004"
.\" .SH NAME
.\" synopsis: .P! <file.ps> supybot\-wizard \- A wizard for creating Supybot configuration files
.\" .SH SYNOPSIS
.de P! .B supybot\-wizard
.fl .RI [ options ]
\!!1 setgray .SH DESCRIPTION
.fl .B
\\&.\" supybot\-wizard
.fl is an in\-depth wizard that provides a nice user interface for creating
\!!0 setgray configuration files for
.fl \" force out current output buffer .IR supybot (1).
\!!save /psv exch def currentpoint translate 0 0 moveto .SH OPTIONS
\!!/showpage{}def .TP
.fl \" prolog .B \-\^\-version
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file Show version of program.
\!!psv restore .TP
. .BR \-h ", " \-\^\-help
.de pF Show summary of options.
.ie \\*(f1 .ds f1 \\n(.f .TP
.el .ie \\*(f2 .ds f2 \\n(.f .B \-\^\-allow\-root
.el .ie \\*(f3 .ds f3 \\n(.f Determines whether the wizard will be allowed to run as root. You do not
.el .ie \\*(f4 .ds f4 \\n(.f want this. Do not do it. Even if you think you want it, you do not.
.el .tm ? font overflow .TP
.ft \\$1 .B \-\^\-no\-network
.. Determines whether the wizard will be allowed to run without a network
.de fP connection.
.ie !\\*(f4 \{\ .SH "SEE ALSO"
. ft \\*(f4 .IR python (1),
. ds f4\" .IR supybot (1),
' br \} .IR supybot\-adduser (1),
.el .ie !\\*(f3 \{\ .IR supybot\-newplugin (1)
. ft \\*(f3 .SH AUTHOR
. ds f3\" This manual page was originally written by James Vega
' br \} <vega dot james at gmail dot com>. Permission is granted to copy,
.el .ie !\\*(f2 \{\ distribute and/or modify this document under the terms of the Supybot
. ft \\*(f2 license, a BSD\-style license.
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "SUPYBOT-WIZARD" "1"
.SH "NAME"
supybot-wizard \(em A wizard for creating configuration files
.SH "SYNOPSIS"
.PP
\fBsupybot-wizard\fR [\fB\options\fP]
.SH "DESCRIPTION"
.PP
\fBsupybot-wizard\fR is an in-depth wizard that provides
a nice user interface for creating configuration files for
\fBsupybot\fR.
.SH "OPTIONS"
.PP
These programs follow the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.
.IP "\fB\--version\fP " 10
Show version of program.
.IP "\fB\-h\fP \fB\--help\fP " 10
Show summary of options.
.IP "\fB\--allow-root\fP" 10
Determines whether the wizard will be allowed to run
as root. You don't want this. Don't do it. Even if you
think you want it, you don't.
.IP "\fB\--no-network\fP" 10
Determines whether the wizard will be allowed to run
without a network connection.
.SH "SEE ALSO"
.PP
python (1), supybot (1), supybot-adduser (1),
supybot-newplugin (1).
.SH "AUTHOR"
.PP
This manual page was originally written by Jonathan Hseu vomjom@debian.org for
the \fBDebian\fP system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license.
.PP
On Debian systems with Supybot installed, the complete text
of the Supybot license can be found in /usr/share/doc/supybot/LICENSE
.\" created by instant / docbook-to-man, Mon 13 Sep 2004, 13:44

36
docs/man/supybot.1
View File

@ -56,11 +56,11 @@
supybot \(em A robust and user friendly Python IRC bot supybot \(em A robust and user friendly Python IRC bot
.SH "SYNOPSIS" .SH "SYNOPSIS"
.PP .PP
\fBsupybot\fR [\fB\options\fP] \fIconfigFile\fR \fBsupybot\fR [\fBoptions\fP] \fIconfigFile\fR
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
\fBsupybot\fR is a robust, user-friendly, \fBsupybot\fR is a robust, user\-friendly,
and programmer-friendly Python IRC bot. It aims to be an adequate and programmer\-friendly Python IRC bot. It aims to be an adequate
replacement for most existing IRC bots. It includes a very replacement for most existing IRC bots. It includes a very
flexible and poerful ACL system for controlling access to flexible and poerful ACL system for controlling access to
commands, as well as more than 50 builtin plugins providing commands, as well as more than 50 builtin plugins providing
@ -69,56 +69,56 @@ around 400 actual commands.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
These programs follow the usual GNU command line syntax, These programs follow the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of with long options starting with two dashes (\`\-\'). A summary of
options is included below. options is included below.
.IP "\fB\--version\fP" 10 .IP "\fB\-\-version\fP" 10
Show version of program. Show version of program.
.IP "\fB\-h\fP \fB\--help\fP " 10 .IP "\fB\-h\fP \fB\-\-help\fP " 10
Show summary of options. Show summary of options.
.IP "\fB\-P\fP \fB\--profile\fP " 10 .IP "\fB\-P\fP \fB\-\-profile\fP " 10
Enable profiling. Enable profiling.
.IP "\fB\-O\fP" 10 .IP "\fB\-O\fP" 10
Optimizes asserts out of the code; -O0 optimizes asserts Optimizes asserts out of the code; \-O0 optimizes asserts
and uses psyco. and uses psyco.
.IP "\fB\-nNICK\fP \fB\--nick=NICK\fP " 10 .IP "\fB\-nNICK\fP \fB\-\-nick=NICK\fP " 10
Nick the bot should use. Nick the bot should use.
.IP "\fB\-uUSER\fP \fB\--user=USER\fP " 10 .IP "\fB\-uUSER\fP \fB\-\-user=USER\fP " 10
Full username the bot should use. Full username the bot should use.
.IP "\fB\-iIDENT\fP \fB\--ident=IDENT\fP " 10 .IP "\fB\-iIDENT\fP \fB\-\-ident=IDENT\fP " 10
Ident the bot should use. Ident the bot should use.
.IP "\fB\-d\fP \fB\--daemon\fP " 10 .IP "\fB\-d\fP \fB\-\-daemon\fP " 10
Determines whether the bot will daemonize. This is a Determines whether the bot will daemonize. This is a
no-op on non-POSIX systems. no-op on non-POSIX systems.
.IP "\fB\--allow-eval\fP" 10 .IP "\fB\-\-allow-eval\fP" 10
Determines whether the bot will allow the evaluation Determines whether the bot will allow the evaluation
of arbitrary Python code. of arbitrary Python code.
.IP "\fB\--allow-default-owner\fP" 10 .IP "\fB\-\-allow-default-owner\fP" 10
Determines whether the bot will allow its defaultCapabilities Determines whether the bot will allow its defaultCapabilities
not to include "-owner", thus giving all users the owner capability not to include "-owner", thus giving all users the owner capability
by default. This is dumb, hence we require a command-line option. by default. This is dumb, hence we require a command-line option.
.IP "\fB\--allow-root\fP" 10 .IP "\fB\-\-allow-root\fP" 10
Determines whether the bot will be allowed to run as root. You Determines whether the bot will be allowed to run as root. You
don't want this. Don't do it. Even if you think you want it, you don't. don't want this. Don't do it. Even if you think you want it, you don't.
.IP "\fB\--debug\fP" 10 .IP "\fB\-\-debug\fP" 10
Determines whether some extra debugging stuff will be logged by Determines whether some extra debugging stuff will be logged by
this script. this script.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
python (1), supybot-wizard (1), supybot-adduser (1), python (1), supybot-wizard (1), supybot-adduser (1),
supybot-newplugin (1). supybot\-newplugin (1).
.SH "AUTHOR" .SH "AUTHOR"
.PP .PP
This manual page was originally written by Jonathan Hseu vomjom@debian.org for This manual page was originally written by Jonathan Hseu vomjom@debian.org for
the \fBDebian\fP system (but may be used by others). Permission is the \fBDebian\fP system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under granted to copy, distribute and/or modify this document under
the terms of the Supybot license, a BSD-style license. the terms of the Supybot license, a BSD\-style license.
.PP .PP
On Debian systems with Supybot installed, the complete text On Debian systems with Supybot installed, the complete text