doc/config-reference.xml

   1 <!DOCTYPE variablelist PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   2
   3 <variablelist>
   4         <varlistentry>
   5                 <term>replication</term>
   6                 <listitem><para>
   7                                 Replication backend to use. See the section about
   8                                 replication below for details.
   9                         </para>
  10                 </listitem>
  11         </varlistentry>
  12
  13         <varlistentry>
  14                 <term>report-time</term>
  15                 <listitem><para>
  16                                 This setting controls whether lines sent to the user should be
  17                                 prefixed with the time the message was received from the
  18                                 network. It can have the value <emphasis>never</emphasis>,
  19                                 <emphasis>always</emphasis> or <emphasis>replication</emphasis>.
  20                         </para>
  21                         <para>
  22                                 <emphasis>never</emphasis> disables prefixing the time.
  23                         </para>
  24                         <para>
  25                                 <emphasis>always</emphasis> will prefix all lines with the
  26                                 time.
  27                         </para>
  28                         <para>
  29                                 <emphasis>replication</emphasis> will only cause messages
  30                                 sent when sending backlog to be prefixed with the time.
  31                         </para>
  32                         <para>The default is <emphasis>never</emphasis></para>
  33                 </listitem>
  34         </varlistentry>
  35
  36         <varlistentry>
  37                 <term>autosave</term>
  38                 <listitem><para>
  39                                 Boolean setting that determines whether to automatically save
  40                                 the configuration on exit.</para>
  41                 </listitem>
  42         </varlistentry>
  43
  44         <varlistentry>
  45                 <term>autoconnect</term>
  46                 <listitem><para>
  47                                 Semi-colon separated list of networks or
  48                                 servers to connect to on startup.
  49                 </para></listitem>
  50         </varlistentry>
  51
  52         <varlistentry>
  53                 <term>motd-file</term>
  54                 <listitem><para>
  55                                 Path to the message of the day file that is sent to
  56                                 clients upon connect.
  57                 </para></listitem>
  58         </varlistentry>
  59
  60         <varlistentry>
  61                 <term>match</term>
  62                 <listitem><para>
  63                                If the replication backend is set
  64                                to <emphasis>highlight</emphasis>, this variable
  65                                 should contain a semicolon-separated list of
  66                                 words to search for.
  67                 </para></listitem>
  68         </varlistentry>
  69
  70         <varlistentry>
  71                 <term>port</term>
  72                 <listitem><para>
  73                         Port at which CtrlProxy should listen for new connections
  74                         Connections can be plain IRC connections or use the SOCKS protocol.
  75                 </para></listitem>
  76         </varlistentry>
  77
  78         <varlistentry>
  79                 <term>password</term>
  80                 <listitem><para>
  81                                 Password that should be used for logging in to ctrlproxy.
  82                                 The password can be prefixed with a network name and a colon
  83                                 to connect to a specific network.
  84                 </para></listitem>
  85         </varlistentry>
  86
  87         <varlistentry>
  88                 <term>bind</term>
  89                 <listitem><para>
  90                                 Optional address CtrlProxy should bind to when listening
  91                                 for new connections.</para>
  92                 </listitem>
  93                 </varlistentry>
  94         </variablelist>
  95
  96
  97         <para>If the [admin] section is present, ControlProxy will
  98                 create a fake network with a control channel that can
  99                 be used for administration.
 100         </para>
 101
 102         <variablelist>
 103                 <varlistentry>
 104                         <term>no_privmsg</term>
 105                         <listitem><para>
 106                                Don't interpret messages to the
 107                                user <emphasis>ctrlproxy</emphasis> as administration commands.
 108                         </para>
 109                         <para>
 110                                 This option would be needed if you want to be able to
 111                                send messages to an actual user with the
 112                                nickname <emphasis>ctrlproxy</emphasis>.
 113                 </para></listitem>
 114                 </varlistentry>
 115         </variablelist>
 116 </refsect2>
 117
 118 <refsect2>
 119         <title>[log-custom]</title>
 120
 121         <para>
 122                 If the [log-custom] section is present, ControlProxy
 123                 will write a log to <filename>~/.ctrlproxy/log-custom/</filename>
 124         </para>
 125 </refsect2>
 126
 127 <refsect2>
 128         <title>[log-irssi]</title>
 129
 130         <para>If the [log-irssi] section is present, ControlProxy
 131                 will write irssi-style log files to <filename>~/.ctrlproxy/log-irssi/NETWORK/CHANNEL</filename>.
 132         </para>
 133
 134         <variablelist>
 135                 <varlistentry>
 136                         <term>logfile</term>
 137                         <listitem><para>
 138                                        Directory in which logs will be written (defaults
 139                                        to <filename>~/.ctrlproxy/log-irssi/</filename>.
 140                         </para></listitem>
 141                 </varlistentry>
 142         </variablelist>
 143 </refsect2>
 144
 145                 <varlistentry>
 146                         <term>auto-away-message</term>
 147                         <listitem><para>
 148                                         Away message to set.
 149                         </para></listitem>
 150                 </varlistentry>
 151                 <varlistentry>
 152                         <term>auto-away-client-limit</term>
 153                         <listitem><para>
 154                                         Integer variable. After idle for the specified time,
 155                                         the connection will only be changed to away if there are
 156                                         not more than client_limit connected. The default is -1
 157                                         (always set idle no matter how many clients there are).
 158                                         To achive the behavior of the old variable <term>only_noclient</term>,
 159                                         set client_limit to 0.
 160                         </para></listitem>
 161                 </varlistentry>
 162
 163                 <varlistentry>
 164                         <term>auto-away-time</term>
 165                         <listitem><para>
 166                                         Number of seconds of idleness after which the
 167                                         connection should be set to away. Default is 10 minutes.
 168                         </para></listitem>
 169                 </varlistentry>
 170
 171                 <varlistentry>
 172                         <term>ssl</term>
 173                         <listitem><para>
 174                                         Specifies whether the incoming connections will be SSL.
 175                         </para></listitem>
 176                 </varlistentry>
 177
 178                 <varlistentry>
 179                         <term>network</term>
 180                         <listitem><para>
 181                                         The default network incoming clients will be connected to.
 182                                 </para>
 183                                 <para>
 184                                         If no network is set, clients will have to select
 185                                         a network upon connect using the <command>CONNECT</command>
 186                                         command.
 187                                 </para>
 188                         </listitem>
 189                 </varlistentry>-->
 190
 191 <refsect1>
 192         <title>REPLICATION</title>
 193
 194         <para>When a client connects, ctrlproxy will send information about
 195                 the channels the user is on. Optionally, it can also send
 196                 some of the messages that were received before the client connected
 197                 (replication).
 198         </para>
 199
 200         <para>
 201                 The <parameter>replication</parameter> variable determines what
 202                 kind of replication is used. At the moment, the following
 203                 values are supported:
 204         </para>
 205
 206         <variablelist>
 207                 <varlistentry>
 208                         <term>none</term>
 209                         <listitem><para>No replication.</para></listitem>
 210                 </varlistentry>
 211
 212                 <varlistentry>
 213                         <term>highlight</term>
 214                         <listitem><para>
 215                                 Send messages that one of a set of regular expressions.
 216                                 The regular expressions should be specified in
 217                                 variable.</para></listitem>
 218                 </varlistentry>
 219
 220                 <varlistentry>
 221                         <term>lastdisconnect</term>
 222                         <listitem><para>
 223                                         Send all messages since the last client disconnected.
 224                         </para></listitem>
 225                 </varlistentry>
 226
 227                 <varlistentry>
 228                         <term>simple</term>
 229                         <listitem><para>
 230                                         Send all messages since the last message said by
 231                                         the user.</para></listitem>
 232                 </varlistentry>
 233         </variablelist>
 234
 235 </refsect1>
 236
 237 </variablelist>