aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am33
-rw-r--r--doc/doxygen/.gitignore5
-rw-r--r--doc/doxygen/Makefile.am3
-rw-r--r--doc/doxygen/gnunet-logo-no-text-small.pngbin0 -> 5006 bytes
-rw-r--r--doc/doxygen/gnunet.doxy2546
-rw-r--r--doc/handbook/.gitignore13
-rw-r--r--doc/handbook/README5
-rw-r--r--doc/handbook/meson.build42
-rw-r--r--doc/man/.gitignore4
-rw-r--r--doc/man/Makefile.am31
-rw-r--r--doc/man/gnunet-ats.1114
-rw-r--r--doc/man/gnunet-config.12
-rw-r--r--doc/man/gnunet-core.16
-rw-r--r--doc/man/gnunet-dht-get.190
-rw-r--r--doc/man/gnunet-dht-hello.175
-rw-r--r--doc/man/gnunet-dht-monitor.182
-rw-r--r--doc/man/gnunet-dht-put.1100
-rw-r--r--doc/man/gnunet-did.1108
-rw-r--r--doc/man/gnunet-dns2gns.11
-rw-r--r--doc/man/gnunet-identity.135
-rw-r--r--doc/man/gnunet-messenger.1 (renamed from doc/man/gnunet-peerinfo.1)75
-rw-r--r--doc/man/gnunet-namestore-dbtool.1 (renamed from doc/man/gnunet-testbed-profiler.1)48
-rw-r--r--doc/man/gnunet-namestore-zonefile.1 (renamed from doc/man/gnunet-namestore-fcfsd.1)50
-rw-r--r--doc/man/gnunet-namestore.1105
-rw-r--r--doc/man/gnunet-nse.13
-rw-r--r--doc/man/gnunet-reclaim.19
-rw-r--r--doc/man/gnunet-search.1313
-rw-r--r--doc/man/meson.build62
-rwxr-xr-xdoc/man/produce_html.sh.in9
-rw-r--r--doc/meson.build2
-rw-r--r--doc/old/doc.h (renamed from doc/doc.h)0
-rw-r--r--doc/old/docstyle.css (renamed from doc/docstyle.css)0
-rw-r--r--doc/old/handbook/.gitignore11
-rw-r--r--doc/old/handbook/Makefile.am (renamed from doc/handbook/Makefile.am)0
-rw-r--r--doc/old/handbook/TODO (renamed from doc/handbook/TODO)0
-rw-r--r--doc/old/handbook/agpl-3.0.texi (renamed from doc/handbook/agpl-3.0.texi)0
-rw-r--r--doc/old/handbook/chapters/configuration.texi (renamed from doc/handbook/chapters/configuration.texi)0
-rw-r--r--doc/old/handbook/chapters/contributing.texi (renamed from doc/handbook/chapters/contributing.texi)0
-rw-r--r--doc/old/handbook/chapters/developer.texi (renamed from doc/handbook/chapters/developer.texi)6
-rw-r--r--doc/old/handbook/chapters/installation.texi (renamed from doc/handbook/chapters/installation.texi)7
-rw-r--r--doc/old/handbook/chapters/keyconcepts.texi (renamed from doc/handbook/chapters/keyconcepts.texi)0
-rw-r--r--doc/old/handbook/chapters/philosophy.texi (renamed from doc/handbook/chapters/philosophy.texi)5
-rw-r--r--doc/old/handbook/chapters/preface.texi (renamed from doc/handbook/chapters/preface.texi)0
-rw-r--r--doc/old/handbook/chapters/user.texi (renamed from doc/handbook/chapters/user.texi)160
-rw-r--r--doc/old/handbook/chapters/vocabulary.texi (renamed from doc/handbook/chapters/vocabulary.texi)0
-rw-r--r--doc/old/handbook/docstyle.css (renamed from doc/handbook/docstyle.css)0
-rw-r--r--doc/old/handbook/fdl-1.3.texi (renamed from doc/handbook/fdl-1.3.texi)0
-rwxr-xr-xdoc/old/handbook/gendocs.sh (renamed from doc/handbook/gendocs.sh)0
-rw-r--r--doc/old/handbook/gendocs_template (renamed from doc/handbook/gendocs_template)0
-rw-r--r--doc/old/handbook/gendocs_template_min (renamed from doc/handbook/gendocs_template_min)0
-rw-r--r--doc/old/handbook/gnunet.texi (renamed from doc/handbook/gnunet.texi)0
-rw-r--r--doc/old/handbook/gpl-3.0.texi (renamed from doc/handbook/gpl-3.0.texi)0
-rw-r--r--doc/old/handbook/htmlxref.cnf (renamed from doc/handbook/htmlxref.cnf)0
-rw-r--r--doc/old/handbook/images/ascension_interaction.png (renamed from doc/handbook/images/ascension_interaction.png)bin1992878 -> 1992878 bytes
-rw-r--r--doc/old/handbook/images/ascension_ssd.png (renamed from doc/handbook/images/ascension_ssd.png)bin69446 -> 69446 bytes
-rw-r--r--doc/old/handbook/images/daemon_lego_block.png (renamed from doc/handbook/images/daemon_lego_block.png)bin7636 -> 7636 bytes
-rw-r--r--doc/old/handbook/images/daemon_lego_block.svg (renamed from doc/handbook/images/daemon_lego_block.svg)0
-rw-r--r--doc/old/handbook/images/gns.dot (renamed from doc/handbook/images/gns.dot)0
-rw-r--r--doc/old/handbook/images/gns.eps (renamed from doc/handbook/images/gns.eps)0
-rw-r--r--doc/old/handbook/images/gns.jpg (renamed from doc/handbook/images/gns.jpg)bin41765 -> 41765 bytes
-rw-r--r--doc/old/handbook/images/gnunet-0-10-peerinfo.png (renamed from doc/handbook/images/gnunet-0-10-peerinfo.png)bin80127 -> 80127 bytes
-rw-r--r--doc/old/handbook/images/gnunet-fs-gtk-0-10-star-tab.png (renamed from doc/handbook/images/gnunet-fs-gtk-0-10-star-tab.png)bin63464 -> 63464 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-download-area.png (renamed from doc/handbook/images/gnunet-gtk-0-10-download-area.png)bin7634 -> 7634 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-menu.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-menu.png)bin8614 -> 8614 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png)bin55507 -> 55507 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-select.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-publish-select.png)bin43448 -> 43448 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png)bin27371 -> 27371 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png)bin27371 -> 27371 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-publish.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-publish.png)bin26496 -> 26496 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-published.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-published.png)bin59635 -> 59635 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs-search.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs-search.png)bin72151 -> 72151 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-fs.png (renamed from doc/handbook/images/gnunet-gtk-0-10-fs.png)bin55706 -> 55706 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-gns-a-done.png (renamed from doc/handbook/images/gnunet-gtk-0-10-gns-a-done.png)bin30880 -> 30880 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-gns-a.png (renamed from doc/handbook/images/gnunet-gtk-0-10-gns-a.png)bin29895 -> 29895 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-gns.png (renamed from doc/handbook/images/gnunet-gtk-0-10-gns.png)bin63783 -> 63783 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-identity.png (renamed from doc/handbook/images/gnunet-gtk-0-10-identity.png)bin62404 -> 62404 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-search-selected.png (renamed from doc/handbook/images/gnunet-gtk-0-10-search-selected.png)bin104599 -> 104599 bytes
-rw-r--r--doc/old/handbook/images/gnunet-gtk-0-10-traffic.png (renamed from doc/handbook/images/gnunet-gtk-0-10-traffic.png)bin68515 -> 68515 bytes
-rw-r--r--doc/old/handbook/images/gnunet-namestore-gtk-phone.png (renamed from doc/handbook/images/gnunet-namestore-gtk-phone.png)bin32631 -> 32631 bytes
-rw-r--r--doc/old/handbook/images/gnunet-namestore-gtk-vpn.png (renamed from doc/handbook/images/gnunet-namestore-gtk-vpn.png)bin35836 -> 35836 bytes
-rw-r--r--doc/old/handbook/images/gnunet-setup-exit.png (renamed from doc/handbook/images/gnunet-setup-exit.png)bin30062 -> 30062 bytes
-rw-r--r--doc/old/handbook/images/gnunet-tutorial-service.png (renamed from doc/handbook/images/gnunet-tutorial-service.png)bin40142 -> 40142 bytes
-rw-r--r--doc/old/handbook/images/gnunet-tutorial-system.png (renamed from doc/handbook/images/gnunet-tutorial-system.png)bin46982 -> 46982 bytes
-rw-r--r--doc/old/handbook/images/iceweasel-preferences.png (renamed from doc/handbook/images/iceweasel-preferences.png)bin57047 -> 57047 bytes
-rw-r--r--doc/old/handbook/images/iceweasel-proxy.png (renamed from doc/handbook/images/iceweasel-proxy.png)bin38773 -> 38773 bytes
-rw-r--r--doc/old/handbook/images/lego_stack.svg (renamed from doc/handbook/images/lego_stack.svg)0
-rw-r--r--doc/old/handbook/images/messenger_room.png (renamed from doc/handbook/images/messenger_room.png)bin76244 -> 76244 bytes
-rw-r--r--doc/old/handbook/images/messenger_room.svg (renamed from doc/handbook/images/messenger_room.svg)0
-rw-r--r--doc/old/handbook/images/service_lego_block.png (renamed from doc/handbook/images/service_lego_block.png)bin15157 -> 15157 bytes
-rw-r--r--doc/old/handbook/images/service_lego_block.svg (renamed from doc/handbook/images/service_lego_block.svg)0
-rw-r--r--doc/old/handbook/images/service_stack.png (renamed from doc/handbook/images/service_stack.png)bin18862 -> 18862 bytes
-rw-r--r--doc/old/handbook/images/structure.dot (renamed from doc/handbook/images/structure.dot)0
-rw-r--r--doc/old/handbook/images/tng.dot (renamed from doc/handbook/images/tng.dot)0
-rw-r--r--doc/old/handbook/images/tng.png (renamed from doc/handbook/images/tng.png)bin75821 -> 75821 bytes
-rw-r--r--doc/old/handbook/manual.css (renamed from doc/handbook/manual.css)0
-rw-r--r--doc/old/handbook/reset.css (renamed from doc/handbook/reset.css)0
-rwxr-xr-xdoc/old/handbook/run-gendocs.sh (renamed from doc/handbook/run-gendocs.sh)0
-rw-r--r--doc/old/handbook/style.css (renamed from doc/handbook/style.css)0
-rw-r--r--doc/old/index.html (renamed from doc/index.html)0
-rw-r--r--doc/old/manual.css (renamed from doc/manual.css)0
-rw-r--r--doc/old/reset.css (renamed from doc/reset.css)0
-rw-r--r--doc/old/style.css (renamed from doc/style.css)0
-rw-r--r--doc/old/tutorial/.gitignore (renamed from doc/tutorial/.gitignore)0
-rw-r--r--doc/old/tutorial/Makefile.am (renamed from doc/tutorial/Makefile.am)0
-rw-r--r--doc/old/tutorial/agpl-3.0.texi (renamed from doc/tutorial/agpl-3.0.texi)0
-rw-r--r--doc/old/tutorial/docstyle.css (renamed from doc/tutorial/docstyle.css)0
-rw-r--r--doc/old/tutorial/examples/001.c (renamed from doc/tutorial/examples/001.c)1
-rw-r--r--doc/old/tutorial/examples/002.c (renamed from doc/tutorial/examples/002.c)0
-rw-r--r--doc/old/tutorial/examples/003.c (renamed from doc/tutorial/examples/003.c)0
-rw-r--r--doc/old/tutorial/examples/004.c (renamed from doc/tutorial/examples/004.c)0
-rw-r--r--doc/old/tutorial/examples/005.c (renamed from doc/tutorial/examples/005.c)0
-rw-r--r--doc/old/tutorial/examples/006.c (renamed from doc/tutorial/examples/006.c)0
-rw-r--r--doc/old/tutorial/examples/007.c (renamed from doc/tutorial/examples/007.c)0
-rw-r--r--doc/old/tutorial/examples/008.c (renamed from doc/tutorial/examples/008.c)0
-rw-r--r--doc/old/tutorial/examples/009.c (renamed from doc/tutorial/examples/009.c)1
-rw-r--r--doc/old/tutorial/examples/010.c (renamed from doc/tutorial/examples/010.c)0
-rw-r--r--doc/old/tutorial/examples/011.c (renamed from doc/tutorial/examples/011.c)0
-rw-r--r--doc/old/tutorial/examples/012.c (renamed from doc/tutorial/examples/012.c)1
-rw-r--r--doc/old/tutorial/examples/013.1.c (renamed from doc/tutorial/examples/013.1.c)0
-rw-r--r--doc/old/tutorial/examples/013.c (renamed from doc/tutorial/examples/013.c)0
-rw-r--r--doc/old/tutorial/examples/014.c (renamed from doc/tutorial/examples/014.c)0
-rw-r--r--doc/old/tutorial/examples/015.c (renamed from doc/tutorial/examples/015.c)0
-rw-r--r--doc/old/tutorial/examples/016.c (renamed from doc/tutorial/examples/016.c)0
-rw-r--r--doc/old/tutorial/examples/017.c (renamed from doc/tutorial/examples/017.c)0
-rw-r--r--doc/old/tutorial/examples/018.c (renamed from doc/tutorial/examples/018.c)0
-rw-r--r--doc/old/tutorial/examples/019.c (renamed from doc/tutorial/examples/019.c)0
-rw-r--r--doc/old/tutorial/examples/020.c (renamed from doc/tutorial/examples/020.c)0
-rw-r--r--doc/old/tutorial/examples/021.c (renamed from doc/tutorial/examples/021.c)0
-rw-r--r--doc/old/tutorial/examples/022.c (renamed from doc/tutorial/examples/022.c)0
-rw-r--r--doc/old/tutorial/examples/023.c (renamed from doc/tutorial/examples/023.c)0
-rw-r--r--doc/old/tutorial/examples/024.c (renamed from doc/tutorial/examples/024.c)0
-rw-r--r--doc/old/tutorial/examples/025.Makefile.am (renamed from doc/tutorial/examples/025.Makefile.am)0
-rw-r--r--doc/old/tutorial/examples/026.c (renamed from doc/tutorial/examples/026.c)0
-rw-r--r--doc/old/tutorial/examples/testbed_test.c (renamed from doc/tutorial/examples/testbed_test.c)1
-rw-r--r--doc/old/tutorial/fdl-1.3.texi (renamed from doc/tutorial/fdl-1.3.texi)0
-rw-r--r--doc/old/tutorial/gpl-3.0.texi (renamed from doc/tutorial/gpl-3.0.texi)0
-rw-r--r--doc/old/tutorial/htmlxref.cnf (renamed from doc/tutorial/htmlxref.cnf)0
-rw-r--r--doc/old/tutorial/manual.css (renamed from doc/tutorial/manual.css)0
-rw-r--r--doc/old/tutorial/reset.css (renamed from doc/tutorial/reset.css)0
-rwxr-xr-xdoc/old/tutorial/run-gendocs.sh (renamed from doc/tutorial/run-gendocs.sh)0
-rw-r--r--doc/old/tutorial/style.css (renamed from doc/tutorial/style.css)0
-rw-r--r--doc/old/tutorial/tutorial.texi (renamed from doc/tutorial/tutorial.texi)4
142 files changed, 3783 insertions, 385 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a9ad69954..b45362d38 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,18 +1,37 @@
1# This Makefile.am is in the public domain 1# This Makefile.am is in the public domain
2 2
3SUBDIRS = .
3 4
4if DOCUMENTATION 5if HAVE_DOXY_BINARY
5 SUBDIRS = doxygen handbook tutorial 6 SUBDIRS += doxygen
6endif 7endif
7 8
8if !DOCUMENTATION 9# OpenBSD is a bit iffy wrt sphinx make info
9 SUBDIRS = doxygen 10if OPENBSD
11all-local:
12 cd handbook/texinfo && make || touch gnunet.info
13GNUNET_TEXI =
14else
15GNUNET_TEXI = handbook/texinfo/gnunet.texi
10endif 16endif
11 17
18install-data-hook:
19 mkdir -p $(DESTDIR)$(docdir)
20 cp -pr handbook/html $(DESTDIR)$(docdir)
21 mkdir -p $(DESTDIR)$(infodir)
22 cp -pr handbook/texinfo/gnunet.info $(DESTDIR)$(infodir)
23
12if INCLUDE_MANPAGES 24if INCLUDE_MANPAGES
13 SUBDIRS += man 25SUBDIRS += man
14endif 26endif
15 27
16EXTRA_DIST = \ 28AM_MAKEINFOFLAGS = --no-headers --no-split
29
30info_TEXINFOS = \
31 $(GNUNET_TEXI)
32
33EXTRA_DIST = \
34 handbook/texinfo \
17 system_specific/outdated-and-old-installation-instructions.txt \ 35 system_specific/outdated-and-old-installation-instructions.txt \
18 system_specific/FROM_SOURCE 36 system_specific/FROM_SOURCE \
37 handbook/html
diff --git a/doc/doxygen/.gitignore b/doc/doxygen/.gitignore
new file mode 100644
index 000000000..8cfc0958d
--- /dev/null
+++ b/doc/doxygen/.gitignore
@@ -0,0 +1,5 @@
1version.doxy
2gnunet.tag
3doxygen_warnings.log
4html/
5xml/
diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
index 7819bb558..52f124e33 100644
--- a/doc/doxygen/Makefile.am
+++ b/doc/doxygen/Makefile.am
@@ -6,13 +6,16 @@ all:
6"\tmake fast - fast mode without dependency graphs" 6"\tmake fast - fast mode without dependency graphs"
7 7
8full: gnunet.doxy 8full: gnunet.doxy
9 python -c "f=open('../../.version'); print(f'PROJECT_NUMBER = {f.read().split(\"-\")[0]}'); f.close()" > version.doxy
9 doxygen $< 10 doxygen $<
10 11
11fast: gnunet.doxy 12fast: gnunet.doxy
13 python -c "f=open('../../.version'); print(f'PROJECT_NUMBER = {f.read().split(\"-\")[0]}'); f.close()" > version.doxy
12 sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen - 14 sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen -
13 15
14clean: 16clean:
15 rm -rf html 17 rm -rf html
18 rm -rf xml
16 19
17EXTRA_DIST = \ 20EXTRA_DIST = \
18 gnunet.doxy 21 gnunet.doxy
diff --git a/doc/doxygen/gnunet-logo-no-text-small.png b/doc/doxygen/gnunet-logo-no-text-small.png
new file mode 100644
index 000000000..1f2c46940
--- /dev/null
+++ b/doc/doxygen/gnunet-logo-no-text-small.png
Binary files differ
diff --git a/doc/doxygen/gnunet.doxy b/doc/doxygen/gnunet.doxy
index 7874576ff..3fe3b866a 100644
--- a/doc/doxygen/gnunet.doxy
+++ b/doc/doxygen/gnunet.doxy
@@ -1,17 +1,145 @@
1# Doxyfile 1.5.6 1# Doxyfile 1.9.5
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15#
16# Note:
17#
18# Use doxygen to compare the used configuration file with the template
19# configuration file:
20# doxygen -x [configFile]
21# Use doxygen to compare the used configuration file with the template
22# configuration file without replacing the environment variables or CMake type
23# replacement variables:
24# doxygen -x_noenv [configFile]
2 25
3#--------------------------------------------------------------------------- 26#---------------------------------------------------------------------------
4# Project related configuration options 27# Project related configuration options
5#--------------------------------------------------------------------------- 28#---------------------------------------------------------------------------
29
30# This tag specifies the encoding used for all characters in the configuration
31# file that follow. The default is UTF-8 which is also the encoding used for all
32# text before the first occurrence of this tag. Doxygen uses libiconv (or the
33# iconv built into libc) for the transcoding. See
34# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35# The default value is: UTF-8.
36
6DOXYFILE_ENCODING = UTF-8 37DOXYFILE_ENCODING = UTF-8
38
39# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40# double-quotes, unless you are using Doxywizard) that should identify the
41# project for which the documentation is generated. This name is used in the
42# title of most generated pages and in a few other places.
43# The default value is: My Project.
44
7PROJECT_NAME = GNUnet 45PROJECT_NAME = GNUnet
8PROJECT_NUMBER = 0.11.x 46
9PROJECT_LOGO = logo.png 47# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48# could be handy for archiving the generated documentation or if some version
49# control system is used.
50
51@INCLUDE = "version.doxy"
52
53# Using the PROJECT_BRIEF tag one can provide an optional one line description
54# for a project that appears at the top of each page and should give viewer a
55# quick idea about the purpose of the project. Keep the description short.
56
57PROJECT_BRIEF =
58
59# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60# in the documentation. The maximum height of the logo should not exceed 55
61# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62# the logo to the output directory.
63
64PROJECT_LOGO = gnunet-logo-no-text-small.png
65
66# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
67# into which the generated documentation will be written. If a relative path is
68# entered, it will be relative to the location where doxygen was started. If
69# left blank the current directory will be used.
70
10OUTPUT_DIRECTORY = . 71OUTPUT_DIRECTORY = .
72
73# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
74# sub-directories (in 2 levels) under the output directory of each output format
75# and will distribute the generated files over these directories. Enabling this
76# option can be useful when feeding doxygen a huge amount of source files, where
77# putting all generated files in the same directory would otherwise causes
78# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
79# control the number of sub-directories.
80# The default value is: NO.
81
11CREATE_SUBDIRS = YES 82CREATE_SUBDIRS = YES
83
84# Controls the number of sub-directories that will be created when
85# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
86# level increment doubles the number of directories, resulting in 4096
87# directories at level 8 which is the default and also the maximum value. The
88# sub-directories are organized in 2 levels, the first level always has a fixed
89# numer of 16 directories.
90# Minimum value: 0, maximum value: 8, default value: 8.
91# This tag requires that the tag CREATE_SUBDIRS is set to YES.
92
93CREATE_SUBDIRS_LEVEL = 8
94
95# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
96# characters to appear in the names of generated files. If set to NO, non-ASCII
97# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
98# U+3044.
99# The default value is: NO.
100
101ALLOW_UNICODE_NAMES = NO
102
103# The OUTPUT_LANGUAGE tag is used to specify the language in which all
104# documentation generated by doxygen is written. Doxygen will use this
105# information to generate all constant output in the proper language.
106# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
107# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
108# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
109# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
110# English messages), Korean, Korean-en (Korean with English messages), Latvian,
111# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
112# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
113# Swedish, Turkish, Ukrainian and Vietnamese.
114# The default value is: English.
115
12OUTPUT_LANGUAGE = English 116OUTPUT_LANGUAGE = English
117
118# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
119# descriptions after the members that are listed in the file and class
120# documentation (similar to Javadoc). Set to NO to disable this.
121# The default value is: YES.
122
13BRIEF_MEMBER_DESC = YES 123BRIEF_MEMBER_DESC = YES
124
125# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
126# description of a member or function before the detailed description
127#
128# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
129# brief descriptions will be completely suppressed.
130# The default value is: YES.
131
14REPEAT_BRIEF = YES 132REPEAT_BRIEF = YES
133
134# This tag implements a quasi-intelligent brief description abbreviator that is
135# used to form the text in various listings. Each string in this list, if found
136# as the leading text of the brief description, will be stripped from the text
137# and the result, after processing the whole list, is used as the annotated
138# text. Otherwise, the brief description is used as-is. If left blank, the
139# following values are used ($name is automatically replaced with the name of
140# the entity):The $name class, The $name widget, The $name file, is, provides,
141# specifies, contains, represents, a, an and the.
142
15ABBREVIATE_BRIEF = "The $name class" \ 143ABBREVIATE_BRIEF = "The $name class" \
16 "The $name widget" \ 144 "The $name widget" \
17 "The $name file" \ 145 "The $name file" \
@@ -23,79 +151,807 @@ ABBREVIATE_BRIEF = "The $name class" \
23 a \ 151 a \
24 an \ 152 an \
25 the 153 the
154
155# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
156# doxygen will generate a detailed section even if there is only a brief
157# description.
158# The default value is: NO.
159
26ALWAYS_DETAILED_SEC = NO 160ALWAYS_DETAILED_SEC = NO
161
162# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
163# inherited members of a class in the documentation of that class as if those
164# members were ordinary class members. Constructors, destructors and assignment
165# operators of the base classes will not be shown.
166# The default value is: NO.
167
27INLINE_INHERITED_MEMB = NO 168INLINE_INHERITED_MEMB = NO
169
170# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
171# before files name in the file list and in the header files. If set to NO the
172# shortest path that makes the file name unique will be used
173# The default value is: YES.
174
28FULL_PATH_NAMES = YES 175FULL_PATH_NAMES = YES
176
177# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
178# Stripping is only done if one of the specified strings matches the left-hand
179# part of the path. The tag can be used to show relative paths in the file list.
180# If left blank the directory from which doxygen is run is used as the path to
181# strip.
182#
183# Note that you can specify absolute paths here, but also relative paths, which
184# will be relative from the directory where doxygen is started.
185# This tag requires that the tag FULL_PATH_NAMES is set to YES.
186
29STRIP_FROM_PATH = ../.. 187STRIP_FROM_PATH = ../..
188
189# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
190# path mentioned in the documentation of a class, which tells the reader which
191# header file to include in order to use a class. If left blank only the name of
192# the header file containing the class definition is used. Otherwise one should
193# specify the list of include paths that are normally passed to the compiler
194# using the -I flag.
195
30STRIP_FROM_INC_PATH = ../../src/include \ 196STRIP_FROM_INC_PATH = ../../src/include \
31 src/include \ 197 src/include \
32 include 198 include
199
200# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
201# less readable) file names. This can be useful is your file systems doesn't
202# support long names like on DOS, Mac, or CD-ROM.
203# The default value is: NO.
204
33SHORT_NAMES = NO 205SHORT_NAMES = NO
206
207# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
208# first line (until the first dot) of a Javadoc-style comment as the brief
209# description. If set to NO, the Javadoc-style will behave just like regular Qt-
210# style comments (thus requiring an explicit @brief command for a brief
211# description.)
212# The default value is: NO.
213
34JAVADOC_AUTOBRIEF = YES 214JAVADOC_AUTOBRIEF = YES
215
216# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
217# such as
218# /***************
219# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
220# Javadoc-style will behave just like regular comments and it will not be
221# interpreted by doxygen.
222# The default value is: NO.
223
224JAVADOC_BANNER = NO
225
226# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
227# line (until the first dot) of a Qt-style comment as the brief description. If
228# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
229# requiring an explicit \brief command for a brief description.)
230# The default value is: NO.
231
35QT_AUTOBRIEF = NO 232QT_AUTOBRIEF = NO
233
234# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
235# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
236# a brief description. This used to be the default behavior. The new default is
237# to treat a multi-line C++ comment block as a detailed description. Set this
238# tag to YES if you prefer the old behavior instead.
239#
240# Note that setting this tag to YES also means that rational rose comments are
241# not recognized any more.
242# The default value is: NO.
243
36MULTILINE_CPP_IS_BRIEF = NO 244MULTILINE_CPP_IS_BRIEF = NO
245
246# By default Python docstrings are displayed as preformatted text and doxygen's
247# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
248# doxygen's special commands can be used and the contents of the docstring
249# documentation blocks is shown as doxygen documentation.
250# The default value is: YES.
251
252PYTHON_DOCSTRING = YES
253
254# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
255# documentation from any documented member that it re-implements.
256# The default value is: YES.
257
37INHERIT_DOCS = YES 258INHERIT_DOCS = YES
259
260# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
261# page for each member. If set to NO, the documentation of a member will be part
262# of the file/class/namespace that contains it.
263# The default value is: NO.
264
38SEPARATE_MEMBER_PAGES = NO 265SEPARATE_MEMBER_PAGES = NO
266
267# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
268# uses this value to replace tabs by spaces in code fragments.
269# Minimum value: 1, maximum value: 16, default value: 4.
270
39TAB_SIZE = 8 271TAB_SIZE = 8
272
273# This tag can be used to specify a number of aliases that act as commands in
274# the documentation. An alias has the form:
275# name=value
276# For example adding
277# "sideeffect=@par Side Effects:^^"
278# will allow you to put the command \sideeffect (or @sideeffect) in the
279# documentation, which will result in a user-defined paragraph with heading
280# "Side Effects:". Note that you cannot put \n's in the value part of an alias
281# to insert newlines (in the resulting output). You can put ^^ in the value part
282# of an alias to insert a newline as if a physical newline was in the original
283# file. When you need a literal { or } or , in the value part of an alias you
284# have to escape them by means of a backslash (\), this can lead to conflicts
285# with the commands \{ and \} for these it is advised to use the version @{ and
286# @} or use a double escape (\\{ and \\})
287
40ALIASES = 288ALIASES =
289
290# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
291# only. Doxygen will then generate output that is more tailored for C. For
292# instance, some of the names that are used will be different. The list of all
293# members will be omitted, etc.
294# The default value is: NO.
295
41OPTIMIZE_OUTPUT_FOR_C = YES 296OPTIMIZE_OUTPUT_FOR_C = YES
297
298# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
299# Python sources only. Doxygen will then generate output that is more tailored
300# for that language. For instance, namespaces will be presented as packages,
301# qualified scopes will look different, etc.
302# The default value is: NO.
303
42OPTIMIZE_OUTPUT_JAVA = NO 304OPTIMIZE_OUTPUT_JAVA = NO
305
306# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
307# sources. Doxygen will then generate output that is tailored for Fortran.
308# The default value is: NO.
309
43OPTIMIZE_FOR_FORTRAN = NO 310OPTIMIZE_FOR_FORTRAN = NO
311
312# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
313# sources. Doxygen will then generate output that is tailored for VHDL.
314# The default value is: NO.
315
44OPTIMIZE_OUTPUT_VHDL = NO 316OPTIMIZE_OUTPUT_VHDL = NO
317
318# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
319# sources only. Doxygen will then generate output that is more tailored for that
320# language. For instance, namespaces will be presented as modules, types will be
321# separated into more groups, etc.
322# The default value is: NO.
323
324OPTIMIZE_OUTPUT_SLICE = NO
325
326# Doxygen selects the parser to use depending on the extension of the files it
327# parses. With this tag you can assign which parser to use for a given
328# extension. Doxygen has a built-in mapping, but you can override or extend it
329# using this tag. The format is ext=language, where ext is a file extension, and
330# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
331# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
332# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
333# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
334# tries to guess whether the code is fixed or free formatted code, this is the
335# default for Fortran type files). For instance to make doxygen treat .inc files
336# as Fortran files (default is PHP), and .f files as C (default is Fortran),
337# use: inc=Fortran f=C.
338#
339# Note: For files without extension you can use no_extension as a placeholder.
340#
341# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
342# the files are not read by doxygen. When specifying no_extension you should add
343# * to the FILE_PATTERNS.
344#
345# Note see also the list of default file extension mappings.
346
347EXTENSION_MAPPING =
348
349# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
350# according to the Markdown format, which allows for more readable
351# documentation. See https://daringfireball.net/projects/markdown/ for details.
352# The output of markdown processing is further processed by doxygen, so you can
353# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
354# case of backward compatibilities issues.
355# The default value is: YES.
356
357MARKDOWN_SUPPORT = YES
358
359# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
360# to that level are automatically included in the table of contents, even if
361# they do not have an id attribute.
362# Note: This feature currently applies only to Markdown headings.
363# Minimum value: 0, maximum value: 99, default value: 5.
364# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
365
366TOC_INCLUDE_HEADINGS = 5
367
368# When enabled doxygen tries to link words that correspond to documented
369# classes, or namespaces to their corresponding documentation. Such a link can
370# be prevented in individual cases by putting a % sign in front of the word or
371# globally by setting AUTOLINK_SUPPORT to NO.
372# The default value is: YES.
373
374AUTOLINK_SUPPORT = YES
375
376# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
377# to include (a tag file for) the STL sources as input, then you should set this
378# tag to YES in order to let doxygen match functions declarations and
379# definitions whose arguments contain STL classes (e.g. func(std::string);
380# versus func(std::string) {}). This also make the inheritance and collaboration
381# diagrams that involve STL classes more complete and accurate.
382# The default value is: NO.
383
45BUILTIN_STL_SUPPORT = NO 384BUILTIN_STL_SUPPORT = NO
385
386# If you use Microsoft's C++/CLI language, you should set this option to YES to
387# enable parsing support.
388# The default value is: NO.
389
46CPP_CLI_SUPPORT = NO 390CPP_CLI_SUPPORT = NO
391
392# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
393# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
394# will parse them like normal C++ but will assume all classes use public instead
395# of private inheritance when no explicit protection keyword is present.
396# The default value is: NO.
397
47SIP_SUPPORT = NO 398SIP_SUPPORT = NO
399
400# For Microsoft's IDL there are propget and propput attributes to indicate
401# getter and setter methods for a property. Setting this option to YES will make
402# doxygen to replace the get and set methods by a property in the documentation.
403# This will only work if the methods are indeed getting or setting a simple
404# type. If this is not the case, or you want to show the methods anyway, you
405# should set this option to NO.
406# The default value is: YES.
407
48IDL_PROPERTY_SUPPORT = YES 408IDL_PROPERTY_SUPPORT = YES
409
410# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
411# tag is set to YES then doxygen will reuse the documentation of the first
412# member in the group (if any) for the other members of the group. By default
413# all members of a group must be documented explicitly.
414# The default value is: NO.
415
49DISTRIBUTE_GROUP_DOC = NO 416DISTRIBUTE_GROUP_DOC = NO
417
418# If one adds a struct or class to a group and this option is enabled, then also
419# any nested class or struct is added to the same group. By default this option
420# is disabled and one has to add nested compounds explicitly via \ingroup.
421# The default value is: NO.
422
423GROUP_NESTED_COMPOUNDS = NO
424
425# Set the SUBGROUPING tag to YES to allow class member groups of the same type
426# (for instance a group of public functions) to be put as a subgroup of that
427# type (e.g. under the Public Functions section). Set it to NO to prevent
428# subgrouping. Alternatively, this can be done per class using the
429# \nosubgrouping command.
430# The default value is: YES.
431
50SUBGROUPING = YES 432SUBGROUPING = YES
433
434# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
435# are shown inside the group in which they are included (e.g. using \ingroup)
436# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
437# and RTF).
438#
439# Note that this feature does not work in combination with
440# SEPARATE_MEMBER_PAGES.
441# The default value is: NO.
442
443INLINE_GROUPED_CLASSES = NO
444
445# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
446# with only public data fields or simple typedef fields will be shown inline in
447# the documentation of the scope in which they are defined (i.e. file,
448# namespace, or group documentation), provided this scope is documented. If set
449# to NO, structs, classes, and unions are shown on a separate page (for HTML and
450# Man pages) or section (for LaTeX and RTF).
451# The default value is: NO.
452
453INLINE_SIMPLE_STRUCTS = NO
454
455# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
456# enum is documented as struct, union, or enum with the name of the typedef. So
457# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
458# with name TypeT. When disabled the typedef will appear as a member of a file,
459# namespace, or class. And the struct will be named TypeS. This can typically be
460# useful for C code in case the coding convention dictates that all compound
461# types are typedef'ed and only the typedef is referenced, never the tag name.
462# The default value is: NO.
463
51TYPEDEF_HIDES_STRUCT = NO 464TYPEDEF_HIDES_STRUCT = NO
465
466# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
467# cache is used to resolve symbols given their name and scope. Since this can be
468# an expensive process and often the same symbol appears multiple times in the
469# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
470# doxygen will become slower. If the cache is too large, memory is wasted. The
471# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
472# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
473# symbols. At the end of a run doxygen will report the cache usage and suggest
474# the optimal cache size from a speed point of view.
475# Minimum value: 0, maximum value: 9, default value: 0.
476
477LOOKUP_CACHE_SIZE = 0
478
479# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
480# during processing. When set to 0 doxygen will based this on the number of
481# cores available in the system. You can set it explicitly to a value larger
482# than 0 to get more control over the balance between CPU load and processing
483# speed. At this moment only the input processing can be done using multiple
484# threads. Since this is still an experimental feature the default is set to 1,
485# which effectively disables parallel processing. Please report any issues you
486# encounter. Generating dot graphs in parallel is controlled by the
487# DOT_NUM_THREADS setting.
488# Minimum value: 0, maximum value: 32, default value: 1.
489
490NUM_PROC_THREADS = 1
491
52#--------------------------------------------------------------------------- 492#---------------------------------------------------------------------------
53# Build related configuration options 493# Build related configuration options
54#--------------------------------------------------------------------------- 494#---------------------------------------------------------------------------
495
496# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
497# documentation are documented, even if no documentation was available. Private
498# class members and static file members will be hidden unless the
499# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
500# Note: This will also disable the warnings about undocumented members that are
501# normally produced when WARNINGS is set to YES.
502# The default value is: NO.
503
55EXTRACT_ALL = YES 504EXTRACT_ALL = YES
505
506# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
507# be included in the documentation.
508# The default value is: NO.
509
56EXTRACT_PRIVATE = YES 510EXTRACT_PRIVATE = YES
511
512# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
513# methods of a class will be included in the documentation.
514# The default value is: NO.
515
516EXTRACT_PRIV_VIRTUAL = NO
517
518# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
519# scope will be included in the documentation.
520# The default value is: NO.
521
522EXTRACT_PACKAGE = NO
523
524# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
525# included in the documentation.
526# The default value is: NO.
527
57EXTRACT_STATIC = YES 528EXTRACT_STATIC = YES
529
530# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
531# locally in source files will be included in the documentation. If set to NO,
532# only classes defined in header files are included. Does not have any effect
533# for Java sources.
534# The default value is: YES.
535
58EXTRACT_LOCAL_CLASSES = YES 536EXTRACT_LOCAL_CLASSES = YES
537
538# This flag is only useful for Objective-C code. If set to YES, local methods,
539# which are defined in the implementation section but not in the interface are
540# included in the documentation. If set to NO, only methods in the interface are
541# included.
542# The default value is: NO.
543
59EXTRACT_LOCAL_METHODS = YES 544EXTRACT_LOCAL_METHODS = YES
545
546# If this flag is set to YES, the members of anonymous namespaces will be
547# extracted and appear in the documentation as a namespace called
548# 'anonymous_namespace{file}', where file will be replaced with the base name of
549# the file that contains the anonymous namespace. By default anonymous namespace
550# are hidden.
551# The default value is: NO.
552
60EXTRACT_ANON_NSPACES = YES 553EXTRACT_ANON_NSPACES = YES
554
555# If this flag is set to YES, the name of an unnamed parameter in a declaration
556# will be determined by the corresponding definition. By default unnamed
557# parameters remain unnamed in the output.
558# The default value is: YES.
559
560RESOLVE_UNNAMED_PARAMS = YES
561
562# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
563# undocumented members inside documented classes or files. If set to NO these
564# members will be included in the various overviews, but no documentation
565# section is generated. This option has no effect if EXTRACT_ALL is enabled.
566# The default value is: NO.
567
61HIDE_UNDOC_MEMBERS = NO 568HIDE_UNDOC_MEMBERS = NO
569
570# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
571# undocumented classes that are normally visible in the class hierarchy. If set
572# to NO, these classes will be included in the various overviews. This option
573# has no effect if EXTRACT_ALL is enabled.
574# The default value is: NO.
575
62HIDE_UNDOC_CLASSES = NO 576HIDE_UNDOC_CLASSES = NO
577
578# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
579# declarations. If set to NO, these declarations will be included in the
580# documentation.
581# The default value is: NO.
582
63HIDE_FRIEND_COMPOUNDS = NO 583HIDE_FRIEND_COMPOUNDS = NO
584
585# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
586# documentation blocks found inside the body of a function. If set to NO, these
587# blocks will be appended to the function's detailed documentation block.
588# The default value is: NO.
589
64HIDE_IN_BODY_DOCS = NO 590HIDE_IN_BODY_DOCS = NO
591
592# The INTERNAL_DOCS tag determines if documentation that is typed after a
593# \internal command is included. If the tag is set to NO then the documentation
594# will be excluded. Set it to YES to include the internal documentation.
595# The default value is: NO.
596
65INTERNAL_DOCS = YES 597INTERNAL_DOCS = YES
598
599# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
600# able to match the capabilities of the underlying filesystem. In case the
601# filesystem is case sensitive (i.e. it supports files in the same directory
602# whose names only differ in casing), the option must be set to YES to properly
603# deal with such files in case they appear in the input. For filesystems that
604# are not case sensitive the option should be set to NO to properly deal with
605# output files written for symbols that only differ in casing, such as for two
606# classes, one named CLASS and the other named Class, and to also support
607# references to files without having to specify the exact matching casing. On
608# Windows (including Cygwin) and MacOS, users should typically set this option
609# to NO, whereas on Linux or other Unix flavors it should typically be set to
610# YES.
611# Possible values are: SYSTEM, NO and YES.
612# The default value is: SYSTEM.
613
66CASE_SENSE_NAMES = YES 614CASE_SENSE_NAMES = YES
615
616# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
617# their full class and namespace scopes in the documentation. If set to YES, the
618# scope will be hidden.
619# The default value is: NO.
620
67HIDE_SCOPE_NAMES = NO 621HIDE_SCOPE_NAMES = NO
622
623# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
624# append additional text to a page's title, such as Class Reference. If set to
625# YES the compound reference will be hidden.
626# The default value is: NO.
627
628HIDE_COMPOUND_REFERENCE= NO
629
630# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
631# will show which file needs to be included to use the class.
632# The default value is: YES.
633
634SHOW_HEADERFILE = YES
635
636# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
637# the files that are included by a file in the documentation of that file.
638# The default value is: YES.
639
68SHOW_INCLUDE_FILES = YES 640SHOW_INCLUDE_FILES = YES
641
642# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
643# grouped member an include statement to the documentation, telling the reader
644# which file to include in order to use the member.
645# The default value is: NO.
646
647SHOW_GROUPED_MEMB_INC = NO
648
649# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
650# files with double quotes in the documentation rather than with sharp brackets.
651# The default value is: NO.
652
653FORCE_LOCAL_INCLUDES = NO
654
655# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
656# documentation for inline members.
657# The default value is: YES.
658
69INLINE_INFO = YES 659INLINE_INFO = YES
660
661# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
662# (detailed) documentation of file and class members alphabetically by member
663# name. If set to NO, the members will appear in declaration order.
664# The default value is: YES.
665
70SORT_MEMBER_DOCS = NO 666SORT_MEMBER_DOCS = NO
667
668# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
669# descriptions of file, namespace and class members alphabetically by member
670# name. If set to NO, the members will appear in declaration order. Note that
671# this will also influence the order of the classes in the class list.
672# The default value is: NO.
673
71SORT_BRIEF_DOCS = NO 674SORT_BRIEF_DOCS = NO
675
676# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
677# (brief and detailed) documentation of class members so that constructors and
678# destructors are listed first. If set to NO the constructors will appear in the
679# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
680# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
681# member documentation.
682# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
683# detailed member documentation.
684# The default value is: NO.
685
686SORT_MEMBERS_CTORS_1ST = NO
687
688# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
689# of group names into alphabetical order. If set to NO the group names will
690# appear in their defined order.
691# The default value is: NO.
692
72SORT_GROUP_NAMES = YES 693SORT_GROUP_NAMES = YES
694
695# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
696# fully-qualified names, including namespaces. If set to NO, the class list will
697# be sorted only by class name, not including the namespace part.
698# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
699# Note: This option applies only to the class list, not to the alphabetical
700# list.
701# The default value is: NO.
702
73SORT_BY_SCOPE_NAME = NO 703SORT_BY_SCOPE_NAME = NO
704
705# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
706# type resolution of all parameters of a function it will reject a match between
707# the prototype and the implementation of a member function even if there is
708# only one candidate or it is obvious which candidate to choose by doing a
709# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
710# accept a match between prototype and implementation in such cases.
711# The default value is: NO.
712
713STRICT_PROTO_MATCHING = NO
714
715# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
716# list. This list is created by putting \todo commands in the documentation.
717# The default value is: YES.
718
74GENERATE_TODOLIST = YES 719GENERATE_TODOLIST = YES
720
721# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
722# list. This list is created by putting \test commands in the documentation.
723# The default value is: YES.
724
75GENERATE_TESTLIST = YES 725GENERATE_TESTLIST = YES
726
727# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
728# list. This list is created by putting \bug commands in the documentation.
729# The default value is: YES.
730
76GENERATE_BUGLIST = YES 731GENERATE_BUGLIST = YES
732
733# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
734# the deprecated list. This list is created by putting \deprecated commands in
735# the documentation.
736# The default value is: YES.
737
77GENERATE_DEPRECATEDLIST= YES 738GENERATE_DEPRECATEDLIST= YES
739
740# The ENABLED_SECTIONS tag can be used to enable conditional documentation
741# sections, marked by \if <section_label> ... \endif and \cond <section_label>
742# ... \endcond blocks.
743
78ENABLED_SECTIONS = 744ENABLED_SECTIONS =
745
746# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
747# initial value of a variable or macro / define can have for it to appear in the
748# documentation. If the initializer consists of more lines than specified here
749# it will be hidden. Use a value of 0 to hide initializers completely. The
750# appearance of the value of individual variables and macros / defines can be
751# controlled using \showinitializer or \hideinitializer command in the
752# documentation regardless of this setting.
753# Minimum value: 0, maximum value: 10000, default value: 30.
754
79MAX_INITIALIZER_LINES = 30 755MAX_INITIALIZER_LINES = 30
756
757# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
758# the bottom of the documentation of classes and structs. If set to YES, the
759# list will mention the files that were used to generate the documentation.
760# The default value is: YES.
761
80SHOW_USED_FILES = YES 762SHOW_USED_FILES = YES
763
764# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
765# will remove the Files entry from the Quick Index and from the Folder Tree View
766# (if specified).
767# The default value is: YES.
768
81SHOW_FILES = YES 769SHOW_FILES = YES
770
771# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
772# page. This will remove the Namespaces entry from the Quick Index and from the
773# Folder Tree View (if specified).
774# The default value is: YES.
775
82SHOW_NAMESPACES = YES 776SHOW_NAMESPACES = YES
777
778# The FILE_VERSION_FILTER tag can be used to specify a program or script that
779# doxygen should invoke to get the current version for each file (typically from
780# the version control system). Doxygen will invoke the program by executing (via
781# popen()) the command command input-file, where command is the value of the
782# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
783# by doxygen. Whatever the program writes to standard output is used as the file
784# version. For an example see the documentation.
785
83FILE_VERSION_FILTER = 786FILE_VERSION_FILTER =
787
788# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
789# by doxygen. The layout file controls the global structure of the generated
790# output files in an output format independent way. To create the layout file
791# that represents doxygen's defaults, run doxygen with the -l option. You can
792# optionally specify a file name after the option, if omitted DoxygenLayout.xml
793# will be used as the name of the layout file. See also section "Changing the
794# layout of pages" for information.
795#
796# Note that if you run doxygen from a directory containing a file called
797# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
798# tag is left empty.
799
800LAYOUT_FILE =
801
802# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
803# the reference definitions. This must be a list of .bib files. The .bib
804# extension is automatically appended if omitted. This requires the bibtex tool
805# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
806# For LaTeX the style of the bibliography can be controlled using
807# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
808# search path. See also \cite for info how to create references.
809
810CITE_BIB_FILES =
811
84#--------------------------------------------------------------------------- 812#---------------------------------------------------------------------------
85# configuration options related to warning and progress messages 813# Configuration options related to warning and progress messages
86#--------------------------------------------------------------------------- 814#---------------------------------------------------------------------------
815
816# The QUIET tag can be used to turn on/off the messages that are generated to
817# standard output by doxygen. If QUIET is set to YES this implies that the
818# messages are off.
819# The default value is: NO.
820
87QUIET = YES 821QUIET = YES
822
823# The WARNINGS tag can be used to turn on/off the warning messages that are
824# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
825# this implies that the warnings are on.
826#
827# Tip: Turn warnings on while writing the documentation.
828# The default value is: YES.
829
88WARNINGS = YES 830WARNINGS = YES
831
832# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
833# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
834# will automatically be disabled.
835# The default value is: YES.
836
89WARN_IF_UNDOCUMENTED = YES 837WARN_IF_UNDOCUMENTED = YES
838
839# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
840# potential errors in the documentation, such as documenting some parameters in
841# a documented function twice, or documenting parameters that don't exist or
842# using markup commands wrongly.
843# The default value is: YES.
844
90WARN_IF_DOC_ERROR = YES 845WARN_IF_DOC_ERROR = YES
846
847# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
848# function parameter documentation. If set to NO, doxygen will accept that some
849# parameters have no documentation without warning.
850# The default value is: YES.
851
852WARN_IF_INCOMPLETE_DOC = YES
853
854# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
855# are documented, but have no documentation for their parameters or return
856# value. If set to NO, doxygen will only warn about wrong parameter
857# documentation, but not about the absence of documentation. If EXTRACT_ALL is
858# set to YES then this flag will automatically be disabled. See also
859# WARN_IF_INCOMPLETE_DOC
860# The default value is: NO.
861
91WARN_NO_PARAMDOC = YES 862WARN_NO_PARAMDOC = YES
863
864# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
865# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
866# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
867# at the end of the doxygen process doxygen will return with a non-zero status.
868# Possible values are: NO, YES and FAIL_ON_WARNINGS.
869# The default value is: NO.
870
871WARN_AS_ERROR = NO
872
873# The WARN_FORMAT tag determines the format of the warning messages that doxygen
874# can produce. The string should contain the $file, $line, and $text tags, which
875# will be replaced by the file and line number from which the warning originated
876# and the warning text. Optionally the format may contain $version, which will
877# be replaced by the version of the file (if it could be obtained via
878# FILE_VERSION_FILTER)
879# See also: WARN_LINE_FORMAT
880# The default value is: $file:$line: $text.
881
92WARN_FORMAT = "$file:$line: $text" 882WARN_FORMAT = "$file:$line: $text"
93WARN_LOGFILE = 883
884# In the $text part of the WARN_FORMAT command it is possible that a reference
885# to a more specific place is given. To make it easier to jump to this place
886# (outside of doxygen) the user can define a custom "cut" / "paste" string.
887# Example:
888# WARN_LINE_FORMAT = "'vi $file +$line'"
889# See also: WARN_FORMAT
890# The default value is: at line $line of file $file.
891
892WARN_LINE_FORMAT = "at line $line of file $file"
893
894# The WARN_LOGFILE tag can be used to specify a file to which warning and error
895# messages should be written. If left blank the output is written to standard
896# error (stderr). In case the file specified cannot be opened for writing the
897# warning and error messages are written to standard error. When as file - is
898# specified the warning and error messages are written to standard output
899# (stdout).
900
901WARN_LOGFILE = doxygen_warnings.log
902
94#--------------------------------------------------------------------------- 903#---------------------------------------------------------------------------
95# configuration options related to the input files 904# Configuration options related to the input files
96#--------------------------------------------------------------------------- 905#---------------------------------------------------------------------------
97INPUT = ../../src ../../contrib ../../doc 906
907# The INPUT tag is used to specify the files and/or directories that contain
908# documented source files. You may enter file names like myfile.cpp or
909# directories like /usr/src/myproject. Separate the files or directories with
910# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
911# Note: If this tag is empty the current directory is searched.
912
913INPUT = ../../src \
914 ../../contrib \
915 ../../doc
916
917# This tag can be used to specify the character encoding of the source files
918# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
919# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
920# documentation (see:
921# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
922# See also: INPUT_FILE_ENCODING
923# The default value is: UTF-8.
924
98INPUT_ENCODING = UTF-8 925INPUT_ENCODING = UTF-8
926
927# This tag can be used to specify the character encoding of the source files
928# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
929# character encoding on a per file pattern basis. Doxygen will compare the file
930# name with each pattern and apply the encoding instead of the default
931# INPUT_ENCODING) if there is a match. The character encodings are a list of the
932# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
933# "INPUT_ENCODING" for further information on supported encodings.
934
935INPUT_FILE_ENCODING =
936
937# If the value of the INPUT tag contains directories, you can use the
938# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
939# *.h) to filter out the source-files in the directories.
940#
941# Note that for custom extensions or not directly supported extensions you also
942# need to set EXTENSION_MAPPING for the extension otherwise the files are not
943# read by doxygen.
944#
945# Note the list of default checked file patterns might differ from the list of
946# default file extension mappings.
947#
948# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
949# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
950# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
951# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
952# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
953# *.vhdl, *.ucf, *.qsf and *.ice.
954
99FILE_PATTERNS = *.c \ 955FILE_PATTERNS = *.c \
100 *.cc \ 956 *.cc \
101 *.cxx \ 957 *.cxx \
@@ -145,161 +1001,1777 @@ FILE_PATTERNS = *.c \
145 *.F \ 1001 *.F \
146 *.VHD \ 1002 *.VHD \
147 *.VHDL 1003 *.VHDL
1004
1005# The RECURSIVE tag can be used to specify whether or not subdirectories should
1006# be searched for input files as well.
1007# The default value is: NO.
1008
148RECURSIVE = YES 1009RECURSIVE = YES
1010
1011# The EXCLUDE tag can be used to specify files and/or directories that should be
1012# excluded from the INPUT source files. This way you can easily exclude a
1013# subdirectory from a directory tree whose root is specified with the INPUT tag.
1014#
1015# Note that relative paths are relative to the directory from which doxygen is
1016# run.
1017
149EXCLUDE = 1018EXCLUDE =
1019
1020# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1021# directories that are symbolic links (a Unix file system feature) are excluded
1022# from the input.
1023# The default value is: NO.
1024
150EXCLUDE_SYMLINKS = NO 1025EXCLUDE_SYMLINKS = NO
151EXCLUDE_PATTERNS = */test_* */.svn/* */.git/* */perf_* .* 1026
1027# If the value of the INPUT tag contains directories, you can use the
1028# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1029# certain files from those directories.
1030#
1031# Note that the wildcards are matched against the file with absolute path, so to
1032# exclude all test directories for example use the pattern */test/*
1033
1034EXCLUDE_PATTERNS = */test_* \
1035 */.svn/* \
1036 */.git/* \
1037 */perf_* \
1038 .*
1039
1040# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1041# (namespaces, classes, functions, etc.) that should be excluded from the
1042# output. The symbol name can be a fully qualified name, a word, or if the
1043# wildcard * is used, a substring. Examples: ANamespace, AClass,
1044# ANamespace::AClass, ANamespace::*Test
1045#
1046# Note that the wildcards are matched against the file with absolute path, so to
1047# exclude all test directories use the pattern */test/*
1048
152EXCLUDE_SYMBOLS = 1049EXCLUDE_SYMBOLS =
1050
1051# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1052# that contain example code fragments that are included (see the \include
1053# command).
1054
153EXAMPLE_PATH = 1055EXAMPLE_PATH =
1056
1057# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1058# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1059# *.h) to filter out the source-files in the directories. If left blank all
1060# files are included.
1061
154EXAMPLE_PATTERNS = * 1062EXAMPLE_PATTERNS = *
1063
1064# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1065# searched for input files to be used with the \include or \dontinclude commands
1066# irrespective of the value of the RECURSIVE tag.
1067# The default value is: NO.
1068
155EXAMPLE_RECURSIVE = NO 1069EXAMPLE_RECURSIVE = NO
1070
1071# The IMAGE_PATH tag can be used to specify one or more files or directories
1072# that contain images that are to be included in the documentation (see the
1073# \image command).
1074
156IMAGE_PATH = 1075IMAGE_PATH =
1076
1077# The INPUT_FILTER tag can be used to specify a program that doxygen should
1078# invoke to filter for each input file. Doxygen will invoke the filter program
1079# by executing (via popen()) the command:
1080#
1081# <filter> <input-file>
1082#
1083# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1084# name of an input file. Doxygen will then use the output that the filter
1085# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1086# will be ignored.
1087#
1088# Note that the filter must not add or remove lines; it is applied before the
1089# code is scanned, but not when the output code is generated. If lines are added
1090# or removed, the anchors will not be placed correctly.
1091#
1092# Note that doxygen will use the data processed and written to standard output
1093# for further processing, therefore nothing else, like debug statements or used
1094# commands (so in case of a Windows batch file always use @echo OFF), should be
1095# written to standard output.
1096#
1097# Note that for custom extensions or not directly supported extensions you also
1098# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1099# properly processed by doxygen.
1100
157INPUT_FILTER = 1101INPUT_FILTER =
1102
1103# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1104# basis. Doxygen will compare the file name with each pattern and apply the
1105# filter if there is a match. The filters are a list of the form: pattern=filter
1106# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1107# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1108# patterns match the file name, INPUT_FILTER is applied.
1109#
1110# Note that for custom extensions or not directly supported extensions you also
1111# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1112# properly processed by doxygen.
1113
158FILTER_PATTERNS = 1114FILTER_PATTERNS =
1115
1116# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1117# INPUT_FILTER) will also be used to filter the input files that are used for
1118# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1119# The default value is: NO.
1120
159FILTER_SOURCE_FILES = NO 1121FILTER_SOURCE_FILES = NO
1122
1123# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1124# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1125# it is also possible to disable source filtering for a specific pattern using
1126# *.ext= (so without naming a filter).
1127# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1128
1129FILTER_SOURCE_PATTERNS =
1130
1131# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1132# is part of the input, its contents will be placed on the main page
1133# (index.html). This can be useful if you have a project on for instance GitHub
1134# and want to reuse the introduction page also for the doxygen output.
1135
1136USE_MDFILE_AS_MAINPAGE =
1137
1138# The Fortran standard specifies that for fixed formatted Fortran code all
1139# characters from position 72 are to be considered as comment. A common
1140# extension is to allow longer lines before the automatic comment starts. The
1141# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1142# be processed before the automatic comment starts.
1143# Minimum value: 7, maximum value: 10000, default value: 72.
1144
1145FORTRAN_COMMENT_AFTER = 72
1146
160#--------------------------------------------------------------------------- 1147#---------------------------------------------------------------------------
161# configuration options related to source browsing 1148# Configuration options related to source browsing
162#--------------------------------------------------------------------------- 1149#---------------------------------------------------------------------------
1150
1151# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1152# generated. Documented entities will be cross-referenced with these sources.
1153#
1154# Note: To get rid of all source code in the generated output, make sure that
1155# also VERBATIM_HEADERS is set to NO.
1156# The default value is: NO.
1157
163SOURCE_BROWSER = YES 1158SOURCE_BROWSER = YES
1159
1160# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1161# classes and enums directly into the documentation.
1162# The default value is: NO.
1163
164INLINE_SOURCES = YES 1164INLINE_SOURCES = YES
1165
1166# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1167# special comment blocks from generated source code fragments. Normal C, C++ and
1168# Fortran comments will always remain visible.
1169# The default value is: YES.
1170
165STRIP_CODE_COMMENTS = YES 1171STRIP_CODE_COMMENTS = YES
1172
1173# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1174# entity all documented functions referencing it will be listed.
1175# The default value is: NO.
1176
166REFERENCED_BY_RELATION = YES 1177REFERENCED_BY_RELATION = YES
1178
1179# If the REFERENCES_RELATION tag is set to YES then for each documented function
1180# all documented entities called/used by that function will be listed.
1181# The default value is: NO.
1182
167REFERENCES_RELATION = YES 1183REFERENCES_RELATION = YES
1184
1185# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1186# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1187# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1188# link to the documentation.
1189# The default value is: YES.
1190
168REFERENCES_LINK_SOURCE = YES 1191REFERENCES_LINK_SOURCE = YES
1192
1193# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1194# source code will show a tooltip with additional information such as prototype,
1195# brief description and links to the definition and documentation. Since this
1196# will make the HTML file larger and loading of large files a bit slower, you
1197# can opt to disable this feature.
1198# The default value is: YES.
1199# This tag requires that the tag SOURCE_BROWSER is set to YES.
1200
1201SOURCE_TOOLTIPS = YES
1202
1203# If the USE_HTAGS tag is set to YES then the references to source code will
1204# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1205# source browser. The htags tool is part of GNU's global source tagging system
1206# (see https://www.gnu.org/software/global/global.html). You will need version
1207# 4.8.6 or higher.
1208#
1209# To use it do the following:
1210# - Install the latest version of global
1211# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1212# - Make sure the INPUT points to the root of the source tree
1213# - Run doxygen as normal
1214#
1215# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1216# tools must be available from the command line (i.e. in the search path).
1217#
1218# The result: instead of the source browser generated by doxygen, the links to
1219# source code will now point to the output of htags.
1220# The default value is: NO.
1221# This tag requires that the tag SOURCE_BROWSER is set to YES.
1222
169USE_HTAGS = NO 1223USE_HTAGS = NO
1224
1225# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1226# verbatim copy of the header file for each class for which an include is
1227# specified. Set to NO to disable this.
1228# See also: Section \class.
1229# The default value is: YES.
1230
170VERBATIM_HEADERS = YES 1231VERBATIM_HEADERS = YES
1232
1233# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1234# clang parser (see:
1235# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1236# performance. This can be particularly helpful with template rich C++ code for
1237# which doxygen's built-in parser lacks the necessary type information.
1238# Note: The availability of this option depends on whether or not doxygen was
1239# generated with the -Duse_libclang=ON option for CMake.
1240# The default value is: NO.
1241
1242CLANG_ASSISTED_PARSING = NO
1243
1244# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1245# tag is set to YES then doxygen will add the directory of each input to the
1246# include path.
1247# The default value is: YES.
1248# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1249
1250CLANG_ADD_INC_PATHS = YES
1251
1252# If clang assisted parsing is enabled you can provide the compiler with command
1253# line options that you would normally use when invoking the compiler. Note that
1254# the include paths will already be set by doxygen for the files and directories
1255# specified with INPUT and INCLUDE_PATH.
1256# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1257
1258CLANG_OPTIONS =
1259
1260# If clang assisted parsing is enabled you can provide the clang parser with the
1261# path to the directory containing a file called compile_commands.json. This
1262# file is the compilation database (see:
1263# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1264# options used when the source files were built. This is equivalent to
1265# specifying the -p option to a clang tool, such as clang-check. These options
1266# will then be passed to the parser. Any options specified with CLANG_OPTIONS
1267# will be added as well.
1268# Note: The availability of this option depends on whether or not doxygen was
1269# generated with the -Duse_libclang=ON option for CMake.
1270
1271CLANG_DATABASE_PATH =
1272
171#--------------------------------------------------------------------------- 1273#---------------------------------------------------------------------------
172# configuration options related to the alphabetical class index 1274# Configuration options related to the alphabetical class index
173#--------------------------------------------------------------------------- 1275#---------------------------------------------------------------------------
1276
1277# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1278# compounds will be generated. Enable this if the project contains a lot of
1279# classes, structs, unions or interfaces.
1280# The default value is: YES.
1281
174ALPHABETICAL_INDEX = YES 1282ALPHABETICAL_INDEX = YES
175COLS_IN_ALPHA_INDEX = 3 1283
1284# In case all classes in a project start with a common prefix, all classes will
1285# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1286# can be used to specify a prefix (or a list of prefixes) that should be ignored
1287# while generating the index headers.
1288# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1289
176IGNORE_PREFIX = GNUNET_ 1290IGNORE_PREFIX = GNUNET_
1291
177#--------------------------------------------------------------------------- 1292#---------------------------------------------------------------------------
178# configuration options related to the HTML output 1293# Configuration options related to the HTML output
179#--------------------------------------------------------------------------- 1294#---------------------------------------------------------------------------
1295
1296# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1297# The default value is: YES.
1298
180GENERATE_HTML = YES 1299GENERATE_HTML = YES
1300
1301# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1302# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1303# it.
1304# The default directory is: html.
1305# This tag requires that the tag GENERATE_HTML is set to YES.
1306
181HTML_OUTPUT = html 1307HTML_OUTPUT = html
1308
1309# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1310# generated HTML page (for example: .htm, .php, .asp).
1311# The default value is: .html.
1312# This tag requires that the tag GENERATE_HTML is set to YES.
1313
182HTML_FILE_EXTENSION = .html 1314HTML_FILE_EXTENSION = .html
1315
1316# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1317# each generated HTML page. If the tag is left blank doxygen will generate a
1318# standard header.
1319#
1320# To get valid HTML the header file that includes any scripts and style sheets
1321# that doxygen needs, which is dependent on the configuration options used (e.g.
1322# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1323# default header using
1324# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1325# YourConfigFile
1326# and then modify the file new_header.html. See also section "Doxygen usage"
1327# for information on how to generate the default header that doxygen normally
1328# uses.
1329# Note: The header is subject to change so you typically have to regenerate the
1330# default header when upgrading to a newer version of doxygen. For a description
1331# of the possible markers and block names see the documentation.
1332# This tag requires that the tag GENERATE_HTML is set to YES.
1333
183HTML_HEADER = 1334HTML_HEADER =
1335
1336# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1337# generated HTML page. If the tag is left blank doxygen will generate a standard
1338# footer. See HTML_HEADER for more information on how to generate a default
1339# footer and what special commands can be used inside the footer. See also
1340# section "Doxygen usage" for information on how to generate the default footer
1341# that doxygen normally uses.
1342# This tag requires that the tag GENERATE_HTML is set to YES.
1343
184HTML_FOOTER = 1344HTML_FOOTER =
1345
1346# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1347# sheet that is used by each HTML page. It can be used to fine-tune the look of
1348# the HTML output. If left blank doxygen will generate a default style sheet.
1349# See also section "Doxygen usage" for information on how to generate the style
1350# sheet that doxygen normally uses.
1351# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1352# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1353# obsolete.
1354# This tag requires that the tag GENERATE_HTML is set to YES.
1355
185HTML_STYLESHEET = 1356HTML_STYLESHEET =
186GENERATE_HTMLHELP = NO 1357
1358# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1359# cascading style sheets that are included after the standard style sheets
1360# created by doxygen. Using this option one can overrule certain style aspects.
1361# This is preferred over using HTML_STYLESHEET since it does not replace the
1362# standard style sheet and is therefore more robust against future updates.
1363# Doxygen will copy the style sheet files to the output directory.
1364# Note: The order of the extra style sheet files is of importance (e.g. the last
1365# style sheet in the list overrules the setting of the previous ones in the
1366# list). For an example see the documentation.
1367# This tag requires that the tag GENERATE_HTML is set to YES.
1368
1369HTML_EXTRA_STYLESHEET =
1370
1371# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1372# other source files which should be copied to the HTML output directory. Note
1373# that these files will be copied to the base HTML output directory. Use the
1374# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1375# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1376# files will be copied as-is; there are no commands or markers available.
1377# This tag requires that the tag GENERATE_HTML is set to YES.
1378
1379HTML_EXTRA_FILES =
1380
1381# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1382# should be rendered with a dark or light theme. Default setting AUTO_LIGHT
1383# enables light output unless the user preference is dark output. Other options
1384# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to
1385# default to dark mode unless the user prefers light mode, and TOGGLE to let the
1386# user toggle between dark and light mode via a button.
1387# Possible values are: LIGHT Always generate light output., DARK Always generate
1388# dark output., AUTO_LIGHT Automatically set the mode according to the user
1389# preference, use light mode if no preference is set (the default)., AUTO_DARK
1390# Automatically set the mode according to the user preference, use dark mode if
1391# no preference is set. and TOGGLE Allow to user to switch between light and
1392# dark mode via a button..
1393# The default value is: AUTO_LIGHT.
1394# This tag requires that the tag GENERATE_HTML is set to YES.
1395
1396HTML_COLORSTYLE = AUTO_LIGHT
1397
1398# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1399# will adjust the colors in the style sheet and background images according to
1400# this color. Hue is specified as an angle on a color-wheel, see
1401# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1402# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1403# purple, and 360 is red again.
1404# Minimum value: 0, maximum value: 359, default value: 220.
1405# This tag requires that the tag GENERATE_HTML is set to YES.
1406
1407HTML_COLORSTYLE_HUE = 220
1408
1409# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1410# in the HTML output. For a value of 0 the output will use gray-scales only. A
1411# value of 255 will produce the most vivid colors.
1412# Minimum value: 0, maximum value: 255, default value: 100.
1413# This tag requires that the tag GENERATE_HTML is set to YES.
1414
1415HTML_COLORSTYLE_SAT = 100
1416
1417# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1418# luminance component of the colors in the HTML output. Values below 100
1419# gradually make the output lighter, whereas values above 100 make the output
1420# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1421# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1422# change the gamma.
1423# Minimum value: 40, maximum value: 240, default value: 80.
1424# This tag requires that the tag GENERATE_HTML is set to YES.
1425
1426HTML_COLORSTYLE_GAMMA = 80
1427
1428# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1429# page will contain the date and time when the page was generated. Setting this
1430# to YES can help to show when doxygen was last run and thus if the
1431# documentation is up to date.
1432# The default value is: NO.
1433# This tag requires that the tag GENERATE_HTML is set to YES.
1434
1435HTML_TIMESTAMP = NO
1436
1437# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1438# documentation will contain a main index with vertical navigation menus that
1439# are dynamically created via JavaScript. If disabled, the navigation index will
1440# consists of multiple levels of tabs that are statically embedded in every HTML
1441# page. Disable this option to support browsers that do not have JavaScript,
1442# like the Qt help browser.
1443# The default value is: YES.
1444# This tag requires that the tag GENERATE_HTML is set to YES.
1445
1446HTML_DYNAMIC_MENUS = YES
1447
1448# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1449# documentation will contain sections that can be hidden and shown after the
1450# page has loaded.
1451# The default value is: NO.
1452# This tag requires that the tag GENERATE_HTML is set to YES.
1453
1454HTML_DYNAMIC_SECTIONS = NO
1455
1456# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1457# shown in the various tree structured indices initially; the user can expand
1458# and collapse entries dynamically later on. Doxygen will expand the tree to
1459# such a level that at most the specified number of entries are visible (unless
1460# a fully collapsed tree already exceeds this amount). So setting the number of
1461# entries 1 will produce a full collapsed tree by default. 0 is a special value
1462# representing an infinite number of entries and will result in a full expanded
1463# tree by default.
1464# Minimum value: 0, maximum value: 9999, default value: 100.
1465# This tag requires that the tag GENERATE_HTML is set to YES.
1466
1467HTML_INDEX_NUM_ENTRIES = 100
1468
1469# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1470# generated that can be used as input for Apple's Xcode 3 integrated development
1471# environment (see:
1472# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1473# create a documentation set, doxygen will generate a Makefile in the HTML
1474# output directory. Running make will produce the docset in that directory and
1475# running make install will install the docset in
1476# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1477# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1478# genXcode/_index.html for more information.
1479# The default value is: NO.
1480# This tag requires that the tag GENERATE_HTML is set to YES.
1481
187GENERATE_DOCSET = NO 1482GENERATE_DOCSET = NO
1483
1484# This tag determines the name of the docset feed. A documentation feed provides
1485# an umbrella under which multiple documentation sets from a single provider
1486# (such as a company or product suite) can be grouped.
1487# The default value is: Doxygen generated docs.
1488# This tag requires that the tag GENERATE_DOCSET is set to YES.
1489
188DOCSET_FEEDNAME = "GNUnet Source Documentation" 1490DOCSET_FEEDNAME = "GNUnet Source Documentation"
1491
1492# This tag determines the URL of the docset feed. A documentation feed provides
1493# an umbrella under which multiple documentation sets from a single provider
1494# (such as a company or product suite) can be grouped.
1495# This tag requires that the tag GENERATE_DOCSET is set to YES.
1496
1497DOCSET_FEEDURL =
1498
1499# This tag specifies a string that should uniquely identify the documentation
1500# set bundle. This should be a reverse domain-name style string, e.g.
1501# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1502# The default value is: org.doxygen.Project.
1503# This tag requires that the tag GENERATE_DOCSET is set to YES.
1504
189DOCSET_BUNDLE_ID = org.gnunet 1505DOCSET_BUNDLE_ID = org.gnunet
190HTML_DYNAMIC_SECTIONS = NO 1506
1507# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1508# the documentation publisher. This should be a reverse domain-name style
1509# string, e.g. com.mycompany.MyDocSet.documentation.
1510# The default value is: org.doxygen.Publisher.
1511# This tag requires that the tag GENERATE_DOCSET is set to YES.
1512
1513DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1514
1515# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1516# The default value is: Publisher.
1517# This tag requires that the tag GENERATE_DOCSET is set to YES.
1518
1519DOCSET_PUBLISHER_NAME = Publisher
1520
1521# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1522# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1523# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1524# on Windows. In the beginning of 2021 Microsoft took the original page, with
1525# a.o. the download links, offline the HTML help workshop was already many years
1526# in maintenance mode). You can download the HTML help workshop from the web
1527# archives at Installation executable (see:
1528# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1529# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1530#
1531# The HTML Help Workshop contains a compiler that can convert all HTML output
1532# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1533# files are now used as the Windows 98 help format, and will replace the old
1534# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1535# HTML files also contain an index, a table of contents, and you can search for
1536# words in the documentation. The HTML workshop also contains a viewer for
1537# compressed HTML files.
1538# The default value is: NO.
1539# This tag requires that the tag GENERATE_HTML is set to YES.
1540
1541GENERATE_HTMLHELP = NO
1542
1543# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1544# file. You can add a path in front of the file if the result should not be
1545# written to the html output directory.
1546# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1547
191CHM_FILE = 1548CHM_FILE =
1549
1550# The HHC_LOCATION tag can be used to specify the location (absolute path
1551# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1552# doxygen will try to run the HTML help compiler on the generated index.hhp.
1553# The file has to be specified with full path.
1554# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1555
192HHC_LOCATION = 1556HHC_LOCATION =
1557
1558# The GENERATE_CHI flag controls if a separate .chi index file is generated
1559# (YES) or that it should be included in the main .chm file (NO).
1560# The default value is: NO.
1561# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1562
193GENERATE_CHI = NO 1563GENERATE_CHI = NO
1564
1565# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1566# and project file content.
1567# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1568
194CHM_INDEX_ENCODING = 1569CHM_INDEX_ENCODING =
1570
1571# The BINARY_TOC flag controls whether a binary table of contents is generated
1572# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1573# enables the Previous and Next buttons.
1574# The default value is: NO.
1575# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1576
195BINARY_TOC = NO 1577BINARY_TOC = NO
1578
1579# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1580# the table of contents of the HTML help documentation and to the tree view.
1581# The default value is: NO.
1582# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1583
196TOC_EXPAND = NO 1584TOC_EXPAND = NO
197DISABLE_INDEX = NO 1585
1586# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1587# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1588# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1589# (.qch) of the generated HTML documentation.
1590# The default value is: NO.
1591# This tag requires that the tag GENERATE_HTML is set to YES.
1592
1593GENERATE_QHP = NO
1594
1595# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1596# the file name of the resulting .qch file. The path specified is relative to
1597# the HTML output folder.
1598# This tag requires that the tag GENERATE_QHP is set to YES.
1599
1600QCH_FILE =
1601
1602# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1603# Project output. For more information please see Qt Help Project / Namespace
1604# (see:
1605# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1606# The default value is: org.doxygen.Project.
1607# This tag requires that the tag GENERATE_QHP is set to YES.
1608
1609QHP_NAMESPACE = org.doxygen.Project
1610
1611# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1612# Help Project output. For more information please see Qt Help Project / Virtual
1613# Folders (see:
1614# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1615# The default value is: doc.
1616# This tag requires that the tag GENERATE_QHP is set to YES.
1617
1618QHP_VIRTUAL_FOLDER = doc
1619
1620# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1621# filter to add. For more information please see Qt Help Project / Custom
1622# Filters (see:
1623# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1624# This tag requires that the tag GENERATE_QHP is set to YES.
1625
1626QHP_CUST_FILTER_NAME =
1627
1628# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1629# custom filter to add. For more information please see Qt Help Project / Custom
1630# Filters (see:
1631# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1632# This tag requires that the tag GENERATE_QHP is set to YES.
1633
1634QHP_CUST_FILTER_ATTRS =
1635
1636# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1637# project's filter section matches. Qt Help Project / Filter Attributes (see:
1638# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1639# This tag requires that the tag GENERATE_QHP is set to YES.
1640
1641QHP_SECT_FILTER_ATTRS =
1642
1643# The QHG_LOCATION tag can be used to specify the location (absolute path
1644# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1645# run qhelpgenerator on the generated .qhp file.
1646# This tag requires that the tag GENERATE_QHP is set to YES.
1647
1648QHG_LOCATION =
1649
1650# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1651# generated, together with the HTML files, they form an Eclipse help plugin. To
1652# install this plugin and make it available under the help contents menu in
1653# Eclipse, the contents of the directory containing the HTML and XML files needs
1654# to be copied into the plugins directory of eclipse. The name of the directory
1655# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1656# After copying Eclipse needs to be restarted before the help appears.
1657# The default value is: NO.
1658# This tag requires that the tag GENERATE_HTML is set to YES.
1659
1660GENERATE_ECLIPSEHELP = NO
1661
1662# A unique identifier for the Eclipse help plugin. When installing the plugin
1663# the directory name containing the HTML and XML files should also have this
1664# name. Each documentation set should have its own identifier.
1665# The default value is: org.doxygen.Project.
1666# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1667
1668ECLIPSE_DOC_ID = org.doxygen.Project
1669
1670# If you want full control over the layout of the generated HTML pages it might
1671# be necessary to disable the index and replace it with your own. The
1672# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1673# of each HTML page. A value of NO enables the index and the value YES disables
1674# it. Since the tabs in the index contain the same information as the navigation
1675# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1676# The default value is: NO.
1677# This tag requires that the tag GENERATE_HTML is set to YES.
1678
1679DISABLE_INDEX = YES
1680
1681# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1682# structure should be generated to display hierarchical information. If the tag
1683# value is set to YES, a side panel will be generated containing a tree-like
1684# index structure (just like the one that is generated for HTML Help). For this
1685# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1686# (i.e. any modern browser). Windows users are probably better off using the
1687# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1688# further fine tune the look of the index (see "Fine-tuning the output"). As an
1689# example, the default style sheet generated by doxygen has an example that
1690# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1691# Since the tree basically has the same information as the tab index, you could
1692# consider setting DISABLE_INDEX to YES when enabling this option.
1693# The default value is: NO.
1694# This tag requires that the tag GENERATE_HTML is set to YES.
1695
1696GENERATE_TREEVIEW = YES
1697
1698# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1699# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1700# area (value NO) or if it should extend to the full height of the window (value
1701# YES). Setting this to YES gives a layout similar to
1702# https://docs.readthedocs.io with more room for contents, but less room for the
1703# project logo, title, and description. If either GENERATE_TREEVIEW or
1704# DISABLE_INDEX is set to NO, this option has no effect.
1705# The default value is: NO.
1706# This tag requires that the tag GENERATE_HTML is set to YES.
1707
1708FULL_SIDEBAR = NO
1709
1710# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1711# doxygen will group on one line in the generated HTML documentation.
1712#
1713# Note that a value of 0 will completely suppress the enum values from appearing
1714# in the overview section.
1715# Minimum value: 0, maximum value: 20, default value: 4.
1716# This tag requires that the tag GENERATE_HTML is set to YES.
1717
198ENUM_VALUES_PER_LINE = 4 1718ENUM_VALUES_PER_LINE = 4
199GENERATE_TREEVIEW = NONE 1719
1720# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1721# to set the initial width (in pixels) of the frame in which the tree is shown.
1722# Minimum value: 0, maximum value: 1500, default value: 250.
1723# This tag requires that the tag GENERATE_HTML is set to YES.
1724
200TREEVIEW_WIDTH = 250 1725TREEVIEW_WIDTH = 250
1726
1727# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1728# external symbols imported via tag files in a separate window.
1729# The default value is: NO.
1730# This tag requires that the tag GENERATE_HTML is set to YES.
1731
1732EXT_LINKS_IN_WINDOW = NO
1733
1734# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1735# addresses.
1736# The default value is: YES.
1737# This tag requires that the tag GENERATE_HTML is set to YES.
1738
1739OBFUSCATE_EMAILS = YES
1740
1741# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1742# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1743# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1744# the HTML output. These images will generally look nicer at scaled resolutions.
1745# Possible values are: png (the default) and svg (looks nicer but requires the
1746# pdf2svg or inkscape tool).
1747# The default value is: png.
1748# This tag requires that the tag GENERATE_HTML is set to YES.
1749
1750HTML_FORMULA_FORMAT = png
1751
1752# Use this tag to change the font size of LaTeX formulas included as images in
1753# the HTML documentation. When you change the font size after a successful
1754# doxygen run you need to manually remove any form_*.png images from the HTML
1755# output directory to force them to be regenerated.
1756# Minimum value: 8, maximum value: 50, default value: 10.
1757# This tag requires that the tag GENERATE_HTML is set to YES.
1758
201FORMULA_FONTSIZE = 10 1759FORMULA_FONTSIZE = 10
1760
1761# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1762# to create new LaTeX commands to be used in formulas as building blocks. See
1763# the section "Including formulas" for details.
1764
1765FORMULA_MACROFILE =
1766
1767# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1768# https://www.mathjax.org) which uses client side JavaScript for the rendering
1769# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1770# installed or if you want to formulas look prettier in the HTML output. When
1771# enabled you may also need to install MathJax separately and configure the path
1772# to it using the MATHJAX_RELPATH option.
1773# The default value is: NO.
1774# This tag requires that the tag GENERATE_HTML is set to YES.
1775
1776USE_MATHJAX = NO
1777
1778# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1779# Note that the different versions of MathJax have different requirements with
1780# regards to the different settings, so it is possible that also other MathJax
1781# settings have to be changed when switching between the different MathJax
1782# versions.
1783# Possible values are: MathJax_2 and MathJax_3.
1784# The default value is: MathJax_2.
1785# This tag requires that the tag USE_MATHJAX is set to YES.
1786
1787MATHJAX_VERSION = MathJax_2
1788
1789# When MathJax is enabled you can set the default output format to be used for
1790# the MathJax output. For more details about the output format see MathJax
1791# version 2 (see:
1792# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1793# (see:
1794# http://docs.mathjax.org/en/latest/web/components/output.html).
1795# Possible values are: HTML-CSS (which is slower, but has the best
1796# compatibility. This is the name for Mathjax version 2, for MathJax version 3
1797# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1798# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1799# is the name for Mathjax version 3, for MathJax version 2 this will be
1800# translated into HTML-CSS) and SVG.
1801# The default value is: HTML-CSS.
1802# This tag requires that the tag USE_MATHJAX is set to YES.
1803
1804MATHJAX_FORMAT = HTML-CSS
1805
1806# When MathJax is enabled you need to specify the location relative to the HTML
1807# output directory using the MATHJAX_RELPATH option. The destination directory
1808# should contain the MathJax.js script. For instance, if the mathjax directory
1809# is located at the same level as the HTML output directory, then
1810# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1811# Content Delivery Network so you can quickly see the result without installing
1812# MathJax. However, it is strongly recommended to install a local copy of
1813# MathJax from https://www.mathjax.org before deployment. The default value is:
1814# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1815# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1816# This tag requires that the tag USE_MATHJAX is set to YES.
1817
1818MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1819
1820# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1821# extension names that should be enabled during MathJax rendering. For example
1822# for MathJax version 2 (see
1823# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1824# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1825# For example for MathJax version 3 (see
1826# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1827# MATHJAX_EXTENSIONS = ams
1828# This tag requires that the tag USE_MATHJAX is set to YES.
1829
1830MATHJAX_EXTENSIONS =
1831
1832# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1833# of code that will be used on startup of the MathJax code. See the MathJax site
1834# (see:
1835# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1836# example see the documentation.
1837# This tag requires that the tag USE_MATHJAX is set to YES.
1838
1839MATHJAX_CODEFILE =
1840
1841# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1842# the HTML output. The underlying search engine uses javascript and DHTML and
1843# should work on any modern browser. Note that when using HTML help
1844# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1845# there is already a search function so this one should typically be disabled.
1846# For large projects the javascript based search engine can be slow, then
1847# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1848# search using the keyboard; to jump to the search box use <access key> + S
1849# (what the <access key> is depends on the OS and browser, but it is typically
1850# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1851# key> to jump into the search results window, the results can be navigated
1852# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1853# the search. The filter options can be selected when the cursor is inside the
1854# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1855# to select a filter and <Enter> or <escape> to activate or cancel the filter
1856# option.
1857# The default value is: YES.
1858# This tag requires that the tag GENERATE_HTML is set to YES.
1859
1860SEARCHENGINE = YES
1861
1862# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1863# implemented using a web server instead of a web client using JavaScript. There
1864# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1865# setting. When disabled, doxygen will generate a PHP script for searching and
1866# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1867# and searching needs to be provided by external tools. See the section
1868# "External Indexing and Searching" for details.
1869# The default value is: NO.
1870# This tag requires that the tag SEARCHENGINE is set to YES.
1871
1872SERVER_BASED_SEARCH = NO
1873
1874# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1875# script for searching. Instead the search results are written to an XML file
1876# which needs to be processed by an external indexer. Doxygen will invoke an
1877# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1878# search results.
1879#
1880# Doxygen ships with an example indexer (doxyindexer) and search engine
1881# (doxysearch.cgi) which are based on the open source search engine library
1882# Xapian (see:
1883# https://xapian.org/).
1884#
1885# See the section "External Indexing and Searching" for details.
1886# The default value is: NO.
1887# This tag requires that the tag SEARCHENGINE is set to YES.
1888
1889EXTERNAL_SEARCH = NO
1890
1891# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1892# which will return the search results when EXTERNAL_SEARCH is enabled.
1893#
1894# Doxygen ships with an example indexer (doxyindexer) and search engine
1895# (doxysearch.cgi) which are based on the open source search engine library
1896# Xapian (see:
1897# https://xapian.org/). See the section "External Indexing and Searching" for
1898# details.
1899# This tag requires that the tag SEARCHENGINE is set to YES.
1900
1901SEARCHENGINE_URL =
1902
1903# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1904# search data is written to a file for indexing by an external tool. With the
1905# SEARCHDATA_FILE tag the name of this file can be specified.
1906# The default file is: searchdata.xml.
1907# This tag requires that the tag SEARCHENGINE is set to YES.
1908
1909SEARCHDATA_FILE = searchdata.xml
1910
1911# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1912# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1913# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1914# projects and redirect the results back to the right project.
1915# This tag requires that the tag SEARCHENGINE is set to YES.
1916
1917EXTERNAL_SEARCH_ID =
1918
1919# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1920# projects other than the one defined by this configuration file, but that are
1921# all added to the same external search index. Each project needs to have a
1922# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1923# to a relative location where the documentation can be found. The format is:
1924# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1925# This tag requires that the tag SEARCHENGINE is set to YES.
1926
1927EXTRA_SEARCH_MAPPINGS =
1928
202#--------------------------------------------------------------------------- 1929#---------------------------------------------------------------------------
203# configuration options related to the LaTeX output 1930# Configuration options related to the LaTeX output
204#--------------------------------------------------------------------------- 1931#---------------------------------------------------------------------------
1932
1933# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1934# The default value is: YES.
1935
205GENERATE_LATEX = NO 1936GENERATE_LATEX = NO
1937
1938# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1939# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1940# it.
1941# The default directory is: latex.
1942# This tag requires that the tag GENERATE_LATEX is set to YES.
1943
206LATEX_OUTPUT = latex 1944LATEX_OUTPUT = latex
1945
1946# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1947# invoked.
1948#
1949# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1950# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1951# chosen this is overwritten by pdflatex. For specific output languages the
1952# default can have been set differently, this depends on the implementation of
1953# the output language.
1954# This tag requires that the tag GENERATE_LATEX is set to YES.
1955
207LATEX_CMD_NAME = latex 1956LATEX_CMD_NAME = latex
1957
1958# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1959# index for LaTeX.
1960# Note: This tag is used in the Makefile / make.bat.
1961# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1962# (.tex).
1963# The default file is: makeindex.
1964# This tag requires that the tag GENERATE_LATEX is set to YES.
1965
208MAKEINDEX_CMD_NAME = makeindex 1966MAKEINDEX_CMD_NAME = makeindex
1967
1968# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1969# generate index for LaTeX. In case there is no backslash (\) as first character
1970# it will be automatically added in the LaTeX code.
1971# Note: This tag is used in the generated output file (.tex).
1972# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1973# The default value is: makeindex.
1974# This tag requires that the tag GENERATE_LATEX is set to YES.
1975
1976LATEX_MAKEINDEX_CMD = makeindex
1977
1978# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1979# documents. This may be useful for small projects and may help to save some
1980# trees in general.
1981# The default value is: NO.
1982# This tag requires that the tag GENERATE_LATEX is set to YES.
1983
209COMPACT_LATEX = YES 1984COMPACT_LATEX = YES
1985
1986# The PAPER_TYPE tag can be used to set the paper type that is used by the
1987# printer.
1988# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1989# 14 inches) and executive (7.25 x 10.5 inches).
1990# The default value is: a4.
1991# This tag requires that the tag GENERATE_LATEX is set to YES.
1992
210PAPER_TYPE = a4 1993PAPER_TYPE = a4
1994
1995# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1996# that should be included in the LaTeX output. The package can be specified just
1997# by its name or with the correct syntax as to be used with the LaTeX
1998# \usepackage command. To get the times font for instance you can specify :
1999# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
2000# To use the option intlimits with the amsmath package you can specify:
2001# EXTRA_PACKAGES=[intlimits]{amsmath}
2002# If left blank no extra packages will be included.
2003# This tag requires that the tag GENERATE_LATEX is set to YES.
2004
211EXTRA_PACKAGES = 2005EXTRA_PACKAGES =
2006
2007# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2008# the generated LaTeX document. The header should contain everything until the
2009# first chapter. If it is left blank doxygen will generate a standard header. It
2010# is highly recommended to start with a default header using
2011# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2012# and then modify the file new_header.tex. See also section "Doxygen usage" for
2013# information on how to generate the default header that doxygen normally uses.
2014#
2015# Note: Only use a user-defined header if you know what you are doing!
2016# Note: The header is subject to change so you typically have to regenerate the
2017# default header when upgrading to a newer version of doxygen. The following
2018# commands have a special meaning inside the header (and footer): For a
2019# description of the possible markers and block names see the documentation.
2020# This tag requires that the tag GENERATE_LATEX is set to YES.
2021
212LATEX_HEADER = 2022LATEX_HEADER =
2023
2024# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2025# the generated LaTeX document. The footer should contain everything after the
2026# last chapter. If it is left blank doxygen will generate a standard footer. See
2027# LATEX_HEADER for more information on how to generate a default footer and what
2028# special commands can be used inside the footer. See also section "Doxygen
2029# usage" for information on how to generate the default footer that doxygen
2030# normally uses. Note: Only use a user-defined footer if you know what you are
2031# doing!
2032# This tag requires that the tag GENERATE_LATEX is set to YES.
2033
2034LATEX_FOOTER =
2035
2036# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2037# LaTeX style sheets that are included after the standard style sheets created
2038# by doxygen. Using this option one can overrule certain style aspects. Doxygen
2039# will copy the style sheet files to the output directory.
2040# Note: The order of the extra style sheet files is of importance (e.g. the last
2041# style sheet in the list overrules the setting of the previous ones in the
2042# list).
2043# This tag requires that the tag GENERATE_LATEX is set to YES.
2044
2045LATEX_EXTRA_STYLESHEET =
2046
2047# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2048# other source files which should be copied to the LATEX_OUTPUT output
2049# directory. Note that the files will be copied as-is; there are no commands or
2050# markers available.
2051# This tag requires that the tag GENERATE_LATEX is set to YES.
2052
2053LATEX_EXTRA_FILES =
2054
2055# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2056# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2057# contain links (just like the HTML output) instead of page references. This
2058# makes the output suitable for online browsing using a PDF viewer.
2059# The default value is: YES.
2060# This tag requires that the tag GENERATE_LATEX is set to YES.
2061
213PDF_HYPERLINKS = YES 2062PDF_HYPERLINKS = YES
2063
2064# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2065# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2066# files. Set this option to YES, to get a higher quality PDF documentation.
2067#
2068# See also section LATEX_CMD_NAME for selecting the engine.
2069# The default value is: YES.
2070# This tag requires that the tag GENERATE_LATEX is set to YES.
2071
214USE_PDFLATEX = YES 2072USE_PDFLATEX = YES
2073
2074# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2075# command to the generated LaTeX files. This will instruct LaTeX to keep running
2076# if errors occur, instead of asking the user for help.
2077# The default value is: NO.
2078# This tag requires that the tag GENERATE_LATEX is set to YES.
2079
215LATEX_BATCHMODE = NO 2080LATEX_BATCHMODE = NO
2081
2082# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2083# index chapters (such as File Index, Compound Index, etc.) in the output.
2084# The default value is: NO.
2085# This tag requires that the tag GENERATE_LATEX is set to YES.
2086
216LATEX_HIDE_INDICES = NO 2087LATEX_HIDE_INDICES = NO
2088
2089# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2090# bibliography, e.g. plainnat, or ieeetr. See
2091# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2092# The default value is: plain.
2093# This tag requires that the tag GENERATE_LATEX is set to YES.
2094
2095LATEX_BIB_STYLE = plain
2096
2097# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2098# page will contain the date and time when the page was generated. Setting this
2099# to NO can help when comparing the output of multiple runs.
2100# The default value is: NO.
2101# This tag requires that the tag GENERATE_LATEX is set to YES.
2102
2103LATEX_TIMESTAMP = NO
2104
2105# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2106# path from which the emoji images will be read. If a relative path is entered,
2107# it will be relative to the LATEX_OUTPUT directory. If left blank the
2108# LATEX_OUTPUT directory will be used.
2109# This tag requires that the tag GENERATE_LATEX is set to YES.
2110
2111LATEX_EMOJI_DIRECTORY =
2112
217#--------------------------------------------------------------------------- 2113#---------------------------------------------------------------------------
218# configuration options related to the RTF output 2114# Configuration options related to the RTF output
219#--------------------------------------------------------------------------- 2115#---------------------------------------------------------------------------
2116
2117# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2118# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2119# readers/editors.
2120# The default value is: NO.
2121
220GENERATE_RTF = NO 2122GENERATE_RTF = NO
2123
2124# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2125# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2126# it.
2127# The default directory is: rtf.
2128# This tag requires that the tag GENERATE_RTF is set to YES.
2129
221RTF_OUTPUT = rtf 2130RTF_OUTPUT = rtf
2131
2132# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2133# documents. This may be useful for small projects and may help to save some
2134# trees in general.
2135# The default value is: NO.
2136# This tag requires that the tag GENERATE_RTF is set to YES.
2137
222COMPACT_RTF = NO 2138COMPACT_RTF = NO
2139
2140# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2141# contain hyperlink fields. The RTF file will contain links (just like the HTML
2142# output) instead of page references. This makes the output suitable for online
2143# browsing using Word or some other Word compatible readers that support those
2144# fields.
2145#
2146# Note: WordPad (write) and others do not support links.
2147# The default value is: NO.
2148# This tag requires that the tag GENERATE_RTF is set to YES.
2149
223RTF_HYPERLINKS = NO 2150RTF_HYPERLINKS = NO
2151
2152# Load stylesheet definitions from file. Syntax is similar to doxygen's
2153# configuration file, i.e. a series of assignments. You only have to provide
2154# replacements, missing definitions are set to their default value.
2155#
2156# See also section "Doxygen usage" for information on how to generate the
2157# default style sheet that doxygen normally uses.
2158# This tag requires that the tag GENERATE_RTF is set to YES.
2159
224RTF_STYLESHEET_FILE = 2160RTF_STYLESHEET_FILE =
2161
2162# Set optional variables used in the generation of an RTF document. Syntax is
2163# similar to doxygen's configuration file. A template extensions file can be
2164# generated using doxygen -e rtf extensionFile.
2165# This tag requires that the tag GENERATE_RTF is set to YES.
2166
225RTF_EXTENSIONS_FILE = 2167RTF_EXTENSIONS_FILE =
2168
226#--------------------------------------------------------------------------- 2169#---------------------------------------------------------------------------
227# configuration options related to the man page output 2170# Configuration options related to the man page output
228#--------------------------------------------------------------------------- 2171#---------------------------------------------------------------------------
2172
2173# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2174# classes and files.
2175# The default value is: NO.
2176
229GENERATE_MAN = NO 2177GENERATE_MAN = NO
2178
2179# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2180# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2181# it. A directory man3 will be created inside the directory specified by
2182# MAN_OUTPUT.
2183# The default directory is: man.
2184# This tag requires that the tag GENERATE_MAN is set to YES.
2185
230MAN_OUTPUT = man 2186MAN_OUTPUT = man
2187
2188# The MAN_EXTENSION tag determines the extension that is added to the generated
2189# man pages. In case the manual section does not start with a number, the number
2190# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2191# optional.
2192# The default value is: .3.
2193# This tag requires that the tag GENERATE_MAN is set to YES.
2194
231MAN_EXTENSION = .3 2195MAN_EXTENSION = .3
2196
2197# The MAN_SUBDIR tag determines the name of the directory created within
2198# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2199# MAN_EXTENSION with the initial . removed.
2200# This tag requires that the tag GENERATE_MAN is set to YES.
2201
2202MAN_SUBDIR =
2203
2204# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2205# will generate one additional man file for each entity documented in the real
2206# man page(s). These additional files only source the real man page, but without
2207# them the man command would be unable to find the correct page.
2208# The default value is: NO.
2209# This tag requires that the tag GENERATE_MAN is set to YES.
2210
232MAN_LINKS = NO 2211MAN_LINKS = NO
2212
233#--------------------------------------------------------------------------- 2213#---------------------------------------------------------------------------
234# configuration options related to the XML output 2214# Configuration options related to the XML output
235#--------------------------------------------------------------------------- 2215#---------------------------------------------------------------------------
236GENERATE_XML = NO 2216
2217# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2218# captures the structure of the code including all documentation.
2219# The default value is: NO.
2220
2221GENERATE_XML = YES
2222
2223# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2224# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2225# it.
2226# The default directory is: xml.
2227# This tag requires that the tag GENERATE_XML is set to YES.
2228
237XML_OUTPUT = xml 2229XML_OUTPUT = xml
238XML_SCHEMA = 2230
239XML_DTD = 2231# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2232# listings (including syntax highlighting and cross-referencing information) to
2233# the XML output. Note that enabling this will significantly increase the size
2234# of the XML output.
2235# The default value is: YES.
2236# This tag requires that the tag GENERATE_XML is set to YES.
2237
240XML_PROGRAMLISTING = YES 2238XML_PROGRAMLISTING = YES
2239
2240# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2241# namespace members in file scope as well, matching the HTML output.
2242# The default value is: NO.
2243# This tag requires that the tag GENERATE_XML is set to YES.
2244
2245XML_NS_MEMB_FILE_SCOPE = NO
2246
241#--------------------------------------------------------------------------- 2247#---------------------------------------------------------------------------
242# configuration options for the AutoGen Definitions output 2248# Configuration options related to the DOCBOOK output
243#--------------------------------------------------------------------------- 2249#---------------------------------------------------------------------------
2250
2251# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2252# that can be used to generate PDF.
2253# The default value is: NO.
2254
2255GENERATE_DOCBOOK = NO
2256
2257# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2258# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2259# front of it.
2260# The default directory is: docbook.
2261# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2262
2263DOCBOOK_OUTPUT = docbook
2264
2265#---------------------------------------------------------------------------
2266# Configuration options for the AutoGen Definitions output
2267#---------------------------------------------------------------------------
2268
2269# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2270# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2271# the structure of the code including all documentation. Note that this feature
2272# is still experimental and incomplete at the moment.
2273# The default value is: NO.
2274
244GENERATE_AUTOGEN_DEF = NO 2275GENERATE_AUTOGEN_DEF = NO
2276
245#--------------------------------------------------------------------------- 2277#---------------------------------------------------------------------------
246# configuration options related to the Perl module output 2278# Configuration options related to the Perl module output
247#--------------------------------------------------------------------------- 2279#---------------------------------------------------------------------------
2280
2281# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2282# file that captures the structure of the code including all documentation.
2283#
2284# Note that this feature is still experimental and incomplete at the moment.
2285# The default value is: NO.
2286
248GENERATE_PERLMOD = NO 2287GENERATE_PERLMOD = NO
2288
2289# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2290# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2291# output from the Perl module output.
2292# The default value is: NO.
2293# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2294
249PERLMOD_LATEX = NO 2295PERLMOD_LATEX = NO
2296
2297# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2298# formatted so it can be parsed by a human reader. This is useful if you want to
2299# understand what is going on. On the other hand, if this tag is set to NO, the
2300# size of the Perl module output will be much smaller and Perl will parse it
2301# just the same.
2302# The default value is: YES.
2303# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2304
250PERLMOD_PRETTY = YES 2305PERLMOD_PRETTY = YES
2306
2307# The names of the make variables in the generated doxyrules.make file are
2308# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2309# so different doxyrules.make files included by the same Makefile don't
2310# overwrite each other's variables.
2311# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2312
251PERLMOD_MAKEVAR_PREFIX = 2313PERLMOD_MAKEVAR_PREFIX =
2314
252#--------------------------------------------------------------------------- 2315#---------------------------------------------------------------------------
253# Configuration options related to the preprocessor 2316# Configuration options related to the preprocessor
254#--------------------------------------------------------------------------- 2317#---------------------------------------------------------------------------
2318
2319# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2320# C-preprocessor directives found in the sources and include files.
2321# The default value is: YES.
2322
255ENABLE_PREPROCESSING = YES 2323ENABLE_PREPROCESSING = YES
2324
2325# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2326# in the source code. If set to NO, only conditional compilation will be
2327# performed. Macro expansion can be done in a controlled way by setting
2328# EXPAND_ONLY_PREDEF to YES.
2329# The default value is: NO.
2330# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2331
256MACRO_EXPANSION = YES 2332MACRO_EXPANSION = YES
2333
2334# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2335# the macro expansion is limited to the macros specified with the PREDEFINED and
2336# EXPAND_AS_DEFINED tags.
2337# The default value is: NO.
2338# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2339
257EXPAND_ONLY_PREDEF = NO 2340EXPAND_ONLY_PREDEF = NO
2341
2342# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2343# INCLUDE_PATH will be searched if a #include is found.
2344# The default value is: YES.
2345# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2346
258SEARCH_INCLUDES = YES 2347SEARCH_INCLUDES = YES
2348
2349# The INCLUDE_PATH tag can be used to specify one or more directories that
2350# contain include files that are not input files but should be processed by the
2351# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2352# RECURSIVE has no effect here.
2353# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2354
259INCLUDE_PATH = 2355INCLUDE_PATH =
2356
2357# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2358# patterns (like *.h and *.hpp) to filter out the header-files in the
2359# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2360# used.
2361# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2362
260INCLUDE_FILE_PATTERNS = 2363INCLUDE_FILE_PATTERNS =
261PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" 2364
2365# The PREDEFINED tag can be used to specify one or more macro names that are
2366# defined before the preprocessor is started (similar to the -D option of e.g.
2367# gcc). The argument of the tag is a list of macros of the form: name or
2368# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2369# is assumed. To prevent a macro definition from being undefined via #undef or
2370# recursively expanded use the := operator instead of the = operator.
2371# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2372
2373PREDEFINED = "GNUNET_UNUSED=" \
2374 "GNUNET_PACKED="
2375
2376# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2377# tag can be used to specify a list of macro names that should be expanded. The
2378# macro definition that is found in the sources will be used. Use the PREDEFINED
2379# tag if you want to use a different macro definition that overrules the
2380# definition found in the source code.
2381# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2382
262EXPAND_AS_DEFINED = 2383EXPAND_AS_DEFINED =
2384
2385# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2386# remove all references to function-like macros that are alone on a line, have
2387# an all uppercase name, and do not end with a semicolon. Such function macros
2388# are typically used for boiler-plate code, and will confuse the parser if not
2389# removed.
2390# The default value is: YES.
2391# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2392
263SKIP_FUNCTION_MACROS = YES 2393SKIP_FUNCTION_MACROS = YES
2394
264#--------------------------------------------------------------------------- 2395#---------------------------------------------------------------------------
265# Configuration::additions related to external references 2396# Configuration options related to external references
266#--------------------------------------------------------------------------- 2397#---------------------------------------------------------------------------
2398
2399# The TAGFILES tag can be used to specify one or more tag files. For each tag
2400# file the location of the external documentation should be added. The format of
2401# a tag file without this location is as follows:
2402# TAGFILES = file1 file2 ...
2403# Adding location for the tag files is done as follows:
2404# TAGFILES = file1=loc1 "file2 = loc2" ...
2405# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2406# section "Linking to external documentation" for more information about the use
2407# of tag files.
2408# Note: Each tag file must have a unique name (where the name does NOT include
2409# the path). If a tag file is not located in the directory in which doxygen is
2410# run, you must also specify the path to the tagfile here.
2411
267TAGFILES = 2412TAGFILES =
2413
2414# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2415# tag file that is based on the input files it reads. See section "Linking to
2416# external documentation" for more information about the usage of tag files.
2417
268GENERATE_TAGFILE = gnunet.tag 2418GENERATE_TAGFILE = gnunet.tag
2419
2420# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2421# the class index. If set to NO, only the inherited external classes will be
2422# listed.
2423# The default value is: NO.
2424
269ALLEXTERNALS = NO 2425ALLEXTERNALS = NO
2426
2427# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2428# in the modules index. If set to NO, only the current project's groups will be
2429# listed.
2430# The default value is: YES.
2431
270EXTERNAL_GROUPS = YES 2432EXTERNAL_GROUPS = YES
271PERL_PATH = /usr/bin/perl 2433
2434# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2435# the related pages index. If set to NO, only the current project's pages will
2436# be listed.
2437# The default value is: YES.
2438
2439EXTERNAL_PAGES = YES
2440
272#--------------------------------------------------------------------------- 2441#---------------------------------------------------------------------------
273# Configuration options related to the dot tool 2442# Configuration options related to the dot tool
274#--------------------------------------------------------------------------- 2443#---------------------------------------------------------------------------
275CLASS_DIAGRAMS = YES 2444
276MSCGEN_PATH = 2445# You can include diagrams made with dia in doxygen documentation. Doxygen will
2446# then run dia to produce the diagram and insert it in the documentation. The
2447# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2448# If left empty dia is assumed to be found in the default search path.
2449
2450DIA_PATH =
2451
2452# If set to YES the inheritance and collaboration graphs will hide inheritance
2453# and usage relations if the target is undocumented or is not a class.
2454# The default value is: YES.
2455
277HIDE_UNDOC_RELATIONS = YES 2456HIDE_UNDOC_RELATIONS = YES
2457
2458# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2459# available from the path. This tool is part of Graphviz (see:
2460# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2461# Bell Labs. The other options in this section have no effect if this option is
2462# set to NO
2463# The default value is: NO.
2464
278HAVE_DOT = YES 2465HAVE_DOT = YES
279DOT_FONTNAME = FreeSans 2466
2467# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2468# to run in parallel. When set to 0 doxygen will base this on the number of
2469# processors available in the system. You can set it explicitly to a value
2470# larger than 0 to get control over the balance between CPU load and processing
2471# speed.
2472# Minimum value: 0, maximum value: 32, default value: 0.
2473# This tag requires that the tag HAVE_DOT is set to YES.
2474
2475DOT_NUM_THREADS = 0
2476
2477# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2478# subgraphs. When you want a differently looking font in the dot files that
2479# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2480# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2481# Edge and Graph Attributes specification</a> You need to make sure dot is able
2482# to find the font, which can be done by putting it in a standard location or by
2483# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2484# directory containing the font. Default graphviz fontsize is 14.
2485# The default value is: fontname=Helvetica,fontsize=10.
2486# This tag requires that the tag HAVE_DOT is set to YES.
2487
2488DOT_COMMON_ATTR = "fontname=FreeSans,fontsize=10"
2489
2490# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2491# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2492# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2493# arrows shapes.</a>
2494# The default value is: labelfontname=Helvetica,labelfontsize=10.
2495# This tag requires that the tag HAVE_DOT is set to YES.
2496
2497DOT_EDGE_ATTR = "labelfontname=FreeSans,labelfontsize=10"
2498
2499# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2500# around nodes set 'shape=plain' or 'shape=plaintext' <a
2501# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2502# The default value is: shape=box,height=0.2,width=0.4.
2503# This tag requires that the tag HAVE_DOT is set to YES.
2504
2505DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2506
2507# You can set the path where dot can find font specified with fontname in
2508# DOT_COMMON_ATTR and others dot attributes.
2509# This tag requires that the tag HAVE_DOT is set to YES.
2510
280DOT_FONTPATH = 2511DOT_FONTPATH =
2512
2513# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2514# graph for each documented class showing the direct and indirect inheritance
2515# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2516# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2517# to TEXT the direct and indirect inheritance relations will be shown as texts /
2518# links.
2519# Possible values are: NO, YES, TEXT and GRAPH.
2520# The default value is: YES.
2521
281CLASS_GRAPH = YES 2522CLASS_GRAPH = YES
2523
2524# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2525# graph for each documented class showing the direct and indirect implementation
2526# dependencies (inheritance, containment, and class references variables) of the
2527# class with other documented classes.
2528# The default value is: YES.
2529# This tag requires that the tag HAVE_DOT is set to YES.
2530
282COLLABORATION_GRAPH = YES 2531COLLABORATION_GRAPH = YES
2532
2533# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2534# groups, showing the direct groups dependencies. See also the chapter Grouping
2535# in the manual.
2536# The default value is: YES.
2537# This tag requires that the tag HAVE_DOT is set to YES.
2538
283GROUP_GRAPHS = YES 2539GROUP_GRAPHS = YES
2540
2541# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2542# collaboration diagrams in a style similar to the OMG's Unified Modeling
2543# Language.
2544# The default value is: NO.
2545# This tag requires that the tag HAVE_DOT is set to YES.
2546
284UML_LOOK = NO 2547UML_LOOK = NO
2548
2549# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2550# class node. If there are many fields or methods and many nodes the graph may
2551# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2552# number of items for each type to make the size more manageable. Set this to 0
2553# for no limit. Note that the threshold may be exceeded by 50% before the limit
2554# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2555# but if the number exceeds 15, the total amount of fields shown is limited to
2556# 10.
2557# Minimum value: 0, maximum value: 100, default value: 10.
2558# This tag requires that the tag UML_LOOK is set to YES.
2559
2560UML_LIMIT_NUM_FIELDS = 10
2561
2562# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2563# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2564# tag is set to YES, doxygen will add type and arguments for attributes and
2565# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2566# will not generate fields with class member information in the UML graphs. The
2567# class diagrams will look similar to the default class diagrams but using UML
2568# notation for the relationships.
2569# Possible values are: NO, YES and NONE.
2570# The default value is: NO.
2571# This tag requires that the tag UML_LOOK is set to YES.
2572
2573DOT_UML_DETAILS = NO
2574
2575# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2576# to display on a single line. If the actual line length exceeds this threshold
2577# significantly it will wrapped across multiple lines. Some heuristics are apply
2578# to avoid ugly line breaks.
2579# Minimum value: 0, maximum value: 1000, default value: 17.
2580# This tag requires that the tag HAVE_DOT is set to YES.
2581
2582DOT_WRAP_THRESHOLD = 17
2583
2584# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2585# collaboration graphs will show the relations between templates and their
2586# instances.
2587# The default value is: NO.
2588# This tag requires that the tag HAVE_DOT is set to YES.
2589
285TEMPLATE_RELATIONS = NO 2590TEMPLATE_RELATIONS = NO
2591
2592# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2593# YES then doxygen will generate a graph for each documented file showing the
2594# direct and indirect include dependencies of the file with other documented
2595# files.
2596# The default value is: YES.
2597# This tag requires that the tag HAVE_DOT is set to YES.
2598
286INCLUDE_GRAPH = YES 2599INCLUDE_GRAPH = YES
2600
2601# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2602# set to YES then doxygen will generate a graph for each documented file showing
2603# the direct and indirect include dependencies of the file with other documented
2604# files.
2605# The default value is: YES.
2606# This tag requires that the tag HAVE_DOT is set to YES.
2607
287INCLUDED_BY_GRAPH = YES 2608INCLUDED_BY_GRAPH = YES
2609
2610# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2611# dependency graph for every global function or class method.
2612#
2613# Note that enabling this option will significantly increase the time of a run.
2614# So in most cases it will be better to enable call graphs for selected
2615# functions only using the \callgraph command. Disabling a call graph can be
2616# accomplished by means of the command \hidecallgraph.
2617# The default value is: NO.
2618# This tag requires that the tag HAVE_DOT is set to YES.
2619
288CALL_GRAPH = YES 2620CALL_GRAPH = YES
2621
2622# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2623# dependency graph for every global function or class method.
2624#
2625# Note that enabling this option will significantly increase the time of a run.
2626# So in most cases it will be better to enable caller graphs for selected
2627# functions only using the \callergraph command. Disabling a caller graph can be
2628# accomplished by means of the command \hidecallergraph.
2629# The default value is: NO.
2630# This tag requires that the tag HAVE_DOT is set to YES.
2631
289CALLER_GRAPH = YES 2632CALLER_GRAPH = YES
2633
2634# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2635# hierarchy of all classes instead of a textual one.
2636# The default value is: YES.
2637# This tag requires that the tag HAVE_DOT is set to YES.
2638
290GRAPHICAL_HIERARCHY = YES 2639GRAPHICAL_HIERARCHY = YES
2640
2641# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2642# dependencies a directory has on other directories in a graphical way. The
2643# dependency relations are determined by the #include relations between the
2644# files in the directories.
2645# The default value is: YES.
2646# This tag requires that the tag HAVE_DOT is set to YES.
2647
291DIRECTORY_GRAPH = YES 2648DIRECTORY_GRAPH = YES
2649
2650# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2651# of child directories generated in directory dependency graphs by dot.
2652# Minimum value: 1, maximum value: 25, default value: 1.
2653# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2654
2655DIR_GRAPH_MAX_DEPTH = 1
2656
2657# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2658# generated by dot. For an explanation of the image formats see the section
2659# output formats in the documentation of the dot tool (Graphviz (see:
2660# http://www.graphviz.org/)).
2661# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2662# to make the SVG files visible in IE 9+ (other browsers do not have this
2663# requirement).
2664# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2665# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2666# png:gdiplus:gdiplus.
2667# The default value is: png.
2668# This tag requires that the tag HAVE_DOT is set to YES.
2669
292DOT_IMAGE_FORMAT = svg 2670DOT_IMAGE_FORMAT = svg
293INTERACTIVE_SVG = NO 2671
2672# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2673# enable generation of interactive SVG images that allow zooming and panning.
2674#
2675# Note that this requires a modern browser other than Internet Explorer. Tested
2676# and working are Firefox, Chrome, Safari, and Opera.
2677# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2678# the SVG files visible. Older versions of IE do not have SVG support.
2679# The default value is: NO.
2680# This tag requires that the tag HAVE_DOT is set to YES.
2681
2682INTERACTIVE_SVG = YES
2683
2684# The DOT_PATH tag can be used to specify the path where the dot tool can be
2685# found. If left blank, it is assumed the dot tool can be found in the path.
2686# This tag requires that the tag HAVE_DOT is set to YES.
2687
294DOT_PATH = 2688DOT_PATH =
2689
2690# The DOTFILE_DIRS tag can be used to specify one or more directories that
2691# contain dot files that are included in the documentation (see the \dotfile
2692# command).
2693# This tag requires that the tag HAVE_DOT is set to YES.
2694
295DOTFILE_DIRS = 2695DOTFILE_DIRS =
2696
2697# The MSCFILE_DIRS tag can be used to specify one or more directories that
2698# contain msc files that are included in the documentation (see the \mscfile
2699# command).
2700
2701MSCFILE_DIRS =
2702
2703# The DIAFILE_DIRS tag can be used to specify one or more directories that
2704# contain dia files that are included in the documentation (see the \diafile
2705# command).
2706
2707DIAFILE_DIRS =
2708
2709# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2710# path where java can find the plantuml.jar file or to the filename of jar file
2711# to be used. If left blank, it is assumed PlantUML is not used or called during
2712# a preprocessing step. Doxygen will generate a warning when it encounters a
2713# \startuml command in this case and will not generate output for the diagram.
2714
2715PLANTUML_JAR_PATH =
2716
2717# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2718# configuration file for plantuml.
2719
2720PLANTUML_CFG_FILE =
2721
2722# When using plantuml, the specified paths are searched for files specified by
2723# the !include statement in a plantuml block.
2724
2725PLANTUML_INCLUDE_PATH =
2726
2727# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2728# that will be shown in the graph. If the number of nodes in a graph becomes
2729# larger than this value, doxygen will truncate the graph, which is visualized
2730# by representing a node as a red box. Note that doxygen if the number of direct
2731# children of the root node in a graph is already larger than
2732# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2733# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2734# Minimum value: 0, maximum value: 10000, default value: 50.
2735# This tag requires that the tag HAVE_DOT is set to YES.
2736
296DOT_GRAPH_MAX_NODES = 50 2737DOT_GRAPH_MAX_NODES = 50
2738
2739# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2740# generated by dot. A depth value of 3 means that only nodes reachable from the
2741# root by following a path via at most 3 edges will be shown. Nodes that lay
2742# further from the root node will be omitted. Note that setting this option to 1
2743# or 2 may greatly reduce the computation time needed for large code bases. Also
2744# note that the size of a graph can be further restricted by
2745# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2746# Minimum value: 0, maximum value: 1000, default value: 0.
2747# This tag requires that the tag HAVE_DOT is set to YES.
2748
297MAX_DOT_GRAPH_DEPTH = 10 2749MAX_DOT_GRAPH_DEPTH = 10
298DOT_TRANSPARENT = YES 2750
2751# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2752# files in one run (i.e. multiple -o and -T options on the command line). This
2753# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2754# this, this feature is disabled by default.
2755# The default value is: NO.
2756# This tag requires that the tag HAVE_DOT is set to YES.
2757
299DOT_MULTI_TARGETS = YES 2758DOT_MULTI_TARGETS = YES
2759
2760# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2761# explaining the meaning of the various boxes and arrows in the dot generated
2762# graphs.
2763# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2764# graphical representation for inheritance and collaboration diagrams is used.
2765# The default value is: YES.
2766# This tag requires that the tag HAVE_DOT is set to YES.
2767
300GENERATE_LEGEND = YES 2768GENERATE_LEGEND = YES
2769
2770# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2771# files that are used to generate the various graphs.
2772#
2773# Note: This setting is not only used for dot files but also for msc temporary
2774# files.
2775# The default value is: YES.
2776
301DOT_CLEANUP = YES 2777DOT_CLEANUP = YES
302#---------------------------------------------------------------------------
303# Configuration::additions related to the search engine
304#---------------------------------------------------------------------------
305SEARCHENGINE = YES
diff --git a/doc/handbook/.gitignore b/doc/handbook/.gitignore
index 80ac74ea0..26718c2e9 100644
--- a/doc/handbook/.gitignore
+++ b/doc/handbook/.gitignore
@@ -1,11 +1,2 @@
1stamp-1 1html/
2version2.texi 2texinfo/
3manual
4*.fn
5*.fns
6*.ky
7*.pg
8*.tp
9*.vr
10gnunet
11gnunet.html
diff --git a/doc/handbook/README b/doc/handbook/README
new file mode 100644
index 000000000..43761d3b4
--- /dev/null
+++ b/doc/handbook/README
@@ -0,0 +1,5 @@
1DO NOT EDIT THE HANDBOOK HERE
2
3The GNUnet handbook can be found (and edited) in gnunet-handbook.git.
4It is included in the submodule contrib/sphinx.
5The html, texinfo and manpages are autogenerated from there on ./bootstrap.
diff --git a/doc/handbook/meson.build b/doc/handbook/meson.build
new file mode 100644
index 000000000..ee6156192
--- /dev/null
+++ b/doc/handbook/meson.build
@@ -0,0 +1,42 @@
1fs = import('fs')
2makeinfo = find_program('makeinfo', native: true, required: false)
3sphinx = find_program('sphinx-build', native: true, required: false)
4
5if fs.exists('html')
6 install_subdir('html',
7 install_dir: docdir,
8 strip_directory: false)
9else
10 if sphinx.found()
11 sphinxhandbook = custom_target('handbook-html',
12 output: 'html',
13 command: [sphinx,
14 '-M', 'html',
15 meson.project_source_root()/'contrib'/'handbook', meson.current_build_dir()],
16 install: true,
17 install_dir: docdir)
18 endif
19endif
20
21if fs.exists('texinfo')
22 install_data('texinfo'/'gnunet.info',
23 install_dir: get_option('infodir'))
24else
25 if sphinx.found()
26 sphinxhandbooktexi = custom_target('handbook-texinfo',
27 output: ['texinfo'],
28 command: [sphinx,
29 '-M', 'texinfo',
30 meson.project_source_root()/'contrib'/'handbook', meson.current_build_dir()],
31 install: false,
32 install_dir: get_option('infodir'))
33 custom_target('gnunet.info',
34 output: 'gnunet.info',
35 depends: sphinxhandbooktexi,
36 command: [makeinfo, '--no-split', '--no-headers',
37 meson.current_build_dir()/'texinfo'/'gnunet.texi', '-o', '@OUTPUT0@'],
38 install: true,
39 install_dir: get_option('infodir'))
40 endif
41endif
42
diff --git a/doc/man/.gitignore b/doc/man/.gitignore
index 38ed67872..decad311d 100644
--- a/doc/man/.gitignore
+++ b/doc/man/.gitignore
@@ -3,3 +3,7 @@ groff_lint.log
3*.html 3*.html
4gnunet-c-tutorial.7 4gnunet-c-tutorial.7
5gnunet-documentation.7 5gnunet-documentation.7
6gana.*
7gnunet.*
8gnunet-dev.*
9lsd.*
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index e7045e8bf..6ab720826 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,20 +1,10 @@
1# This Makefile.am is in the public domain 1# This Makefile.am is in the public domain
2 2
3gnunet.conf.5: gnunet.conf.5.in Makefile 3gnunet.conf.5: gnunet.conf.5.in Makefile
4 $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/bin/dosubst.awk < $(srcdir)/gnunet.conf.5.in > $(srcdir)/gnunet.conf.5 4 $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/scripts/dosubst.awk < $(srcdir)/gnunet.conf.5.in > $(srcdir)/gnunet.conf.5
5 5
6CLEANFILES = gnunet.conf.5 6CLEANFILES = gnunet.conf.5
7 7
8if TEXI2MDOC_GENERATION
9gnunet-tutorial.7: Makefile
10 @texi2mdoc -I../tutorial:../tutorial/chapters ../tutorial/tutorial.texi > gnunet-tutorial.7
11
12gnunet-documentation.7: Makefile
13 @texi2mdoc -I../handbook:../handbook/chapters ../handbook/gnunet.texi > gnunet-documentation.7
14
15CLEANFILES += gnunet-documentation.7 gnunet-tutorial.7
16endif
17
18if HAVE_EXPERIMENTAL 8if HAVE_EXPERIMENTAL
19if HAVE_MANDOC 9if HAVE_MANDOC
20# After I went through the alternatives with the focus 10# After I went through the alternatives with the focus
@@ -24,7 +14,7 @@ if HAVE_MANDOC
24# I want and that the alternatives are depressing and 14# I want and that the alternatives are depressing and
25# nonfunctional. 15# nonfunctional.
26produce_html.sh: produce_html.sh.in Makefile 16produce_html.sh: produce_html.sh.in Makefile
27 $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/bin/dosubst.awk < $(srcdir)/produce_html.sh.in > produce_html.sh 17 $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/scripts/dosubst.awk < $(srcdir)/produce_html.sh.in > produce_html.sh
28 @chmod +x produce_html.sh 18 @chmod +x produce_html.sh
29 19
30CLEANFILES += produce_html.sh 20CLEANFILES += produce_html.sh
@@ -48,7 +38,6 @@ endif
48man_MANS = \ 38man_MANS = \
49 gnunet.conf.5 \ 39 gnunet.conf.5 \
50 gnunet-arm.1 \ 40 gnunet-arm.1 \
51 gnunet-ats.1 \
52 gnunet-auto-share.1 \ 41 gnunet-auto-share.1 \
53 gnunet-base32.1 \ 42 gnunet-base32.1 \
54 gnunet-bcd.1 \ 43 gnunet-bcd.1 \
@@ -57,10 +46,15 @@ man_MANS = \
57 gnunet-core.1 \ 46 gnunet-core.1 \
58 gnunet-conversation.1 \ 47 gnunet-conversation.1 \
59 gnunet-conversation-test.1 \ 48 gnunet-conversation-test.1 \
49 gnunet-dht-get.1 \
50 gnunet-dht-put.1 \
51 gnunet-dht-monitor.1 \
52 gnunet-dht-hello.1 \
60 gnunet-directory.1 \ 53 gnunet-directory.1 \
61 gnunet-dns2gns.1 \ 54 gnunet-dns2gns.1 \
62 gnunet-datastore.1 \ 55 gnunet-datastore.1 \
63 gnunet-download.1 \ 56 gnunet-download.1 \
57 gnunet-did.1 \
64 gnunet-ecc.1 \ 58 gnunet-ecc.1 \
65 gnunet-fs.1 \ 59 gnunet-fs.1 \
66 gnunet-gns.1 \ 60 gnunet-gns.1 \
@@ -68,14 +62,15 @@ man_MANS = \
68 gnunet-gns-proxy-setup-ca.1 \ 62 gnunet-gns-proxy-setup-ca.1 \
69 gnunet-identity.1 \ 63 gnunet-identity.1 \
70 gnunet-cadet.1 \ 64 gnunet-cadet.1 \
65 gnunet-messenger.1 \
71 gnunet-namecache.1 \ 66 gnunet-namecache.1 \
72 gnunet-namestore.1 \ 67 gnunet-namestore.1 \
73 gnunet-namestore-fcfsd.1 \ 68 gnunet-namestore-dbtool.1 \
69 gnunet-namestore-zonefile.1 \
74 gnunet-nat.1 \ 70 gnunet-nat.1 \
75 gnunet-nat-auto.1 \ 71 gnunet-nat-auto.1 \
76 gnunet-nat-server.1 \ 72 gnunet-nat-server.1 \
77 gnunet-nse.1 \ 73 gnunet-nse.1 \
78 gnunet-peerinfo.1 \
79 gnunet-publish.1 \ 74 gnunet-publish.1 \
80 gnunet-qr.1 \ 75 gnunet-qr.1 \
81 gnunet-reclaim.1 \ 76 gnunet-reclaim.1 \
@@ -85,7 +80,7 @@ man_MANS = \
85 gnunet-scrypt.1 \ 80 gnunet-scrypt.1 \
86 gnunet-search.1 \ 81 gnunet-search.1 \
87 gnunet-statistics.1 \ 82 gnunet-statistics.1 \
88 gnunet-testbed-profiler.1 \ 83 gnunet-testing.1 \
89 gnunet-testing-run-service.1 \ 84 gnunet-testing-run-service.1 \
90 gnunet-timeout.1 \ 85 gnunet-timeout.1 \
91 gnunet-transport.1 \ 86 gnunet-transport.1 \
@@ -95,10 +90,6 @@ man_MANS = \
95 gnunet-vpn.1 \ 90 gnunet-vpn.1 \
96 gnunet-zoneimport.1 91 gnunet-zoneimport.1
97 92
98if TEXI2MDOC_GENERATION
99man_MANS += gnunet-tutorial.7 gnunet-documentation.7
100endif
101
102EXTRA_DIST = ${man_MANS} \ 93EXTRA_DIST = ${man_MANS} \
103 gnunet.conf.5.in \ 94 gnunet.conf.5.in \
104 produce_html.sh.in \ 95 produce_html.sh.in \
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1
deleted file mode 100644
index 311501002..000000000
--- a/doc/man/gnunet-ats.1
+++ /dev/null
@@ -1,114 +0,0 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V.
3.\"
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
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd October 16, 2015
25.Dt GNUNET-ATS 1
26.Os
27.Sh NAME
28.Nm gnunet-ats
29.Nd display information about transport resource allocation
30.Sh SYNOPSIS
31.Nm
32.Op Fl a | -all
33.Op Fl C Ar PEERID | Fl -connect= Ns Ar PEERID
34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl h | -help
36.Op Fl i Ar PEERID | Fl -id= Ns Ar PEERID
37.Op Fl k Ar VALUE | Fl -value= Ns Ar VALUE
38.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
39.Op Fl m | -monitor
40.Op Fl n | -numeric
41.Op Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE
42.Op Fl q | -quotas
43.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
44.Op Fl u | -used
45.Op Fl V | -verbose
46.Op Fl v | -version
47.Sh DESCRIPTION
48.Nm
49can be used to display information about the
50GNUnet's transport selection mechanism.
51It shows information about the addresses and
52the assigned input and output bandwidth.
53.Sh OPTIONS
54.Bl -tag -width indent
55.It Fl a | -all
56List all addresses currently known to ats.
57.It Fl C Ar PEERID | Fl -connect= Ns Ar PEERID
58Ask ATS to suggest an address for PEERID to transport
59to establish a connection.
60Note that you can use the
61.Xr gnunet-transport 1
62commandline tool to force disconnects.
63.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
64Use the configuration file FILENAME.
65.It Fl h | -help
66Print short help on options.
67.It Fl i Ar PEERID | Fl -id= Ns Ar PEERID
68Print information for a specific peer identity only.
69.It Fl k Ar VALUE | Fl -value= Ns Ar VALUE
70Value to set for when changing preference values.
71.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
72Use LOGLEVEL for logging.
73Valid values are DEBUG, INFO, WARNING and ERROR.
74.It Fl m | -monitor
75Monitor changes to the bandwidth assignments continuously.
76.It Fl n | -numeric
77Do not resolve IP addresses to hostnames.
78.It Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE
79Set preference values, -i, -k and -t required.
80.It Fl q | -quotas
81Print quotas for all network types
82.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
83Preference type to change: latency | bandwidth
84.It Fl u | -used
85Print addresses actively used only
86.It Fl V | -verbose
87Print verbose output (include ATS address properties)
88.It v | -version
89Print GNUnet version number.
90.El
91.Sh SEE ALSO
92.Xr gnunet-transport 1
93.sp
94The full documentation for gnunet is maintained as a Texinfo manual.
95If the
96.Xr info 1
97and gnunet programs are properly installed at your site, the command
98.Pp
99.Dl info gnunet
100.Pp
101should give you access to the complete handbook,
102.Pp
103.Dl info gnunet-c-tutorial
104.Pp
105will give you access to a tutorial for developers.
106.Pp
107Depending on your installation, this information is also available in
108.Xr gnunet 7 and
109.Xr gnunet-c-tutorial 7 .
110.Sh BUGS
111Report bugs by using
112.Lk https://bugs.gnunet.org
113or by sending electronic mail to
114.Aq Mt bug-gnunet@gnu.org .
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index 93d943758..c454765cf 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -47,7 +47,7 @@
47.Sh DESCRIPTION 47.Sh DESCRIPTION
48.Nm 48.Nm
49can be used to read or modify GNUnet configuration files. 49can be used to read or modify GNUnet configuration files.
50It can also provide informations to properly build applications on top of 50It can also provide information to properly build applications on top of
51GNUnet, like appropriate values for CFLAGS or the installation prefix. 51GNUnet, like appropriate values for CFLAGS or the installation prefix.
52.Bl -tag -width indent 52.Bl -tag -width indent
53.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND 53.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1
index 745a666b8..921f2ead6 100644
--- a/doc/man/gnunet-core.1
+++ b/doc/man/gnunet-core.1
@@ -39,8 +39,6 @@
39.Nm 39.Nm
40is a tool to access various functions of GNUnet's core subsystem 40is a tool to access various functions of GNUnet's core subsystem
41from the command-line. 41from the command-line.
42The only function right now is to monitor the status of peers
43known to the CORE service.
44.Bl -tag -width indent 42.Bl -tag -width indent
45.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 43.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
46Configuration file to use. 44Configuration file to use.
@@ -52,6 +50,10 @@ Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
52.It Fl m | -monitor 50.It Fl m | -monitor
53In monitor mode, gnunet-core will continuously print the connection status, 51In monitor mode, gnunet-core will continuously print the connection status,
54instead of giving just a snapshot. 52instead of giving just a snapshot.
53.It Fl i | -show-identity
54Output current local peer identity.
55.It Fl s | -connection-status
56Show current peer connection status.
55.It Fl v | -version 57.It Fl v | -version
56Print the version number. 58Print the version number.
57.It Fl V | -verbose 59.It Fl V | -verbose
diff --git a/doc/man/gnunet-dht-get.1 b/doc/man/gnunet-dht-get.1
new file mode 100644
index 000000000..bd411f2f0
--- /dev/null
+++ b/doc/man/gnunet-dht-get.1
@@ -0,0 +1,90 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2023 GNUnet e.V.
3.\"
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
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 5, 2023
25.Dt GNUNET-DHT-GET 1
26.Os
27.Sh NAME
28.Nm gnunet-dht-get
29.Nd Issue a GET request to the DHT. Prints results.
30.Sh SYNOPSIS
31.Nm
32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33.Op Fl h | -help
34.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
35.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
36.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
37.Op Fl R | -record
38.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
39.Op Fl T Ar TYPE | Fl -type= Ns Ar TYPE
40.Op Fl V | -verbose
41.Op Fl v | -version
42.Op Fl x | -demultiplex
43.Sh DESCRIPTION
44.Nm
45is a command line tool to issue GET requests to the DHT.
46.Sh OPTIONS
47.Bl -tag -width indent
48.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
49Use the configuration file
50.Ar FILENAME .
51.It Fl h | -help
52Print short help on options.
53.It Fl k Ar KEY | Fl -key= Ns Ar KEY
54use the query key
55.Ar KEY .
56.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
57Use LOGLEVEL for logging.
58Valid values are DEBUG, INFO, WARNING and ERROR.
59.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
60Configure logging to write logs to
61.Ar LOGFILE .
62.It Fl R | -record
63Set DHT's record route option for the request.
64.It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL
65Use the DHT replication level
66.Ar LEVEL .
67.It Fl t Ar TYPE | -type= Ns Ar TYPE
68the block type to look for under
69.Ar KEY .
70.It Fl V | -verbose
71be verbose.
72.It Fl v | -version
73Print GNUnet version number.
74.It Fl x | -demultiplex
75Set DHT's demultiplex everywhere option.
76.El
77.Sh SEE ALSO
78The full documentation for gnunet is maintained as a Texinfo manual.
79If the
80.Xr info 1
81and gnunet programs are properly installed at your site, the command
82.Pp
83.Dl info gnunet
84.\".Sh HISTORY
85.\".Sh AUTHORS
86.Sh BUGS
87Report bugs by using
88.Lk https://bugs.gnunet.org
89or by sending electronic mail to
90.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-dht-hello.1 b/doc/man/gnunet-dht-hello.1
new file mode 100644
index 000000000..b50736f65
--- /dev/null
+++ b/doc/man/gnunet-dht-hello.1
@@ -0,0 +1,75 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2023 GNUnet e.V.
3.\"
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
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 5, 2023
25.Dt GNUNET-DHT-HELLO 1
26.Os
27.Sh NAME
28.Nm gnunet-dht-hello
29.Nd Obtain HELLO from DHT or provide HELLO to DHT for bootstrapping.
30.Sh SYNOPSIS
31.Nm
32.Op Ar URL
33.El
34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl h | -help
36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
38.Op Fl V | -verbose
39.Op Fl v | -version
40.Sh DESCRIPTION
41.Nm
42is a command line tool to either get a HELLO for your own peer (no arguments) or to
43parse a HELLO URL by providing it as the sole argument.
44.Sh OPTIONS
45.Bl -tag -width indent
46.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
47Use the configuration file
48.Ar FILENAME .
49.It Fl h | -help
50Print short help on options.
51.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
52Use LOGLEVEL for logging.
53Valid values are DEBUG, INFO, WARNING and ERROR.
54.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
55Configure logging to write logs to
56.Ar LOGFILE .
57.It Fl V | -verbose
58be verbose.
59.It Fl v | -version
60Print GNUnet version number.
61.El
62.Sh SEE ALSO
63The full documentation for gnunet is maintained as a Texinfo manual.
64If the
65.Xr info 1
66and gnunet programs are properly installed at your site, the command
67.Pp
68.Dl info gnunet
69.\".Sh HISTORY
70.\".Sh AUTHORS
71.Sh BUGS
72Report bugs by using
73.Lk https://bugs.gnunet.org
74or by sending electronic mail to
75.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-dht-monitor.1 b/doc/man/gnunet-dht-monitor.1
new file mode 100644
index 000000000..08707f6bb
--- /dev/null
+++ b/doc/man/gnunet-dht-monitor.1
@@ -0,0 +1,82 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2023 GNUnet e.V.
3.\"
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
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 5, 2023
25.Dt GNUNET-DHT-MONITOR 1
26.Os
27.Sh NAME
28.Nm gnunet-dht-monitor
29.Nd Print packets that go through the DHT on this peer.
30.Sh SYNOPSIS
31.Nm
32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33.Op Fl h | -help
34.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
35.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
36.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
37.Op Fl T Ar TIMEOUT | Fl -timeout= Ns Ar TIMEOUT
38.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
39.Op Fl V | -verbose
40.Op Fl v | -version
41.Sh DESCRIPTION
42.Nm
43is a command line tool to monitor DHT packets that go through this peer.
44.Sh OPTIONS
45.Bl -tag -width indent
46.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
47Use the configuration file
48.Ar FILENAME .
49.It Fl h | -help
50Print short help on options.
51.It Fl k Ar KEY | Fl -key= Ns Ar KEY
52use the query key
53.Ar KEY .
54.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
55Use LOGLEVEL for logging.
56Valid values are DEBUG, INFO, WARNING and ERROR.
57.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
58Configure logging to write logs to
59.Ar LOGFILE .
60.It Fl T Ar TIMEOUT | -timeout= Ns Ar TIMEOUT
61how long should the monitor command run.
62.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
63the block type to filter for.
64.It Fl V | -verbose
65be verbose.
66.It Fl v | -version
67Print GNUnet version number.
68.El
69.Sh SEE ALSO
70The full documentation for gnunet is maintained as a Texinfo manual.
71If the
72.Xr info 1
73and gnunet programs are properly installed at your site, the command
74.Pp
75.Dl info gnunet
76.\".Sh HISTORY
77.\".Sh AUTHORS
78.Sh BUGS
79Report bugs by using
80.Lk https://bugs.gnunet.org
81or by sending electronic mail to
82.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-dht-put.1 b/doc/man/gnunet-dht-put.1
new file mode 100644
index 000000000..ec6b38c44
--- /dev/null
+++ b/doc/man/gnunet-dht-put.1
@@ -0,0 +1,100 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2023 GNUnet e.V.
3.\"
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
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 5, 2023
25.Dt GNUNET-DHT-PUT 1
26.Os
27.Sh NAME
28.Nm gnunet-dht-put
29.Nd Issue a PUT request to the DHT to insert
30.Ar DATA
31under
32.Ar KEY .
33.Sh SYNOPSIS
34.Nm
35.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
36.Op Fl d Ar DATA | Fl -data= Ns Ar DATA
37.Op Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION
38.Op Fl h | -help
39.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
40.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
41.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
42.Op Fl R | -record
43.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
44.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
45.Op Fl V | -verbose
46.Op Fl v | -version
47.Op Fl x | -demultiplex
48.Sh DESCRIPTION
49.Nm
50is a command line tool to issue PUT requests to the DHT.
51.Sh OPTIONS
52.Bl -tag -width indent
53.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
54Use the configuration file
55.Ar FILENAME .
56.It Fl d Ar DATA | Fl -data= Ns Ar DATA
57the data to insert under
58.Ar KEY .
59.It Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION
60how long to store this entry in the DHT (in seconds)
61.It Fl h | -help
62Print short help on options.
63.It Fl k Ar KEY | Fl -key= Ns Ar KEY
64use the query key
65.Ar KEY .
66.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
67Use LOGLEVEL for logging.
68Valid values are DEBUG, INFO, WARNING and ERROR.
69.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
70Configure logging to write logs to
71.Ar LOGFILE .
72.It Fl R | -record
73Set DHT's record route option for the request.
74.It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL
75Use the DHT replication level
76.Ar LEVEL .
77.It Fl t Ar TYPE | -type= Ns Ar TYPE
78the block type of
79.Ar DATA .
80.It Fl V | -verbose
81be verbose.
82.It Fl v | -version
83Print GNUnet version number.
84.It Fl x | -demultiplex
85Set DHT's demultiplex everywhere option.
86.El
87.Sh SEE ALSO
88The full documentation for gnunet is maintained as a Texinfo manual.
89If the
90.Xr info 1
91and gnunet programs are properly installed at your site, the command
92.Pp
93.Dl info gnunet
94.\".Sh HISTORY
95.\".Sh AUTHORS
96.Sh BUGS
97Report bugs by using
98.Lk https://bugs.gnunet.org
99or by sending electronic mail to
100.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-did.1 b/doc/man/gnunet-did.1
new file mode 100644
index 000000000..283561920
--- /dev/null
+++ b/doc/man/gnunet-did.1
@@ -0,0 +1,108 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2023 GNUnet e.V.
3.\"
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
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 5, 2023
25.Dt GNUNET-DID 1
26.Os
27.Sh NAME
28.Nm gnunet-did
29.Nd command line tool to create and manage gnunet identity DIDs.
30.Sh SYNOPSIS
31.Nm
32.Op Fl A | -show-all
33.Op Fl C | -create
34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl d Ar DID | Fl -did= Ns Ar DID
36.Op Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT
37.Op Fl e Ar EGO | Fl -ego= Ns Ar EGO
38.Op Fl g | -get
39.Op Fl h | -help
40.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
41.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
42.Op Fl r | -remove
43.Op Fl R | -replace
44.Op Fl s | -show
45.Op Fl t Ar TIME | Fl -expiration-time= Ns Ar TIME
46.Op Fl v | -version
47.Sh DESCRIPTION
48.Nm
49is a command line tool to create and manage gnunet identity DIDs.
50.Sh OPTIONS
51.Bl -tag -width indent
52.It Fl A | -show-all
53List all DIDs for all egos.
54.It Fl C | -create
55Create a DID Document and display the DID.
56.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
57Use the specified configuration file
58.Ar FILENAME .
59.It Fl d Ar DID | Fl -did= Ns Ar DID
60The to use for the operation is
61.Ar DID .
62.It Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT
63The DID Document to use is
64.Ar DID_DOCUMENT .
65.It Fl e Ar EGO | Fl -ego= Ns Ar EGO
66The ego to use is
67.Ar EGO .
68.It Fl g | -get
69Get the DID Document associated with the DID given in
70.Ar DID .
71.It Fl h | -help
72Print short help on options.
73.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
74Use LOGLEVEL for logging.
75Valid values are DEBUG, INFO, WARNING and ERROR.
76.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
77Configure logging to write logs to
78.Ar LOGFILE .
79.It Fl r | -remove
80Remove the DID given in --did.
81.It Fl R | -replace
82Replace the DID Docuemnt given in --did-document for the DID given in
83.Ar DID .
84.It Fl s | -show
85Show the DID for the ego given in --ego.
86.It Fl t | -expiration-time
87The expiration time to use in the GNS record for the DID Document given in
88Ar. DID_DOCUMENT .
89.It Fl v | -version
90Print GNUnet version number.
91.El
92.Sh SEE ALSO
93The full documentation for gnunet is maintained as a Texinfo manual.
94If the
95.Xr info 1
96and gnunet programs are properly installed at your site, the command
97.Pp
98.Dl info gnunet
99.Pp
100should give you access to the complete handbook.
101.sp
102.\".Sh HISTORY
103.\".Sh AUTHORS
104.Sh BUGS
105Report bugs by using
106.Lk https://bugs.gnunet.org
107or by sending electronic mail to
108.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1
index 0993fb419..72a7785d7 100644
--- a/doc/man/gnunet-dns2gns.1
+++ b/doc/man/gnunet-dns2gns.1
@@ -57,7 +57,6 @@ Valid values are DEBUG, INFO, WARNING and ERROR.
57Print GNUnet version number. 57Print GNUnet version number.
58.El 58.El
59.Sh SEE ALSO 59.Sh SEE ALSO
60.Xr gnunet-gns-fcfs 1 ,
61.Xr gnunet-gns 1 , 60.Xr gnunet-gns 1 ,
62.Xr gnunet-identity 1 61.Xr gnunet-identity 1
63.Pp 62.Pp
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index 599d3b269..d693d3688 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -26,7 +26,7 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-identity 28.Nm gnunet-identity
29.Nd create, delete or list egos 29.Nd maintain (create, delete or list) or perform actions with egos
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl C Ar NAME | Fl -create= Ns Ar NAME 32.Op Fl C Ar NAME | Fl -create= Ns Ar NAME
@@ -34,11 +34,13 @@
34.Op Fl d | -display 34.Op Fl d | -display
35.Op Fl e Ar NAME | Fl -ego= Ns Ar NAME 35.Op Fl e Ar NAME | Fl -ego= Ns Ar NAME
36.Op Fl h | -help 36.Op Fl h | -help
37.Op Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY
37.Op Fl m | -monitor 38.Op Fl m | -monitor
38.Op Fl p | -private-keys 39.Op Fl p | -private-keys
39.Op Fl q | -quiet 40.Op Fl q | -quiet
40.Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM 41.Op Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
41.Op Fl V | -verbose 42.Op Fl V | -verbose
43.Op Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
42.Op Fl X | -eddsa 44.Op Fl X | -eddsa
43.Sh DESCRIPTION 45.Sh DESCRIPTION
44.Nm 46.Nm
@@ -51,6 +53,9 @@ created locally, to create new egos, and to delete
51existing egos (the namespace will continue to exist, but it will 53existing egos (the namespace will continue to exist, but it will
52be impossible to add additional data to it). 54be impossible to add additional data to it).
53.Pp 55.Pp
56In addition, it is possible to encrypt and decrypt messages (arbitrary strings)
57using a given public key (for encryption) or ego (for decryption).
58.Pp
54Creating a new ego requires using the 59Creating a new ego requires using the
55.Fl C 60.Fl C
56option together with an identifier (name) that is to be used for 61option together with an identifier (name) that is to be used for
@@ -72,6 +77,11 @@ Perform "set" operation with the respective ego or restrict "display"
72operation to the respective ego. 77operation to the respective ego.
73.It Fl h | -help 78.It Fl h | -help
74Print the help page. 79Print the help page.
80.It Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY
81The public key to use for a message recipient. Use together with
82.Fl W .
83The recipient can obtain the desired ego's public key using the "display"
84operation.
75.It Fl m | -monitor 85.It Fl m | -monitor
76Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 86Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
77Each ego is listed together with a unique pointer value; if 87Each ego is listed together with a unique pointer value; if
@@ -83,18 +93,21 @@ keys. The second column shows the public key, the third column shows the
83private key. 93private key.
84.It Fl q | -quiet 94.It Fl q | -quiet
85Be quiet, in particular outputs only the public key when listing egos. 95Be quiet, in particular outputs only the public key when listing egos.
86.It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM 96.It Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
87Perform "set" operation for the specified 97Decrypt (read) a message using the respective ego private key. Use together with
88.Ar SUBSYSTEM
89with the respective ego.
90Needs to be used together with option
91.Fl e . 98.Fl e .
92After this, the given SUBSYSTEM will use the ego with the specified NAME. 99The message consists of an ephemeral key and the ciphertext, separated by a dot.
93This will fail if 100Such messages can be created with
94.Ar NAME 101.Fl W .
95does not yet exist.
96.It Fl V | -verbose 102.It Fl V | -verbose
97Be verbose, in particular outputs the public key of freshly created egos. 103Be verbose, in particular outputs the public key of freshly created egos.
104.It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
105Encrypt (write) the given message for the identity given with
106.Fl k .
107The output contains an ephemeral message public key and the message separated
108by a dot. The entire line needs to be transferred to the recipient, who can use
109.Fl R
110to decrypt the message.
98.It Fl X | -eddsa 111.It Fl X | -eddsa
99Use EdDSA instead of ECDSA. 112Use EdDSA instead of ECDSA.
100.El 113.El
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-messenger.1
index 94951af86..9dfe86227 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-messenger.1
@@ -1,5 +1,5 @@
1.\" This file is part of GNUnet. 1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V. 2.\" Copyright (C) 2023 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,59 +21,51 @@
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.Dd March 4, 2013 24.Dd January 5, 2023
25.Dt GNUNET-PEERINFO 1 25.Dt GNUNET-MESSENGER 1
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-peerinfo 28.Nm gnunet-messenger
29.Nd display information about other peers 29.Nd Open and connect to rooms using the MESSENGER service to chat.
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33.Op Fl g | -get-hello 33.Op Fl d Ar PEERIDENTITY | Fl -door= Ns Ar PEERIDENTITY
34.Op Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY
34.Op Fl h | -help 35.Op Fl h | -help
35.Op Fl i | -info
36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE 37.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
38.Op Fl n | -numeric 38.Op Fl p | -private
39.Op Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO 39.Op Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY
40.Op Fl q | -quiet
41.Op Fl s | -self
42.Op Fl v | -version 40.Op Fl v | -version
43.Sh DESCRIPTION 41.Sh DESCRIPTION
44.Nm 42.Nm
45displays the known addresses and trust of known peers. 43is a command line tool to connect to rooms using the MESSENGER service to chat.
44.Sh OPTIONS
46.Bl -tag -width indent 45.Bl -tag -width indent
47.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 46.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
48Load config file, default FILENAME of the config is 47Use the specified configuration file
49.Pa ~/.config/gnunet.conf . 48.Ar FILENAME .
50.It Fl g | -get-hello 49.It Fl d Ar PEERIDENTITY | Fl -did= Ns Ar PEERIDENTITY
51Output HELLO uri(s) 50peer identity to entry into the room.
51.It Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY
52identity to use for messaging
52.It Fl h | -help 53.It Fl h | -help
53Print the help page. 54Print short help on options.
54.It Fl i | -info
55List all known peers (and their addresses).
56.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 55.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
57Set the loglevel 56Use LOGLEVEL for logging.
58.It Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE 57Valid values are DEBUG, INFO, WARNING and ERROR.
59Log messages to LOGFILE 58.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
60.It Fl n | -numeric 59Configure logging to write logs to
61Disable resolution of IPs to hostnames 60.Ar LOGFILE .
62.It Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO 61.It Fl p | -private
63Add given HELLO uri to the database 62flag to enable private mode.
64.It Fl q | -quiet 63.It Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY
65Do not print anything but the peer identities 64key of the room to connect to.
66.It Fl s | -self
67Print only our own identity.
68Together with
69.Fl q ,
70this is the exact line that other peers would have to put in to their friends file in order to consider this peer one of their friends in F2F mode.
71.It Fl v | -version 65.It Fl v | -version
72Print the version number 66Print GNUnet version number.
73.El 67.El
74.Sh SEE ALSO 68.Sh SEE ALSO
75.Xr gnunet.conf 5
76.sp
77The full documentation for gnunet is maintained as a Texinfo manual. 69The full documentation for gnunet is maintained as a Texinfo manual.
78If the 70If the
79.Xr info 1 71.Xr info 1
@@ -81,15 +73,8 @@ and gnunet programs are properly installed at your site, the command
81.Pp 73.Pp
82.Dl info gnunet 74.Dl info gnunet
83.Pp 75.Pp
84should give you access to the complete handbook, 76should give you access to the complete handbook.
85.Pp
86.Dl info gnunet-c-tutorial
87.Pp
88will give you access to a tutorial for developers.
89.sp 77.sp
90Depending on your installation, this information is also available in
91.Xr gnunet 7 and
92.Xr gnunet-c-tutorial 7 .
93.\".Sh HISTORY 78.\".Sh HISTORY
94.\".Sh AUTHORS 79.\".Sh AUTHORS
95.Sh BUGS 80.Sh BUGS
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-namestore-dbtool.1
index d079609ad..af882209b 100644
--- a/doc/man/gnunet-testbed-profiler.1
+++ b/doc/man/gnunet-namestore-dbtool.1
@@ -1,5 +1,5 @@
1.\" This file is part of GNUnet. 1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V. 2.\" Copyright (C) 2001-2022 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,50 +21,48 @@
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.Dd September 13, 2014 24.Dd September 30, 2022
25.Dt GNUNET-TESTBED-PROFILER 1 25.Dt GNUNET-NAMESTORE-DBTOOL 1
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-testbed-profiler 28.Nm gnunet-namestore-dbtool
29.Nd profiling driver for the testbed 29.Nd manipulate GNU Name System (GNS) namestore database
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl i | -initialize
32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33.Op Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT 34.Op Fl r | -reset
34.Op Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME
35.Op Fl h | -help 35.Op Fl h | -help
36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE 37.Op Fl p Ar PLUGIN | Fl -plugin= Ns Ar PLUGIN
38.Op Fl n | -non-interactive
39.Op Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT
40.Op Fl v | -version 38.Op Fl v | -version
41.Sh DESCRIPTION 39.Sh DESCRIPTION
42.Nm 40.Nm
43is a command line profiling driver for the testbed. 41can be used to initialize or reset the namestore database.
44.Sh OPTIONS 42.Pp
43The options are as follows:
45.Bl -tag -width indent 44.Bl -tag -width indent
46.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 45.It Fl i | -initialize
47Use the configuration file FILENAME. 46Desired operation is initialization of a database.
48.It Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT 47.It Fl p Ar PLUGINNAME | Fl -plugin= Ns Ar PLUGINNAME
49Tolerate COUNT number of continuous timeout failures. 48Use the plugin PLUGINNAME.
50.It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME 49.It Fl r | -reset
51Name of the file with the login information for the testbed. 50Desired operation is reset and reinitialization of a database
52.It Fl h | -help 51.It Fl h | -help
53Print short help on options. 52Print short help on options.
54.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 53.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
55Use LOGLEVEL for logging. 54Use LOGLEVEL for logging.
56Valid values are DEBUG, INFO, WARNING and ERROR. 55Valid values are DEBUG, INFO, WARNING and ERROR.
57.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
58Configure logging to write logs to LOGFILE.
59.It Fl n | -non-interactive
60Run profiler in non-interactive mode where upon testbed setup the profiler does not wait for a keystroke but continues to run until a termination signal is received.
61.It Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT
62Create COUNT number of peers.
63.It Fl v | -version 56.It Fl v | -version
64Print GNUnet version number. 57Print GNUnet version number.
65.El 58.El
59.\".Sh EXAMPLES
60.\".Sh FILES
66.Sh SEE ALSO 61.Sh SEE ALSO
67The full documentation for gnunet is maintained as a Texinfo manual. 62.Xr gnunet-gns 1 ,
63.Xr gnunet-namestore 1
64.sp
65The full documentation for GNUnet is maintained as a Texinfo manual.
68If the 66If the
69.Xr info 1 67.Xr info 1
70and gnunet programs are properly installed at your site, the command 68and gnunet programs are properly installed at your site, the command
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-zonefile.1
index 39bb9fcbc..2b602b8df 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-zonefile.1
@@ -1,5 +1,5 @@
1.\" This file is part of GNUnet. 1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V. 2.\" Copyright (C) 2022 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,39 +21,30 @@
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.Dd September 5, 2013 24.Dd Friday 21, 2022
25.Dt GNUNET-NAMESTORE-FCFSD 1 25.Dt GNUNET-NAMESTORE-ZONEFILE 1
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-namestore-fcfsd 28.Nm gnunet-namestore-zonefile
29.Nd HTTP server for GNU Name System First-Come-First-Served name registration 29.Nd Import GNU Name System (GNS) zone data using zonefiles.
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33.Op Fl h | -help 33.Op Fl h | -help
34.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 34.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
35.Op Fl v | -version 35.Op Fl v | -version
36.Op Fl z Ar EGO | -zone= Ns Ar EGO 36.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO
37.Sh DESCRIPTION 37.Sh DESCRIPTION
38Most users will not want to run an FCFS-zone and thus will not need this program.
39.Pp
40.Nm 38.Nm
41runs a web server where users can register names to be mapped to their GNS zone. 39can be used to manipulate records in a GNS zone.
42Names are made available on a First Come First Served basis (hence fcfs). 40.Pp
43Registered names do not expire. 41The zonefile is read from standard input.
44The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT".
45.Pp 42.Pp
46It is possible to manage gnunet-gns-fcfsd using gnunet-(service-arm) by starting the daemon using "gnunet-arm -i fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your configuration and the "-z ZONE" in as the "OPTION". 43$ORIGIN entries in the zonefile will be treated as ego names (without the trailing ".") and created if missing.
47.Pp 44.Pp
48An FCFS-zone is run at 45To implicity give an initial $ORIGIN, use the --ego flag.
49.Lk http://gnunet.org/fcfs/ .
50GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
51.Pp 46.Pp
52If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet-identity -C NAME"), and use it with the 47All records will be created public and with relative expiration times set to the value provided in $TTL entries.
53.Fl z
54option.
55After that, you can start the FCFSD service (possibly using
56.Xr gnunet-arm 1 Ns ).
57.Pp 48.Pp
58The options are as follows: 49The options are as follows:
59.Bl -tag -width indent 50.Bl -tag -width indent
@@ -66,19 +57,22 @@ Use LOGLEVEL for logging.
66Valid values are DEBUG, INFO, WARNING and ERROR. 57Valid values are DEBUG, INFO, WARNING and ERROR.
67.It Fl v | -version 58.It Fl v | -version
68Print GNUnet version number. 59Print GNUnet version number.
69.It Fl z Ar EGO | -zone= Ns Ar EGO 60.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
70Specifies for which 61Specifies the name of the ego controlling the private key for the
71.Ar EGO 62zone. If not provided, we will attempt to use the default identity set
72FCFSD should manage the zone. 63for the "namestore". Alternatively, a private key may be passed in
64Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment
65variable. The latter is useful to improve performance of tools like
66Ascension as it allows the command to skip IPC with the identity
67management subsystem.
73.El 68.El
74.\".Sh EXAMPLES 69.\".Sh EXAMPLES
75.\".Sh FILES 70.\".Sh FILES
76.Sh SEE ALSO 71.Sh SEE ALSO
77.Xr gnunet-identity 1 ,
78.Xr gnunet-gns 1 , 72.Xr gnunet-gns 1 ,
79.Xr gnunet-gns-proxy 1 73.Xr gnunet-namestore 1
80.sp 74.sp
81The full documentation for gnunet is maintained as a Texinfo manual. 75The full documentation for GNUnet is maintained as a Texinfo manual.
82If the 76If the
83.Xr info 1 77.Xr info 1
84and gnunet programs are properly installed at your site, the command 78and gnunet programs are properly installed at your site, the command
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 73bbe5a5c..6915aed6e 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -1,5 +1,5 @@
1.\" This file is part of GNUnet. 1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V. 2.\" Copyright (C) 2001-2022 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
@@ -39,15 +39,20 @@
39.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 39.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
40.Op Fl m | -monitor 40.Op Fl m | -monitor
41.Op Fl n Ar NAME | Fl -name= Ns Ar NAME 41.Op Fl n Ar NAME | Fl -name= Ns Ar NAME
42.Op Fl O | -list-orphans
43.Op Fl o | -omit-private
44.Op Fl P | -purge-orphans
42.Op Fl p | -public 45.Op Fl p | -public
43.Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
44.Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
45.Op Fl s | -shadow 46.Op Fl s | -shadow
47.Op Fl S | -from-stdin
48.Op Fl T | -include-maintenance
46.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE 49.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
47.Op Fl u Ar URI | Fl -uri= Ns Ar URI 50.Op Fl u Ar URI | Fl -uri= Ns Ar URI
48.Op Fl v | -version 51.Op Fl v | -version
49.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE 52.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE
53.Op Fl X | -purge-zone-records
50.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO 54.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO
55.Op Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
51.Sh DESCRIPTION 56.Sh DESCRIPTION
52.Nm 57.Nm
53can be used to manipulate records in a GNS zone. 58can be used to manipulate records in a GNS zone.
@@ -88,26 +93,53 @@ Monitor changes to the zone on an ongoing basis (in contrast to -D,
88which merely displays the current records). 93which merely displays the current records).
89.It Fl n Ar NAME | Fl -name= Ns Ar NAME 94.It Fl n Ar NAME | Fl -name= Ns Ar NAME
90Label or name of the record to add/delete/display. 95Label or name of the record to add/delete/display.
96.It Fl O | -list-orphans
97List orphaned records.
98.It Fl o | -omit-private
99Filter private records. Use in combination with --display.
100.It Fl P | -purge-orphans
101Delete orphaned records from namestore.
91.It Fl p | -public 102.It Fl p | -public
92Create a record that is public (shared with other users that know the 103Create a record that is public (shared with other users that know the
93label). 104label).
94.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY 105.It Fl r | -recordline
95Determine our GNS name for the given public key (reverse lookup of the 106Changes the output format of zones and records to recordline.
96PKEY) in the given zone.
97.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
98Sets record set to values given in RECORDLINE.
99This option can be specified multiple times to provide multiple
100records for the record set.
101Existing records under the same label will be deleted.
102The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is
103the time to live in seconds (unit must not be given explicitly,
104seconds is always implied), TYPE is the DNS/GNS record type,
105FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC".
106The VALUE follows the usual human-readable value format(s) of DNS/GNS.
107.It Fl s | -shadow 107.It Fl s | -shadow
108Create a record that is a shadow record. 108Create a record that is a shadow record.
109Shadow records are only used once all other records of the same type 109Shadow records are only used once all other records of the same type
110under the same label have expired. 110under the same label have expired.
111.It Fl S | -from-stdin
112Read recordlines from stdin until EOF is encountered.
113The format uses
114.B recordlines
115:
116A record in a recordline follows the format
117
118NAME.EGO:
119 TYPE EXPIRATION [FLAGS] VALUE
120 ...
121Multiple records may be provided for a name.
122
123EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 seconds).
124
125FLAGS is a concatenation of record flags.
126Possible values for flags and their meaning are:
127.Pp
128 p: Public
129 s: Shadow
130 S: Supplemental
131 C: Critical
132 r: Relative expiration
133
134TYPE and VALUE are used in the same way as for the "-t" and "-V" options.
135Example formats for recordlines can be output using the "-D" flag combined
136with "--recordline".
137An example record set in recordline format can be found in the examples.
138It is possible to specify multiple record sets.
139Can only be used in combination with "-a" to add the parsed record sets.
140Existing record sets under names will be replaced.
141.It Fl T | -include-maintenance
142Show maintenance records such as TOMBSTONEs. Use in combination with --display.
111.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE 143.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
112Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). 144Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.).
113.It Fl u Ar URI | Fl -uri= Ns Ar URI 145.It Fl u Ar URI | Fl -uri= Ns Ar URI
@@ -121,6 +153,8 @@ Specific format depends on the record type.
121A records expect a dotted decimal IPv4 address, AAAA records an IPv6 153A records expect a dotted decimal IPv4 address, AAAA records an IPv6
122address, PKEY a public key in GNUnet's printable format, and CNAME and 154address, PKEY a public key in GNUnet's printable format, and CNAME and
123NS records should be a domain name. 155NS records should be a domain name.
156.It Fl X | -purge-zone-records
157Delete all records in a zone.
124.It Fl z Ar EGO | Fl -zone= Ns Ar EGO 158.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
125Specifies the name of the ego controlling the private key for the 159Specifies the name of the ego controlling the private key for the
126zone. If not provided, we will attempt to use the default identity set 160zone. If not provided, we will attempt to use the default identity set
@@ -129,8 +163,45 @@ Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment
129variable. The latter is useful to improve performance of tools like 163variable. The latter is useful to improve performance of tools like
130Ascension as it allows the command to skip IPC with the identity 164Ascension as it allows the command to skip IPC with the identity
131management subsystem. 165management subsystem.
166.It Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
167Determine our GNS name for the given public key (reverse lookup of the
168KEY) in the given zone.
132.El 169.El
133.\".Sh EXAMPLES 170.Sh EXAMPLES
171.Tp
172.Nm
173-z example -a -n www -t A -V "1.2.3.4" -e 1d -p
174.Tp
175.Pp
176.Dl Add a public record for ego "example" with name "www" containing an IP address.
177.sp
178.Tp
179.Nm
180-z example -D
181.Tp
182.Pp
183.Dl Show all records for ego "example".
184.sp
185.Tp
186.Nm
187-z example -D -r
188.Tp
189.Pp
190.Dl Show all records for ego "example" in recordline format.
191.sp
192.Tp
193.Nm
194--add --from-stdin <<EOF
195 www.alice:
196 A 3600000000 [pr] 1.2.3.4
197 TXT 3600000001 [pr] Hello World
198
199 www.bob:
200 A 12345679000000 [pr] 4.3.2.1
201 EOF
202.Tp
203.Pp
204.Dl Read record sets in recordline format from stdin.
134.\".Sh FILES 205.\".Sh FILES
135.Sh SEE ALSO 206.Sh SEE ALSO
136.Xr gnunet-gns 1 , 207.Xr gnunet-gns 1 ,
diff --git a/doc/man/gnunet-nse.1 b/doc/man/gnunet-nse.1
index 5f2d02bfa..193173381 100644
--- a/doc/man/gnunet-nse.1
+++ b/doc/man/gnunet-nse.1
@@ -48,6 +48,9 @@ Use LOGLEVEL for logging.
48Valid values are DEBUG, INFO, WARNING and ERROR. 48Valid values are DEBUG, INFO, WARNING and ERROR.
49.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE 49.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
50Configure logging to write logs to LOGFILE. 50Configure logging to write logs to LOGFILE.
51.It Fl m | -monitor
52In monitor mode, gnunet-nse will continuously print the NSE estimates,
53instead of giving just a snapshot.
51.It Fl v | -version 54.It Fl v | -version
52Print GNUnet version number. 55Print GNUnet version number.
53.El 56.El
diff --git a/doc/man/gnunet-reclaim.1 b/doc/man/gnunet-reclaim.1
index 70c63666c..a38d9c9e0 100644
--- a/doc/man/gnunet-reclaim.1
+++ b/doc/man/gnunet-reclaim.1
@@ -39,6 +39,9 @@
39.Op Fl d Ar ID | Fl -delete= Ns Ar ID 39.Op Fl d Ar ID | Fl -delete= Ns Ar ID
40.Op Fl r Ar RP | Fl -rp= Ns Ar RP 40.Op Fl r Ar RP | Fl -rp= Ns Ar RP
41.Op Fl D | -dump 41.Op Fl D | -dump
42.Op Fl A | -credentials
43.Op Fl I | -credential-id Ns Ar CREDENTIAL_ID
44.Op Fl N | -credential-name Ns AR NAME
42.Op Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... 45.Op Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,...
43.Op Fl C Ar TICKET | Fl -consume= Ns Ar TICKET 46.Op Fl C Ar TICKET | Fl -consume= Ns Ar TICKET
44.Op Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET 47.Op Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET
@@ -73,6 +76,12 @@ Delete an attribute with ID.
73Specify relative expiration interval (freshness) of attribute. 76Specify relative expiration interval (freshness) of attribute.
74.It Fl D | -dump 77.It Fl D | -dump
75List all attributes for given identity. 78List all attributes for given identity.
79.It Fl A | -credentials
80List credentials for a given identity.
81.It Fl I | -credential-id= Ns Ar CREDENTIAL_ID
82Credential ID to use when creating an attribute backed by a credential
83.It Fl N | -credential-name= Ns Ar NAME
84The name of the credential to add.
76.It Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... 85.It Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,...
77Authorize a relying party to access a set of attributes. Must be 86Authorize a relying party to access a set of attributes. Must be
78used in conjunction with -r. Returns a TICKET. 87used in conjunction with -r. Returns a TICKET.
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 4ec5189de..3145842a4 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -21,7 +21,7 @@
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.Dd February 25, 2012 24.Dd February 12, 2022
25.Dt GNUNET-SEARCH 1 25.Dt GNUNET-SEARCH 1
26.Os 26.Os
27.Sh NAME 27.Sh NAME
@@ -30,13 +30,18 @@
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL 32.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
33.Op Fl b | -bookmark-only
33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl F Ar FORMAT | Fl -dir-printf= Ns Ar FORMAT
36.Op Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT
34.Op Fl h | -help 37.Op Fl h | -help
38.Op Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT
35.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 39.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
36.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME 40.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
37.Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME 41.Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME
38.Op Fl n | -no-network 42.Op Fl n | -no-network
39.Op Fl N Ar VALUE | Fl -results= Ns Ar VALUE 43.Op Fl N Ar VALUE | Fl -results= Ns Ar VALUE
44.Op Fl s | -silent
40.Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY 45.Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY
41.Op Fl v | -version 46.Op Fl v | -version
42.Op Fl V | -verbose 47.Op Fl V | -verbose
@@ -63,40 +68,207 @@ The specific numeric value (for anonymity levels above 1) is simple:
63Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. 68Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
64The time-period is twice the average delay by which GNUnet artificially delays traffic. 69The time-period is twice the average delay by which GNUnet artificially delays traffic.
65Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. 70Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
71.It Fl b | -bookmark-only
72Do not search, print only the URI that points to the search with the given keywords.
66.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 73.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
67Use the configuration file 74Use the configuration file
68.Ar FILENAME 75.Ar FILENAME
69(default: 76(default:
70.Pa ~/.config/gnunet.conf ) 77.Pa ~/.config/gnunet.conf Ns
78).
79.It Fl F Ar FORMAT | Fl -dir-printf= Ns Ar FORMAT
80Write the search results for directories according to
81.Ar FORMAT Ns
82\&. The directives supported here are identical to those supported in the
83.Fl -printf
84argument (please refer to it for more information). If missing,
85.Fl -dir-printf
86defaults to
87.Fl -printf Ns
88\&. If
89.Fl -printf
90is missing too
91.Fl -dir-printf
92defaults to
93.Ql #%n:\engnunet-download -o Qo %f Qc -R %u\en\en Ns
94\&.
95.It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT
96Write the search results according to
97.Ar FORMAT Ns
98, in which
99.Ql \e
100and
101.Ql %
102directives are interpreted as follows:
103.Bl -tag -width indent
104.It Li \e\e
105a literal backslash
106.No ( Ql \e Ns )
107.It Li \ea
108an alarm bell
109.It Li \eb
110a backspace
111.It Li \ee
112an escape
113.It Li \ef
114a form feed
115.It Li \en
116a newline
117.It Li \er
118a carriage return
119.It Li \et
120a horizontal tab
121.It Li \ev
122a vertical tab
123.It Li \e0
124an ASCII NUL.
125.It Li \eN...
126the character whose ASCII code is N..., expressed in octal digits
127.It Li \exX...
128the character whose ASCII code is X..., expressed in hexadecimal digits
129.Pp
130.El
131.Sy Note:
132The
133.Ql \e
134character followed by any other character not listed above is treated as an ordinary character, so both characters are printed.
135.Bl -tag -width indent
136.It Li %%
137a percent sign
138.It Li %a
139the complete list of all the printable metadata properties available, displayed according to the
140.Fl -iter-printf
141argument; this specifier optionally supports metatype filtering via hash sign
142.No (e.g.
143.Ql %2#a
144prints all embedded file names, if present - see libextractor's metatypes for the complete list of numerical identifiers)
145.It Li %f
146the file's name
147.It Li %j
148the first printable metadata property available, displayed according to the
149.Fl -iter-printf
150argument; this specifier optionally supports metatype filtering via hash sign
151.No (e.g.
152.Ql %5#j
153prints a book title, if present); see libextractor's metatypes for the complete list of numerical identifiers)
154.It Li %l
155the file name's length
156.It Li %m
157the file's mime type
158.It Li %n
159the search result number
160.It Li %s
161the file's size in bytes
162.It Li %u
163the file's URI
164.El
165.Pp
166.Sy Note:
167The
168.Ql %
169character followed by any other character not listed above is treated as an ordinary character, so both characters are printed.
170.Pp
171If missing,
172.Fl -printf
173defaults to
174.Ql #%n:\engnunet-download -o Qo %f Qc %u\en\en Ns
175\&.
71.It Fl h | -help 176.It Fl h | -help
72Print the help page. 177Print the help page.
178.It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT
179When the
180.Ql %a
181or
182.Ql %j
183format specifiers appear in
184.Fl -printf
185or
186.Fl -dir-printf Ns
187, list each metadata property according to
188.Ar FORMAT Ns
189, in which the
190.Ql \e
191directives are interpreted as in
192.Fl -printf
193and
194.Fl -dir-printf Ns
195, while the
196.Ql %
197directives are interpreted as follows:
198.Bl -tag -width indent
199.It Li %%
200a percent sign
201.It Li %p
202the property's content
203.It Li %l
204the property content's length in bytes
205.It Li %i
206the property type's unique identifier
207.It Li %n
208the property number
209.It Li %t
210the property type (available only if compiled with libextractor)
211.It Li %w
212the name of the plugin that provided the information
213.El
214.Pp
215.Sy Note:
216The
217.Ql %
218character followed by any other character not listed above is treated as an ordinary character, so both characters are printed.
219.Pp
220If missing,
221.Fl -iter-printf
222defaults to
223.Ql \& \& %t: %p\en
224or
225.Ql \& \& MetaType #%i: %p\en Ns
226, depending on whether the program was compiled with libextractor or not.
73.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 227.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
74Change the loglevel. 228Change the loglevel.
75Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 229Possible values for
230.Ar LOGLEVEL
231are ERROR, WARNING, INFO and DEBUG.
76.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME 232.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
77Write logs to 233Write logs to
78.Ar FILENAME . 234.Ar FILENAME .
79.It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME 235.It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME
80Writes a GNUnet directory containing all of the search results to 236Writes a GNUnet directory containing all of the search results to
81.Ar FILENAME . 237.Ar FILENAME
238.No (e.g.
239.Ql gnunet-search --output=commons.gnd commons Ns
240).
82.It Fl n | -no-network 241.It Fl n | -no-network
83Only search locally, do not forward requests to other peers. 242Only search locally, do not forward requests to other peers.
84.It Fl N Ar VALUE | Fl -results= Ns Ar VALUE 243.It Fl N Ar VALUE | Fl -results= Ns Ar VALUE
85Automatically terminate the search after receiving 244Automatically terminate the search after receiving
86.Ar VALUE 245.Ar VALUE
87results. 246results.
247.It Fl s | -silent
248Enable silent mode and do not print any result (the
249.Fl -output
250argument is required).
88.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY 251.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY
89Automatically timeout search after 252Automatically timeout search after
90.Ar DELAY . 253.Ar DELAY .
91The value given must be a number followed by a space and a time unit, for example "500 ms". 254The value given must be a number followed by a space and a time unit, for example
92Note that the quotes are required on the shell. 255.Qo 500 ms Qc . Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second).
93Otherwise the search runs until gnunet-search is aborted with CTRL-C. 256If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C.
94.It Fl v | -version 257.It Fl v | -version
95print the version number 258print the version number
96.It Fl V | -verbose 259.It Fl V | -verbose
97print meta data from search results as well 260append
261.Ql %a\en
262to the default
263.Fl -printf
264and
265.Fl -dir-printf
266arguments \[u2013] ignored when these are provided by the user
98.El 267.El
99You can run gnunet-search with an URI instead of a keyword. 268.Pp
269It is possible to run
270.Nm gnunet-search
271with an URI instead of a keyword.
100The URI can have the format for a namespace search or for a keyword search. 272The URI can have the format for a namespace search or for a keyword search.
101For a namespace search, the format is 273For a namespace search, the format is
102.Pp 274.Pp
@@ -108,46 +280,137 @@ For a keyword search, use
108.Pp 280.Pp
109If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. 281If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly.
110.sp 282.sp
111If multiple keywords are passed, gnunet-search will look for content matching any of the keywords. 283If multiple keywords are passed,
112The prefix "+" makes a keyword mandatory. 284.Nm gnunet-search
285will look for content matching any of the keywords.
286The
287.Ql +
288prefix makes a keyword mandatory.
113.Sh FILES 289.Sh FILES
114.Pa ~/.config/gnunet.conf 290.Pa ~/.config/gnunet.conf
115GNUnet configuration file; specifies the default value for the timeout 291GNUnet configuration file; specifies the default value for the timeout
116.Sh EXAMPLES 292.Sh EXAMPLES
117.Dl $ gnunet-search "Das Kapital" 293Example 1:
294.Pp
295.Dl $ gnunet-search 'Das Kapital'
118.Pp 296.Pp
119Searches for content matching the keyword "Das Kapital". 297searches for content matching the keyword
298.Dq Das Kapital Ns
299.
300.Pp
301Example 2:
302.Pp
303.Dl $ gnunet-search Das Kapital
304.Pp
305searches for content matching either keyword
306.Dq Das
307or keyword
308.Dq Kapital Ns
309.
310.Pp
311Example 3:
120.Pp 312.Pp
121.Dl $ gnunet-search +Das +Kapital 313.Dl $ gnunet-search +Das +Kapital
122.Pp 314.Pp
123Searches for content matching both mandatory keywords "Das" and "Kapital". 315searches for content matching both mandatory keywords
316.Dq Das
317and
318.Dq Kapital Ns
319.
124.sp 320.sp
125Search results are printed by gnunet-search like this: 321Search results are printed by
322.Nm gnunet-search
323like this:
126.Pp 324.Pp
127.ad l 325.ad l
128 gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE 326 gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
129 Description: The GNU General Public License 327.Pp
130 Mime-type: text/plain 328 Description: The GNU General Public License
329 Mime-type: text/plain
330 ...
131.ad b 331.ad b
132 332.Pp
133The first line contains the command to run to download the file. 333The first line contains the command to run to download the file.
134The suggested filename in the example is COPYING. 334The suggested filename in the example is
135The GNUnet URI consists of the key and query hash of the file and finally the size of the file. 335.Ql COPYING Ns
136After the command to download the file, GNUnet will print meta-data about the file as advertised in the search result. 336\&. The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
137The meta-data here is the description ("The GNU General Public License") and the mime-type ("text-plain"). 337If the
338.Fl -verbose
339option was provided, after the command to download the file, GNUnet will print metadata about the file as advertised in the search result.
340The metadata here is the description
341.No ( Ns
342.Dq The GNU General Public License Ns
343) and the mime-type
344.No ( Ns
345.Dq text-plain Ns
346).
138See the options for 347See the options for
139.Xr gnunet-publish 1 348.Xr gnunet-publish 1
140on how to supply meta-data by hand. 349on how to supply metadata by hand.
350.Pp
351The
352.Fl -printf
353.No ( Ns
354.Fl f Ns
355),
356.Fl -dir-printf
357.No ( Ns
358.Fl F Ns
359) and
360.Fl -iter-printf
361.No ( Ns
362.Fl i Ns
363) arguments offer powerful tools for manipulating the output printed. For instance,
364.Pp
365Example 4:
366.Pp
367.ad l
368 $ gnunet-search -f '%f (%s bytes)\en' commons
369.Pp
370will print a simple list of the results that match the
371.Dq commons
372keyword, with only the file name and the size printed, without any URI. Or, for instance,
373.Pp
374Example 5:
375.Pp
376.ad l
377 #!/bin/sh
378 {
379 printf '<list>'
380 gnunet-search -f '
381 <file uri="%u">
382 <filename len="%l">%f</filename>
383 <size>%s</size>
384 <mimetype>%m</mimetype>
385 <result_id>%n</result_id>
386 <metadata>%a
387 </metadata>
388 </file>' \e
389 -i '
390 <property tid="%i" type="%t">
391 <content len="%l">%p</content>
392 <property_id>%n</property_id>
393 <provided_by>%w</provided_by>
394 </property>' \e
395 -t '2 s' commons
396 printf '\en</list>\en'
397 } > commons.xml
398.Pp
399will run for two seconds and then create a file named
400.Pa commons.xml Ns
401, containing the search results that match the
402.Dq commons
403keyword in XML format.
141.Sh SEE ALSO 404.Sh SEE ALSO
142.Xr gnunet-download 1 , 405.Xr gnunet-download 1 ,
143.Xr gnunet-fs-gtk 1 , 406.Xr gnunet-fs-gtk 1 ,
144.Xr gnunet-publish 1 , 407.Xr gnunet-publish 1 ,
145.Xr gnunet.conf 5 408.Xr gnunet.conf 5
146.sp 409.sp
147The full documentation for gnunet is maintained as a Texinfo manual. 410The full documentation for GNUnet is maintained as a Texinfo manual.
148If the 411If the
149.Xr info 1 412.Xr info 1
150and gnunet programs are properly installed at your site, the command 413and gnunet packages are properly installed at your site, the command
151.Pp 414.Pp
152.Dl info gnunet 415.Dl info gnunet
153.Pp 416.Pp
diff --git a/doc/man/meson.build b/doc/man/meson.build
new file mode 100644
index 000000000..fbd8179ba
--- /dev/null
+++ b/doc/man/meson.build
@@ -0,0 +1,62 @@
1five = configure_file(input : 'gnunet.conf.5.in',
2 output : 'gnunet.conf.5',
3 configuration : cdata,
4 install: false,
5 install_dir: get_option('mandir'))
6
7install_man(
8 [
9 five,
10 'gnunet-arm.1',
11 'gnunet-auto-share.1',
12 'gnunet-base32.1',
13 'gnunet-bcd.1',
14 'gnunet-bugreport.1',
15 'gnunet-config.1',
16 'gnunet-core.1',
17 'gnunet-conversation.1',
18 'gnunet-conversation-test.1',
19 'gnunet-dht-get.1',
20 'gnunet-dht-put.1',
21 'gnunet-dht-monitor.1',
22 'gnunet-dht-hello.1',
23 'gnunet-directory.1',
24 'gnunet-dns2gns.1',
25 'gnunet-datastore.1',
26 'gnunet-download.1',
27 'gnunet-did.1',
28 'gnunet-ecc.1',
29 'gnunet-fs.1',
30 'gnunet-gns.1',
31 'gnunet-gns-proxy.1',
32 'gnunet-gns-proxy-setup-ca.1',
33 'gnunet-identity.1',
34 'gnunet-cadet.1',
35 'gnunet-messenger.1',
36 'gnunet-namecache.1',
37 'gnunet-namestore.1',
38 'gnunet-namestore-dbtool.1',
39 'gnunet-namestore-zonefile.1',
40 'gnunet-nat.1',
41 'gnunet-nat-auto.1',
42 'gnunet-nat-server.1',
43 'gnunet-nse.1',
44 'gnunet-publish.1',
45 'gnunet-qr.1',
46 'gnunet-reclaim.1',
47 'gnunet-resolver.1',
48 'gnunet-revocation.1',
49 'gnunet-scalarproduct.1',
50 'gnunet-scrypt.1',
51 'gnunet-search.1',
52 'gnunet-statistics.1',
53 'gnunet-testing.1',
54 'gnunet-testing-run-service.1',
55 'gnunet-timeout.1',
56 'gnunet-transport.1',
57 'gnunet-transport-certificate-creation.1',
58 'gnunet-unindex.1',
59 'gnunet-uri.1',
60 'gnunet-vpn.1',
61 'gnunet-zoneimport.1'])
62
diff --git a/doc/man/produce_html.sh.in b/doc/man/produce_html.sh.in
index 8680c0106..e9581622f 100755
--- a/doc/man/produce_html.sh.in
+++ b/doc/man/produce_html.sh.in
@@ -1,13 +1,6 @@
1#!/bin/bash 1#!/bin/bash
2 2
3if test -e @PKGDATADIRECTORY@/existence.sh 3if command -v mandoc >/dev/null 2>&1;
4then
5 . @PKGDATADIRECTORY@/existence.sh
6else
7 . $dir/../../contrib/build-common/sh/lib.sh/existence.sh
8fi
9
10if existence mandoc;
11then 4then
12 for f in `find . -name \*\.[1-9]`; 5 for f in `find . -name \*\.[1-9]`;
13 do 6 do
diff --git a/doc/meson.build b/doc/meson.build
new file mode 100644
index 000000000..84b3cfde2
--- /dev/null
+++ b/doc/meson.build
@@ -0,0 +1,2 @@
1subdir('handbook')
2subdir('man')
diff --git a/doc/doc.h b/doc/old/doc.h
index db079e94a..db079e94a 100644
--- a/doc/doc.h
+++ b/doc/old/doc.h
diff --git a/doc/docstyle.css b/doc/old/docstyle.css
index 8719248d0..8719248d0 100644
--- a/doc/docstyle.css
+++ b/doc/old/docstyle.css
diff --git a/doc/old/handbook/.gitignore b/doc/old/handbook/.gitignore
new file mode 100644
index 000000000..80ac74ea0
--- /dev/null
+++ b/doc/old/handbook/.gitignore
@@ -0,0 +1,11 @@
1stamp-1
2version2.texi
3manual
4*.fn
5*.fns
6*.ky
7*.pg
8*.tp
9*.vr
10gnunet
11gnunet.html
diff --git a/doc/handbook/Makefile.am b/doc/old/handbook/Makefile.am
index 7c10b417a..7c10b417a 100644
--- a/doc/handbook/Makefile.am
+++ b/doc/old/handbook/Makefile.am
diff --git a/doc/handbook/TODO b/doc/old/handbook/TODO
index fa1ce7a23..fa1ce7a23 100644
--- a/doc/handbook/TODO
+++ b/doc/old/handbook/TODO
diff --git a/doc/handbook/agpl-3.0.texi b/doc/old/handbook/agpl-3.0.texi
index eabb0c6df..eabb0c6df 100644
--- a/doc/handbook/agpl-3.0.texi
+++ b/doc/old/handbook/agpl-3.0.texi
diff --git a/doc/handbook/chapters/configuration.texi b/doc/old/handbook/chapters/configuration.texi
index 27efc82e2..27efc82e2 100644
--- a/doc/handbook/chapters/configuration.texi
+++ b/doc/old/handbook/chapters/configuration.texi
diff --git a/doc/handbook/chapters/contributing.texi b/doc/old/handbook/chapters/contributing.texi
index f3beeef76..f3beeef76 100644
--- a/doc/handbook/chapters/contributing.texi
+++ b/doc/old/handbook/chapters/contributing.texi
diff --git a/doc/handbook/chapters/developer.texi b/doc/old/handbook/chapters/developer.texi
index a8f9d1ec3..c8905f2c1 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/old/handbook/chapters/developer.texi
@@ -96,7 +96,7 @@ introduction, each of the GNUnet subsystems (directories in the
96addition to this documentation, GNUnet developers should be aware of the 96addition to this documentation, GNUnet developers should be aware of the
97services available on the GNUnet server to them. 97services available on the GNUnet server to them.
98 98
99New developers can have a look a the @uref{https://docs.gnunet.org/tutorial/gnunet-tutorial.html, GNUnet C tutorial}. 99New developers can have a look a the @uref{https://docs.gnunet.org/tutorial/tutorial.html, GNUnet C tutorial}.
100 100
101@c ** FIXME: Link to files in source, not online. 101@c ** FIXME: Link to files in source, not online.
102@c ** FIXME: Where is the Java tutorial? 102@c ** FIXME: Where is the Java tutorial?
@@ -6250,7 +6250,7 @@ by NAMESTORE.
6250Here a client uses the @code{GNUNET_NAMESTORE_zone_iteration_start} 6250Here a client uses the @code{GNUNET_NAMESTORE_zone_iteration_start}
6251function and passes the namestore handle, the zone to iterate over and a 6251function and passes the namestore handle, the zone to iterate over and a
6252callback function to call with the result. 6252callback function to call with the result.
6253If the client wants to iterate over all the WHAT!? FIXME, it passes NULL for the zone. 6253To iterate over all the zones, it is possible to pass NULL for the zone.
6254A @code{GNUNET_NAMESTORE_ZoneIterator} handle is returned to be used to 6254A @code{GNUNET_NAMESTORE_ZoneIterator} handle is returned to be used to
6255continue iteration. 6255continue iteration.
6256 6256
@@ -9990,7 +9990,7 @@ Also MESSENGER provides multiple features with privacy in mind:
9990 original sender (uses the MESSENGER provided verification) 9990 original sender (uses the MESSENGER provided verification)
9991@item MESSENGER allows using the publicly known anonymous ego instead of any 9991@item MESSENGER allows using the publicly known anonymous ego instead of any
9992 unique identifying ego 9992 unique identifying ego
9993@item MESSENGER allows your node to decide between acting as host of the used 9993@item MESSENGER allows your node to decide between acting as relay of the used
9994 messaging room (sharing your peer's identity with all nodes in the group) 9994 messaging room (sharing your peer's identity with all nodes in the group)
9995 or acting as guest (sharing your peer's identity only with the nodes you 9995 or acting as guest (sharing your peer's identity only with the nodes you
9996 explicitly open a connection to) 9996 explicitly open a connection to)
diff --git a/doc/handbook/chapters/installation.texi b/doc/old/handbook/chapters/installation.texi
index 54fb3f486..f93645114 100644
--- a/doc/handbook/chapters/installation.texi
+++ b/doc/old/handbook/chapters/installation.texi
@@ -41,8 +41,9 @@ should be installed with a package manager.
41 41
42The mandatory libraries and applications are 42The mandatory libraries and applications are
43@itemize @bullet 43@itemize @bullet
44@item autoconf 2.59 or above 44@item autoconf 2.59 or above (when building from git)
45@item automake 1.11.1 or above 45@item automake 1.11.1 or above (when building from git)
46@item recutils 1.0 or above (when building from git)
46@item gettext 47@item gettext
47@item glibc (read below, other libcs work) 48@item glibc (read below, other libcs work)
48@item GnuTLS 3.2.12 or above, recommended to be linked against libunbound 49@item GnuTLS 3.2.12 or above, recommended to be linked against libunbound
@@ -54,6 +55,7 @@ The mandatory libraries and applications are
54@item libidn2 or libidn 55@item libidn2 or libidn
55@item libmicrohttpd 0.9.63 or above 56@item libmicrohttpd 0.9.63 or above
56@item libunistring 57@item libunistring
58@item libjansson
57@item libgmp 59@item libgmp
58@item libgnurl or libcurl (libcurl has to be linked to GnuTLS) 7.35.0 or above 60@item libgnurl or libcurl (libcurl has to be linked to GnuTLS) 7.35.0 or above
59@item Texinfo 5.2 or above (for building the documentation) 61@item Texinfo 5.2 or above (for building the documentation)
@@ -100,7 +102,6 @@ These are the dependencies only required for certain features
100(for attribute-based encryption and the identity provider subsystem) 102(for attribute-based encryption and the identity provider subsystem)
101@item texi2mdoc (for automatic mdoc generation) 103@item texi2mdoc (for automatic mdoc generation)
102@item perl5 for some utilities (which are not installed) 104@item perl5 for some utilities (which are not installed)
103@item libjanson
104@end itemize 105@end itemize
105 106
106About libextractor being optional: 107About libextractor being optional:
diff --git a/doc/handbook/chapters/keyconcepts.texi b/doc/old/handbook/chapters/keyconcepts.texi
index c8dd1599b..c8dd1599b 100644
--- a/doc/handbook/chapters/keyconcepts.texi
+++ b/doc/old/handbook/chapters/keyconcepts.texi
diff --git a/doc/handbook/chapters/philosophy.texi b/doc/old/handbook/chapters/philosophy.texi
index 785a65e42..180589829 100644
--- a/doc/handbook/chapters/philosophy.texi
+++ b/doc/old/handbook/chapters/philosophy.texi
@@ -7,11 +7,12 @@
7@c of GNUnet. 7@c of GNUnet.
8The primary goal of the GNUnet project is to provide a reliable, open, 8The primary goal of the GNUnet project is to provide a reliable, open,
9non-discriminating and censorship-resistant system for information 9non-discriminating and censorship-resistant system for information
10exchange. We value free speech above state interests and intellectual 10exchange.
11We value free speech above state interests and intellectual
11monopoly. GNUnet's long-term goal is to serve as a development 12monopoly. GNUnet's long-term goal is to serve as a development
12platform for the next generation of Internet protocols. 13platform for the next generation of Internet protocols.
13 14
14GNUnet is an anarchistic network. Participants are encouraged to 15Participants are encouraged to
15contribute at least as much resources (storage, bandwidth) to the network 16contribute at least as much resources (storage, bandwidth) to the network
16as they consume, so that their participation does not have a negative 17as they consume, so that their participation does not have a negative
17impact on other users. 18impact on other users.
diff --git a/doc/handbook/chapters/preface.texi b/doc/old/handbook/chapters/preface.texi
index 961ec0737..961ec0737 100644
--- a/doc/handbook/chapters/preface.texi
+++ b/doc/old/handbook/chapters/preface.texi
diff --git a/doc/handbook/chapters/user.texi b/doc/old/handbook/chapters/user.texi
index aa912f96f..714336228 100644
--- a/doc/handbook/chapters/user.texi
+++ b/doc/old/handbook/chapters/user.texi
@@ -56,7 +56,8 @@ $ gnunet-arm -e
56* The GNS Tab:: 56* The GNS Tab::
57* Creating a Record:: 57* Creating a Record::
58* Resolving GNS records:: 58* Resolving GNS records::
59* Integration with Browsers:: 59* Integration with Browsers (DNS2GNS service)::
60* Integration with Browsers (SOCKS proxy)::
60* Creating a Business Card:: 61* Creating a Business Card::
61* Be Social:: 62* Be Social::
62* Backup of Identities and Egos:: 63* Backup of Identities and Egos::
@@ -67,8 +68,16 @@ $ gnunet-arm -e
67@node Preliminaries 68@node Preliminaries
68@subsection Preliminaries 69@subsection Preliminaries
69 70
71In the default configuration, there are two zones defined and shipped with
72GNUnet:
73
74The first is ``gnunet.org'', which points to the authoritate zone of the
75GNUnet project. It can be used to resolve, for example, ``www.gnunet.org''.
76
77``.pin'' is another default zone which points to a special zone also managed
78by gnunet.org. Users may register submodomains on a first-come first-served-basis
79at @url{https://fcfs.gnunet.org}.
70 80
71``.pin'' is a default zone which points to a zone managed by gnunet.org.
72Use @code{gnunet-config -s gns} to view the GNS configuration, including 81Use @code{gnunet-config -s gns} to view the GNS configuration, including
73all configured zones that are operated by other users. The respective 82all configured zones that are operated by other users. The respective
74configuration entry names start with a ``.'', e.g. ``.pin''. 83configuration entry names start with a ``.'', e.g. ``.pin''.
@@ -190,13 +199,99 @@ Got `A' record: 217.92.15.146
190That shows that resolution works, once GNS is integrated with 199That shows that resolution works, once GNS is integrated with
191the application. 200the application.
192 201
193@node Integration with Browsers 202@node Integration with Browsers (DNS2GNS service)
194@subsection Integration with Browsers 203@subsection Integration with Browsers (DNS2GNS service)
204
205Most OSes allow you to either modify your @code{/etc/resolv.conf} directly or
206through @code{resolvectl}.
207We are going to configure the @code{dns2gns} service in order to translate DNS name
208queries by applications to GNS name queries where applicable and else fall back
209to DNS.
210
211Optionally, you may want to configure your @code{dns2gns} service to run on a
212non-priviledged port like 5353.
213But, in case you are going to edit @code{/etc/resolv.conf} directly, the
214@code{dns2gns} service MUST run on port 53 as you cannot specify the port number.
215A $FALLBACK_DNS variable should be a DNS server you trust such as your local router:
216
217@example
218$ gnunet-config -s dns2gns -o OPTIONS -V "-d $FALLBACK_DNS -p 5252"
219$ gnunet-arm -i dns2gns # Make sure the service is started
220@end example
221
222If you edit your resolv.conf directly, it should contain and entry like this:
223
224@example
225nameserver 127.0.0.1
226@end example
227
228In any case, it is very likely that the method of modification of your
229resolver is OS specific.
230Recently, the combination of NetworkManager and systemd-resolved is becoming
231increasingly popular.
232
233If you use resolvectl and systemd-resolved you can temporarily
234set the nameserver like this:
235
236@example
237$ resolvectl $INTERFACE 127.0.0.1:5353
238@end example
239
240Where @code{$INTERFACE} is your network interface such as ``eth0''.
241
242In order to automatically set the DNS2GNS server if it is running already you
243can use NetworkManager-dispatcher. First, enable it:
195 244
245@example
246$ sudo systemctl enable NetworkManager-dispatcher.service
247$ sudo systemctl start NetworkManager-dispatcher.service
248@end example
196 249
197While we recommend integrating GNS using the NSS module in the 250Then, create a script /etc/NetworkManager/dispatch.h/10-dns2-gns.sh:
198GNU libc Name Service Switch, you can also integrate GNS 251
199directly with your browser via the @code{gnunet-gns-proxy}. 252@example
253#!/bin/sh
254interface=$1
255status=$2
256
257if [ "$interface" = "eth0" ]; then
258 case $status in
259 up)
260 if nc -u -z 127.0.0.1 5353; then
261 resolvectl dns $interface 127.0.0.1:5353
262 fi
263 ;;
264 down)
265 ;;
266 esac
267fi
268@end example
269
270Make sure the script is owned by root and executable:
271
272@example
273$ sudo root:root /etc/NetworkManager/dispatch.d/10-dns2gns.sh
274$ sudo +x /etc/NetworkManager/dispatch.d/10-dns2gns.sh
275@end example
276
277You can test accessing this website using your browser or curl:
278
279@example
280$ curl www.gnunet.org
281@end example
282
283Note that ``gnunet.org'' is a domain that also exists in DNS and for which the
284GNUnet project webservers can provide trusted TLS certificates.
285When using non-DNS names with GNS or aliases, this may result in issues
286when accessing HTTPS websites with browsers.
287In order learn how to provide relief for this issue, read on.
288
289@node Integration with Browsers (SOCKS proxy)
290@subsection Integration with Browsers (SOCKS proxy)
291
292While we recommend integrating GNS using the DNS2GNS service or the
293NSSwitch plugin, you can also
294integrate GNS directly with your browser via the @code{gnunet-gns-proxy}.
200This method can have the advantage that the proxy can validate 295This method can have the advantage that the proxy can validate
201TLS/X.509 records and thus strengthen web security; however, the proxy 296TLS/X.509 records and thus strengthen web security; however, the proxy
202is still a bit brittle, so expect subtle failures. We have had reasonable 297is still a bit brittle, so expect subtle failures. We have had reasonable
@@ -1561,6 +1656,9 @@ The GNS currently supports the record types as defined in
1561@uref{https://git.gnunet.org/gana.git/tree/gnu-name-system-record-types/registry.rec, GANA}. 1656@uref{https://git.gnunet.org/gana.git/tree/gnu-name-system-record-types/registry.rec, GANA}.
1562In addition, GNS supports DNS record types, such as A, AAAA or TXT. 1657In addition, GNS supports DNS record types, such as A, AAAA or TXT.
1563 1658
1659For a complete description of the records, please refer to the specification
1660at @uref{https://lsd.gnunet.org/lsd0001, LSD0001}.
1661
1564In the following, we discuss GNS records with specific behaviour or special 1662In the following, we discuss GNS records with specific behaviour or special
1565handling of DNS records. 1663handling of DNS records.
1566 1664
@@ -1570,8 +1668,9 @@ handling of DNS records.
1570* BOX:: 1668* BOX::
1571* LEHO:: 1669* LEHO::
1572* VPN:: 1670* VPN::
1573* CNAME:: 1671* REDIRECT::
1574* GNS2DNS:: 1672* GNS2DNS::
1673* TOMBSTONE::
1575* SOA SRV PTR and MX:: 1674* SOA SRV PTR and MX::
1576@end menu 1675@end menu
1577 1676
@@ -1668,11 +1767,11 @@ having the following lines in the @file{gnunet.conf} configuration file:
1668TCP_REDIRECTS = 80:localhost4:8080 1767TCP_REDIRECTS = 80:localhost4:8080
1669@end example 1768@end example
1670 1769
1671@node CNAME 1770@node REDIRECT
1672@subsubsection CNAME 1771@subsubsection REDIRECT
1673 1772
1674As specified in RFC 1035 whenever a CNAME is encountered the query 1773As specified in LSD0001 whenever a REDIRECT is encountered the query
1675needs to be restarted with the specified name. In GNS a CNAME 1774needs to be restarted with the specified name. A REDIRECT
1676can either be: 1775can either be:
1677 1776
1678@itemize @bullet 1777@itemize @bullet
@@ -1721,6 +1820,21 @@ However, imagine the nameserver was "ns.gnunet.org". In this case,
1721delegating to "ns.gnunet.org" would mean that despite using GNS, 1820delegating to "ns.gnunet.org" would mean that despite using GNS,
1722censorship in the DNS ".org" zone would still be effective. 1821censorship in the DNS ".org" zone would still be effective.
1723 1822
1823@node TOMBSTONE
1824@subsubsection TOMBSTONE
1825
1826The GNUnet GNS implementation uses the TOMBSTONE record to ensure
1827ciphertext indistinguishability for published records.
1828It must be ensured that when relative expiration times are decreased, the
1829expiration time of the next record block MUST be after the last published block.
1830A similar issue arises if the record set under a label is deleted and reused
1831later.
1832
1833The creation and maintenance of the TOMBSTONE record is done automatically.
1834You do not need to mind it yourself and can safely ignore any TOMBSTONE
1835blocks you may see when investigating your zone(s).
1836TOMBSTONE records are always private and will never be published.
1837
1724@node SOA SRV PTR and MX 1838@node SOA SRV PTR and MX
1725@subsubsection SOA SRV PTR and MX 1839@subsubsection SOA SRV PTR and MX
1726 1840
@@ -2346,16 +2460,16 @@ that will terminate at the respective peer's service.
2346@section Using the GNUnet Messenger 2460@section Using the GNUnet Messenger
2347 2461
2348The GNUnet Messenger subsystem allows decentralized message-based 2462The GNUnet Messenger subsystem allows decentralized message-based
2349communication inside of so called rooms. Each room can be hosted by 2463communication inside of so called rooms. Each room can be relayed by
2350a variable amount of peers. Every member of a room has the possibility 2464a variable amount of peers. Every member of a room has the possibility
2351to host the room on its own peer. A peer allows any amount of members 2465to relay the room on its own peer. A peer allows any amount of members
2352to join a room. The amount of members in a room is not restricted. 2466to join a room. The amount of members in a room is not restricted.
2353 2467
2354Messages in a room will be distributed between all peers hosting the 2468Messages in a room will be distributed between all peers relaying the
2355room or being internally (in context of the messenger service) connected 2469room or being internally (in context of the messenger service) connected
2356to a hosting peer. All received or sent messages will be stored on any 2470to a relaying peer. All received or sent messages will be stored on any
2357peer locally which is hosting the respective room or is internally 2471peer locally which is relaying the respective room or is internally
2358connected to such a hosting peer. 2472connected to such a relaying peer.
2359 2473
2360The Messenger service is built on the CADET subsystem to make internal 2474The Messenger service is built on the CADET subsystem to make internal
2361connections between peers using a reliable and encrypted transmission. 2475connections between peers using a reliable and encrypted transmission.
@@ -2392,9 +2506,9 @@ library designed for messenger applications.
2392@node Entering a room 2506@node Entering a room
2393@subsection Entering a room 2507@subsection Entering a room
2394 2508
2395You can enter any room by its ROOMKEY and any PEERIDENTITY of a hosting peer. 2509You can enter any room by its ROOMKEY and any PEERIDENTITY of a relaying
2396Optionally you can provide any IDENTITY which can represent a local ego by 2510peer. Optionally you can provide any IDENTITY which can represent a local
2397its name. 2511ego by its name.
2398 2512
2399@example 2513@example
2400$ gnunet-messenger [-e IDENTITY] -d PEERIDENTITY -r ROOMKEY 2514$ gnunet-messenger [-e IDENTITY] -d PEERIDENTITY -r ROOMKEY
@@ -2422,14 +2536,14 @@ be distributed as your name for the service in any case.
2422@subsection Opening a room 2536@subsection Opening a room
2423 2537
2424You can open any room in a similar way to entering it. You just have to leave 2538You can open any room in a similar way to entering it. You just have to leave
2425out the '-d' parameter and the PEERIDENTITY of the hosting peer. 2539out the '-d' parameter and the PEERIDENTITY of the relaying peer.
2426 2540
2427@example 2541@example
2428$ gnunet-messenger [-e IDENTITY] -r ROOMKEY 2542$ gnunet-messenger [-e IDENTITY] -r ROOMKEY
2429@end example 2543@end example
2430 2544
2431Providing ROOMKEY and IDENTITY is identical to entering a room. Opening a room 2545Providing ROOMKEY and IDENTITY is identical to entering a room. Opening a room
2432will also make your peer to a host of this room. So others can enter the room 2546will also make your peer to a relay of this room. So others can enter the room
2433through your peer if they have the required ROOMKEY and your peer ID. 2547through your peer if they have the required ROOMKEY and your peer ID.
2434 2548
2435If you want to use the zeroed hash as shared secret key for the room you can 2549If you want to use the zeroed hash as shared secret key for the room you can
diff --git a/doc/handbook/chapters/vocabulary.texi b/doc/old/handbook/chapters/vocabulary.texi
index 0ee472b95..0ee472b95 100644
--- a/doc/handbook/chapters/vocabulary.texi
+++ b/doc/old/handbook/chapters/vocabulary.texi
diff --git a/doc/handbook/docstyle.css b/doc/old/handbook/docstyle.css
index 8719248d0..8719248d0 100644
--- a/doc/handbook/docstyle.css
+++ b/doc/old/handbook/docstyle.css
diff --git a/doc/handbook/fdl-1.3.texi b/doc/old/handbook/fdl-1.3.texi
index cb71f05a1..cb71f05a1 100644
--- a/doc/handbook/fdl-1.3.texi
+++ b/doc/old/handbook/fdl-1.3.texi
diff --git a/doc/handbook/gendocs.sh b/doc/old/handbook/gendocs.sh
index 79c92c9ad..79c92c9ad 100755
--- a/doc/handbook/gendocs.sh
+++ b/doc/old/handbook/gendocs.sh
diff --git a/doc/handbook/gendocs_template b/doc/old/handbook/gendocs_template
index cb0450bee..cb0450bee 100644
--- a/doc/handbook/gendocs_template
+++ b/doc/old/handbook/gendocs_template
diff --git a/doc/handbook/gendocs_template_min b/doc/old/handbook/gendocs_template_min
index 6a4711870..6a4711870 100644
--- a/doc/handbook/gendocs_template_min
+++ b/doc/old/handbook/gendocs_template_min
diff --git a/doc/handbook/gnunet.texi b/doc/old/handbook/gnunet.texi
index ca74c347d..ca74c347d 100644
--- a/doc/handbook/gnunet.texi
+++ b/doc/old/handbook/gnunet.texi
diff --git a/doc/handbook/gpl-3.0.texi b/doc/old/handbook/gpl-3.0.texi
index 0e2e212ac..0e2e212ac 100644
--- a/doc/handbook/gpl-3.0.texi
+++ b/doc/old/handbook/gpl-3.0.texi
diff --git a/doc/handbook/htmlxref.cnf b/doc/old/handbook/htmlxref.cnf
index a4928f6fe..a4928f6fe 100644
--- a/doc/handbook/htmlxref.cnf
+++ b/doc/old/handbook/htmlxref.cnf
diff --git a/doc/handbook/images/ascension_interaction.png b/doc/old/handbook/images/ascension_interaction.png
index 84e2e9c0f..84e2e9c0f 100644
--- a/doc/handbook/images/ascension_interaction.png
+++ b/doc/old/handbook/images/ascension_interaction.png
Binary files differ
diff --git a/doc/handbook/images/ascension_ssd.png b/doc/old/handbook/images/ascension_ssd.png
index 3b142ab31..3b142ab31 100644
--- a/doc/handbook/images/ascension_ssd.png
+++ b/doc/old/handbook/images/ascension_ssd.png
Binary files differ
diff --git a/doc/handbook/images/daemon_lego_block.png b/doc/old/handbook/images/daemon_lego_block.png
index 5a088b532..5a088b532 100644
--- a/doc/handbook/images/daemon_lego_block.png
+++ b/doc/old/handbook/images/daemon_lego_block.png
Binary files differ
diff --git a/doc/handbook/images/daemon_lego_block.svg b/doc/old/handbook/images/daemon_lego_block.svg
index 38ad90d13..38ad90d13 100644
--- a/doc/handbook/images/daemon_lego_block.svg
+++ b/doc/old/handbook/images/daemon_lego_block.svg
diff --git a/doc/handbook/images/gns.dot b/doc/old/handbook/images/gns.dot
index 55b05d482..55b05d482 100644
--- a/doc/handbook/images/gns.dot
+++ b/doc/old/handbook/images/gns.dot
diff --git a/doc/handbook/images/gns.eps b/doc/old/handbook/images/gns.eps
index 3f3c28d98..3f3c28d98 100644
--- a/doc/handbook/images/gns.eps
+++ b/doc/old/handbook/images/gns.eps
diff --git a/doc/handbook/images/gns.jpg b/doc/old/handbook/images/gns.jpg
index d71109b95..d71109b95 100644
--- a/doc/handbook/images/gns.jpg
+++ b/doc/old/handbook/images/gns.jpg
Binary files differ
diff --git a/doc/handbook/images/gnunet-0-10-peerinfo.png b/doc/old/handbook/images/gnunet-0-10-peerinfo.png
index c5e711aff..c5e711aff 100644
--- a/doc/handbook/images/gnunet-0-10-peerinfo.png
+++ b/doc/old/handbook/images/gnunet-0-10-peerinfo.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-fs-gtk-0-10-star-tab.png b/doc/old/handbook/images/gnunet-fs-gtk-0-10-star-tab.png
index d7993cc46..d7993cc46 100644
--- a/doc/handbook/images/gnunet-fs-gtk-0-10-star-tab.png
+++ b/doc/old/handbook/images/gnunet-fs-gtk-0-10-star-tab.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-download-area.png b/doc/old/handbook/images/gnunet-gtk-0-10-download-area.png
index 8500d46c9..8500d46c9 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-download-area.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-download-area.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-menu.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-menu.png
index dc20c45a9..dc20c45a9 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-menu.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-menu.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png
index 6f9f75ea6..6f9f75ea6 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-select.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-select.png
index 50672e379..50672e379 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-select.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-select.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png
index b46542563..b46542563 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png
index b46542563..b46542563 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-publish.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish.png
index 033b38fa5..033b38fa5 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-publish.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-publish.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-published.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-published.png
index fbd3dd6a3..fbd3dd6a3 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-published.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-published.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs-search.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs-search.png
index bb64ab92e..bb64ab92e 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs-search.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs-search.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-fs.png b/doc/old/handbook/images/gnunet-gtk-0-10-fs.png
index c7a294878..c7a294878 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-fs.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-fs.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-gns-a-done.png b/doc/old/handbook/images/gnunet-gtk-0-10-gns-a-done.png
index f8231b3a6..f8231b3a6 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-gns-a-done.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-gns-a-done.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-gns-a.png b/doc/old/handbook/images/gnunet-gtk-0-10-gns-a.png
index 39858d72c..39858d72c 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-gns-a.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-gns-a.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-gns.png b/doc/old/handbook/images/gnunet-gtk-0-10-gns.png
index c71a2bd7b..c71a2bd7b 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-gns.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-gns.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-identity.png b/doc/old/handbook/images/gnunet-gtk-0-10-identity.png
index d0b426098..d0b426098 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-identity.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-identity.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-search-selected.png b/doc/old/handbook/images/gnunet-gtk-0-10-search-selected.png
index da1ad4d31..da1ad4d31 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-search-selected.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-search-selected.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-gtk-0-10-traffic.png b/doc/old/handbook/images/gnunet-gtk-0-10-traffic.png
index 76458f717..76458f717 100644
--- a/doc/handbook/images/gnunet-gtk-0-10-traffic.png
+++ b/doc/old/handbook/images/gnunet-gtk-0-10-traffic.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-namestore-gtk-phone.png b/doc/old/handbook/images/gnunet-namestore-gtk-phone.png
index 3bb859629..3bb859629 100644
--- a/doc/handbook/images/gnunet-namestore-gtk-phone.png
+++ b/doc/old/handbook/images/gnunet-namestore-gtk-phone.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-namestore-gtk-vpn.png b/doc/old/handbook/images/gnunet-namestore-gtk-vpn.png
index c716729ba..c716729ba 100644
--- a/doc/handbook/images/gnunet-namestore-gtk-vpn.png
+++ b/doc/old/handbook/images/gnunet-namestore-gtk-vpn.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-setup-exit.png b/doc/old/handbook/images/gnunet-setup-exit.png
index 66bd972bc..66bd972bc 100644
--- a/doc/handbook/images/gnunet-setup-exit.png
+++ b/doc/old/handbook/images/gnunet-setup-exit.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-tutorial-service.png b/doc/old/handbook/images/gnunet-tutorial-service.png
index 6daed2f35..6daed2f35 100644
--- a/doc/handbook/images/gnunet-tutorial-service.png
+++ b/doc/old/handbook/images/gnunet-tutorial-service.png
Binary files differ
diff --git a/doc/handbook/images/gnunet-tutorial-system.png b/doc/old/handbook/images/gnunet-tutorial-system.png
index 8b54e16cf..8b54e16cf 100644
--- a/doc/handbook/images/gnunet-tutorial-system.png
+++ b/doc/old/handbook/images/gnunet-tutorial-system.png
Binary files differ
diff --git a/doc/handbook/images/iceweasel-preferences.png b/doc/old/handbook/images/iceweasel-preferences.png
index e62c2c4d9..e62c2c4d9 100644
--- a/doc/handbook/images/iceweasel-preferences.png
+++ b/doc/old/handbook/images/iceweasel-preferences.png
Binary files differ
diff --git a/doc/handbook/images/iceweasel-proxy.png b/doc/old/handbook/images/iceweasel-proxy.png
index 9caad4508..9caad4508 100644
--- a/doc/handbook/images/iceweasel-proxy.png
+++ b/doc/old/handbook/images/iceweasel-proxy.png
Binary files differ
diff --git a/doc/handbook/images/lego_stack.svg b/doc/old/handbook/images/lego_stack.svg
index a0e8017c3..a0e8017c3 100644
--- a/doc/handbook/images/lego_stack.svg
+++ b/doc/old/handbook/images/lego_stack.svg
diff --git a/doc/handbook/images/messenger_room.png b/doc/old/handbook/images/messenger_room.png
index 8b3590cf8..8b3590cf8 100644
--- a/doc/handbook/images/messenger_room.png
+++ b/doc/old/handbook/images/messenger_room.png
Binary files differ
diff --git a/doc/handbook/images/messenger_room.svg b/doc/old/handbook/images/messenger_room.svg
index 6bd8d425c..6bd8d425c 100644
--- a/doc/handbook/images/messenger_room.svg
+++ b/doc/old/handbook/images/messenger_room.svg
diff --git a/doc/handbook/images/service_lego_block.png b/doc/old/handbook/images/service_lego_block.png
index 56caf6b9c..56caf6b9c 100644
--- a/doc/handbook/images/service_lego_block.png
+++ b/doc/old/handbook/images/service_lego_block.png
Binary files differ
diff --git a/doc/handbook/images/service_lego_block.svg b/doc/old/handbook/images/service_lego_block.svg
index ef0d0234f..ef0d0234f 100644
--- a/doc/handbook/images/service_lego_block.svg
+++ b/doc/old/handbook/images/service_lego_block.svg
diff --git a/doc/handbook/images/service_stack.png b/doc/old/handbook/images/service_stack.png
index 747d087b2..747d087b2 100644
--- a/doc/handbook/images/service_stack.png
+++ b/doc/old/handbook/images/service_stack.png
Binary files differ
diff --git a/doc/handbook/images/structure.dot b/doc/old/handbook/images/structure.dot
index f3cf193d8..f3cf193d8 100644
--- a/doc/handbook/images/structure.dot
+++ b/doc/old/handbook/images/structure.dot
diff --git a/doc/handbook/images/tng.dot b/doc/old/handbook/images/tng.dot
index 14e72ee04..14e72ee04 100644
--- a/doc/handbook/images/tng.dot
+++ b/doc/old/handbook/images/tng.dot
diff --git a/doc/handbook/images/tng.png b/doc/old/handbook/images/tng.png
index 3b93b77cc..3b93b77cc 100644
--- a/doc/handbook/images/tng.png
+++ b/doc/old/handbook/images/tng.png
Binary files differ
diff --git a/doc/handbook/manual.css b/doc/old/handbook/manual.css
index 0fe08b83c..0fe08b83c 100644
--- a/doc/handbook/manual.css
+++ b/doc/old/handbook/manual.css
diff --git a/doc/handbook/reset.css b/doc/old/handbook/reset.css
index 9a6c3065f..9a6c3065f 100644
--- a/doc/handbook/reset.css
+++ b/doc/old/handbook/reset.css
diff --git a/doc/handbook/run-gendocs.sh b/doc/old/handbook/run-gendocs.sh
index e52ae0d23..e52ae0d23 100755
--- a/doc/handbook/run-gendocs.sh
+++ b/doc/old/handbook/run-gendocs.sh
diff --git a/doc/handbook/style.css b/doc/old/handbook/style.css
index e5271197b..e5271197b 100644
--- a/doc/handbook/style.css
+++ b/doc/old/handbook/style.css
diff --git a/doc/index.html b/doc/old/index.html
index 3c25e61bd..3c25e61bd 100644
--- a/doc/index.html
+++ b/doc/old/index.html
diff --git a/doc/manual.css b/doc/old/manual.css
index 0fe08b83c..0fe08b83c 100644
--- a/doc/manual.css
+++ b/doc/old/manual.css
diff --git a/doc/reset.css b/doc/old/reset.css
index 9a6c3065f..9a6c3065f 100644
--- a/doc/reset.css
+++ b/doc/old/reset.css
diff --git a/doc/style.css b/doc/old/style.css
index e5271197b..e5271197b 100644
--- a/doc/style.css
+++ b/doc/old/style.css
diff --git a/doc/tutorial/.gitignore b/doc/old/tutorial/.gitignore
index 11bb2078e..11bb2078e 100644
--- a/doc/tutorial/.gitignore
+++ b/doc/old/tutorial/.gitignore
diff --git a/doc/tutorial/Makefile.am b/doc/old/tutorial/Makefile.am
index afe4aa6c0..afe4aa6c0 100644
--- a/doc/tutorial/Makefile.am
+++ b/doc/old/tutorial/Makefile.am
diff --git a/doc/tutorial/agpl-3.0.texi b/doc/old/tutorial/agpl-3.0.texi
index eabb0c6df..eabb0c6df 100644
--- a/doc/tutorial/agpl-3.0.texi
+++ b/doc/old/tutorial/agpl-3.0.texi
diff --git a/doc/tutorial/docstyle.css b/doc/old/tutorial/docstyle.css
index 8719248d0..8719248d0 100644
--- a/doc/tutorial/docstyle.css
+++ b/doc/old/tutorial/docstyle.css
diff --git a/doc/tutorial/examples/001.c b/doc/old/tutorial/examples/001.c
index 7f6699dd2..7042118ba 100644
--- a/doc/tutorial/examples/001.c
+++ b/doc/old/tutorial/examples/001.c
@@ -1,3 +1,4 @@
1#include "platform.h"
1#include <gnunet/platform.h> 2#include <gnunet/platform.h>
2#include <gnunet/gnunet_util_lib.h> 3#include <gnunet/gnunet_util_lib.h>
3 4
diff --git a/doc/tutorial/examples/002.c b/doc/old/tutorial/examples/002.c
index 02233fd61..02233fd61 100644
--- a/doc/tutorial/examples/002.c
+++ b/doc/old/tutorial/examples/002.c
diff --git a/doc/tutorial/examples/003.c b/doc/old/tutorial/examples/003.c
index d158d7e75..d158d7e75 100644
--- a/doc/tutorial/examples/003.c
+++ b/doc/old/tutorial/examples/003.c
diff --git a/doc/tutorial/examples/004.c b/doc/old/tutorial/examples/004.c
index 0ef007907..0ef007907 100644
--- a/doc/tutorial/examples/004.c
+++ b/doc/old/tutorial/examples/004.c
diff --git a/doc/tutorial/examples/005.c b/doc/old/tutorial/examples/005.c
index 1b59f85a6..1b59f85a6 100644
--- a/doc/tutorial/examples/005.c
+++ b/doc/old/tutorial/examples/005.c
diff --git a/doc/tutorial/examples/006.c b/doc/old/tutorial/examples/006.c
index 944d2b18c..944d2b18c 100644
--- a/doc/tutorial/examples/006.c
+++ b/doc/old/tutorial/examples/006.c
diff --git a/doc/tutorial/examples/007.c b/doc/old/tutorial/examples/007.c
index 096539e43..096539e43 100644
--- a/doc/tutorial/examples/007.c
+++ b/doc/old/tutorial/examples/007.c
diff --git a/doc/tutorial/examples/008.c b/doc/old/tutorial/examples/008.c
index 2dffe2cf9..2dffe2cf9 100644
--- a/doc/tutorial/examples/008.c
+++ b/doc/old/tutorial/examples/008.c
diff --git a/doc/tutorial/examples/009.c b/doc/old/tutorial/examples/009.c
index 26d918fb0..9d6fdd7e7 100644
--- a/doc/tutorial/examples/009.c
+++ b/doc/old/tutorial/examples/009.c
@@ -1,3 +1,4 @@
1#include "platform.h"
1#include <gnunet/gnunet_core_service.h> 2#include <gnunet/gnunet_core_service.h>
2 3
3struct GNUNET_CORE_Handle * 4struct GNUNET_CORE_Handle *
diff --git a/doc/tutorial/examples/010.c b/doc/old/tutorial/examples/010.c
index 33494490d..33494490d 100644
--- a/doc/tutorial/examples/010.c
+++ b/doc/old/tutorial/examples/010.c
diff --git a/doc/tutorial/examples/011.c b/doc/old/tutorial/examples/011.c
index 23bc051de..23bc051de 100644
--- a/doc/tutorial/examples/011.c
+++ b/doc/old/tutorial/examples/011.c
diff --git a/doc/tutorial/examples/012.c b/doc/old/tutorial/examples/012.c
index cb21d78ab..dc59eb506 100644
--- a/doc/tutorial/examples/012.c
+++ b/doc/old/tutorial/examples/012.c
@@ -1,3 +1,4 @@
1#include "platform.h"
1#include "gnunet_peerstore_service.h" 2#include "gnunet_peerstore_service.h"
2 3
3peerstore_handle = GNUNET_PEERSTORE_connect (cfg); 4peerstore_handle = GNUNET_PEERSTORE_connect (cfg);
diff --git a/doc/tutorial/examples/013.1.c b/doc/old/tutorial/examples/013.1.c
index fa5212868..fa5212868 100644
--- a/doc/tutorial/examples/013.1.c
+++ b/doc/old/tutorial/examples/013.1.c
diff --git a/doc/tutorial/examples/013.c b/doc/old/tutorial/examples/013.c
index 6792417e1..6792417e1 100644
--- a/doc/tutorial/examples/013.c
+++ b/doc/old/tutorial/examples/013.c
diff --git a/doc/tutorial/examples/014.c b/doc/old/tutorial/examples/014.c
index db2ed1165..db2ed1165 100644
--- a/doc/tutorial/examples/014.c
+++ b/doc/old/tutorial/examples/014.c
diff --git a/doc/tutorial/examples/015.c b/doc/old/tutorial/examples/015.c
index 0dd267e8e..0dd267e8e 100644
--- a/doc/tutorial/examples/015.c
+++ b/doc/old/tutorial/examples/015.c
diff --git a/doc/tutorial/examples/016.c b/doc/old/tutorial/examples/016.c
index d169da16d..d169da16d 100644
--- a/doc/tutorial/examples/016.c
+++ b/doc/old/tutorial/examples/016.c
diff --git a/doc/tutorial/examples/017.c b/doc/old/tutorial/examples/017.c
index c86fbcd1f..c86fbcd1f 100644
--- a/doc/tutorial/examples/017.c
+++ b/doc/old/tutorial/examples/017.c
diff --git a/doc/tutorial/examples/018.c b/doc/old/tutorial/examples/018.c
index 3fc22584c..3fc22584c 100644
--- a/doc/tutorial/examples/018.c
+++ b/doc/old/tutorial/examples/018.c
diff --git a/doc/tutorial/examples/019.c b/doc/old/tutorial/examples/019.c
index aaf001516..aaf001516 100644
--- a/doc/tutorial/examples/019.c
+++ b/doc/old/tutorial/examples/019.c
diff --git a/doc/tutorial/examples/020.c b/doc/old/tutorial/examples/020.c
index 596db3069..596db3069 100644
--- a/doc/tutorial/examples/020.c
+++ b/doc/old/tutorial/examples/020.c
diff --git a/doc/tutorial/examples/021.c b/doc/old/tutorial/examples/021.c
index 688a31fe0..688a31fe0 100644
--- a/doc/tutorial/examples/021.c
+++ b/doc/old/tutorial/examples/021.c
diff --git a/doc/tutorial/examples/022.c b/doc/old/tutorial/examples/022.c
index a373619bd..a373619bd 100644
--- a/doc/tutorial/examples/022.c
+++ b/doc/old/tutorial/examples/022.c
diff --git a/doc/tutorial/examples/023.c b/doc/old/tutorial/examples/023.c
index 820c38b10..820c38b10 100644
--- a/doc/tutorial/examples/023.c
+++ b/doc/old/tutorial/examples/023.c
diff --git a/doc/tutorial/examples/024.c b/doc/old/tutorial/examples/024.c
index 2e84b5905..2e84b5905 100644
--- a/doc/tutorial/examples/024.c
+++ b/doc/old/tutorial/examples/024.c
diff --git a/doc/tutorial/examples/025.Makefile.am b/doc/old/tutorial/examples/025.Makefile.am
index 66d4f80ec..66d4f80ec 100644
--- a/doc/tutorial/examples/025.Makefile.am
+++ b/doc/old/tutorial/examples/025.Makefile.am
diff --git a/doc/tutorial/examples/026.c b/doc/old/tutorial/examples/026.c
index 264e0b6b9..264e0b6b9 100644
--- a/doc/tutorial/examples/026.c
+++ b/doc/old/tutorial/examples/026.c
diff --git a/doc/tutorial/examples/testbed_test.c b/doc/old/tutorial/examples/testbed_test.c
index 1696234b0..1a8c25655 100644
--- a/doc/tutorial/examples/testbed_test.c
+++ b/doc/old/tutorial/examples/testbed_test.c
@@ -1,3 +1,4 @@
1#include "platform.h"
1#include <unistd.h> 2#include <unistd.h>
2#include <gnunet/platform.h> 3#include <gnunet/platform.h>
3#include <gnunet/gnunet_util_lib.h> 4#include <gnunet/gnunet_util_lib.h>
diff --git a/doc/tutorial/fdl-1.3.texi b/doc/old/tutorial/fdl-1.3.texi
index cb71f05a1..cb71f05a1 100644
--- a/doc/tutorial/fdl-1.3.texi
+++ b/doc/old/tutorial/fdl-1.3.texi
diff --git a/doc/tutorial/gpl-3.0.texi b/doc/old/tutorial/gpl-3.0.texi
index 0e2e212ac..0e2e212ac 100644
--- a/doc/tutorial/gpl-3.0.texi
+++ b/doc/old/tutorial/gpl-3.0.texi
diff --git a/doc/tutorial/htmlxref.cnf b/doc/old/tutorial/htmlxref.cnf
index a4928f6fe..a4928f6fe 100644
--- a/doc/tutorial/htmlxref.cnf
+++ b/doc/old/tutorial/htmlxref.cnf
diff --git a/doc/tutorial/manual.css b/doc/old/tutorial/manual.css
index 0fe08b83c..0fe08b83c 100644
--- a/doc/tutorial/manual.css
+++ b/doc/old/tutorial/manual.css
diff --git a/doc/tutorial/reset.css b/doc/old/tutorial/reset.css
index 9a6c3065f..9a6c3065f 100644
--- a/doc/tutorial/reset.css
+++ b/doc/old/tutorial/reset.css
diff --git a/doc/tutorial/run-gendocs.sh b/doc/old/tutorial/run-gendocs.sh
index b4899722c..b4899722c 100755
--- a/doc/tutorial/run-gendocs.sh
+++ b/doc/old/tutorial/run-gendocs.sh
diff --git a/doc/tutorial/style.css b/doc/old/tutorial/style.css
index e5271197b..e5271197b 100644
--- a/doc/tutorial/style.css
+++ b/doc/old/tutorial/style.css
diff --git a/doc/tutorial/tutorial.texi b/doc/old/tutorial/tutorial.texi
index 0a011c0c8..f849e116a 100644
--- a/doc/tutorial/tutorial.texi
+++ b/doc/old/tutorial/tutorial.texi
@@ -225,7 +225,7 @@ This is required for obtaining the repository, which is achieved with
225the following command: 225the following command:
226 226
227@example 227@example
228$ git clone https://git.gnunet.org/gnunet 228$ git clone https://git.gnunet.org/gnunet.git
229@end example 229@end example
230 230
231@noindent 231@noindent
@@ -795,7 +795,7 @@ a template build system for writing GNUnet extensions in C. It can be
795obtained as follows: 795obtained as follows:
796 796
797@example 797@example
798$ git clone https://git.gnunet.org/gnunet-ext 798$ git clone https://git.gnunet.org/gnunet-ext.git
799$ cd gnunet-ext/ 799$ cd gnunet-ext/
800$ ./bootstrap 800$ ./bootstrap
801$ ./configure --prefix=$PREFIX --with-gnunet=$PREFIX 801$ ./configure --prefix=$PREFIX --with-gnunet=$PREFIX