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" [
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:
14 DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
18 manpage.1: manpage.dbk
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.
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">
48 <!ENTITY debian "<productname>Debian</productname>">
49 <!ENTITY gnu "<acronym>GNU</acronym>">
50 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
53 <refentry id="&dhapp;.1">
56 <productname>&dhapp;</productname>
62 <contrib>&debian; package maintainer</contrib>
68 <contrib>&dhapp; maintainer</contrib>
72 <year>2004-2009</year>
73 <holder>&dhusername;</holder>
77 <holder>&gbusername;</holder>
85 <refmiscinfo class="manual">&dhapp; man page</refmiscinfo>
86 <refmiscinfo class="source">&dhpackage;</refmiscinfo>
87 <refmiscinfo class="version">&dhpackageversion;</refmiscinfo>
91 <refname>&dhapp;</refname>
93 <refpurpose>IRC bot written in ruby</refpurpose>
98 <command>&dhapp;</command>
102 <arg><option>-d</option></arg>
103 <arg><option>--debug</option></arg>
106 <arg><option>-h</option></arg>
107 <arg><option>--help</option></arg>
110 <arg><option>-v</option></arg>
111 <arg><option>--version</option></arg>
114 <arg><option>-l LEVEL</option></arg>
115 <arg><option>--loglevel LEVEL</option></arg>
118 <arg><option>-b</option></arg>
119 <arg><option>--background</option></arg>
122 <arg><option>-p PIDFILE</option></arg>
123 <arg><option>--pidfile PIDFILE</option></arg>
127 <arg choice="opt" rep="norepeat">confdir</arg>
132 <title>DESCRIPTION</title>
134 <para><command>&dhapp;</command> starts the Rbot (ruby IRC bot).</para>
138 <title>OPTIONS</title>
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>
146 <term><option>-d</option></term>
147 <term><option>--debug</option></term>
149 <para>Display debug information (very verbose).</para>
154 <term><option>-h</option></term>
155 <term><option>--help</option></term>
157 <para>Show summary of options.</para>
162 <term><option>-v</option></term>
163 <term><option>--version</option></term>
165 <para>Display version information.</para>
170 <term><option>-l <parameter>LEVEL</parameter></option></term>
171 <term><option>--loglevel <parameter>LEVEL</parameter></option></term>
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
185 <term><option>-b</option></term>
186 <term><option>--background</option></term>
188 <para>Background (daemonize) the bot.</para>
193 <term><option>-p <parameter>PIDFILE</parameter></option></term>
194 <term><option>--pidfile <parameter>PIDFILE</parameter></option></term>
196 <para>Write the bot pid to PIDFILE. The default pidfile is BOTDIR/rbot.pid.</para>
201 <term><parameter>BOTDIR</parameter></term>
203 <para>Path to the directory where are stored the bot's configuration files. The default config directory is ~/.rbot.</para>
209 <title>VERSION</title>
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.
218 On Debian systems, the complete text of the GNU General Public
219 License can be found in /usr/share/common-licenses/GPL.