diff options
Diffstat (limited to 'doc/man/gnunet-gns-proxy.1')
-rw-r--r-- | doc/man/gnunet-gns-proxy.1 | 29 |
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 |
30 | run 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 |
40 | Most users will want to run this SOCKS proxy. | 39 | Most users will want to run this SOCKS proxy. |
41 | It can be used in combination with browsers that support the SOCKS 4a protocol. | 40 | It can be used in combination with browsers that support the SOCKS 4a protocol. |
42 | .Pp | 41 | .Pp |
43 | The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. | 42 | The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. |
44 | To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. | 43 | To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. |
45 | 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. | 44 | 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. |
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 |
48 | Use the configuration file FILENAME. | 47 | Use 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 |
50 | 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. | 49 | 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. |
51 | The default port is specified in the configuration file for the gns service under "[gns-proxy]": | 50 | The default port is specified in the configuration file for the gns service under "[gns-proxy]": |
52 | "[gns-proxy]" | 51 | "[gns-proxy]" |
53 | PROXY_CACERT | 52 | PROXY_CACERT |
54 | .It Fl p Ar PORT | Fl \-port= Ns Ar PORT | 53 | .It Fl p Ar PORT | Fl -port= Ns Ar PORT |
55 | The port this proxy should listen on. Default is 7777. | 54 | The port this proxy should listen on. Default is 7777. |
56 | .It Fl h | \-help | 55 | .It Fl h | -help |
57 | Print short help on options. | 56 | Print 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 |
59 | Use LOGLEVEL for logging. | 58 | Use LOGLEVEL for logging. |
60 | Valid values are DEBUG, INFO, WARNING and ERROR. | 59 | Valid values are DEBUG, INFO, WARNING and ERROR. |
61 | .It Fl v | \-version | 60 | .It Fl v | -version |
62 | Print GNUnet version number. | 61 | Print GNUnet version number. |
63 | .El | 62 | .El |
64 | .\".Sh EXAMPLES | 63 | .\".Sh EXAMPLES |