aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-zoneimport.1117
1 files changed, 64 insertions, 53 deletions
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index b825a99e8..e99b235b8 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -1,5 +1,5 @@
1.\" This file is part of GNUnet. 1.\" This file is part of GNUnet.
2.\" Copyright (C) 2018,2019 GNUnet e.V. 2.\" Copyright (C) 2018, 2019 GNUnet e.V.
3.\" 3.\"
4.\" Permission is granted to copy, distribute and/or modify this document 4.\" Permission is granted to copy, distribute and/or modify this document
5.\" under the terms of the GNU Free Documentation License, Version 1.3 or 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -21,75 +21,86 @@
21.\" 21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\" 23.\"
24.TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet" 24.Dd April 23, 2018
25.SH NAME 25.Dt GNUNET-ZONEIMPORT 1
26gnunet\-zoneimport \- import DNS zone into GNS zone 26.Os
27.SH SYNOPSIS 27.Sh NAME
28.B gnunet\-zoneimport 28.Nm gnunet-zoneimport
29.RI [-c\ FILENAME\ |\ --config=FILENAME] 29.Nd
30.RI [-h\ |\ --help] 30import DNS zone into GNS zone
31.RI [-m\ RELATIVETIME\ |\ --minimum-expiration=RELATIVETIME] 31.Sh SYNOPSIS
32.RI [-s\ MAPSIZE\ |\ --size=MAPSIZE] 32.Nm
33[IP]+ 33.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME
34.SH DESCRIPTION 34.Op Fl h | \-help
35\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from stdin and issues DNS queries for each of the domain names given. 35.Op Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME
36.Op Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE
37.Op Ar \IP
38.Sh DESCRIPTION
39.Nm
40reads a list of domain names (FQDN) from stdin and issues DNS queries for each of the domain names given.
36It then checks if a local ego with a name matching the domain exists. 41It then checks if a local ego with a name matching the domain exists.
37Specifically, 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"). 42Specifically, 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").
38If 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). 43If 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).
39.PP 44.Pp
40The arguments given to gnunet\-zoneimport is a list of IP addresses of DNS servers to query. 45The arguments given to gnunet-zoneimport is a list of IP addresses of DNS servers to query.
41.PP 46.Pp
42gnunet\-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. 47gnunet-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.
43.PP 48.Pp
44gnunet\-zoneimport will issue many DNS queries in parallel, but is rate-limited in various ways, so most DNS servers should easily handle the load. 49gnunet-zoneimport will issue many DNS queries in parallel, but is rate-limited in various ways, so most DNS servers should easily handle the load.
45gnunet\-zoneimport will perform a limited number of retries if queries fail. 50gnunet-zoneimport will perform a limited number of retries if queries fail.
46.PP 51.Pp
47gnunet\-zoneimport operates incrementally. 52gnunet-zoneimport operates incrementally.
48It 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. 53It 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.
49Thus, it is fine to restart gnunet\-zoneimport whenever the list of domain names changes. 54Thus, it is fine to restart gnunet-zoneimport whenever the list of domain names changes.
50.PP 55.Pp
51Finally, gnunet\-zoneimport keeps information for each domain name in memory. 56Finally, gnunet-zoneimport keeps information for each domain name in memory.
52This consumes about 200 bytes per domain name, or 1 GB for 5 million labels. 57This consumes about 200 bytes per domain name, or 1 GB for 5 million labels.
53.SH OPTIONS 58.Bl -tag -width Ds
54.IP "\-c FILENAME\ | \-\-config=FILENAME" 59.It Fl c Ar FILENAME | \-config= Ns Ar FILENAME
55Use the configuration file FILENAME. 60Use the configuration file FILENAME.
56.IP "\-h\ | \-\-help" 61.It Fl h | \-help
57Print short help on options. 62Print short help on options.
58.IP "\-m RELATIVETIME\ | \-\-minimum-expiration=RELATIVETIME" 63.It Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME
59Ensure that imported DNS records never have an expiration time that is less than RELATIVETIME into the future. 64Ensure that imported DNS records never have an expiration time that is less than RELATIVETIME into the future.
60RELATIVETIME is a time given like "1 week" or "1 h". 65RELATIVETIME is a time given like "1 week" or "1 h".
61If DNS returns records with a shorter lifetime, gnunet\-zoneimport will simply bump the lifetime to the specified value (relative to the time of the import). 66If DNS returns records with a shorter lifetime, gnunet\-zoneimport will simply bump the lifetime to the specified value (relative to the time of the import).
62Default is zero. 67Default is zero.
63.IP "\-s MAPSIZE\ | \-\-size=MAPSIZE" 68.It Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE
64Specifies the size (in number of entries) to use for the main hash map. 69Specifies the size (in number of entries) to use for the main hash map.
65The value provided should be at least twice the number of domain names that will be given to the tool. 70The value provided should be at least twice the number of domain names that will be given to the tool.
66This 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). 71This 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).
67Do not worry about this unless you are importing millions of domain names from a zone. 72Do not worry about this unless you are importing millions of domain names from a zone.
68.SH EXAMPLES 73.It Ar \IP
69.TP 74IP Is the list of IPs given.
75.El
76.Sh EXAMPLES
70Typical invocaton would be: 77Typical invocaton would be:
71$ gnunet\-zoneimport 1.2.3.4 < names.txt 78.Pp
72.SH SEE ALSO 79.Dl $ gnunet\-zoneimport 1.2.3.4 < names.txt
73gnunet\-gns(1), gnunet\-namestore(1) 80.Sh SEE ALSO
74.PP 81.Xr gnunet-gns 1 ,
75The full documentation for 82.Xr gnunet-namestore 1
76.B gnunet 83.sp
77is maintained as a Texinfo manual. 84The full documentation for gnunet is maintained as a Texinfo manual.
78If the 85If the
79.B info 86.Xr info 1
80and 87and gnunet programs are properly installed at your site, the command
81.B gnunet 88.Pp
82programs are properly installed at your site, the command 89.Dl info gnunet
83.IP 90.Pp
84.B info gnunet
85.PP
86should give you access to the complete handbook, 91should give you access to the complete handbook,
87.IP 92.Pp
88.B info gnunet-c-tutorial 93.Dl info gnunet-c-tutorial
89.PP 94.Pp
90will give you access to a tutorial for developers. 95will give you access to a tutorial for developers.
91.PP 96.sp
92Depending on your installation, this information is also available in 97Depending on your installation, this information is also available in
93\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 98.Xr gnunet 7 and
94.SH BUGS 99.Xr gnunet-c-tutorial 7 .
95Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>. 100.\".Sh HISTORY
101.\".Sh AUTHORS
102.Sh BUGS
103Report bugs by using
104.Lk https://bugs.gnunet.org
105or by sending electronic mail to
106.Aq Mt gnunet-developers@gnu.org .