diff options
author | Nils Gillmann <ng0@n0.is> | 2018-10-27 20:29:27 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-10-27 20:29:27 +0000 |
commit | d269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch) | |
tree | c9661262fee4604bd83b0bc739e7223c8cddfb0a /doc/man/gnunet-zoneimport.1 | |
parent | 4be442739c7f6745848a2f5544a59592f06a6cb3 (diff) | |
download | gnunet-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.1 | 30 |
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 |
4 | gnunet\-zoneimport \- import DNS zone into GNS zone | 3 | gnunet\-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 |
12 | stdin and issues DNS queries for each of the domain names given. It | 8 | stdin 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 | |||
17 | records into GNS records (in particular converting NS records and glue | 13 | records into GNS records (in particular converting NS records and glue |
18 | records to GNS2DNS records) and add them to the namestore under the | 14 | records to GNS2DNS records) and add them to the namestore under the |
19 | label ("example" in the examples above). | 15 | label ("example" in the examples above). |
20 | 16 | .PP | |
21 | The arguments given to gnunet\-zoneimport is a list of IP addresses of | 17 | The arguments given to gnunet\-zoneimport is a list of IP addresses of |
22 | DNS servers to query. | 18 | DNS servers to query. |
23 | 19 | .PP | |
24 | gnunet\-zoneimport will usually never terminate: it will check when | 20 | gnunet\-zoneimport will usually never terminate: it will check when |
25 | DNS records expire, and re-issue requests when the old DNS records | 21 | DNS records expire, and re-issue requests when the old DNS records |
26 | have expired so that GNS always has the latest data. | 22 | have expired so that GNS always has the latest data. |
27 | 23 | .PP | |
28 | gnunet\-zoneimport will issue many DNS queries in parallel, but is | 24 | gnunet\-zoneimport will issue many DNS queries in parallel, but is |
29 | rate-limited in various ways, so most DNS servers should easily handle | 25 | rate-limited in various ways, so most DNS servers should easily handle |
30 | the load. gnunet\-zoneimport will perform a limited number of retries | 26 | the load. gnunet\-zoneimport will perform a limited number of retries |
31 | if queries fail. | 27 | if queries fail. |
32 | 28 | .PP | |
33 | gnunet\-zoneimport operates incrementally. It will check if the | 29 | gnunet\-zoneimport operates incrementally. It will check if the |
34 | namestore already has (non-expired) records stored for a given name in | 30 | namestore already has (non-expired) records stored for a given name in |
35 | the respective zone and not issue those requests again. Thus, it is | 31 | the respective zone and not issue those requests again. Thus, it is |
36 | fine to restart gnunet\-zoneimport whenever the list of domain names | 32 | fine to restart gnunet\-zoneimport whenever the list of domain names |
37 | changes. | 33 | changes. |
38 | 34 | .PP | |
39 | Finally, gnunet\-zoneimport keeps information for each domain name in | 35 | Finally, gnunet\-zoneimport keeps information for each domain name in |
40 | memory. This consumes about 200 bytes per domain name, or 1 GB for 5 | 36 | memory. This consumes about 200 bytes per domain name, or 1 GB for 5 |
41 | million labels. | 37 | million 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 | |||
55 | given like "1 week" or "1 h". If DNS returns records with a shorter | 50 | given like "1 week" or "1 h". If DNS returns records with a shorter |
56 | lifetime, gnunet\-zoneimport will simply bump the lifetime to the | 51 | lifetime, gnunet\-zoneimport will simply bump the lifetime to the |
57 | specified value (relative to the time of the import). Default is zero. | 52 | specified value (relative to the time of the import). Default is zero. |
58 | |||
59 | .IP "\-s MAPSIZE, \-\-size=MAPSIZE" | 53 | .IP "\-s MAPSIZE, \-\-size=MAPSIZE" |
60 | Specifies the size (in number of entries) to use for the main hash | 54 | Specifies the size (in number of entries) to use for the main hash |
61 | map. The value provided should be at least twice the number of domain | 55 | map. 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 | |||
64 | the automatic growth mechanism to work (that one is limited to at most | 58 | the automatic growth mechanism to work (that one is limited to at most |
65 | 16 MB allocations for security reasons). Do not worry about this | 59 | 16 MB allocations for security reasons). Do not worry about this |
66 | unless you are importing millions of domain names from a zone. | 60 | unless you are importing millions of domain names from a zone. |
67 | |||
68 | .SH NOTES | 61 | .SH NOTES |
69 | 62 | .TP | |
70 | Typical invocaton would be: | 63 | Typical 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 |
78 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending | 66 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
79 | electronic mail to <gnunet\-developers@gnu.org> | 67 | electronic mail to <gnunet\-developers@gnu.org> |
80 | .SH SEE ALSO | 68 | .SH SEE ALSO |
81 | gnunet\-gns(1), gnunet\-namestore(1) | 69 | gnunet\-gns(1), gnunet\-namestore(1) |
70 | .PP | ||
82 | The full documentation for | 71 | The full documentation for |
83 | .B gnunet | 72 | .B gnunet |
84 | is maintained as a Texinfo manual. If the | 73 | is maintained as a Texinfo manual. |
74 | If the | ||
85 | .B info | 75 | .B info |
86 | and | 76 | and |
87 | .B gnunet | 77 | .B gnunet |