man pages

Courtesy of Debian maintainer Marc Dequènes (Duck) <duck@duckcorp.org>

1 files changed, 193 insertions, 0 deletions

diff --git a/man/rbot-remote.xml b/man/rbot-remote.xml
new file mode 100644
index 00000000..b761c3aa
--- /dev/null
+++ b/man/rbot-remote.xml
@@ -0,0 +1,193 @@
+<?xml version='1.0' encoding='utf-8'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+<!--
+
+Process this file with an XSLT processor: `xsltproc \
+-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
+manpages/docbook.xsl manpage.dbk'.  A manual page
+<package>.<section> will be generated.  You may view the
+manual page with: nroff -man <package>.<section> | less'.  A
+typical entry in a Makefile or Makefile.am is:
+
+DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
+manpages/docbook.xsl
+XP=xsltproc -''-nonet
+
+manpage.1: manpage.dbk
+        $(XP) $(DB2MAN) $<
+    
+The xsltproc binary is found in the xsltproc package.  The
+XSL files are in docbook-xsl.  Please remember that if you
+create the nroff version in one of the debian/rules file
+targets (such as build), you will need to include xsltproc
+and docbook-xsl in your Build-Depends control field.
+
+-->
+
+  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+  <!ENTITY dhfirstname "<firstname>Marc</firstname>">
+  <!ENTITY dhsurname   "<surname>Dequ\[`e]nes</surname>">
+  <!-- Please adjust the date whenever revising the manpage. -->
+  <!ENTITY dhdate      "<date>20090401</date>">
+  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+       allowed: see man(7), man(1). -->
+  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
+  <!ENTITY dhemail     "<email>Duck@DuckCorp.org</email>">
+  <!ENTITY dhusername  "Marc Dequ\[`e]nes (Duck)">
+  <!ENTITY dhucpackage "<refentrytitle>RBOT-REMOTE</refentrytitle>">
+  <!ENTITY dhpackage   "rbot-remote">
+
+  <!ENTITY debian      "<productname>Debian</productname>">
+  <!ENTITY gnu         "<acronym>GNU</acronym>">
+  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+  <refentryinfo>
+    <address>
+      &dhemail;
+    </address>
+    <author>
+      &dhfirstname;
+      &dhsurname;
+    </author>
+    <copyright>
+      <year>2004-2009</year>
+      <holder>&dhusername;</holder>
+    </copyright>
+    &dhdate;
+  </refentryinfo>
+  <refmeta>
+    &dhucpackage;
+
+    &dhsection;
+  </refmeta>
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+
+    <refpurpose>IRC bot written in ruby</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+
+        <group choice="req">
+           <group choice="req">
+	  	<arg><option>-u USER</option></arg>
+	  	<arg><option>--user USER</option></arg>
+           </group>
+           <group choice="req">
+	  	<arg><option>-p PASSWORD</option></arg>
+	  	<arg><option>--password PASSWORD</option></arg>
+           </group>
+	</group>
+        <group choice="opt">
+           <group choice="req">
+	  	<arg><option>-d DEST</option></arg>
+	  	<arg><option>--destination DEST</option></arg>
+           </group>
+           <group choice="req">
+	  	<arg><option>-r DRB_URI</option></arg>
+	  	<arg><option>--uri DRB_URI</option></arg>
+           </group>
+           <group choice="req">
+	  	<arg><option>-h</option></arg>
+	  	<arg><option>--help</option></arg>
+           </group>
+           <group choice="req">
+	  	<arg><option>-a</option></arg>
+	  	<arg><option>--about</option></arg>
+           </group>
+	</group>
+
+    </cmdsynopsis>
+  </refsynopsisdiv>
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para><command>&dhpackage;</command> is a proof-of-concept example for
+      rbot druby-based api. This program reads lines of text from the standard
+      input and sends them to a specified irc channel or user via rbot.
+    </para>
+
+    <para>Make sure you have remotectl.rb plugin loaded and assigned the needed
+       rights to the user before use.
+    </para>
+
+  </refsect1>
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <para>This program follow the usual &gnu; command line syntax,
+      with long options starting with two dashes (`-').  A summary of
+      options is included below.</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>-u <parameter>USER</parameter></option></term>
+        <term><option>--user <parameter>USER</parameter></option></term>
+        <listitem>
+          <para>Remote user.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-p <parameter>PASSWORD</parameter></option></term>
+        <term><option>--password <parameter>PASSWORD</parameter></option></term>
+        <listitem>
+          <para>Remote user password.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-d <parameter>DEST</parameter></option></term>
+        <term><option>--destination <parameter>DEST</parameter></option></term>
+        <listitem>
+          <para>Destination for message (user or channel).</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-r <parameter>DRB_URI</parameter></option></term>
+        <term><option>--uri <parameter>DRB_URI</parameter></option></term>
+        <listitem>
+          <para>Rbot url.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-h</option></term>
+        <term><option>--help</option></term>
+        <listitem>
+          <para>Show summary of options.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-a</option></term>
+        <term><option>--about</option></term>
+        <listitem>
+          <para>Tell what it's all about.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+  <refsect1>
+    <title>AUTHOR</title>
+
+    <para>This manual page was written by &dhusername; &dhemail; for
+      the &debian; system (but may be used by others).  Permission is
+      granted to copy, distribute and/or modify this document under
+      the terms of the &gnu; General Public License, Version 3 or
+      any later version published by the Free Software Foundation.
+    </para>
+	<para>
+	  On Debian systems, the complete text of the GNU General Public
+	  License can be found in /usr/share/common-licenses/GPL.
+	</para>
+
+  </refsect1>
+</refentry>
+