Update HTML documentation from man pages

This commit is contained in:
github-actions[bot] committed 2026-08-22 11:28:42 +00:00
1 parent 22c7dfe0e1
commit 984366ce3e
13 files changed
+719 -742

No files matched your search

+83 -88
View File
@@ -1,4 +1,4 @@
<!-- Creator : groff version 1.24.1 -->
<!-- Creator : groff version 1.23.0 -->
<html>
<head>
@@ -24,7 +24,7 @@
</h2>
<p style="margin-left:6%; margin-top: 1em"><b>tlspr</b> -
<p style="margin-left:9%; margin-top: 1em"><b>tlspr</b> -
SNI proxy gateway service</p>
<h2>SYNOPSIS
@@ -32,7 +32,7 @@ SNI proxy gateway service</p>
</h2>
<p style="margin-left:6%; margin-top: 1em"><b>tlspr</b>
<p style="margin-left:9%; margin-top: 1em"><b>tlspr</b>
[<b>-d</b>][<b>-a</b>] [<b>-l</b>[[<i>@</i>]<i>logfile</i>]]
[<b>-p</b><i>listening_port</i>]
[<b>-P</b><i>destination_port</i>]
@@ -45,7 +45,7 @@ SNI proxy gateway service</p>
</h2>
<p style="margin-left:6%; margin-top: 1em"><b>tlspr</b> is
<p style="margin-left:9%; margin-top: 1em"><b>tlspr</b> is
an SNI gateway service (destination host is taken from TLS
handshake). The destination port must be specified via the
-P option (or it may be detected with the Transparent
@@ -61,81 +61,80 @@ access control is required.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-I</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Inetd mode. Standalone service
only.</p> </td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-d</b></p></td>
<p><b>-d</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Daemonize. Detach service from
console and run in the background.</p></td></tr>
<p>Daemonize. Detach service from console and run in the
background.</p> </td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-t</b></p></td>
<p><b>-t</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Be silenT. Do not log
start/stop/accept error records.</p></td></tr>
<p>Be silenT. Do not log start/stop/accept error
records.</p> </td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-u</b></p></td>
<p><b>-u</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Never ask for username
authentication</p> </td></tr>
<p>Never ask for username authentication</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-e</b></p></td>
<p><b>-e</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">External address. IP address of
the interface the proxy should initiate connections from. By
default, the system will decide which address to use in
accordance with the routing table.</p></td></tr>
<p>External address. IP address of the interface the proxy
should initiate connections from. By default, the system
will decide which address to use in accordance with the
routing table.</p></td></tr>
</table>
<p style="margin-left:6%;"><b>-ni</b><i>PATH</i></p>
<p style="margin-left:9%;"><b>-ni</b><i>PATH</i></p>
<p style="margin-left:15%;">(Linux only) Switch to the
<p style="margin-left:18%;">(Linux only) Switch to the
network namespace identified by <i>PATH</i> before opening
the listening socket. The current namespace is saved and
restored immediately after binding, so outgoing connections
run in the original namespace unless <b>-ne</b> is also
given.</p>
<p style="margin-left:6%;"><b>-ne</b><i>PATH</i></p>
<p style="margin-left:9%;"><b>-ne</b><i>PATH</i></p>
<p style="margin-left:15%;">(Linux only) Switch to the
<p style="margin-left:18%;">(Linux only) Switch to the
network namespace identified by <i>PATH</i> after the
listening socket has been bound (and after restoring from
<b>-ni</b> if applicable). Both options accept any namespace
@@ -146,13 +145,13 @@ file path (e.g. <i>/var/run/netns/myns</i> or
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p><b>-i</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p>Internal address. IP address the proxy accepts
@@ -162,93 +161,90 @@ 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">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>-a</b></p></td>
<p><b>-a</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Anonymous. Hide information
about client.</p></td></tr>
<p>Anonymous. Hide information about client.</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>-a1</b></p></td>
<p><b>-a1</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Anonymous. Show fake information
about client.</p></td></tr>
<p>Anonymous. Show fake information about client.</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>-p</b></p></td>
<p><b>-p</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">listening_port. Port proxy
listens for incoming connections. Default is 1443.</p></td></tr>
<p>listening_port. Port proxy listens for incoming
connections. Default is 1443.</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>-P</b></p></td>
<p><b>-P</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">destination_port. Port to
establish outgoing connections. Required unless the
Transparent plugin is used, because the TLS handshake does
not contain port information. Default is 443.</p></td></tr>
<p>destination_port. Port to establish outgoing
connections. Required unless the Transparent plugin is used,
because the TLS handshake does not contain port information.
Default is 443.</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>-c</b></p></td>
<p><b>-c</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">TLS_CHECK_LEVEL. 0 (default) -
allow non-TLS traffic to pass, 1 - require TLS, only check
client HELLO packet, 2 - require TLS, check both client and
server HELLO, 3 - require TLS, check that the server sends a
certificate (not compatible with TLS 1.3), 4 - require
mutual TLS, check that the server sends a certificate
request and the client sends a certificate (not compatible
with TLS 1.3)</p></td></tr>
<p>TLS_CHECK_LEVEL. 0 (default) - allow non-TLS traffic to
pass, 1 - require TLS, only check client HELLO packet, 2 -
require TLS, check both client and server HELLO, 3 - require
TLS, check that the server sends a certificate (not
compatible with TLS 1.3), 4 - require mutual TLS, check that
the server sends a certificate request and the client sends
a certificate (not compatible with TLS 1.3)</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>-s</b></p></td>
<p><b>-s</b></p></td>
<td width="5%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Split the TLS Client HELLO
packet across multiple TCP segments to make SNI-based DPI
detection harder. An optional numeric value can follow (e.g.
<b>-s1</b>) to control the splitting behaviour.</p></td></tr>
<p>Split the TLS Client HELLO packet across multiple TCP
segments to make SNI-based DPI detection harder. An optional
numeric value can follow (e.g. <b>-s1</b>) to control the
splitting behaviour.</p></td></tr>
</table>
<p style="margin-left:6%;"><b>-Ximap | -Xpop3 |
<p style="margin-left:9%;"><b>-Ximap | -Xpop3 |
-Xsmtp</b></p>
<p style="margin-left:15%;">STARTTLS mode for the given
<p style="margin-left:18%;">STARTTLS mode for the given
protocol. The proxy speaks the plaintext protocol with the
client (greeting, capability advertisement with STARTTLS
only, STARTTLS command), then, after the client issues
@@ -262,13 +258,13 @@ client fails.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p><b>-l</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p>Log. By default logging is to stdout. If <i>logfile</i>
@@ -276,18 +272,17 @@ is specified logging is to file. Under Unix, if
&acute;<i>@</i>&acute; precedes <i>logfile</i>, syslog is
used for logging.</p></td></tr>
<tr valign="top" align="left">
<td width="6%"></td>
<td width="9%"></td>
<td width="3%">
<p style="margin-top: 1em"><b>-S</b></p></td>
<p><b>-S</b></p></td>
<td width="6%"></td>
<td width="85%">
<td width="82%">
<p style="margin-top: 1em">Increase or decrease stack size.
You may want to try something like -S8192 if you experience
3proxy crashes.</p></td></tr>
<p>Increase or decrease stack size. You may want to try
something like -S8192 if you experience 3proxy crashes.</p></td></tr>
</table>
<h2>CLIENTS
@@ -295,7 +290,7 @@ You may want to try something like -S8192 if you experience
</h2>
<p style="margin-left:6%; margin-top: 1em">You should use a
<p style="margin-left:9%; margin-top: 1em">You should use a
client with TLS support or configure a router to redirect
TLS traffic to the proxy (transparent proxy). Configure the
client to connect to <i>internal_ip</i> and <i>port</i>. If
@@ -306,7 +301,7 @@ you need to limit clients, use <b>3proxy</b>(8) instead.</p>
</h2>
<p style="margin-left:6%; margin-top: 1em">Report all bugs
<p style="margin-left:9%; margin-top: 1em">Report all bugs
to <b>3proxy@3proxy.org</b></p>
<h2>SEE ALSO
@@ -314,7 +309,7 @@ to <b>3proxy@3proxy.org</b></p>
</h2>
<p style="margin-left:6%; margin-top: 1em">3proxy(8),
<p style="margin-left:9%; margin-top: 1em">3proxy(8),
ftppr(8), proxy(8), socks(8), pop3p(8), smtpp(8), tcppm(8),
udppm(8), syslogd(8), <br>
https://3proxy.org/</p>
@@ -324,7 +319,7 @@ https://3proxy.org/</p>
</h2>
<p style="margin-left:6%; margin-top: 1em">3proxy is
<p style="margin-left:9%; margin-top: 1em">3proxy is
designed by Vladimir Dubrovin &lt;vlad@3proxy.org&gt;</p>
<hr>
</body>