aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2018-04-23 12:42:00 +0200
committerChristian Grothoff <christian@grothoff.org>2018-04-23 12:42:00 +0200
commite1f46c052dca3cd7a390f18f97b10162fe537a15 (patch)
treedaa43ca3b189b6f86425801dc94413a71a04a66c /doc/man
parentff4d7b51f37f61633766664647e9b148af1e4f0a (diff)
downloadgnunet-e1f46c052dca3cd7a390f18f97b10162fe537a15.tar.gz
gnunet-e1f46c052dca3cd7a390f18f97b10162fe537a15.zip
move to @ for empty label, fix empty-label resolution bug in GNS API, install gnunet-zoneimport and add man page
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am4
-rw-r--r--doc/man/gnunet-fs.17
-rw-r--r--doc/man/gnunet-gns-import.117
-rw-r--r--doc/man/gnunet-zoneimport.145
4 files changed, 50 insertions, 23 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index c40363b59..a6a116dca 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -17,7 +17,6 @@ man_MANS = \
17 gnunet-ecc.1 \ 17 gnunet-ecc.1 \
18 gnunet-fs.1 \ 18 gnunet-fs.1 \
19 gnunet-gns.1 \ 19 gnunet-gns.1 \
20 gnunet-gns-import.1 \
21 gnunet-gns-proxy.1 \ 20 gnunet-gns-proxy.1 \
22 gnunet-identity.1 \ 21 gnunet-identity.1 \
23 gnunet-cadet.1 \ 22 gnunet-cadet.1 \
@@ -42,6 +41,7 @@ man_MANS = \
42 gnunet-transport-certificate-creation.1 \ 41 gnunet-transport-certificate-creation.1 \
43 gnunet-unindex.1 \ 42 gnunet-unindex.1 \
44 gnunet-uri.1 \ 43 gnunet-uri.1 \
45 gnunet-vpn.1 44 gnunet-vpn.1 \
45 gnunet-zoneimport.1
46 46
47EXTRA_DIST = ${man_MANS} 47EXTRA_DIST = ${man_MANS}
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index 53a900b46..65f104d61 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -29,10 +29,9 @@ print the version number
29\fB\-V\fR, \fB\-\-verbose\fR 29\fB\-V\fR, \fB\-\-verbose\fR
30be verbose 30be verbose
31 31
32.SH NOTES
33 32
34 33.SH BUGS
35.SH "REPORTING BUGS"
36Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 34Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
37.SH "SEE ALSO" 35
36.SH SEE ALSO
38\fBgnunet\-publish\fP(1) 37\fBgnunet\-publish\fP(1)
diff --git a/doc/man/gnunet-gns-import.1 b/doc/man/gnunet-gns-import.1
deleted file mode 100644
index f90f7f375..000000000
--- a/doc/man/gnunet-gns-import.1
+++ /dev/null
@@ -1,17 +0,0 @@
1.TH GNUNET\-GNS\-IMPORT 1 "Jan 31, 2014" "GNUnet"
2
3.SH NAME
4gnunet\-gns\-import \- import some GNS authorities into your GNS namestore
5
6.SH SYNOPSIS
7.B gnunet\-gns\-import
8.br
9
10.SH DESCRIPTION
11\fBgnunet\-gns\-import\fP calls gnunet-namestore to fetch some GNS authorities into your GNS namestore.
12
13.SH BUGS
14Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
15
16.SH SEE ALSO
17gnunet\-gns(1), gnunet\-namestore(1)
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
new file mode 100644
index 000000000..d268bf9ff
--- /dev/null
+++ b/doc/man/gnunet-zoneimport.1
@@ -0,0 +1,45 @@
1.TH GNUNET\-ZONEIMPORT 1 "Apr 23, 2018" "GNUnet"
2
3.SH NAME
4gnunet\-zoneimport \- import DNS zone into GNS zone
5
6.SH SYNOPSIS
7.B gnunet\-zoneimport -s IP
8.br
9
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).
12
13gnunet\-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.
14
15gnunet\-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.
16
17gnunet\-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.
18
19Finally, gnunet\-zoneimport keeps information for each domain name in memory. This consumes about 200 bytes per label, or 2 GB for 10 million labels.
20
21.SH OPTIONS
22.B
23.IP "\-c FILENAME, \-\-config=FILENAME"
24Use the configuration file FILENAME.
25.B
26.IP "\-s IP, \-\-server IP"
27IP address of the DNS server to query. Should be the authoritative server for the domain (lookup the IP address of the NS server!) and not some recursive resolver (which would be both slow and is more likely to return only partial information).
28.B
29.IP "\-h, \-\-help"
30Print short help on options.
31
32.SH NOTES
33
34Typical invocaton would be:
35
36$ gnunet\-zoneimport -s 1.2.3.4 < names.txt
37
38
39
40
41.SH BUGS
42Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
43
44.SH SEE ALSO
45gnunet\-gns(1), gnunet\-namestore(1)