aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-zoneimport.1
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
committerNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
commitd269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch)
treec9661262fee4604bd83b0bc739e7223c8cddfb0a /doc/man/gnunet-zoneimport.1
parent4be442739c7f6745848a2f5544a59592f06a6cb3 (diff)
downloadgnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.tar.gz
gnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.zip
doc/man: More fixes.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-zoneimport.1')
-rw-r--r--doc/man/gnunet-zoneimport.130
1 files changed, 10 insertions, 20 deletions
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index 0b3f44fff..97d784136 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -1,12 +1,8 @@
1.TH GNUNET\-ZONEIMPORT 1 "Apr 23, 2018" "GNUnet" 1.TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-zoneimport \- import DNS zone into GNS zone 3gnunet\-zoneimport \- import DNS zone into GNS zone
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-zoneimport [IP]+ 5.B gnunet\-zoneimport [IP]+
8.br
9
10.SH DESCRIPTION 6.SH DESCRIPTION
11\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from 7\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from
12stdin and issues DNS queries for each of the domain names given. It 8stdin and issues DNS queries for each of the domain names given. It
@@ -17,29 +13,28 @@ will look for an ego called "com.fr"). If so, it will convert the DNS
17records into GNS records (in particular converting NS records and glue 13records into GNS records (in particular converting NS records and glue
18records to GNS2DNS records) and add them to the namestore under the 14records to GNS2DNS records) and add them to the namestore under the
19label ("example" in the examples above). 15label ("example" in the examples above).
20 16.PP
21The arguments given to gnunet\-zoneimport is a list of IP addresses of 17The arguments given to gnunet\-zoneimport is a list of IP addresses of
22DNS servers to query. 18DNS servers to query.
23 19.PP
24gnunet\-zoneimport will usually never terminate: it will check when 20gnunet\-zoneimport will usually never terminate: it will check when
25DNS records expire, and re-issue requests when the old DNS records 21DNS records expire, and re-issue requests when the old DNS records
26have expired so that GNS always has the latest data. 22have expired so that GNS always has the latest data.
27 23.PP
28gnunet\-zoneimport will issue many DNS queries in parallel, but is 24gnunet\-zoneimport will issue many DNS queries in parallel, but is
29rate-limited in various ways, so most DNS servers should easily handle 25rate-limited in various ways, so most DNS servers should easily handle
30the load. gnunet\-zoneimport will perform a limited number of retries 26the load. gnunet\-zoneimport will perform a limited number of retries
31if queries fail. 27if queries fail.
32 28.PP
33gnunet\-zoneimport operates incrementally. It will check if the 29gnunet\-zoneimport operates incrementally. It will check if the
34namestore already has (non-expired) records stored for a given name in 30namestore already has (non-expired) records stored for a given name in
35the respective zone and not issue those requests again. Thus, it is 31the respective zone and not issue those requests again. Thus, it is
36fine to restart gnunet\-zoneimport whenever the list of domain names 32fine to restart gnunet\-zoneimport whenever the list of domain names
37changes. 33changes.
38 34.PP
39Finally, gnunet\-zoneimport keeps information for each domain name in 35Finally, gnunet\-zoneimport keeps information for each domain name in
40memory. This consumes about 200 bytes per domain name, or 1 GB for 5 36memory. This consumes about 200 bytes per domain name, or 1 GB for 5
41million labels. 37million labels.
42
43.SH OPTIONS 38.SH OPTIONS
44.B 39.B
45.IP "\-c FILENAME, \-\-config=FILENAME" 40.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -55,7 +50,6 @@ is less than RELATIVETIME into the future. RELATIVETIME is a time
55given like "1 week" or "1 h". If DNS returns records with a shorter 50given like "1 week" or "1 h". If DNS returns records with a shorter
56lifetime, gnunet\-zoneimport will simply bump the lifetime to the 51lifetime, gnunet\-zoneimport will simply bump the lifetime to the
57specified value (relative to the time of the import). Default is zero. 52specified value (relative to the time of the import). Default is zero.
58
59.IP "\-s MAPSIZE, \-\-size=MAPSIZE" 53.IP "\-s MAPSIZE, \-\-size=MAPSIZE"
60Specifies the size (in number of entries) to use for the main hash 54Specifies the size (in number of entries) to use for the main hash
61map. The value provided should be at least twice the number of domain 55map. The value provided should be at least twice the number of domain
@@ -64,24 +58,20 @@ large zones where the number of records encountered is too large for
64the automatic growth mechanism to work (that one is limited to at most 58the automatic growth mechanism to work (that one is limited to at most
6516 MB allocations for security reasons). Do not worry about this 5916 MB allocations for security reasons). Do not worry about this
66unless you are importing millions of domain names from a zone. 60unless you are importing millions of domain names from a zone.
67
68.SH NOTES 61.SH NOTES
69 62.TP
70Typical invocaton would be: 63Typical invocaton would be:
71
72$ gnunet\-zoneimport 1.2.3.4 < names.txt 64$ gnunet\-zoneimport 1.2.3.4 < names.txt
73
74
75
76
77.SH BUGS 65.SH BUGS
78Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 66Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
79electronic mail to <gnunet\-developers@gnu.org> 67electronic mail to <gnunet\-developers@gnu.org>
80.SH SEE ALSO 68.SH SEE ALSO
81gnunet\-gns(1), gnunet\-namestore(1) 69gnunet\-gns(1), gnunet\-namestore(1)
70.PP
82The full documentation for 71The full documentation for
83.B gnunet 72.B gnunet
84is maintained as a Texinfo manual. If the 73is maintained as a Texinfo manual.
74If the
85.B info 75.B info
86and 76and
87.B gnunet 77.B gnunet