[GNUnet-SVN] r24602 - gnunet/doc/man

[gnunet]

Author: schanzen
Date: 2012-10-30 07:17:52 +0100 (Tue, 30 Oct 2012)
New Revision: 24602

Added:
   gnunet/doc/man/gnunet-gns-proxy.1
Modified:
   gnunet/doc/man/Makefile.am
Log:
-add gns proxy man page


Modified: gnunet/doc/man/Makefile.am
===================================================================
--- gnunet/doc/man/Makefile.am  2012-10-30 06:17:19 UTC (rev 24601)
+++ gnunet/doc/man/Makefile.am  2012-10-30 06:17:52 UTC (rev 24602)
@@ -12,6 +12,7 @@
   gnunet-fs.1 \
   gnunet-gns.1 \
   gnunet-gns-fcfsd.1 \
+  gnunet-gns-proxy.1 \
   gnunet-namestore.1 \
   gnunet-nat-server.1 \
   gnunet-peerinfo.1 \

Added: gnunet/doc/man/gnunet-gns-proxy.1
===================================================================
--- gnunet/doc/man/gnunet-gns-proxy.1                           (rev 0)
+++ gnunet/doc/man/gnunet-gns-proxy.1   2012-10-30 06:17:52 UTC (rev 24602)
@@ -0,0 +1,41 @@
+.TH GNUNET\-GNS\-PROXY 1 "Oct 25, 2012" "GNUnet"
+
+.SH NAME
+gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy
+
+.SH SYNOPSIS
+.B gnunet\-gns\-proxy
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+Most users will want to run this SOCKS proxy. It can be used in combination 
with browsers that support the SOCKS 4a protocol.
+
+The proxy will perform SSL authentication of GNS names and rewrite GNS enabled 
HTML content. To assert the validity of GNS names a local root CA certificate 
has to be generated that is used by the proxy. Thus "gnunet-gns-proxy-setup-ca" 
should be executed before the first launch of this proxy or the \-\-authority 
switch is used to specify an appropriate CA certificate that is already trusted 
by the browser.
+
+.SH OPTIONS
+.B
+.IP "\-c FILENAME,  \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.B
+.IP "\-a AUTHORITY,  \-\-authority=AUTHORITY"
+Path to a PEM CA file that contains the certificate and private key of the CA 
to use to assert the validity of GNS names. The default port is specified in 
the configuration file for the gns service under "[gns-proxy]" PROXY_CACERT.
+.B
+.IP "\-p PORT,  \-\-port=PORT"
+The port this proxy should listen on. Default is 7777.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
+.B
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
+
+.SH SEE ALSO
+gnunet\-gns(1)