doc/man/5,1: in SEE ALSO mention that the main documentation is maintained in texinfo...
[oweals/gnunet.git] / doc / man / gnunet-gns-proxy.1
1 .TH GNUNET\-GNS\-PROXY 1 "Oct 25, 2012" "GNUnet"
2
3 .SH NAME
4 gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy
5
6 .SH SYNOPSIS
7 .B gnunet\-gns\-proxy
8 .RI [ options ]
9 .br
10
11 .SH DESCRIPTION
12 Most users will want to run this SOCKS proxy. It can be used in
13 combination with browsers that support the SOCKS 4a protocol.
14
15 The proxy will perform SSL authentication of GNS names and rewrite GNS
16 enabled HTML content. To assert the validity of GNS names a local root
17 CA 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
19 of this proxy or the \-\-authority switch is used to specify an
20 appropriate CA certificate that is already trusted by the browser.
21
22 .SH OPTIONS
23 .B
24 .IP "\-c FILENAME,  \-\-config=FILENAME"
25 Use the configuration file FILENAME.
26 .B
27 .IP "\-a AUTHORITY,  \-\-authority=AUTHORITY"
28 Path to a PEM CA file that contains the certificate and private key of
29 the CA to use to assert the validity of GNS names. The default port is
30 specified in the configuration file for the gns service under
31 "[gns-proxy]" PROXY_CACERT.
32 .B
33 .IP "\-p PORT,  \-\-port=PORT"
34 The port this proxy should listen on. Default is 7777.
35 .B
36 .IP "\-h, \-\-help"
37 Print short help on options.
38 .B
39 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
40 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and
41 ERROR.
42 .B
43 .IP "\-v, \-\-version"
44 Print GNUnet version number.
45
46
47 .SH BUGS
48 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org>
49
50 .SH SEE ALSO
51 gnunet\-gns(1)
52 The full documentation for
53 .B gnunet
54 is maintained as a Texinfo manual.  If the
55 .B info
56 and
57 .B gnunet
58 programs are properly installed at your site, the command
59 .IP
60 .B info gnunet
61 .PP
62 should give you access to the complete handbook,
63 .IP
64 .B info gnunet-c-tutorial
65 .PP
66 will give you access to a tutorial for developers.
67 .PP
68 Depending on your installation, this information is also
69 available in
70 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).