From ae223f784f852ea27f8b0c7be55ae541a0e98f15 Mon Sep 17 00:00:00 2001 From: Giuseppe Bilotta Date: Sat, 11 Apr 2009 11:37:12 +0200 Subject: man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Courtesy of Debian maintainer Marc Dequènes (Duck) --- man/Makefile | 2 + man/rbot-remote.xml | 193 ++++++++++++++++++++++++++++++++++++++++++++++++++ man/rbot.xml | 200 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 395 insertions(+) create mode 100644 man/Makefile create mode 100644 man/rbot-remote.xml create mode 100644 man/rbot.xml (limited to 'man') diff --git a/man/Makefile b/man/Makefile new file mode 100644 index 00000000..29cf355c --- /dev/null +++ b/man/Makefile @@ -0,0 +1,2 @@ +%.1: %.xml + xsltproc -nonet -o $@ /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl $< 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 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| 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. + +--> + + + Marc"> + Dequ\[`e]nes"> + + 20090401"> + + 1"> + Duck@DuckCorp.org"> + + RBOT-REMOTE"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2004-2009 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + IRC bot written in ruby + + + + &dhpackage; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + DESCRIPTION + + &dhpackage; 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. + + + Make sure you have remotectl.rb plugin loaded and assigned the needed + rights to the user before use. + + + + + OPTIONS + + This program follow the usual &gnu; command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + Remote user. + + + + + + + + Remote user password. + + + + + + + + Destination for message (user or channel). + + + + + + + + Rbot url. + + + + + + + + Show summary of options. + + + + + + + + Tell what it's all about. + + + + + + AUTHOR + + 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. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + diff --git a/man/rbot.xml b/man/rbot.xml new file mode 100644 index 00000000..bd8ccfbf --- /dev/null +++ b/man/rbot.xml @@ -0,0 +1,200 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| 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. + +--> + + + Marc"> + Dequ\[`e]nes"> + + 20090401"> + + 1"> + Duck@DuckCorp.org"> + + RBOT"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2004-2009 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + IRC bot written in ruby + + + + &dhpackage; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + confdir + + + + + DESCRIPTION + + &dhpackage; starts the Rbot (ruby IRC bot). + + + + OPTIONS + + This program follow the usual &gnu; command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + Display debug information (very verbose). + + + + + + + + Show summary of options. + + + + + + + + Display version information. + + + + + + + + + Sets the minimum log level verbosity. Possible values for the + loglevel are 0 (DEBUG), 1 (INFO), 2 (WARN), 3 (ERROR), 4 + (FATAL). The default loglevel is 1 (INFO messages). The logfile + is located at BOTDIR/BOTNAME.log and doesn't contain IRC logs + (which are located at BOTDIR/logs/*), but only rbot diagnostic + messages. + + + + + + + + + Background (daemonize) the bot. + + + + + + + + Write the bot pid to PIDFILE. The default pidfile is BOTDIR/rbot.pid. + + + + + CONFDIR + + Path to the directory where are stored the bot's configuration files. The default config directory is ~/.rbot. + + + + + + AUTHOR + + 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. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + -- cgit v1.2.3