summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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 @@
.\" This file is part of GNUnet.
-.\" Copyright (C) 2018,2019 GNUnet e.V.
+.\" Copyright (C) 2018, 2019 GNUnet e.V.
.\"
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -21,75 +21,86 @@
.\"
.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
.\"
-.TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet"
-.SH NAME
-gnunet\-zoneimport \- import DNS zone into GNS zone
-.SH SYNOPSIS
-.B gnunet\-zoneimport
-.RI [-c\ FILENAME\ |\ --config=FILENAME]
-.RI [-h\ |\ --help]
-.RI [-m\ RELATIVETIME\ |\ --minimum-expiration=RELATIVETIME]
-.RI [-s\ MAPSIZE\ |\ --size=MAPSIZE]
-[IP]+
-.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.
+.Dd April 23, 2018
+.Dt GNUNET-ZONEIMPORT 1
+.Os
+.Sh NAME
+.Nm gnunet-zoneimport
+.Nd
+import DNS zone into GNS zone
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME
+.Op Fl h | \-help
+.Op Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME
+.Op Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE
+.Op Ar \IP
+.Sh DESCRIPTION
+.Nm
+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).
-.PP
-The arguments given to gnunet\-zoneimport is a list of IP addresses of DNS servers to query.
-.PP
-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.
-.PP
-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.
-.PP
-gnunet\-zoneimport operates incrementally.
+.Pp
+The arguments given to gnunet-zoneimport is a list of IP addresses of DNS servers to query.
+.Pp
+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.
+.Pp
+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.
+.Pp
+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.
-.PP
-Finally, gnunet\-zoneimport keeps information for each domain name in memory.
+Thus, it is fine to restart gnunet-zoneimport whenever the list of domain names changes.
+.Pp
+Finally, 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.
-.SH OPTIONS
-.IP "\-c FILENAME\ | \-\-config=FILENAME"
+.Bl -tag -width Ds
+.It Fl c Ar FILENAME | \-config= Ns Ar FILENAME
Use the configuration file FILENAME.
-.IP "\-h\ | \-\-help"
+.It Fl h | \-help
Print short help on options.
-.IP "\-m RELATIVETIME\ | \-\-minimum-expiration=RELATIVETIME"
+.It Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME
Ensure that imported DNS records never have an expiration time that is less than RELATIVETIME into the future.
RELATIVETIME is a time given like "1 week" or "1 h".
If 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).
Default is zero.
-.IP "\-s MAPSIZE\ | \-\-size=MAPSIZE"
+.It Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE
Specifies 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.
-.SH EXAMPLES
-.TP
+.It Ar \IP
+IP Is the list of IPs given.
+.El
+.Sh EXAMPLES
Typical invocaton would be:
-$ gnunet\-zoneimport 1.2.3.4 < names.txt
-.SH SEE ALSO
-gnunet\-gns(1), gnunet\-namestore(1)
-.PP
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.
+.Pp
+.Dl $ gnunet\-zoneimport 1.2.3.4 < names.txt
+.Sh SEE ALSO
+.Xr gnunet-gns 1 ,
+.Xr gnunet-namestore 1
+.sp
+The full documentation for gnunet is maintained as a Texinfo manual.
If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
will give you access to a tutorial for developers.
-.PP
+.sp
Depending on your installation, this information is also available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
-.SH BUGS
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>.
+.Xr gnunet 7 and
+.Xr gnunet-c-tutorial 7 .
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .