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ènes</surname>">
  32   <!ENTITY gbgname     "<firstname>Giuseppe</firstname>">
  33   <!ENTITY gbfname     "<surname>Bilotta</surname>">
  34   <!-- Please adjust the date whenever revising the manpage. -->
  35   <!ENTITY dhdate      "<date>20100701</date>">
  36   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  37        allowed: see man(7), man(1). -->
  38   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  39   <!ENTITY dhemail     "<email>Duck@DuckCorp.org</email>">
  40   <!ENTITY gbemail     "<email>giuseppe.bilotta@gmail.com</email>">
  41   <!ENTITY dhusername  "Marc Dequènes (Duck)">
  42   <!ENTITY gbusername  "Giuseppe Bilotta">
  43   <!ENTITY dhucapp     "<refentrytitle>RBOT</refentrytitle>">
  44   <!ENTITY dhapp       "rbot">
  45   <!ENTITY dhpackage   "rbot">
  46   <!ENTITY dhpackageversion "0.9.15">
  47
  48   <!ENTITY debian      "<productname>Debian</productname>">
  49   <!ENTITY gnu         "<acronym>GNU</acronym>">
  50   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  51 ]>
  52
  53 <refentry id="&dhapp;.1">
  54
  55   <refentryinfo>
  56     <productname>&dhapp;</productname>
  57     <authorgroup>
  58       <author>
  59         &dhfirstname;
  60         &dhsurname;
  61         &dhemail;
  62         <contrib>&debian; package maintainer</contrib>
  63       </author>
  64       <author>
  65         &gbgname;
  66         &gbfname;
  67         &gbemail;
  68         <contrib>&dhapp; maintainer</contrib>
  69       </author>
  70     </authorgroup>
  71     <copyright>
  72       <year>2004-2009</year>
  73       <holder>&dhusername;</holder>
  74     </copyright>
  75     <copyright>
  76       <year>2010</year>
  77       <holder>&gbusername;</holder>
  78     </copyright>
  79     &dhdate;
  80   </refentryinfo>
  81
  82   <refmeta>
  83     &dhucapp;
  84     &dhsection;
  85     <refmiscinfo class="manual">&dhapp; man page</refmiscinfo>
  86     <refmiscinfo class="source">&dhpackage;</refmiscinfo>
  87     <refmiscinfo class="version">&dhpackageversion;</refmiscinfo>
  88   </refmeta>
  89
  90   <refnamediv>
  91     <refname>&dhapp;</refname>
  92
  93     <refpurpose>IRC bot written in ruby</refpurpose>
  94   </refnamediv>
  95
  96   <refsynopsisdiv>
  97     <cmdsynopsis>
  98       <command>&dhapp;</command>
  99
 100       <group choice="opt">
 101         <group choice="req">
 102           <arg><option>-d</option></arg>
 103           <arg><option>--debug</option></arg>
 104         </group>
 105         <group choice="req">
 106           <arg><option>-h</option></arg>
 107           <arg><option>--help</option></arg>
 108         </group>
 109         <group choice="req">
 110           <arg><option>-v</option></arg>
 111           <arg><option>--version</option></arg>
 112         </group>
 113         <group choice="req">
 114           <arg><option>-l LEVEL</option></arg>
 115           <arg><option>--loglevel LEVEL</option></arg>
 116         </group>
 117         <group choice="req">
 118           <arg><option>-b</option></arg>
 119           <arg><option>--background</option></arg>
 120         </group>
 121         <group choice="req">
 122           <arg><option>-p PIDFILE</option></arg>
 123           <arg><option>--pidfile PIDFILE</option></arg>
 124         </group>
 125       </group>
 126
 127       <arg choice="opt" rep="norepeat">confdir</arg>
 128
 129     </cmdsynopsis>
 130   </refsynopsisdiv>
 131   <refsect1>
 132     <title>DESCRIPTION</title>
 133
 134     <para><command>&dhapp;</command> starts the Rbot (ruby IRC bot).</para>
 135
 136   </refsect1>
 137   <refsect1>
 138     <title>OPTIONS</title>
 139
 140     <para>This program follow the usual &gnu; command line syntax,
 141       with long options starting with two dashes (`-').  A summary of
 142       options is included below.</para>
 143
 144     <variablelist>
 145       <varlistentry>
 146         <term><option>-d</option></term>
 147         <term><option>--debug</option></term>
 148         <listitem>
 149           <para>Display debug information (very verbose).</para>
 150         </listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term><option>-h</option></term>
 155         <term><option>--help</option></term>
 156         <listitem>
 157           <para>Show summary of options.</para>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry>
 162         <term><option>-v</option></term>
 163         <term><option>--version</option></term>
 164         <listitem>
 165           <para>Display version information.</para>
 166         </listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term><option>-l <parameter>LEVEL</parameter></option></term>
 171         <term><option>--loglevel <parameter>LEVEL</parameter></option></term>
 172         <listitem>
 173           <para>
 174             Sets the minimum log level verbosity. Possible values for the
 175             loglevel are 0 (DEBUG), 1 (INFO), 2 (WARN), 3 (ERROR), 4
 176             (FATAL). The default loglevel is 1 (INFO messages). The logfile
 177             is located at BOTDIR/BOTNAME.log and doesn't contain IRC logs
 178             (which are located at BOTDIR/logs/*), but only rbot diagnostic
 179             messages.
 180           </para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term><option>-b</option></term>
 186         <term><option>--background</option></term>
 187         <listitem>
 188           <para>Background (daemonize) the bot.</para>
 189         </listitem>
 190       </varlistentry>
 191
 192       <varlistentry>
 193         <term><option>-p <parameter>PIDFILE</parameter></option></term>
 194         <term><option>--pidfile <parameter>PIDFILE</parameter></option></term>
 195         <listitem>
 196           <para>Write the bot pid to PIDFILE. The default pidfile is BOTDIR/rbot.pid.</para>
 197         </listitem>
 198       </varlistentry>
 199
 200       <varlistentry>
 201         <term><parameter>BOTDIR</parameter></term>
 202         <listitem>
 203           <para>Path to the directory where are stored the bot's configuration files. The default config directory is ~/.rbot.</para>
 204         </listitem>
 205       </varlistentry>
 206     </variablelist>
 207   </refsect1>
 208   <refsect1>
 209     <title>VERSION</title>
 210
 211     <para>This manual page was written by &dhusername; &dhemail; for
 212       the &debian; system (but may be used by others).  Permission is
 213       granted to copy, distribute and/or modify this document under
 214       the terms of the &gnu; General Public License, Version 3 or
 215       any later version published by the Free Software Foundation.
 216     </para>
 217     <para>
 218       On Debian systems, the complete text of the GNU General Public
 219       License can be found in /usr/share/common-licenses/GPL.
 220     </para>
 221
 222   </refsect1>
 223 </refentry>
 224