[tor-commits] [meek/master] Generate man pages.

Thu May 8 04:51:55 UTC 2014

commit bacbdb31abf5710236ffa29b09bc525e09ec5dc5
Author: David Fifield <david at bamsoftware.com>
Date:   Wed May 7 21:51:29 2014 -0700

    Generate man pages.
---
 doc/meek-client.1 |  111 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/meek-server.1 |   96 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 207 insertions(+)

diff --git a/doc/meek-client.1 b/doc/meek-client.1
new file mode 100644
index 0000000..51b31ca
--- /dev/null
+++ b/doc/meek-client.1
@@ -0,0 +1,111 @@
+'\" t
+.\"     Title: meek-client
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\"      Date: 05/07/2014
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "MEEK\-CLIEN" "1" "05/07/2014" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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"
+meek-client \- The meek client transport plugin
+.SH "SYNOPSIS"
+.sp
+\fBmeek\-client\fR \fB\-\-url\fR=\fIURL\fR \fB\-\-front\fR=\fIDOMAIN\fR [\fIOPTIONS\fR]
+.SH "DESCRIPTION"
+.sp
+meek\-client is a transport plugin for Tor that encodes a stream as a sequence of HTTP requests and responses\&. It is usually run with the \fB\-\-url\fR and \fB\-\-front\fR options\&. The \fB\-\-url\fR option controls what URL requests are made to; the web server at that URL should be configured to forward requests to a meek\-server somewhere\&. The \fB\-\-front\fR option is for domain name camouflage: The domain name in the URL is replaced by the front domain before the request is made, but the Host header inside the HTTP request still points to the original domain\&. The idea is to front through a domain that is not blocked to a domain that is blocked\&.
+.sp
+Configuration for meek\-client usually appears in a torrc file\&. Most user configuration can happen either through SOCKS args (i\&.e\&., args on a Bridge line) or through command line options\&. SOCKS args take precedence per\-connection over command line options\&. For example, this configuration using SOCKS args:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Bridge meek 0\&.0\&.2\&.0:1 url=https://meek\-reflect\&.appspot\&.com/ front=www\&.google\&.com
+ClientTransportPlugin meek exec \&./meek\-client
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+is the same as this one using command line options:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Bridge meek 0\&.0\&.2\&.0:1
+ClientTransportPlugin meek exec \&./meek\-client \-\-url=https://meek\-reflect\&.appspot\&.com/ \-\-front=www\&.google\&.com
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+The advantage of SOCKS args is that multiple Bridge lines can have different configurations\&.
+.sp
+The \fB\-\-helper\fR option prevents meek\-client from doing any network operations itself\&. Rather, it will send all requests through a browser extension, which must be set up separately\&.
+.SH "OPTIONS"
+.PP
+\fB\-\-front\fR=\fIDOMAIN\fR
+.RS 4
+Front domain name\&. The
+\fBfront\fR
+SOCKS arg overrides the command line\&.
+.RE
+.PP
+\fB\-\-helper\fR=\fIADDRESS\fR
+.RS 4
+Address of HTTP helper browser extension\&. For example,
+\fB\-\-helper 127\&.0\&.0\&.1:7000\fR\&.
+.RE
+.PP
+\fB\-\-http\-proxy\fR=\fIURL\fR
+.RS 4
+URL of HTTP proxy\&. If not given, the proxy URL may be taken from the The
+\fBhttp\-proxy\fR
+SOCKS arg overrides the command line\&. For example,
+\fB\-\-http\-proxy=http://localhost:8787/\fR\&.
+.RE
+.PP
+\fB\-\-log\fR=\fIFILENAME\fR
+.RS 4
+Name of a file to write log messages to (default stderr)\&.
+.RE
+.PP
+\fB\-\-url\fR=\fIURL\fR
+.RS 4
+URL to correspond with\&. The domain part of the URL may be modified by
+\fB\-\-front\fR\&.
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Display a help message and exit\&.
+.RE
+.SH "SEE ALSO"
+.sp
+\fBhttps://trac\&.torproject\&.org/projects/tor/wiki/doc/meek\fR
+.SH "BUGS"
+.sp
+Please report at \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&.
diff --git a/doc/meek-server.1 b/doc/meek-server.1
new file mode 100644
index 0000000..9dc3f07
--- /dev/null
+++ b/doc/meek-server.1
@@ -0,0 +1,96 @@
+'\" t
+.\"     Title: meek-server
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\"      Date: 05/07/2014
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "MEEK\-SERVE" "1" "05/07/2014" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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"
+meek-server \- The meek server transport plugin
+.SH "SYNOPSIS"
+.sp
+\fBmeek\-server\fR \fB\-\-cert\fR=\fIFILENAME\fR \fB\-\-key\fR=\fIFILENAME\fR [\fIOPTIONS\fR]
+.SH "DESCRIPTION"
+.sp
+meek\-server is a transport plugin for Tor that encodes a stream as a sequence of HTTP requests and responses\&.
+.sp
+The server runs in HTTPS mode by default, and the \fB\-\-cert\fR and \fB\-\-key\fR options are required\&. Use the \fB\-\-disable\-tls\fR option to run with plain HTTP\&.
+.sp
+Configuration for meek\-server usually appears in a torrc file\&. Here is a sample configuration using HTTPS:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ServerTransportPlugin meek exec \&./meek\-server \-\-port 8443 \-\-cert cert\&.pem \-\-key key\&.pem \-\-log meek\-server\&.log
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Here is a sample configuration using plain HTTP:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ServerTransportPlugin meek exec \&./meek\-server \-\-port 8080 \-\-disable\-tls \-\-log meek\-server\&.log
+.fi
+.if n \{\
+.RE
+.\}
+.SH "OPTIONS"
+.PP
+\fB\-\-cert\fR=\fIFILENAME\fR
+.RS 4
+Name of a PEM\-encoded TLS certificate file\&. Required unless
+\fB\-\-disable\-tls\fR
+is used\&.
+.RE
+.sp
+\fB\-\-disable\-tls\fR: Use plain HTTP rather than HTTPS\&.
+.sp
+\fB\-\-key\fR=\fIFILENAME\fR: Name of a PEM\-encoded TLS private key file\&. Required unless \fB\-\-disable\-tls\fR is used\&.
+.PP
+\fB\-\-log\fR=\fIFILENAME\fR
+.RS 4
+Name of a file to write log messages to (default stderr)\&.
+.RE
+.PP
+\fB\-\-port\fR=\fIPORT\fR
+.RS 4
+Port to listen on\&. Overrides the TOR_PT_SERVER_BINDADDR environment variable set by tor\&.
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Display a help message and exit\&.
+.RE
+.SH "SEE ALSO"
+.sp
+\fBhttps://trac\&.torproject\&.org/projects/tor/wiki/doc/meek\fR
+.SH "BUGS"
+.sp
+Please report at \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&.

