irk.xml

   1 <!DOCTYPE refentry PUBLIC
   2    "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3    "docbook/docbookx.dtd">
   4 <refentry id='irk.8'>
   5 <refmeta>
   6 <refentrytitle>irk</refentrytitle>
   7 <manvolnum>1</manvolnum>
   8 <refmiscinfo class='date'>Apr 30 2014</refmiscinfo>
   9 <refmiscinfo class='source'>irker</refmiscinfo>
  10 <refmiscinfo class='product'>irker</refmiscinfo>
  11 <refmiscinfo class='manual'>Commands</refmiscinfo>
  12 </refmeta>
  13 <refnamediv id='name'>
  14 <refname>irk</refname>
  15 <refpurpose>test program for irkerd</refpurpose>
  16 </refnamediv>
  17 <refsynopsisdiv id='synopsis'>
  18
  19 <cmdsynopsis>
  20   <command>irk</command>
  21      <arg><replaceable>target</replaceable></arg>
  22      <arg choice='opt'><replaceable>message text</replaceable></arg>
  23 </cmdsynopsis>
  24 </refsynopsisdiv>
  25
  26 <refsect1 id='description'><title>DESCRIPTION</title>
  27
  28 <para><application>irk</application> is a simple test program for
  29 <citerefentry><refentrytitle>irkerd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. It
  30 will construct a simple JSON object and pass it to the daemon running
  31 on localhost.</para>
  32 </refsect1>
  33
  34 <refsect1 id='options'><title>OPTIONS</title>
  35
  36 <para><application>irk</application> takes the following options:</para>
  37
  38 <variablelist>
  39 <varlistentry>
  40 <term>target</term>
  41 <listitem><para>Which server and channel to join to announced the
  42 message. If not prefixed with "irc:", it will prefix
  43 "irc://chat.freenode.net/" to the argument before passing it directly
  44 to irkerd. This argument is passed as the "to" parameter in the JSON
  45 object.</para></listitem>
  46 </varlistentry>
  47 <varlistentry>
  48 <term>message</term>
  49 <listitem><para>Which message to send to the target specified
  50 above. If the string "-", the message will be read from standard
  51 input, with newlines stripped.</para></listitem>
  52 </varlistentry>
  53 </variablelist>
  54
  55 </refsect1>
  56
  57 <refsect1 id='limitations'><title>LIMITATIONS</title>
  58
  59 <para><application>irk</application> has no commandline usage and may
  60 be riddled with bugs.</para>
  61
  62 <para><application>irk</application> doesn't know how to talk to your
  63 favorite VCS. You will generally want to use
  64 <citerefentry><refentrytitle>irkerhook</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  65 instead</para>
  66
  67 <para><application>irk</application> has also all the limitations of
  68 <application>irkerd</application>.</para>
  69 </refsect1>
  70
  71 <refsect1 id='see_also'><title>SEE ALSO</title>
  72 <para>
  73 <citerefentry><refentrytitle>irkerhook</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  74 </para>
  75 </refsect1>
  76
  77 <refsect1 id='authors'><title>AUTHOR</title>
  78 <para>Eric S. Raymond <email>esr@snark.thyrsus.com</email>.  See the
  79 project page at <ulink
  80 url='http://www.catb.org/~esr/irker'>http://www.catb.org/~esr/irker</ulink>
  81 for updates and other resources, including an installable repository
  82 hook script.</para>
  83 </refsect1>
  84 </refentry>