summaryrefslogtreecommitdiff
path: root/doc/tcpproxy.8.txt
blob: 96b7733e88234e64984377df97bc5ac9160926c2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
tcpproxy(8)
===========

NAME
----

tcpproxy - IPv4/IPv6 tcp connection proxy


SYNOPSIS
--------

....
tcpproxy
  [ -h|--help ]
  [ -D|--nodaemonize ]
  [ -u|--username <username> ]
  [ -g|--groupname <groupname> ]
  [ -C|--chroot <path> ]
  [ -P|--write-pid <filename> ]
  [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
  [ -U|--debug ]
  [ -l|--local-addr <host> ]
  [ -p|--local-port <service> ]
  [ -r|--remote-addr <host> ]
  [ -o|--remote-port <service> ]
  [ -s|--source-addr <host> ]
  [ -c|--config <file> ]
....


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 
and vice versa.

OPTIONS
-------

The following options can be passed to the *tcpproxy* daemon:

*-D, --nodaemonize*::
   This option instructs *tcpproxy* to run in foreground
   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 
   the user is used. The default is to not drop privileges.

*-g, --groupname <groupname>*::
   run as this group. If no username is specified (*-u*) this gets ignored.
   The default is to not drop privileges.

*-C, --chroot <path>*::
   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 
   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 
   hast 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 the once with different levels.
   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:

   *syslog*;; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
   *file*;; log to file, parameters <level>[,<path>]
   *stdout*;; log to standard output, parameters <level>
   *stderr*;; log to standard error, parameters <level>

*-U, --debug*::
   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.

*-l, --local-addr <host>*::
   tba

*-p, --local-port <service>*::
   tba

*-r, --remote-addr <host>*::
   tba

*-o, --remote-port <service>*::
   tba

*-s, --source-addr <host>*::
   tba

*-c, --config <file>*::
   tba


EXAMPLES
--------

nothing yet..


BUGS
----
Most likely there are some bugs in *tcpproxy*. If you find a bug, please let
the developers know at tcpproxy@spreadspace.org. Of course, patches are preferred.


SEE ALSO
--------
nothing yet..


AUTHORS
-------

Christian Pointner <equinox@spreadspace.org>


RESOURCES
---------

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 
Foundation, either version 3 of the License, or any later version.