[tor-commits] [flashproxy/master] Add man page for flashproxy-reg-url.

[dcf at torproject.org]

commit 84121a13013ec043f0c1228edaed44346e3143a9
Author: Alexandre Allaire <alexandre.allaire at mail.mcgill.ca>
Date:   Wed Mar 13 19:20:59 2013 -0400

    Add man page for flashproxy-reg-url.
---
 doc/flashproxy-reg-url.1     |   78 ++++++++++++++++++++++++++++++++++++++++++
 doc/flashproxy-reg-url.1.txt |   59 +++++++++++++++++++++++++++++++
 2 files changed, 137 insertions(+), 0 deletions(-)

diff --git a/doc/flashproxy-reg-url.1 b/doc/flashproxy-reg-url.1
new file mode 100644
index 0000000..58a537f
--- /dev/null
+++ b/doc/flashproxy-reg-url.1
@@ -0,0 +1,78 @@
+'\" t
+.\"     Title: flashproxy-reg-url
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.78.0 <http://docbook.sf.net/>
+.\"      Date: 03/13/2013
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "FLASHPROXY\-REG\-URL" "1" "03/13/2013" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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-url \- Register with a facilitator using an indirect URL
+.SH "SYNOPSIS"
+.sp
+\fBflashproxy\-reg\-url\fR [\fIOPTIONS\fR] \fIREMOTE\fR[:\fIPORT\fR]
+.SH "DESCRIPTION"
+.sp
+Print a URL, which, when retrieved, will cause the client address \fIREMOTE\fR[:\fIPORT\fR] to be registered with the flash proxy facilitator\&. The default \fIPORT\fR is 9000\&.
+.SH "OPTIONS"
+.PP
+\fB\-f\fR, \fB\-\-facilitator\fR=\fIURL\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 "EXAMPLE"
+.sp
+Say you wish to register 101\&.202\&.10\&.20:9000\&. Run
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+\&./flashproxy\-reg\-url 101\&.202\&.10\&.20:9000
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+The program should output a long string looking something like
+.sp
+https://tor\-facilitator\&.bamsoftware\&.com/reg/0labtDob545HeKpLZ8LqGeOi\-OK7HXoQvfQzj0P2pjh1NrCKNDaPe91zo\&.\&.\&.
+.sp
+Copy this string and paste it into any URL fetching website or program\&. An example would be the W3C Markup Validation Service at http://validator\&.w3\&.org\&. Once the URL is retrieved your address will be registered with the facilitator\&.
+.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-url.1.txt b/doc/flashproxy-reg-url.1.txt
new file mode 100644
index 0000000..e8b8acc
--- /dev/null
+++ b/doc/flashproxy-reg-url.1.txt
@@ -0,0 +1,59 @@
+// This file is asciidoc source code.
+// To generate manpages, use the a2x command.
+// This one has a long name, if you don't change the
+// default length parameter it will be truncated, use:
+// a2x --no-xmllint --xsltproc-opts "--stringparam man.th.title.max.length 23" -d manpage -f manpage flashproxy-reg-url.1.txt
+FLASHPROXY-REG-URL(1)
+=====================
+
+NAME
+----
+flashproxy-reg-url - Register with a facilitator using an indirect URL
+
+SYNOPSIS
+--------
+**flashproxy-reg-url** [__OPTIONS__] __REMOTE__[:__PORT__]
+
+DESCRIPTION
+-----------
+Print a URL, which, when retrieved, will cause the client address
+__REMOTE__[:__PORT__] to be registered with the flash proxy facilitator. The
+default __PORT__ is 9000.
+
+OPTIONS
+-------
+**-f**, **--facilitator**=__URL__::
+    Register with the given facilitator (by default "https://tor-facilitator.bamsoftware.com/").
+
+**-h**, **--help**::
+    Display help message and exit.
+
+EXAMPLE
+-------
+Say you wish to register 101.202.10.20:9000. Run
+
+.......................................
+./flashproxy-reg-url 101.202.10.20:9000
+.......................................
+
+The program should output a long string looking something like
+
+https://tor-facilitator.bamsoftware.com/reg/0labtDob545HeKpLZ8LqGeOi-OK7HXoQvfQzj0P2pjh1NrCKNDaPe91zo\...
+
+Copy this string and paste it into any URL fetching website or program.
+An example would be the W3C Markup Validation Service at http://validator.w3.org.
+Once the URL is retrieved your address will be registered with the facilitator.
+
+SEE ALSO
+--------
+**http://crypto.stanford.edu/flashproxy/**
+
+**https://www.torproject.org/docs/pluggable-transports.html.en**
+
+BUGS
+----
+Please report using **https://trac.torproject.org/projects/tor**.
+
+AUTHORS
+-------
+David Fifield [dcf at torproject.org].