From e1f46c052dca3cd7a390f18f97b10162fe537a15 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 23 Apr 2018 12:42:00 +0200 Subject: move to @ for empty label, fix empty-label resolution bug in GNS API, install gnunet-zoneimport and add man page --- doc/man/Makefile.am | 4 ++-- doc/man/gnunet-fs.1 | 7 +++---- doc/man/gnunet-gns-import.1 | 17 ----------------- doc/man/gnunet-zoneimport.1 | 45 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 50 insertions(+), 23 deletions(-) delete mode 100644 doc/man/gnunet-gns-import.1 create mode 100644 doc/man/gnunet-zoneimport.1 (limited to 'doc/man') diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index c40363b59..a6a116dca 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -17,7 +17,6 @@ man_MANS = \ gnunet-ecc.1 \ gnunet-fs.1 \ gnunet-gns.1 \ - gnunet-gns-import.1 \ gnunet-gns-proxy.1 \ gnunet-identity.1 \ gnunet-cadet.1 \ @@ -42,6 +41,7 @@ man_MANS = \ gnunet-transport-certificate-creation.1 \ gnunet-unindex.1 \ gnunet-uri.1 \ - gnunet-vpn.1 + gnunet-vpn.1 \ + gnunet-zoneimport.1 EXTRA_DIST = ${man_MANS} diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1 index 53a900b46..65f104d61 100644 --- a/doc/man/gnunet-fs.1 +++ b/doc/man/gnunet-fs.1 @@ -29,10 +29,9 @@ print the version number \fB\-V\fR, \fB\-\-verbose\fR be verbose -.SH NOTES - -.SH "REPORTING BUGS" +.SH BUGS Report bugs by using mantis or by sending electronic mail to -.SH "SEE ALSO" + +.SH SEE ALSO \fBgnunet\-publish\fP(1) diff --git a/doc/man/gnunet-gns-import.1 b/doc/man/gnunet-gns-import.1 deleted file mode 100644 index f90f7f375..000000000 --- a/doc/man/gnunet-gns-import.1 +++ /dev/null @@ -1,17 +0,0 @@ -.TH GNUNET\-GNS\-IMPORT 1 "Jan 31, 2014" "GNUnet" - -.SH NAME -gnunet\-gns\-import \- import some GNS authorities into your GNS namestore - -.SH SYNOPSIS -.B gnunet\-gns\-import -.br - -.SH DESCRIPTION -\fBgnunet\-gns\-import\fP calls gnunet-namestore to fetch some GNS authorities into your GNS namestore. - -.SH BUGS -Report bugs by using Mantis or by sending electronic mail to - -.SH SEE ALSO -gnunet\-gns(1), gnunet\-namestore(1) diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1 new file mode 100644 index 000000000..d268bf9ff --- /dev/null +++ b/doc/man/gnunet-zoneimport.1 @@ -0,0 +1,45 @@ +.TH GNUNET\-ZONEIMPORT 1 "Apr 23, 2018" "GNUnet" + +.SH NAME +gnunet\-zoneimport \- import DNS zone into GNS zone + +.SH SYNOPSIS +.B gnunet\-zoneimport -s IP +.br + +.SH DESCRIPTION +\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from stdin and issues DNS queries for each of the domain names given. It then checks if a local ego with a name matching the domain exists. Specifically, if the domain name is "example.fr", it will check if an ego "fr" exists, while for a domain "example.com.fr" it will look for an ego called "com.fr"). If so, it will convert the DNS records into GNS records (in particular converting NS records and glue records to GNS2DNS records) and add them to the namestore under the label ("example" in the examples above). + +gnunet\-zoneimport will usually never terminate: it will check when DNS records expire, and re-issue requests when the old DNS records have expired so that GNS always has the latest data. + +gnunet\-zoneimport will issue many DNS queries in parallel, but is rate-limited in various ways, so most DNS servers should easily handle the load. gnunet\-zoneimport will perform a limited number of retries if queries fail. + +gnunet\-zoneimport operates incrementally. It will check if the namestore already has (non-expired) records stored for a given name in the respective zone and not issue those requests again. Thus, it is fine to restart gnunet\-zoneimport whenever the list of domain names changes. + +Finally, gnunet\-zoneimport keeps information for each domain name in memory. This consumes about 200 bytes per label, or 2 GB for 10 million labels. + +.SH OPTIONS +.B +.IP "\-c FILENAME, \-\-config=FILENAME" +Use the configuration file FILENAME. +.B +.IP "\-s IP, \-\-server IP" +IP address of the DNS server to query. Should be the authoritative server for the domain (lookup the IP address of the NS server!) and not some recursive resolver (which would be both slow and is more likely to return only partial information). +.B +.IP "\-h, \-\-help" +Print short help on options. + +.SH NOTES + +Typical invocaton would be: + +$ gnunet\-zoneimport -s 1.2.3.4 < names.txt + + + + +.SH BUGS +Report bugs by using Mantis or by sending electronic mail to + +.SH SEE ALSO +gnunet\-gns(1), gnunet\-namestore(1) -- cgit v1.2.3