mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-20 09:29:24 +01:00
Add the manpages.
This commit is contained in:
James Vega
parent
c7278b5902
commit
e44ad15808
183
docs/DocBook/man/supybot-adduser.sgml
Normal file
183
docs/DocBook/man/supybot-adduser.sgml
Normal file
@ -0,0 +1,183 @@
|
|||||||
|
<!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
Normal file
165
docs/DocBook/man/supybot-newplugin.sgml
Normal file
@ -0,0 +1,165 @@
|
|||||||
|
<!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
Normal file
159
docs/DocBook/man/supybot-wizard.sgml
Normal file
@ -0,0 +1,159 @@
|
|||||||
|
<!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
Normal file
230
docs/DocBook/man/supybot.sgml
Normal file
@ -0,0 +1,230 @@
|
|||||||
|
<!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:
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
99
docs/man/supybot-adduser.1
Normal file
99
docs/man/supybot-adduser.1
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
.\" $Header$
|
||||||
|
.\"
|
||||||
|
.\" transcript compatibility for postscript use.
|
||||||
|
.\"
|
||||||
|
.\" synopsis: .P! <file.ps>
|
||||||
|
.\"
|
||||||
|
.de P!
|
||||||
|
.fl
|
||||||
|
\!!1 setgray
|
||||||
|
.fl
|
||||||
|
\\&.\"
|
||||||
|
.fl
|
||||||
|
\!!0 setgray
|
||||||
|
.fl \" force out current output buffer
|
||||||
|
\!!save /psv exch def currentpoint translate 0 0 moveto
|
||||||
|
\!!/showpage{}def
|
||||||
|
.fl \" prolog
|
||||||
|
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
|
||||||
|
\!!psv restore
|
||||||
|
.
|
||||||
|
.de pF
|
||||||
|
.ie \\*(f1 .ds f1 \\n(.f
|
||||||
|
.el .ie \\*(f2 .ds f2 \\n(.f
|
||||||
|
.el .ie \\*(f3 .ds f3 \\n(.f
|
||||||
|
.el .ie \\*(f4 .ds f4 \\n(.f
|
||||||
|
.el .tm ? font overflow
|
||||||
|
.ft \\$1
|
||||||
|
..
|
||||||
|
.de fP
|
||||||
|
.ie !\\*(f4 \{\
|
||||||
|
. ft \\*(f4
|
||||||
|
. ds f4\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f3 \{\
|
||||||
|
. ft \\*(f3
|
||||||
|
. ds f3\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f2 \{\
|
||||||
|
. ft \\*(f2
|
||||||
|
. 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-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
|
||||||
94
docs/man/supybot-newplugin.1
Normal file
94
docs/man/supybot-newplugin.1
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
.\" $Header$
|
||||||
|
.\"
|
||||||
|
.\" transcript compatibility for postscript use.
|
||||||
|
.\"
|
||||||
|
.\" synopsis: .P! <file.ps>
|
||||||
|
.\"
|
||||||
|
.de P!
|
||||||
|
.fl
|
||||||
|
\!!1 setgray
|
||||||
|
.fl
|
||||||
|
\\&.\"
|
||||||
|
.fl
|
||||||
|
\!!0 setgray
|
||||||
|
.fl \" force out current output buffer
|
||||||
|
\!!save /psv exch def currentpoint translate 0 0 moveto
|
||||||
|
\!!/showpage{}def
|
||||||
|
.fl \" prolog
|
||||||
|
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
|
||||||
|
\!!psv restore
|
||||||
|
.
|
||||||
|
.de pF
|
||||||
|
.ie \\*(f1 .ds f1 \\n(.f
|
||||||
|
.el .ie \\*(f2 .ds f2 \\n(.f
|
||||||
|
.el .ie \\*(f3 .ds f3 \\n(.f
|
||||||
|
.el .ie \\*(f4 .ds f4 \\n(.f
|
||||||
|
.el .tm ? font overflow
|
||||||
|
.ft \\$1
|
||||||
|
..
|
||||||
|
.de fP
|
||||||
|
.ie !\\*(f4 \{\
|
||||||
|
. ft \\*(f4
|
||||||
|
. ds f4\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f3 \{\
|
||||||
|
. ft \\*(f3
|
||||||
|
. ds f3\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f2 \{\
|
||||||
|
. ft \\*(f2
|
||||||
|
. 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-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
|
||||||
98
docs/man/supybot-wizard.1
Normal file
98
docs/man/supybot-wizard.1
Normal file
@ -0,0 +1,98 @@
|
|||||||
|
.\" $Header$
|
||||||
|
.\"
|
||||||
|
.\" transcript compatibility for postscript use.
|
||||||
|
.\"
|
||||||
|
.\" synopsis: .P! <file.ps>
|
||||||
|
.\"
|
||||||
|
.de P!
|
||||||
|
.fl
|
||||||
|
\!!1 setgray
|
||||||
|
.fl
|
||||||
|
\\&.\"
|
||||||
|
.fl
|
||||||
|
\!!0 setgray
|
||||||
|
.fl \" force out current output buffer
|
||||||
|
\!!save /psv exch def currentpoint translate 0 0 moveto
|
||||||
|
\!!/showpage{}def
|
||||||
|
.fl \" prolog
|
||||||
|
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
|
||||||
|
\!!psv restore
|
||||||
|
.
|
||||||
|
.de pF
|
||||||
|
.ie \\*(f1 .ds f1 \\n(.f
|
||||||
|
.el .ie \\*(f2 .ds f2 \\n(.f
|
||||||
|
.el .ie \\*(f3 .ds f3 \\n(.f
|
||||||
|
.el .ie \\*(f4 .ds f4 \\n(.f
|
||||||
|
.el .tm ? font overflow
|
||||||
|
.ft \\$1
|
||||||
|
..
|
||||||
|
.de fP
|
||||||
|
.ie !\\*(f4 \{\
|
||||||
|
. ft \\*(f4
|
||||||
|
. ds f4\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f3 \{\
|
||||||
|
. ft \\*(f3
|
||||||
|
. ds f3\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f2 \{\
|
||||||
|
. ft \\*(f2
|
||||||
|
. 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
|
||||||
127
docs/man/supybot.1
Normal file
127
docs/man/supybot.1
Normal file
@ -0,0 +1,127 @@
|
|||||||
|
.\" $Header$
|
||||||
|
.\"
|
||||||
|
.\" transcript compatibility for postscript use.
|
||||||
|
.\"
|
||||||
|
.\" synopsis: .P! <file.ps>
|
||||||
|
.\"
|
||||||
|
.de P!
|
||||||
|
.fl
|
||||||
|
\!!1 setgray
|
||||||
|
.fl
|
||||||
|
\\&.\"
|
||||||
|
.fl
|
||||||
|
\!!0 setgray
|
||||||
|
.fl \" force out current output buffer
|
||||||
|
\!!save /psv exch def currentpoint translate 0 0 moveto
|
||||||
|
\!!/showpage{}def
|
||||||
|
.fl \" prolog
|
||||||
|
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
|
||||||
|
\!!psv restore
|
||||||
|
.
|
||||||
|
.de pF
|
||||||
|
.ie \\*(f1 .ds f1 \\n(.f
|
||||||
|
.el .ie \\*(f2 .ds f2 \\n(.f
|
||||||
|
.el .ie \\*(f3 .ds f3 \\n(.f
|
||||||
|
.el .ie \\*(f4 .ds f4 \\n(.f
|
||||||
|
.el .tm ? font overflow
|
||||||
|
.ft \\$1
|
||||||
|
..
|
||||||
|
.de fP
|
||||||
|
.ie !\\*(f4 \{\
|
||||||
|
. ft \\*(f4
|
||||||
|
. ds f4\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f3 \{\
|
||||||
|
. ft \\*(f3
|
||||||
|
. ds f3\"
|
||||||
|
' br \}
|
||||||
|
.el .ie !\\*(f2 \{\
|
||||||
|
. ft \\*(f2
|
||||||
|
. 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" "1"
|
||||||
|
.SH "NAME"
|
||||||
|
supybot \(em A robust and user friendly Python IRC bot
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.PP
|
||||||
|
\fBsupybot\fR [\fB\options\fP] \fIconfigFile\fR
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
.PP
|
||||||
|
\fBsupybot\fR 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.
|
||||||
|
|
||||||
|
.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\-P\fP \fB\--profile\fP " 10
|
||||||
|
Enable profiling.
|
||||||
|
.IP "\fB\-O\fP" 10
|
||||||
|
Optimizes asserts out of the code; -O0 optimizes asserts
|
||||||
|
and uses psyco.
|
||||||
|
|
||||||
|
.IP "\fB\-nNICK\fP \fB\--nick=NICK\fP " 10
|
||||||
|
Nick the bot should use.
|
||||||
|
.IP "\fB\-uUSER\fP \fB\--user=USER\fP " 10
|
||||||
|
Full username the bot should use.
|
||||||
|
.IP "\fB\-iIDENT\fP \fB\--ident=IDENT\fP " 10
|
||||||
|
Ident the bot should use.
|
||||||
|
.IP "\fB\-d\fP \fB\--daemon\fP " 10
|
||||||
|
Determines whether the bot will daemonize. This is a
|
||||||
|
no-op on non-POSIX systems.
|
||||||
|
|
||||||
|
.IP "\fB\--allow-eval\fP" 10
|
||||||
|
Determines whether the bot will allow the evaluation
|
||||||
|
of arbitrary Python code.
|
||||||
|
|
||||||
|
.IP "\fB\--allow-default-owner\fP" 10
|
||||||
|
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.
|
||||||
|
|
||||||
|
.IP "\fB\--allow-root\fP" 10
|
||||||
|
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.
|
||||||
|
|
||||||
|
.IP "\fB\--debug\fP" 10
|
||||||
|
Determines whether some extra debugging stuff will be logged by
|
||||||
|
this script.
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
python (1), supybot-wizard (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
|
||||||
Loading…
Reference in New Issue
Block a user