added config file format to manpage

git-svn-id: https://svn.spreadspace.org/tcpproxy/trunk@28 e61f0598-a718-4e21-a8f0-0aadfa62ad6b

2 files changed, 37 insertions, 7 deletions

diff --git a/doc/tcpproxy.8 b/doc/tcpproxy.8
index b4ea062..c0d9729 100644
--- a/doc/tcpproxy.8
+++ b/doc/tcpproxy.8
@@ -2,12 +2,12 @@
 .\"     Title: tcpproxy
 .\"    Author: [see the "AUTHORS" section]
 .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\"      Date: 12/02/2010
+.\"      Date: 12/03/2010
 .\"    Manual: tcpproxy user manual
 .\"    Source: tcpproxy trunk
 .\"  Language: English
 .\"
-.TH "TCPPROXY" "8" "12/02/2010" "tcpproxy trunk" "tcpproxy user manual"
+.TH "TCPPROXY" "8" "12/03/2010" "tcpproxy trunk" "tcpproxy user manual"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -175,9 +175,27 @@ will allocate two buffers of this size for any client which is connected\&. By d
 .RS 4
 The path to the configuration file to be used\&. This is only evaluated if the local port is omitted\&.
 .RE
-.SH "EXAMPLES"
+.SH "CONFIGURATION FILE"
 .sp
-nothing yet\&.\&.
+If the configuratin file is used it should contain one or more of the following stanzas:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+listen (*|address|hostname) (port\-number|service\-name)
+{
+  resolv: (ipv4|ipv6)
+  remote: (address|hostname) (port\-number|service\-name);
+  remote\-resolv: (ipv4|ipv6);
+  source: (address|hostname);
+};
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Everything between the curly brackets except for the \fBremote\fR parameter may be omitted\&.
 .SH "BUGS"
 .sp
 Most likely there are some bugs in \fBtcpproxy\fR\&. If you find a bug, please let the developers know at tcpproxy@spreadspace\&.org\&. Of course, patches are preferred\&.
diff --git a/doc/tcpproxy.8.txt b/doc/tcpproxy.8.txt
index 14a12af..c6574d1 100644
--- a/doc/tcpproxy.8.txt
+++ b/doc/tcpproxy.8.txt
@@ -124,10 +124,22 @@ The following options can be passed to the *tcpproxy* daemon:
    is omitted.
 
 
-EXAMPLES
---------
+CONFIGURATION FILE
+------------------
 
-nothing yet..
+If the configuratin file is used it should contain one or more of the following stanzas:
+
+....
+listen (*|address|hostname) (port-number|service-name)
+{
+  resolv: (ipv4|ipv6)
+  remote: (address|hostname) (port-number|service-name);
+  remote-resolv: (ipv4|ipv6);
+  source: (address|hostname);
+};
+....
+
+Everything between the curly brackets except for the *remote* parameter may be omitted.
 
 
 BUGS