added many comments

[oweals/gnunet.git] / doc / man / gnunet-namestore.1

diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 8fd4b33e4ca7f62cdf17c5b344aa7d9b2126b13b..ec99d088d233c0857fd34b8ce424914d6b2d4c73 100644 (file)
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -1,15 +1,15 @@
-.TH GNUNET\-GNS 1 "Jan 4, 2012" "GNUnet"
+.TH GNUNET\-NAMESTORE 1 "Mar 5, 2012" "GNUnet"
 
 .SH NAME
-gnunet\-gns \- manipulate GNUnet GNS zones
+gnunet\-namestore \- manipulate GNUnet zones
 
 .SH SYNOPSIS
-.B gnunet\-gns
+.B gnunet\-namestore
 .RI [ options ] -z ZONEFILE
 .br
 
 .SH DESCRIPTION
-\fBgnunet\-gns\fP can be used to create and manipulate a GNS zone.  
+\fBgnunet\-namestore\fP can be used to create and manipulate a GNS zone.
 
 .SH OPTIONS
 .B
@@ -20,7 +20,7 @@ Desired operation is adding a record
 Use the configuration file FILENAME.
 .B
 .IP "\-d, \-\-delete"
-Desired operation is deleting a record
+Desired operation is deleting all of the records under the given name
 .B
 .IP "\-D, \-\-display"
 Desired operation is listing of matching records
@@ -34,22 +34,34 @@ Print short help on options.
 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
 .B
+.IP "\-m, \-\-monitor"
+Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records)
+.B
 .IP "\-n NAME, \-\-name=NAME"
 Name of the record to add/delete/display
 .B
+.IP "\-r PKEY, \-\-reverse=PKEY"
+Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone.
+.B
 .IP "\-t TYPE, \-\-type=TYPE"
 Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.)
 .B
+.IP "\-u URI, \-\-uri=URI"
+Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used
+.B
 .IP "\-v, \-\-version"
 Print GNUnet version number.
 .B
 .IP "\-V VALUE, \-\-value=VALUE"
 Value to store or remove from the GNS zone.  Specific format depends on the record type.  A records expect a dotted decimal IPv4 address, AAAA records an IPv6 address, PKEY a public key in GNUnet's printable format, and CNAME and NS records should be a domain name.
 .B
-.IP "\-z FILENAME, \-\-zonekey=FILENAME"
-Specifies the filename with the private key for the zone (mandatory option)
+.IP "\-z EGO, \-\-zone=EGO"
+Specifies the name of the ego controlling the private key for the zone (mandatory option)
 
 
 .SH BUGS
 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
 
+
+.SH "SEE ALSO"
+\fBgnunet\-gns\fP(1)