git.oblomov.eu Git - rbot/blob - man/rbot.xml

   1 <?xml version='1.0' encoding='utf-8'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!--
   6
   7 Process this file with an XSLT processor: `xsltproc \
   8 -''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
   9 manpages/docbook.xsl manpage.dbk'.  A manual page
  10 <package>.<section> will be generated.  You may view the
  11 manual page with: nroff -man <package>.<section> | less'.  A
  12 typical entry in a Makefile or Makefile.am is:
  13
  14 DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
  15 manpages/docbook.xsl
  16 XP=xsltproc -''-nonet
  17
  18 manpage.1: manpage.dbk
  19         $(XP) $(DB2MAN) $<
  20
  21 The xsltproc binary is found in the xsltproc package.  The
  22 XSL files are in docbook-xsl.  Please remember that if you
  23 create the nroff version in one of the debian/rules file
  24 targets (such as build), you will need to include xsltproc
  25 and docbook-xsl in your Build-Depends control field.
  26
  27 -->
  28
  29   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  30   <!ENTITY dhfirstname "<firstname>Marc</firstname>">
  31   <!ENTITY dhsurname   "<surname>Dequ\[`e]nes</surname>">
  32   <!-- Please adjust the date whenever revising the manpage. -->
  33   <!ENTITY dhdate      "<date>20090401</date>">
  34   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  35        allowed: see man(7), man(1). -->
  36   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  37   <!ENTITY dhemail     "<email>Duck@DuckCorp.org</email>">
  38   <!ENTITY dhusername  "Marc Dequ\[`e]nes (Duck)">
  39   <!ENTITY dhucpackage "<refentrytitle>RBOT</refentrytitle>">
  40   <!ENTITY dhpackage   "rbot">
  41
  42   <!ENTITY debian      "<productname>Debian</productname>">
  43   <!ENTITY gnu         "<acronym>GNU</acronym>">
  44   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  45 ]>
  46
  47 <refentry>
  48   <refentryinfo>
  49     <address>
  50       &dhemail;
  51     </address>
  52     <author>
  53       &dhfirstname;
  54       &dhsurname;
  55     </author>
  56     <copyright>
  57       <year>2004-2009</year>
  58       <holder>&dhusername;</holder>
  59     </copyright>
  60     &dhdate;
  61   </refentryinfo>
  62   <refmeta>
  63     &dhucpackage;
  64
  65     &dhsection;
  66   </refmeta>
  67   <refnamediv>
  68     <refname>&dhpackage;</refname>
  69
  70     <refpurpose>IRC bot written in ruby</refpurpose>
  71   </refnamediv>
  72   <refsynopsisdiv>
  73     <cmdsynopsis>
  74       <command>&dhpackage;</command>
  75
  76         <group choice="opt">
  77            <group choice="req">
  78                 <arg><option>-d</option></arg>
  79                 <arg><option>--debug</option></arg>
  80            </group>
  81            <group choice="req">
  82                 <arg><option>-h</option></arg>
  83                 <arg><option>--help</option></arg>
  84            </group>
  85            <group choice="req">
  86                 <arg><option>-v</option></arg>
  87                 <arg><option>--version</option></arg>
  88            </group>
  89            <group choice="req">
  90                 <arg><option>-l LEVEL</option></arg>
  91                 <arg><option>--loglevel LEVEL</option></arg>
  92            </group>
  93            <group choice="req">
  94                 <arg><option>-b</option></arg>
  95                 <arg><option>--background</option></arg>
  96            </group>
  97            <group choice="req">
  98                 <arg><option>-p PIDFILE</option></arg>
  99                 <arg><option>--pidfile PIDFILE</option></arg>
 100            </group>
 101         </group>
 102
 103         <arg choice="opt" rep="norepeat">confdir</arg>
 104
 105     </cmdsynopsis>
 106   </refsynopsisdiv>
 107   <refsect1>
 108     <title>DESCRIPTION</title>
 109
 110     <para><command>&dhpackage;</command> starts the Rbot (ruby IRC bot).</para>
 111
 112   </refsect1>
 113   <refsect1>
 114     <title>OPTIONS</title>
 115
 116     <para>This program follow the usual &gnu; command line syntax,
 117       with long options starting with two dashes (`-').  A summary of
 118       options is included below.</para>
 119
 120     <variablelist>
 121       <varlistentry>
 122         <term><option>-d</option></term>
 123         <term><option>--debug</option></term>
 124         <listitem>
 125           <para>Display debug information (very verbose).</para>
 126         </listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term><option>-h</option></term>
 131         <term><option>--help</option></term>
 132         <listitem>
 133           <para>Show summary of options.</para>
 134         </listitem>
 135       </varlistentry>
 136
 137       <varlistentry>
 138         <term><option>-v</option></term>
 139         <term><option>--version</option></term>
 140         <listitem>
 141           <para>Display version information.</para>
 142         </listitem>
 143       </varlistentry>
 144
 145       <varlistentry>
 146         <term><option>-l <parameter>LEVEL</parameter></option></term>
 147         <term><option>--loglevel <parameter>LEVEL</parameter></option></term>
 148         <listitem>
 149           <para>
 150              Sets the minimum log level verbosity. Possible values for the
 151              loglevel are 0 (DEBUG), 1 (INFO), 2 (WARN), 3 (ERROR), 4
 152              (FATAL). The default loglevel is 1 (INFO messages). The logfile
 153              is located at BOTDIR/BOTNAME.log and doesn't contain IRC logs
 154              (which are located at BOTDIR/logs/*), but only rbot diagnostic
 155              messages.
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry>
 161         <term><option>-b</option></term>
 162         <term><option>--background</option></term>
 163         <listitem>
 164           <para>Background (daemonize) the bot.</para>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term><option>-p <parameter>PIDFILE</parameter></option></term>
 170         <term><option>--pidfile <parameter>PIDFILE</parameter></option></term>
 171         <listitem>
 172           <para>Write the bot pid to PIDFILE. The default pidfile is BOTDIR/rbot.pid.</para>
 173         </listitem>
 174       </varlistentry>
 175
 176       <varlistentry>
 177         <term><parameter>CONFDIR</parameter></term>
 178         <listitem>
 179           <para>Path to the directory where are stored the bot's configuration files. The default config directory is ~/.rbot.</para>
 180         </listitem>
 181       </varlistentry>
 182     </variablelist>
 183   </refsect1>
 184   <refsect1>
 185     <title>AUTHOR</title>
 186
 187     <para>This manual page was written by &dhusername; &dhemail; for
 188       the &debian; system (but may be used by others).  Permission is
 189       granted to copy, distribute and/or modify this document under
 190       the terms of the &gnu; General Public License, Version 3 or
 191       any later version published by the Free Software Foundation.
 192     </para>
 193         <para>
 194           On Debian systems, the complete text of the GNU General Public
 195           License can be found in /usr/share/common-licenses/GPL.
 196         </para>
 197
 198   </refsect1>
 199 </refentry>
 200