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