Some minor updates to the docs.
authorJelmer Vernooij <jelmer@samba.org>
Mon, 2 Apr 2007 14:21:19 +0000 (16:21 +0200)
committerJelmer Vernooij <jelmer@samba.org>
Mon, 2 Apr 2007 14:21:19 +0000 (16:21 +0200)
doc/about.xml [new file with mode: 0644]
doc/commands.xml
doc/help.xml
doc/introduction.xml
doc/logging.xml
doc/user-guide.xml

diff --git a/doc/about.xml b/doc/about.xml
new file mode 100644 (file)
index 0000000..12eb7aa
--- /dev/null
@@ -0,0 +1,11 @@
+<chapter id="about">
+<title>About</title>
+
+<para>CtrlProxy was written by Jelmer Vernooij with the help from 
+       various other people. See the AUTHORS file in the tarball for details.
+</para>
+
+<para>The CtrlProxy homepage can be found at 
+       <emphasis>http://ctrlproxy.vernstok.nl/</emphasis>.</para>
+
+</chapter>
index 16bc755fa008e96a4a45c0bb33fcb9081c03fb1e..f5150aab43ebf256778598a34a8ee508a39ff0b3 100644 (file)
@@ -87,7 +87,5 @@
                <varlistentry><term>HELP [&lt;topic&gt;]</term>
                <listitem><para>Prints out list of available commands.</para></listitem></varlistentry>
 
-
-
        </variablelist>
 </sect1>
index 1e5b097c2f2d252facb01f06c1a058182908e0f9..bd8b017980a6975e8b1de16198cdaeaf8b6a28bd 100644 (file)
@@ -28,5 +28,8 @@ You can read more about them with <emphasis>help &lt;subject&gt;</emphasis>
 <xi:include href="admin.xml"/>
 <xi:include href="clients.xml"/>
 <xi:include href="commands.xml"/>
+<xi:include href="about.xml"/>
+<xi:include href="logging.xml"/>
+<xi:include href="introduction.xml"/>
 
 </book>
index b5b40345e35708a33749bb3d7a6f3897e5f12135..445116a7fe294cf9a74b075cfbfcd0beafea2818 100644 (file)
@@ -1,7 +1,7 @@
 <chapter id="introduction">
        <title>Introduction</title>
 
-       <sect1>
+       <sect1 id="why">
                <title>Why ctrlproxy?</title>
 
 <para>
@@ -16,7 +16,7 @@ The structure of ctrlproxy is very modular and it is easily extendible.
 
 </sect1>
 
-<sect1><title>What is ctrlproxy?</title>
+<sect1 id="whatis"><title>What is ctrlproxy?</title>
 
        <para>Ctrlproxy is a so-called IRC proxy or BNC (bouncer). It keeps a 
                permanent connection to one or more IRC servers. The user can then 
@@ -33,7 +33,7 @@ The structure of ctrlproxy is very modular and it is easily extendible.
        
 </sect1>
 
-<sect1><title>Features</title>
+<sect1 id="features"><title>Features</title>
 
 <itemizedlist>
        <listitem><para>Connect to one server with many clients under one nick transparently</para></listitem>
@@ -52,7 +52,7 @@ The structure of ctrlproxy is very modular and it is easily extendible.
 
 </sect1>
 
-<sect1>
+<sect1 id="requirements">
        <title>Requirements</title>
 
 <itemizedlist>
index 3031cc003f967306a594f0b0454991b8e77fe5a8..bc6d5844e9d2a951d5e7d20946ea7e16ca5a7e77 100644 (file)
@@ -6,7 +6,7 @@
        CtrlProxy has various means for logging conversions to file. 
 </para>
 
-<sect1>
+<sect1 id="log irssi">
        <title>Logging in irssi-style format</title>
 
        <para>By setting <parameter>log_irssi_path</parameter> to a directory, 
@@ -20,7 +20,7 @@
        <para>If no directory is specified, data will be logged to <filename>$HOME/.ctrlproxy/log_irssi/$NETWORK/$CHANNEL</filename>.</para>
 </sect1>
 
-<sect1>
+<sect1 id="log custom">
        <title>Logging in a custom format</title>
 
        <para>
@@ -32,7 +32,7 @@
 
        </para>
 
-       <sect2>
+       <sect2 id="log custom variables">
                <title>Substitutes</title>
 
                <para>The configuration values define the syntax that is used to
index ea0383a8c8e454dfc48092b24d982effcacdc55e..cb7d34d0a9d417079c054281ca840dd7a51c1702 100644 (file)
@@ -28,5 +28,6 @@
 <xi:include href="admin.xml"/>
 <xi:include href="logging.xml"/>
 <xi:include href="clients.xml"/>
+<xi:include href="about.xml"/>
 
 </book>