[GNUnet-SVN] r24590 - in gnunet: doc/man src/gns

[gnunet]

Author: grothoff
Date: 2012-10-29 13:00:45 +0100 (Mon, 29 Oct 2012)
New Revision: 24590

Modified:
   gnunet/doc/man/Makefile.am
   gnunet/doc/man/gnunet-dns2gns.1
   gnunet/doc/man/gnunet-gns-fcfsd.1
   gnunet/doc/man/gnunet-resolver.1
   gnunet/src/gns/gnunet-dns2gns.c
Log:
-more man pages, typos'


Modified: gnunet/doc/man/Makefile.am
===================================================================
--- gnunet/doc/man/Makefile.am  2012-10-29 09:26:42 UTC (rev 24589)
+++ gnunet/doc/man/Makefile.am  2012-10-29 12:00:45 UTC (rev 24590)
@@ -5,11 +5,13 @@
   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 \

Modified: gnunet/doc/man/gnunet-dns2gns.1
===================================================================
--- gnunet/doc/man/gnunet-dns2gns.1     2012-10-29 09:26:42 UTC (rev 24589)
+++ gnunet/doc/man/gnunet-dns2gns.1     2012-10-29 12:00:45 UTC (rev 24590)
@@ -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 @@
 .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 @@
 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
 
 .SH SEE ALSO
-gnunet\-transport(1)
+gnunet\-gns\-fcfs(1), gnunet\-gns(1)

Modified: gnunet/doc/man/gnunet-gns-fcfsd.1
===================================================================
--- gnunet/doc/man/gnunet-gns-fcfsd.1   2012-10-29 09:26:42 UTC (rev 24589)
+++ gnunet/doc/man/gnunet-gns-fcfsd.1   2012-10-29 12:00:45 UTC (rev 24590)
@@ -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,8 +9,12 @@
 .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
 .IP "\-c FILENAME,  \-\-config=FILENAME"
@@ -30,4 +34,5 @@
 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
 
 .SH SEE ALSO
-gnunet\-transport(1)
+gnunet\-gns(1), gnunet\-gns\-proxy(1)
+

Modified: gnunet/doc/man/gnunet-resolver.1
===================================================================
--- gnunet/doc/man/gnunet-resolver.1    2012-10-29 09:26:42 UTC (rev 24589)
+++ gnunet/doc/man/gnunet-resolver.1    2012-10-29 12:00:45 UTC (rev 24590)
@@ -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 @@
 .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 @@
 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
 
 .SH SEE ALSO
-gnunet\-transport(1)
+gnunet\-transport(1), nslookup(1)

Modified: gnunet/src/gns/gnunet-dns2gns.c
===================================================================
--- gnunet/src/gns/gnunet-dns2gns.c     2012-10-29 09:26:42 UTC (rev 24589)
+++ gnunet/src/gns/gnunet-dns2gns.c     2012-10-29 12:00:45 UTC (rev 24590)
@@ -669,13 +669,13 @@
       char *const *argv)
 {
   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
-    {'d', "dns", NULL,
-      gettext_noop ("IP of recursive dns resolver to use (required)"), 1,
+    {'d', "dns", "IP",
+      gettext_noop ("IP of recursive DNS resolver to use (required)"), 1,
       &GNUNET_GETOPT_set_string, &dns_ip},
-    {'s', "suffix", NULL,
+    {'s', "suffix", "SUFFIX",
       gettext_noop ("Authoritative DNS suffix to use (optional); default: 
zkey.eu"), 1,
       &GNUNET_GETOPT_set_string, &dns_suffix},
-    {'f', "fcfs", NULL,
+    {'f', "fcfs", "NAME",
       gettext_noop ("Authoritative FCFS suffix to use (optional); default: 
fcfs.zkey.eu"), 1,
       &GNUNET_GETOPT_set_string, &fcfs_suffix},
     GNUNET_GETOPT_OPTION_END