doc/commands.xml

   1 <sect1 id="commands">
   2         <title>Commands</title>
   3
   4         <para>The following commands are supported:</para>
   5
   6         <variablelist>
   7                 <varlistentry><term>ADDNETWORK &lt;name&gt;</term>
   8                 <listitem><para>
   9                 Adds a new network with the specified name.
  10                 </para></listitem></varlistentry>
  11
  12                 <varlistentry><term>ADDSERVER &lt;network&gt; &lt;server&gt; &lt;port&gt;</term>
  13                 <listitem><para>
  14                 Adds a new server to the specified network with the specified type and options.</para>
  15
  16                 <para>Example: <command>addserver OPN irc.freenode.net 6667</command></para>
  17
  18                 </listitem></varlistentry>
  19
  20                 <varlistentry><term>BACKLOG [&lt;channel&gt;]</term>
  21                 <listitem>
  22                         <para>Without any arguments, the BACKLOG command replicates all the
  23                         backlogs for the current channel.</para>
  24
  25                 <para>With one argument, the name of a channel, all lines on that
  26                         channel are replicated.</para>
  27
  28                 </listitem></varlistentry>
  29
  30                 <varlistentry><term>CONNECT &lt;network&gt;</term>
  31
  32                 <listitem><para>Connect to the specifed network. Ctrlproxy will connect to the first known server for this network.</para></listitem></varlistentry>
  33
  34                 <varlistentry><term>DELNETWORK &lt;network&gt;</term>
  35
  36                 <listitem><para>Remove the specified network. The network may not be connected.</para></listitem></varlistentry>
  37
  38                 <varlistentry><term>DIE</term>
  39
  40                 <listitem><para>Disconnect all clients and servers and exit ctrlproxy.</para></listitem></varlistentry>
  41
  42                 <varlistentry><term>DISCONNECT &lt;network&gt;</term>
  43
  44                 <listitem><para>Disconnect from the specified network.</para></listitem></varlistentry>
  45
  46                 <varlistentry><term>DETACH</term>
  47
  48                 <listitem><para>Detach client from the proxy.</para></listitem></varlistentry>
  49
  50                 <varlistentry><term>LISTNETWORKS</term>
  51                 <listitem><para>Prints out a list of all networks
  52                 ctrlproxy is connected to at the moment.</para></listitem></varlistentry>
  53
  54                 <varlistentry><term>NEXTSERVER</term>
  55                         <listitem><para>Makes the specified network disconnect from the current server and go to the next one.</para></listitem>
  56                 </varlistentry>
  57
  58                 <varlistentry><term>SAVECONFIG</term>
  59                         <listitem><para>Save the (updated) configuration to the location it was loaded from (usually <filename>$HOME/.ctrlproxy/</filename>).</para></listitem></varlistentry>
  60
  61                 <varlistentry><term>HELP</term>
  62                 <listitem><para>Prints out list of available commands.</para></listitem></varlistentry>
  63
  64
  65
  66         </variablelist>
  67 </sect1>