[tor-commits] [flashproxy/master] Added asciidoc file for flashproxy-reg-email man page.

[dcf at torproject.org]

commit 98141a52228d8edb4e18274ae94bb744f1af0717
Author: Alexandre Allaire <alexandre.allaire at mail.mcgill.ca>
Date:   Sun Nov 11 22:05:02 2012 -0500

    Added asciidoc file for flashproxy-reg-email man page.
    
    Added the asciidoc source for the flashproxy-reg-email
    man page. The title on this one is a bit big, with the
    default options a2x will truncate it. To generate a manpage
    with the full title use:
    
    a2x --no-xmllint --xsltproc-opts "--stringparam man.th.title.max.length 23" \
    -d manpage -f manpage flashproxy-reg-email.1.txt
    
    The style is based on the man pages for tor and asciidoc.
---
 doc/flashproxy-reg-email.1.txt |   64 ++++++++++++++++++++++++++++++++++++++++
 1 files changed, 64 insertions(+), 0 deletions(-)

diff --git a/doc/flashproxy-reg-email.1.txt b/doc/flashproxy-reg-email.1.txt
new file mode 100644
index 0000000..f98472e
--- /dev/null
+++ b/doc/flashproxy-reg-email.1.txt
@@ -0,0 +1,64 @@
+// 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-email.1.txt
+:man source: Flashproxy Register Email
+:man manual: Flashproxy Manual
+
+FLASHPROXY-REG-EMAIL(1)
+=======================
+
+NAME
+----
+flashproxy-reg-email - Register with a facilitator using the email method
+
+SYNOPSIS
+--------
+**flashproxy-reg-email** [__OPTIONS__] [__REMOTE__][:__PORT__]
+
+DESCRIPTION
+-----------
+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).
+
+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.
+
+This program requires the M2Crypto library for Python.
+
+OPTIONS
+-------
+**-4**::
+    Name lookups use only IPv4.
+
+**-6**::
+    Name lookups use only IPv6.
+
+**-d**, **--debug**::
+    Enable debugging output (Python smtplib messages).
+
+**-e**, **--email**=__ADDRESS__::
+    Send mail to __ADDRESS__ (default is "flashproxyreg.a at gmail.com").
+
+**-h**, **--help**::
+    Display help message and exit.
+
+**-s**, **--smtp**=__HOST__[:__PORT__]::
+    Use the given SMTP server (default is "gmail-smtp-in.l.google.com:25").
+
+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].