From 75bebe4af5841951ef7d4dfe47b70c26da15fae1 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 29 Oct 2012 12:00:45 +0000 Subject: -more man pages, typos' --- doc/man/Makefile.am | 2 ++ doc/man/gnunet-dns2gns.1 | 21 +++++++++++++++++---- doc/man/gnunet-gns-fcfsd.1 | 13 +++++++++---- doc/man/gnunet-resolver.1 | 11 +++++++---- 4 files changed, 35 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 51d915689..ca0c1cd6e 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -5,11 +5,13 @@ man_MANS = \ gnunet-config.1 \ gnunet-core.1 \ gnunet-directory.1 \ + gnunet-dns2gns.1 \ gnunet-download.1 \ gnunet-download-manager.1 \ gnunet-ecc.1 \ gnunet-fs.1 \ gnunet-gns.1 \ + gnunet-gns-fcfsd.1 \ gnunet-namestore.1 \ gnunet-nat-server.1 \ gnunet-peerinfo.1 \ diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1 index efe30622f..f60f40e7e 100644 --- a/doc/man/gnunet-dns2gns.1 +++ b/doc/man/gnunet-dns2gns.1 @@ -1,7 +1,7 @@ -.TH GNUNET\-DNS2GNS 1 "Jan 4, 2012" "GNUnet" +.TH GNUNET\-DNS2GNS 1 "Oct 25, 2012" "GNUnet" .SH NAME -gnunet\-dns2gns \- display information about transport resource allocation +gnunet\-dns2gns \- run a DNS-to-GNS proxy .SH SYNOPSIS .B gnunet\-dns2gns @@ -9,19 +9,32 @@ gnunet\-dns2gns \- display information about transport resource allocation .br .SH DESCRIPTION -\fBgnunet\-dns2gns\fP can be used to +Most users will not want to run an DNS to GADS proxy/gateway and thus will not need this program. + +\fBgnunet\-dns2gns\fP runs a DNS resolver which delegates requests to the ".gads" and ".zkey" zones to GADS. All other requests are forwarded to DNS. This DNS proxy is useful for enabling non-personalized GADS\-resolution to an entire network or to offer GADS\-resolution to DNS users. + +A DNS\-to\-GNS proxy using gnunet\-dns2gns is available at ".zkey.eu" .SH OPTIONS .B .IP "\-c FILENAME, \-\-config=FILENAME" Use the configuration file FILENAME. .B +.IP "\-d IP, \-\-dns=IP" +IP address of a recursive DNS resolver that should be used for non-GADS hostnames. +.B +.IP "\-f NAME, \-\-fcfs=NAME" +Authoritative FCFS suffix to use. This is the name under which the local zone's names will be made available. Default is "fcfs.zkey.eu". +.B .IP "\-h, \-\-help" Print short help on options. .B .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. .B +.IP "\-s SUFFIX, \-\-suffix=SUFFIX" +Authoritative DNS suffix to use. This is the name under which the GADS ".zkey" zone is mapped into the DNS namespace. Default is "zkey.eu". +.B .IP "\-v, \-\-version" Print GNUnet version number. @@ -30,4 +43,4 @@ Print GNUnet version number. Report bugs by using Mantis or by sending electronic mail to .SH SEE ALSO -gnunet\-transport(1) +gnunet\-gns\-fcfs(1), gnunet\-gns(1) diff --git a/doc/man/gnunet-gns-fcfsd.1 b/doc/man/gnunet-gns-fcfsd.1 index 0ad67dddf..fbd45e4a2 100644 --- a/doc/man/gnunet-gns-fcfsd.1 +++ b/doc/man/gnunet-gns-fcfsd.1 @@ -1,7 +1,7 @@ -.TH GNUNET\-GNS-FCFSD 1 "Jan 4, 2012" "GNUnet" +.TH GNUNET\-GNS-FCFSD 1 "Oct 25, 2012" "GNUnet" .SH NAME -gnunet\-gns-fcfsd \- display information about transport resource allocation +gnunet\-gns-fcfsd \- HTTP server for GADS domain registration .SH SYNOPSIS .B gnunet\-gns-fcfsd @@ -9,7 +9,11 @@ gnunet\-gns-fcfsd \- display information about transport resource allocation .br .SH DESCRIPTION -\fBgnunet\-gns-fcfsd\fP can be used to +Most users will not want to run an FCFS\-zone and thus will not need this program. + +\fBgnunet\-gns-fcfsd\fP runs a web server where users can register names to be mapped to their GADS zone. Names are made available on a First Come First Served basis (hence fcfs). Registered names do not expire. The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". The key of the zone in which the names are registered must be specified under the name "ZONEKEY" in the same section. It is possible to manage gnunet\-gns\-fcfsd using gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm -i fcfsd" or by adding "fcfds" to the "DEFAULTSERVICES" option. + +An FCFS\-zone is run at http://gnunet.org/fcfs/. The respective zone key can be imported into an individual user's zone using "gnunet-gns-import.sh". GADS users are encouraged to register their zone with the gnunet.org FCFS authority. .SH OPTIONS .B @@ -30,4 +34,5 @@ Print GNUnet version number. Report bugs by using Mantis or by sending electronic mail to .SH SEE ALSO -gnunet\-transport(1) +gnunet\-gns(1), gnunet\-gns\-proxy(1) + diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1 index a2ac907f5..6766979f4 100644 --- a/doc/man/gnunet-resolver.1 +++ b/doc/man/gnunet-resolver.1 @@ -1,15 +1,15 @@ .TH GNUNET\-RESOLVER 1 "Jan 4, 2012" "GNUnet" .SH NAME -gnunet\-resolver \- display information about transport resource allocation +gnunet\-resolver \- perform DNS resolution using GNUnet resolver service .SH SYNOPSIS .B gnunet\-resolver -.RI [ options ] +.RI [ options ] HOSTNAME .br .SH DESCRIPTION -\fBgnunet\-resolver\fP can be used to +\fBgnunet\-resolver\fP can be used to lookup the IP address(es) for a hostname or the hostname for an IP address. gnunet\-resolver uses the GNUnet service infrastructure to do this, but otherwise does nothing special. .SH OPTIONS .B @@ -22,6 +22,9 @@ Print short help on options. .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. .B +.IP "\-r, \-\-reverse" +Perform a reverse lookup. +.B .IP "\-v, \-\-version" Print GNUnet version number. @@ -30,4 +33,4 @@ Print GNUnet version number. Report bugs by using Mantis or by sending electronic mail to .SH SEE ALSO -gnunet\-transport(1) +gnunet\-transport(1), nslookup(1) -- cgit v1.2.3