aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-zoneimport.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-zoneimport.1')
-rw-r--r--doc/man/gnunet-zoneimport.150
1 files changed, 38 insertions, 12 deletions
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index 06b3a6bcf..bcfa7b734 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -8,17 +8,37 @@ gnunet\-zoneimport \- import DNS zone into GNS zone
8.br 8.br
9 9
10.SH DESCRIPTION 10.SH DESCRIPTION
11\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). 11\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from
12 12stdin and issues DNS queries for each of the domain names given. It
13The arguments given to gnunet\-zoneimport is a list of IP addresses of DNS servers to query. 13then checks if a local ego with a name matching the domain
14 14exists. Specifically, if the domain name is "example.fr", it will
15gnunet\-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. 15check if an ego "fr" exists, while for a domain "example.com.fr" it
16 16will look for an ego called "com.fr"). If so, it will convert the DNS
17gnunet\-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. 17records into GNS records (in particular converting NS records and glue
18 18records to GNS2DNS records) and add them to the namestore under the
19gnunet\-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. 19label ("example" in the examples above).
20 20
21Finally, gnunet\-zoneimport keeps information for each domain name in memory. This consumes about 200 bytes per domain name, or 1 GB for 5 million labels. 21The arguments given to gnunet\-zoneimport is a list of IP addresses of
22DNS servers to query.
23
24gnunet\-zoneimport will usually never terminate: it will check when
25DNS records expire, and re-issue requests when the old DNS records
26have expired so that GNS always has the latest data.
27
28gnunet\-zoneimport will issue many DNS queries in parallel, but is
29rate-limited in various ways, so most DNS servers should easily handle
30the load. gnunet\-zoneimport will perform a limited number of retries
31if queries fail.
32
33gnunet\-zoneimport operates incrementally. It will check if the
34namestore already has (non-expired) records stored for a given name in
35the respective zone and not issue those requests again. Thus, it is
36fine to restart gnunet\-zoneimport whenever the list of domain names
37changes.
38
39Finally, gnunet\-zoneimport keeps information for each domain name in
40memory. This consumes about 200 bytes per domain name, or 1 GB for 5
41million labels.
22 42
23.SH OPTIONS 43.SH OPTIONS
24.B 44.B
@@ -29,7 +49,13 @@ Use the configuration file FILENAME.
29Print short help on options. 49Print short help on options.
30.B 50.B
31.IP "\-s MAPSIZE, \-\-size=MAPSIZE" 51.IP "\-s MAPSIZE, \-\-size=MAPSIZE"
32Specifies the size (in number of entries) to use for the main hash map. The value provided should be at least twice the number of domain names that will be given to the tool. This option is required for very large zones where the number of records encountered is too large for the automatic growth mechanism to work (that one is limited to at most 16 MB allocations for security reasons). Do not worry about this unless you are importing millions of domain names from a zone. 52Specifies the size (in number of entries) to use for the main hash
53map. The value provided should be at least twice the number of domain
54names that will be given to the tool. This option is required for very
55large zones where the number of records encountered is too large for
56the automatic growth mechanism to work (that one is limited to at most
5716 MB allocations for security reasons). Do not worry about this
58unless you are importing millions of domain names from a zone.
33 59
34.SH NOTES 60.SH NOTES
35 61