commit c5ca41f1387b2157c0c8e66a0ecaf7a36506c4fe Author: meskio <meskio@torproject.org> Date: Tue Jun 1 19:25:10 2021 +0200 Add man pages for proxy and client commands To be used by the debian package (#19409) --- doc/snowflake-client.1 | 46 ++++++++++++++++++++++++++++++++++++++++++++++ doc/snowflake-proxy.1 | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+) diff --git a/doc/snowflake-client.1 b/doc/snowflake-client.1 new file mode 100644 index 0000000..977fc70 --- /dev/null +++ b/doc/snowflake-client.1 @@ -0,0 +1,46 @@ +.TH SNOWFLAKE-CLIENT "1" "June 2021" "snowflake-client" "User Commands" +.SH NAME +snowflake-client \- WebRTC pluggable transport client for Tor +.SH DESCRIPTION +Snowflake helps users circumvent censorship by making a WebRTC +connection to volunteer proxies. These proxies relay Tor traffic to a +Snowflake bridge and then through the Tor network. +.SS "Usage of snowflake-client:" +.HP +\fB\-front\fR string +.IP +front domain +.HP +\fB\-ice\fR string +.IP +comma\-separated list of ICE servers +.HP +\fB\-keep\-local\-addresses\fR +.IP +keep local LAN address ICE candidates +.HP +\fB\-log\fR string +.IP +name of log file +.HP +\fB\-log\-to\-state\-dir\fR +.IP +resolve the log file relative to tor's pt state dir +.HP +\fB\-logToStateDir\fR +.IP +use \fB\-log\-to\-state\-dir\fR instead +.HP +\fB\-max\fR int +.IP +capacity for number of multiplexed WebRTC peers (default 1) +.HP +\fB\-unsafe\-logging\fR +.IP +prevent logs from being scrubbed +.HP +\fB\-url\fR string +.IP +URL of signaling broker +.SH "SEE ALSO" +https://snowflake.torproject.org diff --git a/doc/snowflake-proxy.1 b/doc/snowflake-proxy.1 new file mode 100644 index 0000000..ccdd9a2 --- /dev/null +++ b/doc/snowflake-proxy.1 @@ -0,0 +1,38 @@ +.TH SNOWFLAKE-PROXY "1" "June 2021" "swnoflake-proxy" "User Commands" +.SH NAME +snowflake-proxy \- WebRTC pluggable transport proxy for Tor +.SH DESCRIPTION +Snowflake helps users circumvent censorship by making a WebRTC +connection to volunteer proxies. These proxies relay Tor traffic to a +Snowflake bridge and then through the Tor network. +.SS "Usage of snowflake-proxy:" +.HP +\fB\-broker\fR string +.IP +broker URL (default "https://snowflake\-broker.bamsoftware.com/") +.HP +\fB\-capacity\fR uint +.IP +maximum concurrent clients (default 10) +.HP +\fB\-keep\-local\-addresses\fR +.IP +keep local LAN address ICE candidates +.HP +\fB\-log\fR string +.IP +log filename +.HP +\fB\-relay\fR string +.IP +websocket relay URL (default "wss://snowflake.bamsoftware.com/") +.HP +\fB\-stun\fR string +.IP +stun URL (default "stun:stun.stunprotocol.org:3478") +.HP +\fB\-unsafe\-logging\fR +.IP +prevent logs from being scrubbed +.SH "SEE ALSO" +https://snowflake.torproject.org