[tor-commits] [flashproxy/master] Add generated .1 man pages.

dcf at torproject.org dcf at torproject.org
Tue Nov 13 04:21:40 UTC 2012 

commit 1e91752ed7466c09f305c55be84ed84d3e1c26d7
Author: David Fifield <david at bamsoftware.com>
Date:   Mon Nov 12 20:00:01 2012 -0800

    Add generated .1 man pages.
    
    On second thought, I want to include these generated files so that they
    can be included with "make install".
---
 doc/flashproxy-client.1    |  109 ++++++++++++++++++++++++++++++++++++++++++++
 doc/flashproxy-reg-email.1 |   85 ++++++++++++++++++++++++++++++++++
 doc/flashproxy-reg-http.1  |   59 ++++++++++++++++++++++++
 3 files changed, 253 insertions(+), 0 deletions(-)

diff --git a/doc/flashproxy-client.1 b/doc/flashproxy-client.1
new file mode 100644
index 0000000..8409a58
--- /dev/null
+++ b/doc/flashproxy-client.1
@@ -0,0 +1,109 @@
+'\" t
+.\"     Title: flashproxy-client
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 11/12/2012
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "FLASHPROXY\-CLIENT" "1" "11/12/2012" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+flashproxy-client \- The flash proxy client transport plugin
+.SH "SYNOPSIS"
+.sp
+\fBflashproxy\-client\fR \fB\-\-register\fR [\fIOPTIONS\fR] [\fILOCAL\fR][:\fIPORT\fR] [\fIREMOTE\fR][:\fIPORT\fR]
+.SH "DESCRIPTION"
+.sp
+Wait for connections on a local and a remote port\&. When any pair of connections exists, data is ferried between them until one side is closed\&. By default \fILOCAL\fR is localhost addresses on port 9001 and \fIREMOTE\fR is all addresses on port 9000\&.
+.sp
+The local connection acts as a SOCKS4a proxy, but the host and port in the SOCKS request are ignored and the local connection is always linked to a remote connection\&.
+.sp
+By default, runs as a managed proxy: informs a parent Tor project of support for the "websocket" pluggable transport\&. In managed mode, the \fILOCAL\fR port is chosen arbitrarily instead of defaulting to 9001; however this can be overridden by including a \fILOCAL\fR port in the command\&. This is the way the program should be invoked in a torrc ClientTransportPlugin "exec" line\&. Use the \fB\-\-external\fR option to run as an external proxy that does not interact with Tor\&.
+.sp
+If any of the \fB\-\-register\fR, \fB\-\-register\-addr\fR, or \fB\-\-register\-methods\fR options are used, then your IP address will be sent to the facilitator so that proxies can connect to you\&. You need to register in some way in order to get any service\&. The \fB\-\-facilitator\fR option allows controlling which facilitator is used; if omitted, it uses a public default\&.
+.SH "OPTIONS"
+.PP
+\fB\-\-daemon\fR
+.RS 4
+Daemonize (Unix only)\&.
+.RE
+.PP
+\fB\-\-external\fR
+.RS 4
+Be an external proxy (don\(cqt interact with Tor using environment variables and stdout)\&.
+.RE
+.PP
+\fB\-f\fR, \fB\-\-facilitator\fR=\fIURL\fR
+.RS 4
+Advertise willingness to receive connections to URL\&.
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Display a help message and exit\&.
+.RE
+.PP
+\fB\-l\fR, \fB\-\-log\fR \fIFILENAME\fR
+.RS 4
+Write log to
+\fIFILENAME\fR
+(default is stdout)\&.
+.RE
+.PP
+\fB\-\-pidfile\fR \fIFILENAME\fR
+.RS 4
+Write PID to
+\fIFILENAME\fR
+after daemonizing\&.
+.RE
+.PP
+\fB\-r\fR, \fB\-\-register\fR
+.RS 4
+Register with the facilitator\&.
+.RE
+.PP
+\fB\-\-register\-addr\fR=\fIADDR\fR
+.RS 4
+Register the given address (in case it differs from REMOTE)\&. Implies \-\-register\&.
+.RE
+.PP
+\fB\-\-register\-methods\fR=\fIMETHOD\fR[,\fIMETHOD\fR]
+.RS 4
+Register using the given comma\-separated list of methods\&. Implies \-\-register\&. Possible methods are: email, http\&. Default is "email,http"\&.
+.RE
+.PP
+\fB\-\-unsafe\-logging\fR
+.RS 4
+Don\(cqt scrub IP addresses from logs\&.
+.RE
+.SH "SEE ALSO"
+.sp
+\fBhttp://crypto\&.stanford\&.edu/flashproxy/\fR
+.sp
+\fBhttps://www\&.torproject\&.org/docs/pluggable\-transports\&.html\&.en\fR
+.SH "BUGS"
+.sp
+Please report using \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&.
+.SH "AUTHORS"
+.sp
+David Fifield [dcf at torproject\&.org]\&.
diff --git a/doc/flashproxy-reg-email.1 b/doc/flashproxy-reg-email.1
new file mode 100644
index 0000000..3ff9c32
--- /dev/null
+++ b/doc/flashproxy-reg-email.1
@@ -0,0 +1,85 @@
+'\" t
+.\"     Title: flashproxy-reg-email
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 11/12/2012
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "FLASHPROXY\-REG\-EMAIL" "1" "11/12/2012" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+flashproxy-reg-email \- Register with a facilitator using the email method
+.SH "SYNOPSIS"
+.sp
+\fBflashproxy\-reg\-email\fR [\fIOPTIONS\fR] [\fIREMOTE\fR][:\fIPORT\fR]
+.SH "DESCRIPTION"
+.sp
+Register with a flash proxy facilitator through email\&. Makes a STARTTLS connection to an SMTP server and sends mail with a client IP address to a designated address\&. By default the remote address registered is ":9000" (the external IP address is guessed)\&.
+.sp
+Using an SMTP server or email address other than the defaults will not work unless you have made special arrangements to connect them to a facilitator\&.
+.sp
+This program requires the M2Crypto library for Python\&.
+.SH "OPTIONS"
+.PP
+\fB\-4\fR
+.RS 4
+Name lookups use only IPv4\&.
+.RE
+.PP
+\fB\-6\fR
+.RS 4
+Name lookups use only IPv6\&.
+.RE
+.PP
+\fB\-d\fR, \fB\-\-debug\fR
+.RS 4
+Enable debugging output (Python smtplib messages)\&.
+.RE
+.PP
+\fB\-e\fR, \fB\-\-email\fR=\fIADDRESS\fR
+.RS 4
+Send mail to
+\fIADDRESS\fR
+(default is "flashproxyreg\&.a at gmail\&.com")\&.
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Display help message and exit\&.
+.RE
+.PP
+\fB\-s\fR, \fB\-\-smtp\fR=\fIHOST\fR[:\fIPORT\fR]
+.RS 4
+Use the given SMTP server (default is "gmail\-smtp\-in\&.l\&.google\&.com:25")\&.
+.RE
+.SH "SEE ALSO"
+.sp
+\fBhttp://crypto\&.stanford\&.edu/flashproxy/\fR
+.sp
+\fBhttps://www\&.torproject\&.org/docs/pluggable\-transports\&.html\&.en\fR
+.SH "BUGS"
+.sp
+Please report using \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&.
+.SH "AUTHORS"
+.sp
+David Fifield [dcf at torproject\&.org]\&.
diff --git a/doc/flashproxy-reg-http.1 b/doc/flashproxy-reg-http.1
new file mode 100644
index 0000000..7b55e50
--- /dev/null
+++ b/doc/flashproxy-reg-http.1
@@ -0,0 +1,59 @@
+'\" t
+.\"     Title: flashproxy-reg-http
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 11/12/2012
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "FLASHPROXY\-REG\-HTTP" "1" "11/12/2012" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+flashproxy-reg-http \- Register with a facilitator using the HTTP method
+.SH "SYNOPSIS"
+.sp
+\fBflashproxy\-reg\-http\fR [\fIOPTIONS\fR] [\fIREMOTE\fR][:\fIPORT\fR]
+.SH "DESCRIPTION"
+.sp
+Register with a flash proxy facilitator using an HTTP POST\&. By default the remote address registered is ":9000"\&.
+.SH "OPTIONS"
+.PP
+\fB\-f\fR, \fB\-\-facilitator\fR
+.RS 4
+Register with the given facilitator (by default "https://tor\-facilitator\&.bamsoftware\&.com/")\&.
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Display help message and exit\&.
+.RE
+.SH "SEE ALSO"
+.sp
+\fBhttp://crypto\&.stanford\&.edu/flashproxy/\fR
+.sp
+\fBhttps://www\&.torproject\&.org/docs/pluggable\-transports\&.html\&.en\fR
+.SH "BUGS"
+.sp
+Please report using \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&.
+.SH "AUTHORS"
+.sp
+David Fifield [dcf at torproject\&.org]\&.

More information about the tor-commits mailing list