summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2013-10-07 11:55:08 +0000
committerChristian Pointner <equinox@spreadspace.org>2013-10-07 11:55:08 +0000
commit6c40ae29a879eb7d7a70cbea9e3ff16e643ccce7 (patch)
tree4c05ef3d015aa4747668cccc00238de88d1e25af /doc
parentfixed build with -Wall (diff)
whitespace cleanups
updated copyright notice git-svn-id: https://svn.spreadspace.org/tcpproxy/trunk@68 e61f0598-a718-4e21-a8f0-0aadfa62ad6b
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile14
-rw-r--r--doc/tcpproxy.821
-rw-r--r--doc/tcpproxy.8.txt34
3 files changed, 39 insertions, 30 deletions
diff --git a/doc/Makefile b/doc/Makefile
index d094e90..404da2d 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,14 +1,14 @@
##
## tcpproxy
##
-## tcpproxy is a simple tcp connection proxy which combines the
-## features of rinetd and 6tunnel. tcpproxy supports IPv4 and
-## IPv6 and also supports connections from IPv6 to IPv4
+## tcpproxy is a simple tcp connection proxy which combines the
+## features of rinetd and 6tunnel. tcpproxy supports IPv4 and
+## IPv6 and also supports connections from IPv6 to IPv4
## endpoints and vice versa.
-##
##
-## Copyright (C) 2010-2011 Christian Pointner <equinox@spreadspace.org>
-##
+##
+## Copyright (C) 2010-2013 Christian Pointner <equinox@spreadspace.org>
+##
## This file is part of tcpproxy.
##
## tcpproxy is free software: you can redistribute it and/or modify
@@ -27,7 +27,7 @@
VERSION=$(shell cat ../version)
-.PHONY: clean
+.PHONY: clean
all: manpage
diff --git a/doc/tcpproxy.8 b/doc/tcpproxy.8
index 1eab26a..090d818 100644
--- a/doc/tcpproxy.8
+++ b/doc/tcpproxy.8
@@ -1,13 +1,22 @@
'\" t
.\" Title: tcpproxy
.\" Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\" Date: 12/14/2010
-.\" Manual: tcpproxy user manual
-.\" Source: tcpproxy trunk
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 10/07/2013
+.\" Manual: \ \&
+.\" Source: \ \&
.\" Language: English
.\"
-.TH "TCPPROXY" "8" "12/14/2010" "tcpproxy trunk" "tcpproxy user manual"
+.TH "TCPPROXY" "8" "10/07/2013" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -213,4 +222,4 @@ Christian Pointner <equinox@spreadspace\&.org>
Main web site: http://www\&.spreadspace\&.org/tcpproxy/
.SH "COPYING"
.sp
-Copyright (C) 2010 Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&.
+Copyright (C) 2010\-2013 Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&.
diff --git a/doc/tcpproxy.8.txt b/doc/tcpproxy.8.txt
index c727c69..85bb7f6 100644
--- a/doc/tcpproxy.8.txt
+++ b/doc/tcpproxy.8.txt
@@ -35,9 +35,9 @@ tcpproxy
DESCRIPTION
-----------
-*tcpproxy* is a simple tcp connection proxy which combines the
-features of rinetd and 6tunnel. *tcpproxy* supports IPv4 and
-IPv6 and also supports connections from IPv6 to IPv4 endpoints
+*tcpproxy* is a simple tcp connection proxy which combines the
+features of rinetd and 6tunnel. *tcpproxy* supports IPv4 and
+IPv6 and also supports connections from IPv6 to IPv4 endpoints
and vice versa.
OPTIONS
@@ -50,7 +50,7 @@ The following options can be passed to the *tcpproxy* daemon:
instead of becoming a daemon which is the default.
*-u, --username <username>*::
- run as this user. If no group is specified (*-g*) the default group of
+ run as this user. If no group is specified (*-g*) the default group of
the user is used. The default is to not drop privileges.
*-g, --groupname <groupname>*::
@@ -58,20 +58,20 @@ The following options can be passed to the *tcpproxy* daemon:
The default is to not drop privileges.
*-C, --chroot <path>*::
- Instruct *tcpproxy* to run in a chroot jail. The default is
+ Instruct *tcpproxy* to run in a chroot jail. The default is
to not run in chroot.
*-P, --write-pid <filename>*::
- Instruct *tcpproxy* to write it's pid to this file. The default is
+ Instruct *tcpproxy* to write it's pid to this file. The default is
to not create a pid file.
*-L, --log <target>:<level>[,<param1>[,<param2>[..]]]*::
add log target to logging system. This can be invoked several times
- in order to log to different targets at the same time. Every target
+ in order to log to different targets at the same time. Every target
has its own log level which is a number between 0 and 5. Where 0 means
disabling log and 5 means debug messages are enabled. +
The file target can be used more than once with different levels.
- If no target is provided at the command line a single target with the
+ If no target is provided at the command line a single target with the
config *syslog:3,tcpproxy,daemon* is added. +
The following targets are supported:
@@ -81,7 +81,7 @@ The following options can be passed to the *tcpproxy* daemon:
*stderr*;; log to standard error, parameters <level>
*-U, --debug*::
- This option instructs *tcpproxy* to run in debug mode. It implicits *-D*
+ This option instructs *tcpproxy* to run in debug mode. It implicits *-D*
(don't daemonize) and adds a log target with the configuration
*stdout:5* (logging with maximum level). In future releases there might
be additional output when this option is supplied.
@@ -95,7 +95,7 @@ The following options can be passed to the *tcpproxy* daemon:
to resolv both.
*-p, --local-port <service>*::
- The local port to bind to. By default there is no port defined in which case
+ 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>*::
@@ -116,7 +116,7 @@ The following options can be passed to the *tcpproxy* daemon:
By default *tcpproxy* uses the default source address for the defined remote host.
*-b, --buffer-size <size>*::
- The size of the transmit buffers to use. *tcpproxy* will allocate two buffers of this
+ 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>*::
@@ -148,12 +148,12 @@ SIGNALS
After receiving the HUP signal *tcpproxy* tries to reload the configuration file. It only
reopens a listen socket if the local address and or port has changed. Therefore reloading the
configuration after the daemon has dropped privileges is safe as long as there are no changes
-in the local address and port. However this is only of concern if any of the listen ports is
+in the local address and port. However this is only of concern if any of the listen ports is
a privileged port (<1024). If there is a syntax error at the configuration file all changes
are discarded.
On SIGUSR1 *tcpproxy* prints some information about the listening sockets and after SIGUSR2
-information about open client connections is printed. This is sent to all configured log
-targets at a level of 3.
+information about open client connections is printed. This is sent to all configured log
+targets at a level of 3.
BUGS
@@ -182,7 +182,7 @@ Main web site: http://www.spreadspace.org/tcpproxy/
COPYING
-------
-Copyright \(C) 2010 Christian Pointner. This program is free
-software: you can redistribute it and/or modify it under the terms
-of the GNU General Public License as published by the Free Software
+Copyright \(C) 2010-2013 Christian Pointner. This program is free
+software: you can redistribute it and/or modify it under the terms
+of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or any later version.