aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-gns-proxy.1
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-05-04 19:57:38 +0000
committerNils Gillmann <ng0@n0.is>2018-05-04 19:57:38 +0000
commitc3c9fef22fa6e4657c3fc862bad365b440ee2305 (patch)
treea19406f086fd3a1c059c66b6916b78148f83d5bb /doc/man/gnunet-gns-proxy.1
parent295384b197a85ebfb1cb7bbe5d1b02af4c40d342 (diff)
downloadgnunet-c3c9fef22fa6e4657c3fc862bad365b440ee2305.tar.gz
gnunet-c3c9fef22fa6e4657c3fc862bad365b440ee2305.zip
Follow-up commit to format most of the other man pages code.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-gns-proxy.1')
-rw-r--r--doc/man/gnunet-gns-proxy.118
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
index 9b9f603bd..96e9911a2 100644
--- a/doc/man/gnunet-gns-proxy.1
+++ b/doc/man/gnunet-gns-proxy.1
@@ -9,9 +9,15 @@ gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy
9.br 9.br
10 10
11.SH DESCRIPTION 11.SH DESCRIPTION
12Most users will want to run this SOCKS proxy. It can be used in combination with browsers that support the SOCKS 4a protocol. 12Most users will want to run this SOCKS proxy. It can be used in
13combination with browsers that support the SOCKS 4a protocol.
13 14
14The 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. 15The proxy will perform SSL authentication of GNS names and rewrite GNS
16enabled HTML content. To assert the validity of GNS names a local root
17CA certificate has to be generated that is used by the proxy. Thus
18"gnunet-gns-proxy-setup-ca" should be executed before the first launch
19of this proxy or the \-\-authority switch is used to specify an
20appropriate CA certificate that is already trusted by the browser.
15 21
16.SH OPTIONS 22.SH OPTIONS
17.B 23.B
@@ -19,7 +25,10 @@ The proxy will perform SSL authentication of GNS names and rewrite GNS enabled H
19Use the configuration file FILENAME. 25Use the configuration file FILENAME.
20.B 26.B
21.IP "\-a AUTHORITY, \-\-authority=AUTHORITY" 27.IP "\-a AUTHORITY, \-\-authority=AUTHORITY"
22Path 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. 28Path to a PEM CA file that contains the certificate and private key of
29the CA to use to assert the validity of GNS names. The default port is
30specified in the configuration file for the gns service under
31"[gns-proxy]" PROXY_CACERT.
23.B 32.B
24.IP "\-p PORT, \-\-port=PORT" 33.IP "\-p PORT, \-\-port=PORT"
25The port this proxy should listen on. Default is 7777. 34The port this proxy should listen on. Default is 7777.
@@ -28,7 +37,8 @@ The port this proxy should listen on. Default is 7777.
28Print short help on options. 37Print short help on options.
29.B 38.B
30.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 39.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
31Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 40Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and
41ERROR.
32.B 42.B
33.IP "\-v, \-\-version" 43.IP "\-v, \-\-version"
34Print GNUnet version number. 44Print GNUnet version number.