commit 04af9f01727bed246defb9197046a557d0b12317 Author: David Fifield <david@bamsoftware.com> Date: Sun May 19 01:02:00 2013 -0700 Add basic man page for flashproxy-reg-appspot. --- Makefile | 2 +- doc/flashproxy-reg-appspot.1 | 56 ++++++++++++++++++++++++++++++++++++++ doc/flashproxy-reg-appspot.1.txt | 39 ++++++++++++++++++++++++++ 3 files changed, 96 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index c11bec3..73b9b5a 100644 --- a/Makefile +++ b/Makefile @@ -17,7 +17,7 @@ all: $(CLIENT_DIST_FILES) $(CLIENT_MAN) %.1: %.1.txt rm -f $@ - a2x --no-xmllint --xsltproc-opts "--stringparam man.th.title.max.length 23" -d manpage -f manpage $< + a2x --no-xmllint --xsltproc-opts "--stringparam man.th.title.max.length 24" -d manpage -f manpage $< install: mkdir -p $(BINDIR) diff --git a/doc/flashproxy-reg-appspot.1 b/doc/flashproxy-reg-appspot.1 new file mode 100644 index 0000000..2f6bfda --- /dev/null +++ b/doc/flashproxy-reg-appspot.1 @@ -0,0 +1,56 @@ +'\" t +.\" Title: flashproxy-reg-appspot +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> +.\" Date: 05/19/2013 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "FLASHPROXY\-REG\-APPSPOT" "1" "05/19/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-appspot \- Register with a facilitator through Google App Engine\&. +.SH "SYNOPSIS" +.sp +\fBflashproxy\-reg\-appspot\fR [\fIOPTIONS\fR] [\fIREMOTE\fR][:\fIPORT\fR] +.SH "DESCRIPTION" +.sp +Register with a flash proxy facilitator through a Google App Engine app\&. By default the remote address registered is ":9000" (the external IP address is guessed)\&. +.SH "OPTIONS" +.PP +\fB\-\-facilitator\-pubkey\fR=\fIFILENAME\fR +.RS 4 +Encrypt registrations to the given PEM\-formatted public key (default built\-in)\&. +.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\&. diff --git a/doc/flashproxy-reg-appspot.1.txt b/doc/flashproxy-reg-appspot.1.txt new file mode 100644 index 0000000..de9f020 --- /dev/null +++ b/doc/flashproxy-reg-appspot.1.txt @@ -0,0 +1,39 @@ +// 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 24" -d manpage -f manpage flashproxy-reg-appspot.1.txt +FLASHPROXY-REG-APPSPOT(1) +========================= + +NAME +---- +flashproxy-reg-appspot - Register with a facilitator through Google App Engine. + +SYNOPSIS +-------- +**flashproxy-reg-appspot** [__OPTIONS__] [__REMOTE__][:__PORT__] + +DESCRIPTION +----------- +Register with a flash proxy facilitator through a Google App Engine app. +By default the remote address registered is ":9000" (the +external IP address is guessed). + +OPTIONS +------- +**--facilitator-pubkey**=__FILENAME__:: + Encrypt registrations to the given PEM-formatted public key (default built-in). + +**-h**, **--help**:: + Display help message and exit. + +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**.