Add unix sockets to man

This commit is contained in:
Vladimir Dubrovin 2026-04-13 11:54:24 +03:00
parent 878a432481
commit 2fd536781f
16 changed files with 146 additions and 19 deletions

View File

@ -101,7 +101,13 @@ smtpp</b> SMTP proxy (default port 25) <b><br>
ftppr</b> FTP proxy (default port 21) <b><br> ftppr</b> FTP proxy (default port 21) <b><br>
admin</b> Web interface (default port 80) <b><br> admin</b> Web interface (default port 80) <b><br>
dnspr</b> caching DNS proxy (default port 53) <b><br> dnspr</b> caching DNS proxy (default port 53) <b><br>
tcppm</b> TCP portmapper <b><br> tcppm</b> TCP portmapper. Destination address (DSTADDR) can
be a Unix domain socket using the syntax
<i>unix:/path/to/socket</i> (e.g., tcppm 8080
unix:/var/run/app.sock 0). On Linux, abstract sockets use
<i>unix:@socketname</i> syntax. When using Unix socket
destination, the port number is ignored but must be
specified for syntax compatibility. <b><br>
udppm</b> UDP portmapper</p> udppm</b> UDP portmapper</p>
<p style="margin-left:6%; margin-top: 1em">Options: <b><br> <p style="margin-left:6%; margin-top: 1em">Options: <b><br>
@ -172,7 +178,9 @@ system will decide which address to use in accordance with
the routing table. <b><br> the routing table. <b><br>
-i</b> Internal address. IP address the proxy accepts -i</b> Internal address. IP address the proxy accepts
connections to. By default, connections to any interface are connections to. By default, connections to any interface are
accepted. <b><br> accepted. Unix domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax. On Linux, abstract
sockets use <i>-iunix:@socketname</i> syntax. <b><br>
-N</b> (for socks) External NAT address 3proxy reports to -N</b> (for socks) External NAT address 3proxy reports to
client for BIND and UDPASSOC By default external address is client for BIND and UDPASSOC By default external address is
reported. It&rsquo;s only useful in the case of IP-IP NAT reported. It&rsquo;s only useful in the case of IP-IP NAT
@ -447,7 +455,14 @@ connection.</p>
sets ip address of internal interface. This IP address will sets ip address of internal interface. This IP address will
be used to bind gateways. Alternatively you can use -i be used to bind gateways. Alternatively you can use -i
option for individual gateways. Since 0.8 version, IPv6 option for individual gateways. Since 0.8 version, IPv6
address may be used.</p> address may be used. <br>
Unix domain sockets are supported with the syntax
<i>unix:/path/to/socket</i> (e.g., internal
unix:/var/run/3proxy.sock). On Linux, abstract (fileless)
Unix sockets are supported with the syntax
<i>unix:@socketname</i> (e.g., internal unix:@3proxy). When
using Unix sockets, the socket file is automatically created
and removed on service start/stop.</p>
<p style="margin-left:6%; margin-top: 1em"><b>external</b> <p style="margin-left:6%; margin-top: 1em"><b>external</b>
&lt;ipaddr&gt; <br> &lt;ipaddr&gt; <br>
@ -699,7 +714,15 @@ special case of local redirection, it works only with
redirected to different service, <b>ftp</b> locally redirected to different service, <b>ftp</b> locally
redirects to <b>ftppr pop3</b> locally redirects to <b>pop3p redirects to <b>ftppr pop3</b> locally redirects to <b>pop3p
http</b> locally redirects to <b>proxy admin</b> locally http</b> locally redirects to <b>proxy admin</b> locally
redirects to the admin -s service.</p> redirects to the admin -s service. <br>
Unix domain sockets can be used instead of IP address with
the syntax <i>unix:/path/to/socket</i> (e.g., parent 1000
socks5 unix:/var/run/parent.sock 1080). On Linux, abstract
(fileless) Unix sockets are supported with
<i>unix:@socketname</i> syntax (e.g., parent 1000 http
unix:@parent.proxy 3128). When using Unix sockets, the port
number is ignored but must be specified for syntax
compatibility.</p>
<p style="margin-left:6%; margin-top: 1em">Main purpose of <p style="margin-left:6%; margin-top: 1em">Main purpose of
local redirections is to have the requested resource (URL or local redirections is to have the requested resource (URL or

View File

@ -128,7 +128,11 @@ accordance with the routing table.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/ftppr.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="3%"> <td width="3%">

View File

@ -128,7 +128,11 @@ accordance with the routing table.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/pop3p.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="3%"> <td width="3%">

View File

@ -127,7 +127,11 @@ accordance with the routing table.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/proxy.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="4%"> <td width="4%">

View File

@ -128,7 +128,11 @@ accordance with the routing table.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/smtpp.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="3%"> <td width="3%">

View File

@ -162,7 +162,11 @@ and does not work with port translation.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/socks.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="4%"> <td width="4%">

View File

@ -116,7 +116,11 @@ accordance with the routing table.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/tcppm.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="3%"> <td width="3%">
@ -160,12 +164,18 @@ connections on</p>
<p style="margin-left:6%;"><i>remote_host</i></p> <p style="margin-left:6%;"><i>remote_host</i></p>
<p style="margin-left:15%;">- IP address of the host the <p style="margin-left:15%;">- IP address of the host the
connection is forwarded to</p> connection is forwarded to. Unix domain sockets can be
specified with the syntax <i>unix:/path/to/socket</i> (e.g.,
unix:/var/run/app.sock). On Linux, abstract (fileless) Unix
sockets use the syntax <i>unix:@socketname</i> (e.g.,
unix:@app.socket).</p>
<p style="margin-left:6%;"><i>remote_port</i></p> <p style="margin-left:6%;"><i>remote_port</i></p>
<p style="margin-left:15%;">- remote port the connection is <p style="margin-left:15%;">- remote port the connection is
forwarded to</p> forwarded to. Ignored when using Unix socket destination,
but must be specified (use any positive value) for syntax
compatibility.</p>
<h2>CLIENTS <h2>CLIENTS
<a name="CLIENTS"></a> <a name="CLIENTS"></a>

View File

@ -132,7 +132,11 @@ accordance with the routing table.</p></td></tr>
<p style="margin-top: 1em">Internal address. IP address the <p style="margin-top: 1em">Internal address. IP address the
proxy accepts connections to. By default, connections to any proxy accepts connections to. By default, connections to any
interface are accepted. It&acute;s usually unsafe.</p></td></tr> interface are accepted. It&acute;s usually unsafe. Unix
domain sockets can be specified with
<i>-iunix:/path/to/socket</i> syntax (e.g.,
-iunix:/var/run/tlspr.sock). On Linux, abstract sockets use
<i>-iunix:@socketname</i> syntax.</p></td></tr>
<tr valign="top" align="left"> <tr valign="top" align="left">
<td width="6%"></td> <td width="6%"></td>
<td width="4%"> <td width="4%">

View File

@ -87,7 +87,7 @@ SOCKS 4/4.5/5 proxy (default port 1080)
SNI proxy (destination address is taken from TLS handshake), may be used to redirect any TLS-based traffic SNI proxy (destination address is taken from TLS handshake), may be used to redirect any TLS-based traffic
.br .br
.B auto .B auto
Proxy with protocol autoselection between proxy / socks / tlspr Proxy with protocol autoselection between proxy / socks / tlspr
.br .br
.B pop3p .B pop3p
POP3 proxy (default port 110) POP3 proxy (default port 110)
@ -105,7 +105,13 @@ Web interface (default port 80)
caching DNS proxy (default port 53) caching DNS proxy (default port 53)
.br .br
.B tcppm .B tcppm
TCP portmapper TCP portmapper. Destination address (DSTADDR) can be a Unix domain socket
using the syntax
.I unix:/path/to/socket
(e.g., tcppm 8080 unix:/var/run/app.sock 0). On Linux, abstract sockets use
.I unix:@socketname
syntax. When using Unix socket destination, the port number is ignored
but must be specified for syntax compatibility.
.br .br
.B udppm .B udppm
UDP portmapper UDP portmapper
@ -180,7 +186,12 @@ with the routing table.
.br .br
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. By default, connections to any interface are accepted.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax. On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.br .br
.B -N .B -N
(for socks) External NAT address 3proxy reports to client for BIND and UDPASSOC (for socks) External NAT address 3proxy reports to client for BIND and UDPASSOC
@ -513,6 +524,14 @@ http://dial.right.now/ from browser to set up connection.
sets ip address of internal interface. This IP address will be used sets ip address of internal interface. This IP address will be used
to bind gateways. Alternatively you can use -i option for individual to bind gateways. Alternatively you can use -i option for individual
gateways. Since 0.8 version, IPv6 address may be used. gateways. Since 0.8 version, IPv6 address may be used.
.br
Unix domain sockets are supported with the syntax
.I unix:/path/to/socket
(e.g., internal unix:/var/run/3proxy.sock). On Linux, abstract (fileless)
Unix sockets are supported with the syntax
.I unix:@socketname
(e.g., internal unix:@3proxy). When using Unix sockets, the socket file
is automatically created and removed on service start/stop.
.br .br
.B external .B external
@ -795,7 +814,7 @@ If port is zero, it\'s taken from original request, only IP is changed.
If both IP and port are zero - it\'s a special case of local redirection, If both IP and port are zero - it\'s a special case of local redirection,
it works only with it works only with
.B socks .B socks
proxy. In case of local redirection request is redirected to different service, proxy. In case of local redirection request is redirected to different service,
.B ftp .B ftp
locally redirects to locally redirects to
.B ftppr .B ftppr
@ -807,6 +826,14 @@ locally redirects to
.B proxy .B proxy
.B admin .B admin
locally redirects to the admin -s service. locally redirects to the admin -s service.
.br
Unix domain sockets can be used instead of IP address with the syntax
.I unix:/path/to/socket
(e.g., parent 1000 socks5 unix:/var/run/parent.sock 1080). On Linux,
abstract (fileless) Unix sockets are supported with
.I unix:@socketname
syntax (e.g., parent 1000 http unix:@parent.proxy 3128). When using Unix
sockets, the port number is ignored but must be specified for syntax compatibility.
.br .br
Main purpose of local redirections is to have the requested resource Main purpose of local redirections is to have the requested resource

View File

@ -36,6 +36,11 @@ with the routing table.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/ftppr.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -h .B -h
Default destination. It's used if the target address is not specified by the user. Default destination. It's used if the target address is not specified by the user.

View File

@ -36,6 +36,11 @@ with the routing table.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/pop3p.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -p .B -p
Port. Port proxy listens for incoming connections. Default is 110. Port. Port proxy listens for incoming connections. Default is 110.

View File

@ -34,6 +34,11 @@ with the routing table.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/proxy.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -a .B -a
Anonymous. Hide information about client. Anonymous. Hide information about client.

View File

@ -36,6 +36,11 @@ with the routing table.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/smtpp.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -p .B -p
Port. Port proxy listens for incoming connections. Default is 25. Port. Port proxy listens for incoming connections. Default is 25.

View File

@ -49,6 +49,11 @@ of IP-IP NAT and does not work with port translation.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/socks.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -p .B -p
Port. Port proxy listens for incoming connections. Default is 1080. Port. Port proxy listens for incoming connections. Default is 1080.

View File

@ -31,6 +31,11 @@ with the routing table.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/tcppm.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -l .B -l
Log. By default logging is to stdout. If Log. By default logging is to stdout. If
@ -50,10 +55,18 @@ crashes.
- port tcppm accepts connections on - port tcppm accepts connections on
.TP .TP
.I remote_host .I remote_host
- IP address of the host the connection is forwarded to - IP address of the host the connection is forwarded to. Unix domain sockets
can be specified with the syntax
.I unix:/path/to/socket
(e.g., unix:/var/run/app.sock). On Linux, abstract (fileless) Unix sockets
use the syntax
.I unix:@socketname
(e.g., unix:@app.socket).
.TP .TP
.I remote_port .I remote_port
- remote port the connection is forwarded to - remote port the connection is forwarded to. Ignored when using Unix socket
destination, but must be specified (use any positive value) for syntax
compatibility.
.SH CLIENTS .SH CLIENTS
Any TCP-based application can be used as a client. Use Any TCP-based application can be used as a client. Use
.I internal_ip .I internal_ip

View File

@ -36,6 +36,11 @@ with the routing table.
.B -i .B -i
Internal address. IP address the proxy accepts connections to. Internal address. IP address the proxy accepts connections to.
By default, connections to any interface are accepted. It\'s usually unsafe. By default, connections to any interface are accepted. It\'s usually unsafe.
Unix domain sockets can be specified with
.I -iunix:/path/to/socket
syntax (e.g., -iunix:/var/run/tlspr.sock). On Linux, abstract sockets use
.I -iunix:@socketname
syntax.
.TP .TP
.B -a .B -a
Anonymous. Hide information about client. Anonymous. Hide information about client.