summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Schanzenbach <mschanzenbach@posteo.de>2012-10-30 06:17:52 +0000
committerMartin Schanzenbach <mschanzenbach@posteo.de>2012-10-30 06:17:52 +0000
commit312426a2efd842c060c13581988c7faa4d1600c8 (patch)
treeda53240b097283ca813f42a087ce816d421eac37 /doc
parent8c786c49c21bade1f302203bce58cb00c3ee6045 (diff)
-add gns proxy man page
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-gns-proxy.141
2 files changed, 42 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index ca0c1cd6e..5d96d88d7 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -12,6 +12,7 @@ man_MANS = \
gnunet-fs.1 \
gnunet-gns.1 \
gnunet-gns-fcfsd.1 \
+ gnunet-gns-proxy.1 \
gnunet-namestore.1 \
gnunet-nat-server.1 \
gnunet-peerinfo.1 \
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
new file mode 100644
index 000000000..9b9f603bd
--- /dev/null
+++ b/doc/man/gnunet-gns-proxy.1
@@ -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 <bug\-gnunet@gnu.org>
+
+.SH SEE ALSO
+gnunet\-gns(1)