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-REMOTE</refentrytitle>">
44 <!ENTITY dhapp "rbot-remote">
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>-u USER</option></arg>
103 <arg><option>--user USER</option></arg>
106 <arg><option>-p PASSWORD</option></arg>
107 <arg><option>--password PASSWORD</option></arg>
112 <arg><option>-d DEST</option></arg>
113 <arg><option>--destination DEST</option></arg>
116 <arg><option>-r DRB_URI</option></arg>
117 <arg><option>--uri DRB_URI</option></arg>
120 <arg><option>-h</option></arg>
121 <arg><option>--help</option></arg>
124 <arg><option>-a</option></arg>
125 <arg><option>--about</option></arg>
132 <title>DESCRIPTION</title>
134 <para><command>&dhapp;</command> is a proof-of-concept example for
135 rbot druby-based api. This program reads lines of text from the standard
136 input and sends them to a specified irc channel or user via rbot.
139 <para>Make sure you have the remotectl plugin loaded and assigned the needed
140 rights to the user before use.
145 <title>OPTIONS</title>
147 <para>This program follow the usual &gnu; command line syntax,
148 with long options starting with two dashes (`-'). A summary of
149 options is included below.</para>
153 <term><option>-u <parameter>USER</parameter></option></term>
154 <term><option>--user <parameter>USER</parameter></option></term>
156 <para>Remote user.</para>
161 <term><option>-p <parameter>PASSWORD</parameter></option></term>
162 <term><option>--password <parameter>PASSWORD</parameter></option></term>
164 <para>Remote user password.</para>
169 <term><option>-d <parameter>DEST</parameter></option></term>
170 <term><option>--destination <parameter>DEST</parameter></option></term>
172 <para>Destination for message (user or channel).</para>
177 <term><option>-r <parameter>DRB_URI</parameter></option></term>
178 <term><option>--uri <parameter>DRB_URI</parameter></option></term>
180 <para>Rbot url.</para>
185 <term><option>-h</option></term>
186 <term><option>--help</option></term>
188 <para>Show summary of options.</para>
193 <term><option>-a</option></term>
194 <term><option>--about</option></term>
196 <para>Tell what it's all about.</para>
202 <title>VERSION</title>
204 <para>This manual page was written by &dhusername; &dhemail; for
205 the &debian; system (but may be used by others). Permission is
206 granted to copy, distribute and/or modify this document under
207 the terms of the &gnu; General Public License, Version 3 or
208 any later version published by the Free Software Foundation.
211 On Debian systems, the complete text of the GNU General Public
212 License can be found in /usr/share/common-licenses/GPL.