aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-05-02 07:59:41 +0000
committerNils Gillmann <ng0@n0.is>2018-05-02 07:59:41 +0000
commita40c86500c64edc047dbe2e3019a71e2f72b6633 (patch)
tree9b4f6c9d84132e4cff2b494348aff5e1a400c863 /doc
parent8682c673eec5d48e5b57a58c80b538a808810ab2 (diff)
parent2e86e317379837414b76460295e284b54d2bf775 (diff)
downloadgnunet-a40c86500c64edc047dbe2e3019a71e2f72b6633.tar.gz
gnunet-a40c86500c64edc047dbe2e3019a71e2f72b6633.zip
Merge branch 'master' of gnunet.org:gnunet
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation/chapters/installation.texi47
-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-namestore-fcfsd.12
-rw-r--r--doc/man/gnunet-zoneimport.147
6 files changed, 69 insertions, 55 deletions
diff --git a/doc/documentation/chapters/installation.texi b/doc/documentation/chapters/installation.texi
index eeb14473b..3a76fb162 100644
--- a/doc/documentation/chapters/installation.texi
+++ b/doc/documentation/chapters/installation.texi
@@ -294,7 +294,7 @@ If you want to be able to enable DEBUG-level log messages, add
294@command{./configure} command. 294@command{./configure} command.
295@code{DEBUG}-level log messages are in English only and 295@code{DEBUG}-level log messages are in English only and
296should only be useful for developers (or for filing 296should only be useful for developers (or for filing
297really detailed bug reports). 297really detailed bug reports).
298 298
299Finally, you probably want to compile @command{gnunet-gtk}, which 299Finally, you probably want to compile @command{gnunet-gtk}, which
300includes @command{gnunet-setup} (a graphical tool for 300includes @command{gnunet-setup} (a graphical tool for
@@ -389,10 +389,9 @@ For those services, systems with more than one user may require each user
389to specify a different port number in their personal configuration file. 389to specify a different port number in their personal configuration file.
390 390
391Finally, the user should perform the basic initial setup for the GNU Name 391Finally, the user should perform the basic initial setup for the GNU Name
392System (GNS). This is done by running two commands: 392System (GNS) certificate authority. This is done by running:
393 393
394@example 394@example
395$ gnunet-gns-import.sh
396$ gnunet-gns-proxy-setup-ca 395$ gnunet-gns-proxy-setup-ca
397@end example 396@end example
398 397
@@ -420,7 +419,7 @@ hosts: files gns [NOTFOUND=return] mdns4_minimal \
420 419
421@c FIXME: Document new behavior. 420@c FIXME: Document new behavior.
422You might want to make sure that @file{/lib/libnss_gns.so.2} exists on 421You might want to make sure that @file{/lib/libnss_gns.so.2} exists on
423your system, it should have been created during the installation. 422your system, it should have been created during the installation.
424 423
425@node Build instructions for Ubuntu 12.04 using Git 424@node Build instructions for Ubuntu 12.04 using Git
426@section Build instructions for Ubuntu 12.04 using Git 425@section Build instructions for Ubuntu 12.04 using Git
@@ -802,7 +801,7 @@ $ gpg --keyserver pgp.mit.edu --recv-keys A88C8ADD129828D7EAC02E52E22F9BBFEE3485
802@end example 801@end example
803 802
804@noindent 803@noindent
805and rerun the gpg --verify command. 804and rerun the gpg --verify command.
806 805
807@example 806@example
808$ tar xvf gnurl-7.57.0.tar.xz 807$ tar xvf gnurl-7.57.0.tar.xz
@@ -1418,7 +1417,7 @@ as a normal user.
1418We begin by installing a few Debian packages from stable: 1417We begin by installing a few Debian packages from stable:
1419 1418
1420@example 1419@example
1421# apt-get install gcc make python-zbar libltdl-dev libsqlite3-dev \ 1420# apt-get install gcc make python-zbar libltdl-dev libsqlite3-dev \
1422libunistring-dev libopus-dev libpulse-dev openssl libglpk-dev texlive \ 1421libunistring-dev libopus-dev libpulse-dev openssl libglpk-dev texlive \
1423libidn11-dev libmysqlclient-dev libpq-dev libarchive-dev libbz2-dev \ 1422libidn11-dev libmysqlclient-dev libpq-dev libarchive-dev libbz2-dev \
1424libflac-dev libgif-dev libglib2.0-dev libgtk-3-dev libmpeg2-4-dev \ 1423libflac-dev libgif-dev libglib2.0-dev libgtk-3-dev libmpeg2-4-dev \
@@ -1633,7 +1632,7 @@ have to compile it from source:
1633@item Unzip the downloaded source tarball using your favourite 1632@item Unzip the downloaded source tarball using your favourite
1634unzipper application In the MSYS shell 1633unzipper application In the MSYS shell
1635 1634
1636@item change to the respective directory 1635@item change to the respective directory
1637 1636
1638@item Configure glpk for "i686-pc-mingw32": 1637@item Configure glpk for "i686-pc-mingw32":
1639 1638
@@ -1781,7 +1780,7 @@ $ make install
1781This document is a @b{DEPRECATED} installation guide for GNUnet on 1780This document is a @b{DEPRECATED} installation guide for GNUnet on
1782Windows. 1781Windows.
1783It will not work for recent GNUnet versions, but maybe it will be of 1782It will not work for recent GNUnet versions, but maybe it will be of
1784some use if problems arise. 1783some use if problems arise.
1785 1784
1786The Windows build uses a UNIX emulator for Windows, 1785The Windows build uses a UNIX emulator for Windows,
1787@uref{http://www.mingw.org/, MinGW}, to build the executable modules. 1786@uref{http://www.mingw.org/, MinGW}, to build the executable modules.
@@ -1799,7 +1798,7 @@ We regret any inconvenience, and if you have problems, please report them.
1799* Installer:: 1798* Installer::
1800* Source:: 1799* Source::
1801@end menu 1800@end menu
1802 1801
1803@node Hardware and OS requirements 1802@node Hardware and OS requirements
1804@subsubsection Hardware and OS requirements 1803@subsubsection Hardware and OS requirements
1805 1804
@@ -1878,7 +1877,7 @@ This batch file opens a shell which is used to invoke the build
1878processes. 1877processes.
1879MinGW's standard shell (@command{msys.bat}) is not suitable 1878MinGW's standard shell (@command{msys.bat}) is not suitable
1880because it opens a separate console window. 1879because it opens a separate console window.
1881On Vista, @command{bash.bat} needs to be run as Administrator. 1880On Vista, @command{bash.bat} needs to be run as Administrator.
1882 1881
1883@item 1882@item
1884Start @command{bash.sh} and rename 1883Start @command{bash.sh} and rename
@@ -1948,7 +1947,7 @@ directory (@file{c:\mingw\mingw}).
1948 1947
1949@item @strong{SQLite}@ 1948@item @strong{SQLite}@
1950GNUnet uses the SQLite database to store data. 1949GNUnet uses the SQLite database to store data.
1951Get the prebuilt binary from here and unpack it to your MinGW directory. 1950Get the prebuilt binary from here and unpack it to your MinGW directory.
1952 1951
1953@item @strong{MySQL}@ 1952@item @strong{MySQL}@
1954As an alternative to SQLite, GNUnet also supports MySQL. 1953As an alternative to SQLite, GNUnet also supports MySQL.
@@ -1984,7 +1983,7 @@ dlltool --input-def ../include/libmySQL.def \
1984--output-lib libmysqlclient.a -k 1983--output-lib libmysqlclient.a -k
1985@end example 1984@end example
1986 1985
1987@item Copy include\* to include\mysql\ 1986@item Copy include\* to include\mysql\
1988 1987
1989@item Pass @code{--with-mysql=/c/mysql} to 1988@item Pass @code{--with-mysql=/c/mysql} to
1990@command{./configure} and copy @file{libmysql.dll} 1989@command{./configure} and copy @file{libmysql.dll}
@@ -2082,7 +2081,7 @@ debug information and are quite large. To compile release versions
2082(small and fast) set the variable @code{CFLAGS}: 2081(small and fast) set the variable @code{CFLAGS}:
2083 2082
2084@example 2083@example
2085export CFLAGS='-O2 -march=pentium -fomit-frame-pointer' 2084export CFLAGS='-O2 -march=pentium -fomit-frame-pointer'
2086./configure --prefix=$HOME --with-extractor=$HOME 2085./configure --prefix=$HOME --with-extractor=$HOME
2087@end example 2086@end example
2088 2087
@@ -2097,7 +2096,7 @@ located in @file{contrib\win} in the GNUnet source tree.
2097@subsubsection Source 2096@subsubsection Source
2098 2097
2099@c FIXME: URL 2098@c FIXME: URL
2100The sources of all dependencies are available here. 2099The sources of all dependencies are available here.
2101 2100
2102@c @node Portable GNUnet 2101@c @node Portable GNUnet
2103@c @section Portable GNUnet 2102@c @section Portable GNUnet
@@ -2372,7 +2371,7 @@ The hostlist client supports the following proxy types at the moment:
2372@end itemize 2371@end itemize
2373 2372
2374In addition authentication at the proxy with username and password can be 2373In addition authentication at the proxy with username and password can be
2375configured. 2374configured.
2376 2375
2377To configure proxy support for the hostlist client in the 2376To configure proxy support for the hostlist client in the
2378@command{gnunet-setup} tool, select the "hostlist" tab and select 2377@command{gnunet-setup} tool, select the "hostlist" tab and select
@@ -2521,7 +2520,7 @@ inconsistencies. Some of the other databases do not support repair.
2521@item Access mysql as root: 2520@item Access mysql as root:
2522 2521
2523@example 2522@example
2524$ mysql -u root -p 2523$ mysql -u root -p
2525@end example 2524@end example
2526 2525
2527@noindent 2526@noindent
@@ -3324,19 +3323,6 @@ steps.
3324First of all, GNS needs to be integrated with the operating system. Most 3323First of all, GNS needs to be integrated with the operating system. Most
3325of this section is about the operating system level integration. 3324of this section is about the operating system level integration.
3326 3325
3327Additionally, each individual user who wants to use the system must also
3328initialize their GNS zones. This can be done by running (after starting
3329GNUnet)
3330
3331@example
3332$ gnunet-gns-import.sh
3333@end example
3334
3335@noindent
3336after the local GNUnet peer has been started. Note that the namestore (in
3337particular the namestore database backend) should not be reconfigured
3338afterwards (as records are not automatically migrated between backends).
3339
3340The remainder of this chapter will detail the various methods for 3326The remainder of this chapter will detail the various methods for
3341configuring the use of GNS with your operating system. 3327configuring the use of GNS with your operating system.
3342 3328
@@ -3528,7 +3514,7 @@ gnurl --version
3528curl 7.56.0 (x86_64-unknown-linux-gnu) libcurl/7.56.0 \ 3514curl 7.56.0 (x86_64-unknown-linux-gnu) libcurl/7.56.0 \
3529GnuTLS/3.5.13 zlib/1.2.11 libidn2/2.0.4 3515GnuTLS/3.5.13 zlib/1.2.11 libidn2/2.0.4
3530Release-Date: 2017-10-08 3516Release-Date: 2017-10-08
3531Protocols: http https 3517Protocols: http https
3532Features: AsynchDNS IDN IPv6 Largefile NTLM SSL libz \ 3518Features: AsynchDNS IDN IPv6 Largefile NTLM SSL libz \
3533TLS-SRP UnixSockets HTTPS-proxy 3519TLS-SRP UnixSockets HTTPS-proxy
3534@end example 3520@end example
@@ -4125,4 +4111,3 @@ Furthermore, 'make install' will silently fail to set the DNS binaries to
4125be owned by group "gnunetdns" unless that group already exists (!). 4111be owned by group "gnunetdns" unless that group already exists (!).
4126An alternative name for the "gnunetdns" group can be specified using the 4112An alternative name for the "gnunetdns" group can be specified using the
4127@code{--with-gnunetdns=GRPNAME} configure option. 4113@code{--with-gnunetdns=GRPNAME} configure option.
4128
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-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index 3160910d4..8039e796f 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -13,7 +13,7 @@ Most users will not want to run an FCFS\-zone and thus will not need this progra
13 13
14\fBgnunet\-gns-fcfsd\fP runs a web server where users can register names to be mapped to their GNS zone. Names are made available on a First Come First Served basis (hence fcfs). Registered names do not expire. The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". The key of the zone in which the names are registered must be specified under the name "ZONEKEY" in the same section. It is possible to manage gnunet\-gns\-fcfsd using gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i fcfsd" or by setting "FORCESTART=YES" in the "fcfds" section of your configuration. 14\fBgnunet\-gns-fcfsd\fP runs a web server where users can register names to be mapped to their GNS zone. Names are made available on a First Come First Served basis (hence fcfs). Registered names do not expire. The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". The key of the zone in which the names are registered must be specified under the name "ZONEKEY" in the same section. It is possible to manage gnunet\-gns\-fcfsd using gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i fcfsd" or by setting "FORCESTART=YES" in the "fcfds" section of your configuration.
15 15
16An FCFS\-zone is run at http://gnunet.org/fcfs/. The respective zone key can be imported into an individual user's zone using "gnunet-gns-import.sh". GNS users are encouraged to register their zone with the gnunet.org FCFS authority. 16An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
17 17
18If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet\-identity \-C NAME"), and then assign it to be used for the "fcfsd" service using "gnunet\-identity \-e NAME \-s fcfsd". After that, you can start the FCFSD service (possibly using gnunet\-arm). 18If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet\-identity \-C NAME"), and then assign it to be used for the "fcfsd" service using "gnunet\-identity \-e NAME \-s fcfsd". After that, you can start the FCFSD service (possibly using gnunet\-arm).
19 19
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
new file mode 100644
index 000000000..06b3a6bcf
--- /dev/null
+++ b/doc/man/gnunet-zoneimport.1
@@ -0,0 +1,47 @@
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 [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
13The arguments given to gnunet\-zoneimport is a list of IP addresses of DNS servers to query.
14
15gnunet\-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.
16
17gnunet\-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.
18
19gnunet\-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.
20
21Finally, 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.
22
23.SH OPTIONS
24.B
25.IP "\-c FILENAME, \-\-config=FILENAME"
26Use the configuration file FILENAME.
27.B
28.IP "\-h, \-\-help"
29Print short help on options.
30.B
31.IP "\-s MAPSIZE, \-\-size=MAPSIZE"
32Specifies 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.
33
34.SH NOTES
35
36Typical invocaton would be:
37
38$ gnunet\-zoneimport 1.2.3.4 < names.txt
39
40
41
42
43.SH BUGS
44Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
45
46.SH SEE ALSO
47gnunet\-gns(1), gnunet\-namestore(1)