aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-gns-proxy.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-gns-proxy.1')
-rw-r--r--doc/man/gnunet-gns-proxy.129
1 files changed, 14 insertions, 15 deletions
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
index d985ee0d9..16b3b42f1 100644
--- a/doc/man/gnunet-gns-proxy.1
+++ b/doc/man/gnunet-gns-proxy.1
@@ -26,39 +26,38 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-gns-proxy 28.Nm gnunet-gns-proxy
29.Nd 29.Nd run a client-side GNS SOCKS proxy
30run a client side GNS SOCKS proxy
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
34.Op Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY 33.Op Fl a Ar AUTHORITY | Fl -authority= Ns Ar AUTHORITY
35.Op Fl p Ar PORT | Fl \-port= Ns Ar PORT 34.Op Fl p Ar PORT | Fl -port= Ns Ar PORT
36.Op Fl h | \-help 35.Op Fl h | -help
37.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
38.Op Fl v | \-version 37.Op Fl v | -version
39.Sh DESCRIPTION 38.Sh DESCRIPTION
40Most users will want to run this SOCKS proxy. 39Most users will want to run this SOCKS proxy.
41It can be used in combination with browsers that support the SOCKS 4a protocol. 40It can be used in combination with browsers that support the SOCKS 4a protocol.
42.Pp 41.Pp
43The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. 42The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content.
44To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. 43To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy.
45Thus "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. 44Thus "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.
46.Bl -tag -width indent 45.Bl -tag -width indent
47.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 46.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
48Use the configuration file FILENAME. 47Use the configuration file FILENAME.
49.It Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY 48.It Fl a Ar AUTHORITY | Fl -authority= Ns Ar AUTHORITY
50Path to a PEM CA file that contains the certificate and private key of the CA to use to assert the validity of GNS names. 49Path to a PEM CA file that contains the certificate and private key of the CA to use to assert the validity of GNS names.
51The default port is specified in the configuration file for the gns service under "[gns-proxy]": 50The default port is specified in the configuration file for the gns service under "[gns-proxy]":
52"[gns-proxy]" 51"[gns-proxy]"
53PROXY_CACERT 52PROXY_CACERT
54.It Fl p Ar PORT | Fl \-port= Ns Ar PORT 53.It Fl p Ar PORT | Fl -port= Ns Ar PORT
55The port this proxy should listen on. Default is 7777. 54The port this proxy should listen on. Default is 7777.
56.It Fl h | \-help 55.It Fl h | -help
57Print short help on options. 56Print short help on options.
58.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 57.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
59Use LOGLEVEL for logging. 58Use LOGLEVEL for logging.
60Valid values are DEBUG, INFO, WARNING and ERROR. 59Valid values are DEBUG, INFO, WARNING and ERROR.
61.It Fl v | \-version 60.It Fl v | -version
62Print GNUnet version number. 61Print GNUnet version number.
63.El 62.El
64.\".Sh EXAMPLES 63.\".Sh EXAMPLES