Limnoria/docs/DocBook/man/supybot.sgml

<!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:
-->