git.oblomov.eu Git - rbot/blob - man/rbot-remote.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-REMOTE</refentrytitle>">
  40   <!ENTITY dhpackage   "rbot-remote">
  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="req">
  77            <group choice="req">
  78                 <arg><option>-u USER</option></arg>
  79                 <arg><option>--user USER</option></arg>
  80            </group>
  81            <group choice="req">
  82                 <arg><option>-p PASSWORD</option></arg>
  83                 <arg><option>--password PASSWORD</option></arg>
  84            </group>
  85         </group>
  86         <group choice="opt">
  87            <group choice="req">
  88                 <arg><option>-d DEST</option></arg>
  89                 <arg><option>--destination DEST</option></arg>
  90            </group>
  91            <group choice="req">
  92                 <arg><option>-r DRB_URI</option></arg>
  93                 <arg><option>--uri DRB_URI</option></arg>
  94            </group>
  95            <group choice="req">
  96                 <arg><option>-h</option></arg>
  97                 <arg><option>--help</option></arg>
  98            </group>
  99            <group choice="req">
 100                 <arg><option>-a</option></arg>
 101                 <arg><option>--about</option></arg>
 102            </group>
 103         </group>
 104
 105     </cmdsynopsis>
 106   </refsynopsisdiv>
 107   <refsect1>
 108     <title>DESCRIPTION</title>
 109
 110     <para><command>&dhpackage;</command> is a proof-of-concept example for
 111       rbot druby-based api. This program reads lines of text from the standard
 112       input and sends them to a specified irc channel or user via rbot.
 113     </para>
 114
 115     <para>Make sure you have remotectl.rb plugin loaded and assigned the needed
 116        rights to the user before use.
 117     </para>
 118
 119   </refsect1>
 120   <refsect1>
 121     <title>OPTIONS</title>
 122
 123     <para>This program follow the usual &gnu; command line syntax,
 124       with long options starting with two dashes (`-').  A summary of
 125       options is included below.</para>
 126
 127     <variablelist>
 128       <varlistentry>
 129         <term><option>-u <parameter>USER</parameter></option></term>
 130         <term><option>--user <parameter>USER</parameter></option></term>
 131         <listitem>
 132           <para>Remote user.</para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term><option>-p <parameter>PASSWORD</parameter></option></term>
 138         <term><option>--password <parameter>PASSWORD</parameter></option></term>
 139         <listitem>
 140           <para>Remote user password.</para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry>
 145         <term><option>-d <parameter>DEST</parameter></option></term>
 146         <term><option>--destination <parameter>DEST</parameter></option></term>
 147         <listitem>
 148           <para>Destination for message (user or channel).</para>
 149         </listitem>
 150       </varlistentry>
 151
 152       <varlistentry>
 153         <term><option>-r <parameter>DRB_URI</parameter></option></term>
 154         <term><option>--uri <parameter>DRB_URI</parameter></option></term>
 155         <listitem>
 156           <para>Rbot url.</para>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry>
 161         <term><option>-h</option></term>
 162         <term><option>--help</option></term>
 163         <listitem>
 164           <para>Show summary of options.</para>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term><option>-a</option></term>
 170         <term><option>--about</option></term>
 171         <listitem>
 172           <para>Tell what it's all about.</para>
 173         </listitem>
 174       </varlistentry>
 175     </variablelist>
 176   </refsect1>
 177   <refsect1>
 178     <title>AUTHOR</title>
 179
 180     <para>This manual page was written by &dhusername; &dhemail; for
 181       the &debian; system (but may be used by others).  Permission is
 182       granted to copy, distribute and/or modify this document under
 183       the terms of the &gnu; General Public License, Version 3 or
 184       any later version published by the Free Software Foundation.
 185     </para>
 186         <para>
 187           On Debian systems, the complete text of the GNU General Public
 188           License can be found in /usr/share/common-licenses/GPL.
 189         </para>
 190
 191   </refsect1>
 192 </refentry>
 193