diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/tcpproxy.8 | 45 | ||||
| -rw-r--r-- | doc/tcpproxy.8.txt | 36 |
2 files changed, 65 insertions, 16 deletions
diff --git a/doc/tcpproxy.8 b/doc/tcpproxy.8 index 6739750..d4bcb42 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.2 <http://docbook.sf.net/> -.\" Date: 11/30/2010 +.\" Date: 12/02/2010 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "TCPPROXY" "8" "11/30/2010" "\ \&" "\ \&" +.TH "TCPPROXY" "8" "12/02/2010" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,10 +42,13 @@ tcpproxy \- IPv4/IPv6 tcp connection proxy [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ] [ \fB\-U|\-\-debug\fR ] [ \fB\-l|\-\-local\-addr\fR <host> ] + [ \fB\-t|\-\-local\-resolv\fR (ipv4|4|ipv6|6) ] [ \fB\-p|\-\-local\-port\fR <service> ] [ \fB\-r|\-\-remote\-addr\fR <host> ] + [ \fB\-R|\-\-remote\-resolv\fR (ipv4|4|ipv6|6) ] [ \fB\-o|\-\-remote\-port\fR <service> ] [ \fB\-s|\-\-source\-addr\fR <host> ] + [ \fB\-S|\-\-source\-resolv\fR (ipv4|4|ipv6|6) ] [ \fB\-b|\-\-buffer\-size\fR <size> ] [ \fB\-c|\-\-config\fR <file> ] .fi @@ -131,37 +134,61 @@ to run in debug mode\&. It implicits .PP \fB\-l, \-\-local\-addr <host>\fR .RS 4 -tba +The local address to bind to\&. By default +\fBtcpproxy\fR +will listen on any interface (IPv6 and IPv4)\&. +.RE +.PP +\fB\-t|\-\-local\-resolv (ipv4|4|ipv6|6)\fR +.RS 4 +When resolving the local address (see above) use only IPv4 or IPv6\&. The default is to resolv both\&. .RE .PP \fB\-p, \-\-local\-port <service>\fR .RS 4 -tba +The local port to bind to\&. By default there is no port defined in which case +\fBtcpproxy\fR +will try to read the configuration file\&. .RE .PP \fB\-r, \-\-remote\-addr <host>\fR .RS 4 -tba +The remote address to connect to\&. Unless the configuration file should be used this must be set to a valid address or hostname\&. +.RE +.PP +\fB\-R|\-\-remote\-resolv (ipv4|4|ipv6|6)\fR +.RS 4 +When resolving the remote address (see above) use only IPv4 or IPv6\&. The default is to resolv both\&. .RE .PP \fB\-o, \-\-remote\-port <service>\fR .RS 4 -tba +The remote port to connect to\&. Unless the configuration file should be used this must be set to a valid port or servicename\&. .RE .PP \fB\-s, \-\-source\-addr <host>\fR .RS 4 -tba +Instruct tcpproxy to use this source address for connections to +\fB\-R|\-\-remote\-address\fR\&. By default +\fBtcpproxy\fR +uses the default source address for the defined remote host\&. +.RE +.PP +\fB\-S|\-\-source\-resolv (ipv4|4|ipv6|6)\fR +.RS 4 +When resolving the source address (see above) use only IPv4 or IPv6\&. The default is to resolv both\&. .RE .PP \fB\-b, \-\-buffer\-size <size>\fR .RS 4 -tba +The size of the transmit buffers to use\&. +\fBtcpproxy\fR +will allocate two buffers of this size for any client which is connected\&. By default a value of 10Kbytes is used\&. .RE .PP \fB\-c, \-\-config <file>\fR .RS 4 -tba +The path to the configuration file to be used\&. This is only evaluated if the local port is omitted\&. .RE .SH "EXAMPLES" .sp diff --git a/doc/tcpproxy.8.txt b/doc/tcpproxy.8.txt index ebbac12..8da0b98 100644 --- a/doc/tcpproxy.8.txt +++ b/doc/tcpproxy.8.txt @@ -21,10 +21,13 @@ tcpproxy [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ] [ -U|--debug ] [ -l|--local-addr <host> ] + [ -t|--local-resolv (ipv4|4|ipv6|6) ] [ -p|--local-port <service> ] [ -r|--remote-addr <host> ] + [ -R|--remote-resolv (ipv4|4|ipv6|6) ] [ -o|--remote-port <service> ] [ -s|--source-addr <host> ] + [ -S|--source-resolv (ipv4|4|ipv6|6) ] [ -b|--buffer-size <size> ] [ -c|--config <file> ] .... @@ -85,25 +88,44 @@ The following options can be passed to the *tcpproxy* daemon: be additional output when this option is supplied. *-l, --local-addr <host>*:: - tba + The local address to bind to. By default *tcpproxy* will listen on any interface + (IPv6 and IPv4). + +*-t|--local-resolv (ipv4|4|ipv6|6)*:: + When resolving the local address (see above) use only IPv4 or IPv6. The default is + to resolv both. *-p, --local-port <service>*:: - tba + The local port to bind to. By default there is no port defined in which case + *tcpproxy* will try to read the configuration file. *-r, --remote-addr <host>*:: - tba + The remote address to connect to. Unless the configuration file should be used this + must be set to a valid address or hostname. + +*-R|--remote-resolv (ipv4|4|ipv6|6)*:: + When resolving the remote address (see above) use only IPv4 or IPv6. The default is + to resolv both. *-o, --remote-port <service>*:: - tba + The remote port to connect to. Unless the configuration file should be used this + must be set to a valid port or servicename. *-s, --source-addr <host>*:: - tba + Instruct tcpproxy to use this source address for connections to *-R|--remote-address*. + By default *tcpproxy* uses the default source address for the defined remote host. + +*-S|--source-resolv (ipv4|4|ipv6|6)*:: + When resolving the source address (see above) use only IPv4 or IPv6. The default is + to resolv both. *-b, --buffer-size <size>*:: - tba + The size of the transmit buffers to use. *tcpproxy* will allocate two buffers of this + size for any client which is connected. By default a value of 10Kbytes is used. *-c, --config <file>*:: - tba + The path to the configuration file to be used. This is only evaluated if the local port + is omitted. EXAMPLES |