From 6a3cb4128da8cd7f94830adaf53fda7de463e928 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 12 Oct 2026 11:04:32 +0000
Subject: [PATCH] Update HTML documentation from man pages
---
doc/html/man5/3proxy.cfg.5.html | 68 ++++++++++++++++++++++++---------
1 file changed, 49 insertions(+), 19 deletions(-)
diff --git a/doc/html/man5/3proxy.cfg.5.html b/doc/html/man5/3proxy.cfg.5.html
index 5ae244d..21ca9aa 100644
--- a/doc/html/man5/3proxy.cfg.5.html
+++ b/doc/html/man5/3proxy.cfg.5.html
@@ -210,18 +210,30 @@ or hostname, useful in case of dynamic DNS.
-oROPTIONS options for proxy-to-client
(-oc), proxy-to-server (-os), proxy listening
(-ol), connect back client (-or), connect back
-listening (-oR) sockets. Options like TCP_CORK,
-TCP_NODELAY, TCP_DEFER_ACCEPT, TCP_QUICKACK, TCP_TIMESTAMPS,
+listening (-oR) sockets. OPTIONS is a comma
+separated list of NAME or NAME=VALUE; a
+name alone sets the option to 1 (TCP_MAXSEG to the value of
+maxseg), and NAME=0 turns it off. Options add
+to the defaults and to the options given earlier for the
+same socket. An unknown name or a value which is not a
+number is an error. TCP_NODELAY is set by default on
+proxy-to-client and proxy-to-server sockets, so a reply
+written in several parts is not delayed by Nagle’s
+algorithm; use -ocTCP_NODELAY=0 or
+-osTCP_NODELAY=0 to turn it off, e.g. to send fewer
+packets on slow links. Options like TCP_CORK, TCP_NODELAY,
+TCP_DEFER_ACCEPT, TCP_QUICKACK, TCP_TIMESTAMPS,
TCP_FASTOPEN, SO_REUSEADDR, SO_REUSEPORT,
SO_EXCLUSIVEADDRUSE, SO_PORT_SCALABILITY,
SO_REUSE_UNICASTPORT, SO_KEEPALIVE, SO_DONTROUTE may be
supported depending on OS. SO_REUSEADDR and SO_REUSEPORT are
-set on the listening socket by default on Unix. On Windows
-SO_REUSEADDR is not set: it is not required to rebind a
-listening port and it only lets another local process bind
-the same address and port. Use SO_EXCLUSIVEADDRUSE (Windows)
-on the listening socket (-ol) to prevent that.
-
+set by default on the listening sockets (-ol,
+-oR) on Unix; -olSO_REUSEPORT=0 turns one off.
+On Windows SO_REUSEADDR is not set: it is not required to
+rebind a listening port and it only lets another local
+process bind the same address and port. Use
+SO_EXCLUSIVEADDRUSE (Windows) on the listening socket
+(-ol) to prevent that.
-H (for all services) Expect HAProxy PROXY protocol v1
header on incoming connection. This allows the proxy to
receive real client IP address from HAProxy or other load
@@ -236,12 +248,23 @@ second. Useful to minimize polling
-s
(for admin) secure, allow only secure operations, currently
only traffic counters view without ability to reset.
-(for TCP services, Linux) enable splice(). splice() is not
-built by default and is disabled even when built, because
-current Linux does not implement SPLICE_F_MOVE, so no real
-zero-copy takes place and the read/write path is faster for
-most traffic. Rebuild with -DWITHSPLICE to make -s
-available, -s0 disables it explicitly.
+(for TCP services, Linux) use splice() to pass data between
+the client and the server without copying it through 3proxy.
+-s alone splices both directions where it pays: a
+body of known length if at least 16K of it is left to read,
+a stream once it carries large reads, back to copying when
+they turn small. -s1 always splices what the server
+sends to the client (downloads), -s2 what the client
+sends (uploads), -s3 both; adding 4 (-s5,
+-s6, -s7, the last the same as -s)
+splices those directions only where it pays. -s0, the
+default, turns it off. splice() suits large transfers: they
+go faster and use less CPU; small requests go slower with
+it. A spliced direction needs a pipe (two file descriptors),
+made when first needed and kept for the connection, and more
+kernel memory; data filters are not applied to spliced data.
+Available in builds with WITHSPLICE, the default on Linux.
+
-C
(for TCP services) a connection closed by any of the sides
terminates the session, buffered data is delivered before
@@ -277,7 +300,12 @@ client reported)
-a1 (for proxy) anonymous proxy (random client
information reported)
-a2 (for proxy) generate Via: and X-Forwarded-For:
-instead of Forwarded:
+instead of Forwarded:
+-Xftp (for proxy) fetch ftp:// URLs, in a build
+with FTP support. Without this the scheme is not one the
+service knows, whatever the build: fetching it opens a
+second connection and builds a listing, which a service
+serving http has no use for.
Also, all options mentioned for proxy(8)
socks(8) pop3p(8) imapp(8)
tcppm(8) udppm(8) ftppr(8)
@@ -1590,10 +1618,12 @@ authentication and/or allow/deny ACLs.
and FTP are built when they are asked for, and are not in a
default build. MAILPROXY=true builds pop3p,
imapp and smtpp, and FTP=true builds
-ftppr and the ftp:// scheme of the HTTP proxy;
-with CMake the switches are -D3PROXY_USE_MAILPROXY=ON
-and -D3PROXY_USE_FTP=ON. The standalone binaries of
-those services are built with them and not without.
+ftppr and the ftp:// scheme of the HTTP proxy,
+which a proxy service then still has to ask for with
+-Xftp; with CMake the switches are
+-D3PROXY_USE_MAILPROXY=ON and
+-D3PROXY_USE_FTP=ON. The standalone binaries of those
+services are built with them and not without.
A configuration naming a service which was not built is
still read. The three mail proxies become tlspr
negotiating STARTTLS in that protocol, which is what most of