doc/ctrlproxy-admin.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   3 <refentry id="ctrlproxy.1">
   4
   5 <refmeta>
   6         <refentrytitle>ctrlproxy-admin</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10 <refnamediv>
  11         <refname>ctrlproxy-admin</refname>
  12         <refpurpose>command-line interface for managing ctrlproxy</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>ctrlproxy</command>
  18                 <arg choice="opt">-c config dir</arg>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25 <para>
  26         <command>ctrlproxy-admin</command> is a simple command-line
  27         tool for managing a ctrlproxy instance. It accepts the
  28         same syntax as the "admin" network in ctrlproxy.
  29 </para>
  30
  31 </refsect1>
  32
  33 <refsect1>
  34         <title>OPTIONS</title>
  35
  36 <para><command>ctrlproxy-admin</command> recognizes the following command-line options</para>
  37
  38 <variablelist>
  39         <varlistentry><term>-c, --config-dir=DIR</term>
  40                 <listitem><para>Read configuration files from the specified directory <option>DIR</option> instead of from <filename>.ctrlproxy</filename> in the users' homedirectory.</para></listitem>
  41         </varlistentry>
  42
  43         <varlistentry><term>-?, --help</term>
  44         <listitem><para>Show help message with short argument information</para></listitem>
  45         </varlistentry>
  46
  47 </variablelist>
  48
  49 </refsect1>
  50
  51 <refsect1>
  52         <title>SEE ALSO</title>
  53
  54 <para>irssi(1), ctrlproxy(1), ctrlproxy_config(5), http://ctrlproxy.vernstok.nl/, config.example</para>
  55
  56 </refsect1>
  57
  58 <refsect1>
  59         <title>FILES</title>
  60
  61         <para><filename>~/.ctrlproxy/admin</filename> is the UNIX domain socket ctrlproxy-admin uses to
  62                 communicate with the ctrlproxy instance.</para>
  63 </refsect1>
  64
  65 <refsect1>
  66         <title>BUGS</title>
  67
  68 <para>
  69 Probably, but none are known at the moment. Please send
  70 any you find to jelmer@samba.org
  71 </para>
  72 </refsect1>
  73
  74 <refsect1>
  75         <title>LICENSE</title>
  76
  77 <para>
  78 This program is free software; you can redistribute it and/or modify
  79 it under the terms of the GNU General Public License as published by
  80 the Free Software Foundation; either version 3 of the License, or
  81 (at your option) any later version.
  82 </para>
  83
  84 <para>
  85 This program is distributed in the hope that it will be useful, but
  86 \fBWITHOUT ANY WARRANTY\fR; without even the implied warranty of
  87 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  88 General Public License for more details.
  89 </para>
  90
  91 <para>
  92 You should have received a copy of the GNU General Public License
  93 along with this program; if not, write to the Free Software
  94 Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA  02111-1307  USA
  95 </para>
  96
  97 </refsect1>
  98
  99 <refsect1>
 100         <title>AUTHORS</title>
 101 <para>
 102 <ulink url="mailto:jelmer@samba.org">Jelmer Vernooij</ulink> (main developer)
 103 </para>
 104
 105 <para>See the file AUTHORS for a full list of contributors.</para>
 106 </refsect1>
 107 </refentry>