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\[`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">
42 <!ENTITY debian "<productname>Debian</productname>">
43 <!ENTITY gnu "<acronym>GNU</acronym>">
44 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
57 <year>2004-2009</year>
58 <holder>&dhusername;</holder>
68 <refname>&dhpackage;</refname>
70 <refpurpose>IRC bot written in ruby</refpurpose>
74 <command>&dhpackage;</command>
78 <arg><option>-d</option></arg>
79 <arg><option>--debug</option></arg>
82 <arg><option>-h</option></arg>
83 <arg><option>--help</option></arg>
86 <arg><option>-v</option></arg>
87 <arg><option>--version</option></arg>
90 <arg><option>-l LEVEL</option></arg>
91 <arg><option>--loglevel LEVEL</option></arg>
94 <arg><option>-b</option></arg>
95 <arg><option>--background</option></arg>
98 <arg><option>-p PIDFILE</option></arg>
99 <arg><option>--pidfile PIDFILE</option></arg>
103 <arg choice="opt" rep="norepeat">confdir</arg>
108 <title>DESCRIPTION</title>
110 <para><command>&dhpackage;</command> starts the Rbot (ruby IRC bot).</para>
114 <title>OPTIONS</title>
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>
122 <term><option>-d</option></term>
123 <term><option>--debug</option></term>
125 <para>Display debug information (very verbose).</para>
130 <term><option>-h</option></term>
131 <term><option>--help</option></term>
133 <para>Show summary of options.</para>
138 <term><option>-v</option></term>
139 <term><option>--version</option></term>
141 <para>Display version information.</para>
146 <term><option>-l <parameter>LEVEL</parameter></option></term>
147 <term><option>--loglevel <parameter>LEVEL</parameter></option></term>
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
161 <term><option>-b</option></term>
162 <term><option>--background</option></term>
164 <para>Background (daemonize) the bot.</para>
169 <term><option>-p <parameter>PIDFILE</parameter></option></term>
170 <term><option>--pidfile <parameter>PIDFILE</parameter></option></term>
172 <para>Write the bot pid to PIDFILE. The default pidfile is BOTDIR/rbot.pid.</para>
177 <term><parameter>CONFDIR</parameter></term>
179 <para>Path to the directory where are stored the bot's configuration files. The default config directory is ~/.rbot.</para>
185 <title>AUTHOR</title>
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.
194 On Debian systems, the complete text of the GNU General Public
195 License can be found in /usr/share/common-licenses/GPL.