man/ronin-proxy.1 in ronin-2.0.5 vs man/ronin-proxy.1 in ronin-2.1.0.rc1
- old
+ new
@@ -1,129 +1,103 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
.\" https://github.com/postmodern/kramdown-man#readme
.TH ronin-proxy 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-proxy \- Starts a TCP\[sl]UDP\[sl]SSL\[sl]TLS intercept proxy server
.SH SYNOPSIS
-.LP
-.HP
+.PP
\fBronin proxy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIPROXY\[ru]HOST\fP:\[rB]\fIPROXY\[ru]PORT\fP \fIUPSTREAM\[ru]HOST\fP:\fIUPSTREAM\[ru]PORT\fP
-.LP
.SH DESCRIPTION
-.LP
.PP
Starts a TCP\[sl]UDP\[sl]SSL\[sl]TLS proxy server\.
-.LP
.SH ARGUMENTS
-.LP
.TP
\fIPROXY\[ru]HOST\fP
The local host to listen on\.
-.LP
.TP
\fIPROXY\[ru]PORT\fP
The local port to bind to\.
-.LP
.TP
\fIUPSTREAM\[ru]HOST\fP
The upstream host to proxy data to\.
-.LP
.TP
\fIUPSTREAM\[ru]PORT\fP
The upstream port to proxy data to\.
-.LP
.SH OPTIONS
-.LP
.TP
-\fB-t\fR, \fB--tcp\fR
+\fB\-t\fR, \fB\-\-tcp\fR
Enables or disables TCP mode\.
-.LP
.TP
-\fB-S\fR, \fB--ssl\fR
+\fB\-S\fR, \fB\-\-ssl\fR
Enables or disables SSL mode\.
-.LP
.TP
-\fB-T\fR, \fB--tls\fR
+\fB\-T\fR, \fB\-\-tls\fR
Enables or disables TLS mode\.
-.LP
.TP
-\fB-u\fR, \fB--udp\fR
+\fB\-u\fR, \fB\-\-udp\fR
Enables or disables UDP mode\.
-.LP
.TP
-\fB-x\fR, \fB--[no-]hexdump\fR
+\fB\-x\fR, \fB\-\-\[lB]no\-\[rB]hexdump\fR
Enables or disables hexdump mode\.
-.LP
.TP
-\fB-r\fR, \fB--rewrite\fR \fI\[sl]REGEXP\[sl]:STRING\fP
+\fB\-r\fR, \fB\-\-rewrite\fR \fI\[sl]REGEXP\[sl]:STRING\fP
Replace REGEXP with STRING in every message\.
-.LP
.TP
-\fB--rewrite-client\fR \fI\[sl]REGEXP\[sl]:STRING\fP
+\fB\-\-rewrite\-client\fR \fI\[sl]REGEXP\[sl]:STRING\fP
Replace REGEXP with STRING in every client message\.
-.LP
.TP
-\fB--rewrite-server\fR \fI\[sl]REGEXP\[sl]:STRING\fP
+\fB\-\-rewrite\-server\fR \fI\[sl]REGEXP\[sl]:STRING\fP
Replace REGEXP with STRING in every server message\.
-.LP
.TP
-\fB-i\fR, \fB--ignore\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-i\fR, \fB\-\-ignore\fR \fI\[sl]REGEXP\[sl]\fP
Ignore messages matching the REGEXP\.
-.LP
.TP
-\fB--ignore-client\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-ignore\-client\fR \fI\[sl]REGEXP\[sl]\fP
Ignore messages from the client matching the REGEXP\.
-.LP
.TP
-\fB--ignore-server\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-ignore\-server\fR \fI\[sl]REGEXP\[sl]\fP
Ignore messages from the server matching the REGEXP\.
-.LP
.TP
-\fB-C\fR, \fB--close\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-C\fR, \fB\-\-close\fR \fI\[sl]REGEXP\[sl]\fP
Closes the connection if the client or server sends a message matching
the REGEXP\.
-.LP
.TP
-\fB--close-client\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-close\-client\fR \fI\[sl]REGEXP\[sl]\fP
Closes the connection if the client sends a message matching the REGEXP\.
-.LP
.TP
-\fB--close-server\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-close\-server\fR \fI\[sl]REGEXP\[sl]\fP
Closes the connection if the server sends a message matching the REGEXP\.
-.LP
.TP
-\fB-R\fR, \fB--reset\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-R\fR, \fB\-\-reset\fR \fI\[sl]REGEXP\[sl]\fP
Reset the connection if the client or server sends a message matching
the REGEXP\.
-.LP
.TP
-\fB--reset-client\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-reset\-client\fR \fI\[sl]REGEXP\[sl]\fP
Reset the connection if the client sends a message matching the REGEXP\.
-.LP
.TP
-\fB--reset-server\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-reset\-server\fR \fI\[sl]REGEXP\[sl]\fP
Reset the connection if the server sends a message matching the REGEXP\.
-.LP
.SH EXAMPLES
-.LP
.PP
Starts a TCP proxy listening on \fBlocalhost\fR port 8080 that forwards all data
-to \fBgoogle.com\fR port 80:
-.LP
-.nf
- ronin proxy 8080 google\.com:80
-.fi
-.LP
+to \fBgoogle\.com\fR port 80:
.PP
-Starts a UDP proxy listening on \fB0.8.0.0\fR port 53 that forwards all data to
-\fB8.8.8.8\fR port 53:
-.LP
-.nf
- sudo ronin proxy \-\-udp \-\-hexdump 0\.0\.0\.0:53 8\.8\.8\.8:53
-.fi
-.LP
+.RS 4
+.EX
+\[Do] ronin proxy 8080 google\.com:80
+.EE
+.RE
+.PP
+Starts a UDP proxy listening on \fB0\.8\.0\.0\fR port 53 that forwards all data to
+\fB8\.8\.8\.8\fR port 53:
+.PP
+.RS 4
+.EX
+\[Do] sudo ronin proxy \-\-udp \-\-hexdump 0\.0\.0\.0:53 8\.8\.8\.8:53
+.EE
+.RE
.SH AUTHOR
-.LP
.PP
Postmodern
.MT postmodern\.mod3\[at]gmail\.com
.ME
-.LP
\ No newline at end of file