From a72c48b86b0b5049f05d2637930d298a3d313daf Mon Sep 17 00:00:00 2001 From: ng0 Date: Thu, 18 Apr 2019 17:43:41 +0000 Subject: [PATCH] gnunet-gns-proxy.1 --- doc/man/gnunet-gns-proxy.1 | 112 ++++++++++++++++++++----------------- 1 file 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 @@ -.TH GNUNET-GNS-PROXY 1 "October 25, 2012" "GNUnet" -.SH NAME -gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy -.SH SYNOPSIS -.B gnunet\-gns\-proxy -.RI [ options ] -.SH DESCRIPTION -Most users will want to run this SOCKS proxy. It can be used in -combination with browsers that support the SOCKS 4a protocol. -.PP -The proxy will perform SSL authentication of GNS names and rewrite GNS -enabled HTML content. To assert the validity of GNS names a local root -CA certificate has to be generated that is used by the proxy. 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. -.SH OPTIONS -.IP "\-c FILENAME, \-\-config=FILENAME" +.Dd October 25, 2012 +.Dt GNUNET-GNS-PROXY 1 +.Os +.Sh NAME +.Nm gnunet-gns-proxy +.Nd +run a client side GNS SOCKS proxy +.Sh SYNOPSIS +.Nm +.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME +.Op Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY +.Op Fl p Ar PORT | Fl \-port= Ns Ar PORT +.Op Fl h | \-help +.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +.Op Fl v | \-version +.Sh DESCRIPTION +Most users will want to run this SOCKS proxy. +It can be used in combination with browsers that support the SOCKS 4a protocol. +.Pp +The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content. +To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy. +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. +.Bl -tag -width Ds +.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME Use the configuration file FILENAME. -.IP "\-a AUTHORITY, \-\-authority=AUTHORITY" -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. The default port is -specified in the configuration file for the gns service under -"[gns-proxy]" PROXY_CACERT. -.IP "\-p PORT, \-\-port=PORT" +.It Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY +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. +The default port is specified in the configuration file for the gns service under "[gns-proxy]": +"[gns-proxy]" +PROXY_CACERT +.It Fl p Ar PORT | Fl \-port= Ns Ar PORT The port this proxy should listen on. Default is 7777. -.IP "\-h, \-\-help" +.It Fl h | \-help Print short help on options. -.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" -Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and -ERROR. -.IP "\-v, \-\-version" +.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL +Use LOGLEVEL for logging. +Valid values are DEBUG, INFO, WARNING and ERROR. +.It Fl v | \-version Print GNUnet version number. -.SH BUGS -Report bugs by using Mantis or by sending -electronic mail to -.SH SEE ALSO -gnunet\-gns(1) -.PP -The full documentation for -.B gnunet -is maintained as a Texinfo manual. +.El +.\".Sh EXAMPLES +.Sh SEE ALSO +.Xr gnunet-gns 1 +.sp +The full documentation for gnunet is maintained as a Texinfo manual. If the -.B info -and -.B gnunet -programs are properly installed at your site, the command -.IP -.B info gnunet -.PP +.Xr info 1 +and gnunet programs are properly installed at your site, the command +.Pp +.Dl info gnunet +.Pp should give you access to the complete handbook, -.IP -.B info gnunet-c-tutorial -.PP +.Pp +.Dl info gnunet-c-tutorial +.Pp will give you access to a tutorial for developers. -.PP -Depending on your installation, this information is also -available in -\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). +.sp +Depending on your installation, this information is also available in +.Xr gnunet 7 and +.Xr gnunet-c-tutorial 7 . +.\".Sh HISTORY +.\".Sh AUTHORS +.Sh BUGS +Report bugs by using +.Lk https://bugs.gnunet.org +or by sending electronic mail to +.Aq Mt gnunet-developers@gnu.org . -- 2.25.1