Adapt manpages to reflect renamed proxy binary (fixes rhbz#2271587)

2024-03-29 08:51:35 +00:00 · 2024-03-29 08:51:35 +00:00 · bb47a76f7b
commit bb47a76f7b
parent ccd21cf6bb
2 changed files with 288 additions and 0 deletions
--- a/3proxy-0.9.4-manpage.patch
+++ b/3proxy-0.9.4-manpage.patch
@ -0,0 +1,286 @@
+--- man/proxy.8
+++ /dev/null
+@@ -1,78 +0,0 @@
+-.TH proxy "8" "January 2019" "3proxy 0.9" "Universal proxy server"
+-.SH NAME
+-.B proxy
+-\- HTTP proxy gateway service
+-.SH SYNOPSIS
+-.BR "proxy " [ -d ][ -a ]
+-.IB \fR[ -l \fR[ \fR[ @ \fR] logfile \fR]]
+-.IB \fR[ -p port\fR]
+-.IB \fR[ -i internal_ip\fR]
+-.IB \fR[ -e external_ip\fR]
+-.SH DESCRIPTION
+-.B proxy
+-is HTTP gateway service with HTTPS and FTP over HTTPS support.
+-.SH OPTIONS
+-.TP
+-.B -I
+-Inetd mode. Standalone service only.
+-.TP
+-.B -d
+-Daemonise. Detach service from console and run in the background.
+-.TP
+-.B -t
+-Be silenT. Do not log start/stop/accept error records.
+-.TP
+-.B -u
+-Never ask for username authentication
+-.TP
+-.B -e
+-External address. IP address of interface proxy should initiate connections
+-from. 
+-By default system will deside which address to use in accordance
+-with routing table.
+-.TP
+-.B -i
+-Internal address. IP address proxy accepts connections to.
+-By default connection to any interface is accepted. It\'s usually unsafe.
+-.TP
+-.B -a
+-Anonymous. Hide information about client.
+-.TP
+-.B -a1
+-Anonymous. Show fake information about client.
+-.TP
+-.B -p
+-Port. Port proxy listens for incoming connections. Default is 3128.
+-.TP
+-.B -l
+-Log. By default logging is to stdout. If
+-.I logfile
+-is specified logging is to file. Under Unix, if
+-.RI \' @ \'
+-preceeds
+-.IR logfile ,
+-syslog is used for logging.
+-.TP
+-.B -S
+-Increase or decrease stack size. You may want to try something like -S8192 if you experience 3proxy
+-crashes.
+-.SH CLIENTS
+-You should use client with HTTP proxy support or configure router to redirect
+-HTTP traffic to proxy (transparent proxy). Configure client to connect to
+-.I internal_ip
+-and
+-.IR port .
+-HTTPS support allows to use almost any TCP based protocol. If you need to
+-limit clients, use 
+-.BR 3proxy (8)
+-instead.
+-.SH BUGS
+-Report all bugs to
+-.BR 3proxy@3proxy.ru
+-.SH SEE ALSO
+-3proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
+-.br
+-https://3proxy.org/
+-.SH AUTHORS
+-3proxy is designed by Vladimir 3APA3A Dubrovin
+-.RI ( 3proxy@3proxy.ru )
+--- /dev/null
+++ man/htproxy.8
+@@ -0,0 +1,78 @@
+.TH proxy "8" "January 2019" "3proxy 0.9" "Universal proxy server"
+.SH NAME
+.B htproxy
+\- HTTP proxy gateway service
+.SH SYNOPSIS
+.BR "htproxy " [ -d ][ -a ]
+.IB \fR[ -l \fR[ \fR[ @ \fR] logfile \fR]]
+.IB \fR[ -p port\fR]
+.IB \fR[ -i internal_ip\fR]
+.IB \fR[ -e external_ip\fR]
+.SH DESCRIPTION
+.B htproxy
+is HTTP gateway service with HTTPS and FTP over HTTPS support.
+.SH OPTIONS
+.TP
+.B -I
+Inetd mode. Standalone service only.
+.TP
+.B -d
+Daemonise. Detach service from console and run in the background.
+.TP
+.B -t
+Be silenT. Do not log start/stop/accept error records.
+.TP
+.B -u
+Never ask for username authentication
+.TP
+.B -e
+External address. IP address of interface proxy should initiate connections
+from. 
+By default system will deside which address to use in accordance
+with routing table.
+.TP
+.B -i
+Internal address. IP address proxy accepts connections to.
+By default connection to any interface is accepted. It\'s usually unsafe.
+.TP
+.B -a
+Anonymous. Hide information about client.
+.TP
+.B -a1
+Anonymous. Show fake information about client.
+.TP
+.B -p
+Port. Port proxy listens for incoming connections. Default is 3128.
+.TP
+.B -l
+Log. By default logging is to stdout. If
+.I logfile
+is specified logging is to file. Under Unix, if
+.RI \' @ \'
+preceeds
+.IR logfile ,
+syslog is used for logging.
+.TP
+.B -S
+Increase or decrease stack size. You may want to try something like -S8192 if you experience 3proxy
+crashes.
+.SH CLIENTS
+You should use client with HTTP proxy support or configure router to redirect
+HTTP traffic to proxy (transparent proxy). Configure client to connect to
+.I internal_ip
+and
+.IR port .
+HTTPS support allows to use almost any TCP based protocol. If you need to
+limit clients, use 
+.BR 3proxy (8)
+instead.
+.SH BUGS
+Report all bugs to
+.BR 3proxy@3proxy.ru
+.SH SEE ALSO
+3proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
+.br
+https://3proxy.org/
+.SH AUTHORS
+3proxy is designed by Vladimir 3APA3A Dubrovin
+.RI ( 3proxy@3proxy.ru )
+--- man/3proxy.8
+++ man/3proxy.8
+@@ -26,7 +26,7 @@
+ gateways with HTTP and HTTPS proxy with FTP over HTTP support, SOCKS v4,
+ v4.5 and v5, POP3 proxy, UDP and TCP portmappers. Each gateway is started
+ from configuration file like independant service 
+-.BR proxy (8)
+.BR htproxy (8)
+ .BR socks (8)
+ .BR pop3p (8)
+ .BR tcppm (8)
+@@ -140,7 +140,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy.cfg(3), proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8),
+3proxy.cfg(3), ftppr(8), htproxy(8), socks(8), pop3p(8), tcppm(8), udppm(8),
+ kill(1), syslogd(8),
+ .br
+ https://3proxy.org/
+--- man/3proxy.cfg.3
+++ man/3proxy.cfg.3
+@@ -46,7 +46,7 @@
+  Next commands start gateway services:
+ 
+ .br
+-.B proxy
+.B htproxy
+ [options]
+ .br
+ .B socks
+@@ -74,7 +74,7 @@
+ .br
+  Descriptions:
+ .br
+-.B proxy
+.B htproxy
+ HTTP/HTTPS proxy (default port 3128)
+ .br
+ .B socks
+@@ -174,7 +174,7 @@
+ of IP-IP NAT (will not work for PAT)
+ .br
+  Also, all options mentioned for 
+-.BR proxy (8)
+.BR htproxy (8)
+ .BR socks (8)
+ .BR pop3p (8)
+ .BR tcppm (8)
+@@ -1057,7 +1057,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), proxy(8), ftppr(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
+3proxy(8), ftppr(8), htproxy(8), socks(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
+ .br
+  https://3proxy.org/
+ .SH TRIVIA
+--- man/ftppr.8
+++ man/ftppr.8
+@@ -79,7 +79,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), proxy(8), pop3p(8), socks(8), tcppm(8), udppm(8), syslogd(8),
+3proxy(8), htproxy(8), pop3p(8), socks(8), tcppm(8), udppm(8), syslogd(8),
+ .br
+ https://3proxy.org/
+ .SH AUTHORS
+--- man/pop3p.8
+++ man/pop3p.8
+@@ -75,7 +75,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), ftppr(8), proxy(8), socks(8), tcppm(8), udppm(8), syslogd(8),
+3proxy(8), ftppr(8), htproxy(8), socks(8), tcppm(8), udppm(8), syslogd(8),
+ .br
+ https://3proxy.org/
+ .SH AUTHORS
+--- man/smtpp.8
+++ man/smtpp.8
+@@ -76,7 +76,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), ftppr(8), proxy(8), socks(8), tcppm(8), udppm(8), syslogd(8),
+3proxy(8), ftppr(8), htproxy(8), socks(8), tcppm(8), udppm(8), syslogd(8),
+ .br
+ https://3proxy.org/
+ .SH AUTHORS
+--- man/socks.8
+++ man/socks.8
+@@ -76,7 +76,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), proxy(8), ftppr(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
+3proxy(8), ftppr(8), htproxy(8), pop3p(8), tcppm(8), udppm(8), syslogd(8),
+ .br
+ https://3proxy.org/
+ .SH AUTHORS
+--- man/tcppm.8
+++ man/tcppm.8
+@@ -65,7 +65,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), proxy(8), ftppr(8), socks(8), pop3p(8), udppm(8), syslogd(8),
+3proxy(8), ftppr(8), htproxy(8), socks(8), pop3p(8), udppm(8), syslogd(8),
+ .br
+ https://3proxy.org/
+ .SH AUTHORS
+--- man/udppm.8
+++ man/udppm.8
+@@ -71,7 +71,7 @@
+ Report all bugs to
+ .BR 3proxy@3proxy.ru
+ .SH SEE ALSO
+-3proxy(8), proxy(8), ftppr(8), socks(8), pop3p(8), udppm(8), syslogd(8),
+3proxy(8), ftppr(8), htproxy(8), socks(8), pop3p(8), udppm(8), syslogd(8),
+ .br
+ https://3proxy.org/
+ .SH AUTHORS
--- a/3proxy.spec
+++ b/3proxy.spec
@ -22,6 +22,8 @@ BuildRequires:    systemd-rpm-macros
 Patch0:           3proxy-0.6.1-config-path.patch
 # Fixes *_poll build error
 Patch1:           3proxy-0.9.4-poll-build.patch
+# Adapt manpages to reflect renamed proxy binary
+Patch2:           3proxy-0.9.4-manpage.patch

 %description
 %{name} -- light proxy server.