diff options
author | ng0 <ng0@n0.is> | 2019-04-18 17:43:41 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-18 17:43:41 +0000 |
commit | a72c48b86b0b5049f05d2637930d298a3d313daf (patch) | |
tree | df5f8fa879031f97798d09ceec94267792201e80 /doc/man | |
parent | e4910de8d19b09c66b56b41835df793bafd21bad (diff) | |
download | gnunet-a72c48b86b0b5049f05d2637930d298a3d313daf.tar.gz gnunet-a72c48b86b0b5049f05d2637930d298a3d313daf.zip |
gnunet-gns-proxy.1
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/gnunet-gns-proxy.1 | 112 |
1 files changed, 60 insertions, 52 deletions
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1 index 603c5a28c..5edecd007 100644 --- a/doc/man/gnunet-gns-proxy.1 +++ b/doc/man/gnunet-gns-proxy.1 | |||
@@ -1,59 +1,67 @@ | |||
1 | .TH GNUNET-GNS-PROXY 1 "October 25, 2012" "GNUnet" | 1 | .Dd October 25, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-GNS-PROXY 1 |
3 | gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-gns\-proxy | 5 | .Nm gnunet-gns-proxy |
6 | .RI [ options ] | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | run a client side GNS SOCKS proxy |
8 | Most users will want to run this SOCKS proxy. It can be used in | 8 | .Sh SYNOPSIS |
9 | combination with browsers that support the SOCKS 4a protocol. | 9 | .Nm |
10 | .PP | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
11 | The proxy will perform SSL authentication of GNS names and rewrite GNS | 11 | .Op Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY |
12 | enabled HTML content. To assert the validity of GNS names a local root | 12 | .Op Fl p Ar PORT | Fl \-port= Ns Ar PORT |
13 | CA certificate has to be generated that is used by the proxy. Thus | 13 | .Op Fl h | \-help |
14 | "gnunet-gns-proxy-setup-ca" should be executed before the first launch | 14 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
15 | of this proxy or the \-\-authority switch is used to specify an | 15 | .Op Fl v | \-version |
16 | appropriate CA certificate that is already trusted by the browser. | 16 | .Sh DESCRIPTION |
17 | .SH OPTIONS | 17 | Most users will want to run this SOCKS proxy. |
18 | .IP "\-c FILENAME, \-\-config=FILENAME" | 18 | It can be used in combination with browsers that support the SOCKS 4a protocol. |
19 | .Pp | ||
20 | The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. | ||
21 | To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. | ||
22 | 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. | ||
23 | .Bl -tag -width Ds | ||
24 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
19 | Use the configuration file FILENAME. | 25 | Use the configuration file FILENAME. |
20 | .IP "\-a AUTHORITY, \-\-authority=AUTHORITY" | 26 | .It Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY |
21 | Path to a PEM CA file that contains the certificate and private key of | 27 | 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. |
22 | the CA to use to assert the validity of GNS names. The default port is | 28 | The default port is specified in the configuration file for the gns service under "[gns-proxy]": |
23 | specified in the configuration file for the gns service under | 29 | "[gns-proxy]" |
24 | "[gns-proxy]" PROXY_CACERT. | 30 | PROXY_CACERT |
25 | .IP "\-p PORT, \-\-port=PORT" | 31 | .It Fl p Ar PORT | Fl \-port= Ns Ar PORT |
26 | The port this proxy should listen on. Default is 7777. | 32 | The port this proxy should listen on. Default is 7777. |
27 | .IP "\-h, \-\-help" | 33 | .It Fl h | \-help |
28 | Print short help on options. | 34 | Print short help on options. |
29 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 35 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
30 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 36 | Use LOGLEVEL for logging. |
31 | ERROR. | 37 | Valid values are DEBUG, INFO, WARNING and ERROR. |
32 | .IP "\-v, \-\-version" | 38 | .It Fl v | \-version |
33 | Print GNUnet version number. | 39 | Print GNUnet version number. |
34 | .SH BUGS | 40 | .El |
35 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 41 | .\".Sh EXAMPLES |
36 | electronic mail to <bug\-gnunet@gnu.org> | 42 | .Sh SEE ALSO |
37 | .SH SEE ALSO | 43 | .Xr gnunet-gns 1 |
38 | gnunet\-gns(1) | 44 | .sp |
39 | .PP | 45 | The full documentation for gnunet is maintained as a Texinfo manual. |
40 | The full documentation for | ||
41 | .B gnunet | ||
42 | is maintained as a Texinfo manual. | ||
43 | If the | 46 | If the |
44 | .B info | 47 | .Xr info 1 |
45 | and | 48 | and gnunet programs are properly installed at your site, the command |
46 | .B gnunet | 49 | .Pp |
47 | programs are properly installed at your site, the command | 50 | .Dl info gnunet |
48 | .IP | 51 | .Pp |
49 | .B info gnunet | ||
50 | .PP | ||
51 | should give you access to the complete handbook, | 52 | should give you access to the complete handbook, |
52 | .IP | 53 | .Pp |
53 | .B info gnunet-c-tutorial | 54 | .Dl info gnunet-c-tutorial |
54 | .PP | 55 | .Pp |
55 | will give you access to a tutorial for developers. | 56 | will give you access to a tutorial for developers. |
56 | .PP | 57 | .sp |
57 | Depending on your installation, this information is also | 58 | Depending on your installation, this information is also available in |
58 | available in | 59 | .Xr gnunet 7 and |
59 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 60 | .Xr gnunet-c-tutorial 7 . |
61 | .\".Sh HISTORY | ||
62 | .\".Sh AUTHORS | ||
63 | .Sh BUGS | ||
64 | Report bugs by using | ||
65 | .Lk https://bugs.gnunet.org | ||
66 | or by sending electronic mail to | ||
67 | .Aq Mt gnunet-developers@gnu.org . | ||