aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am30
-rw-r--r--doc/doxygen/.gitignore4
-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.doxy2346
-rw-r--r--doc/handbook/.gitignore13
-rw-r--r--doc/handbook/README5
-rw-r--r--doc/man/.gitignore4
-rw-r--r--doc/man/Makefile.am36
-rw-r--r--doc/man/gnunet-config.12
-rw-r--r--doc/man/gnunet-namestore-dbtool.187
-rw-r--r--doc/man/gnunet-search.18
-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)2
-rw-r--r--doc/old/handbook/chapters/installation.texi (renamed from doc/handbook/chapters/installation.texi)0
-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)0
-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)131
-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)0
-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)0
-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)0
-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)0
-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)0
124 files changed, 2596 insertions, 86 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a9ad69954..a8b044ccc 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,18 +1,34 @@
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
10endif 13endif
11 14
15install-data-hook:
16 mkdir -p $(DESTDIR)$(docdir)
17 cp -pr handbook/html $(DESTDIR)$(docdir)
18 mkdir -p $(DESTDIR)$(infodir)
19 cp -pr handbook/texinfo/gnunet.info $(DESTDIR)$(infodir)
20
12if INCLUDE_MANPAGES 21if INCLUDE_MANPAGES
13 SUBDIRS += man 22SUBDIRS += man
14endif 23endif
15 24
16EXTRA_DIST = \ 25AM_MAKEINFOFLAGS = --no-headers --no-split
26
27info_TEXINFOS = \
28 handbook/texinfo/gnunet.texi
29
30EXTRA_DIST = \
31 handbook/texinfo \
17 system_specific/outdated-and-old-installation-instructions.txt \ 32 system_specific/outdated-and-old-installation-instructions.txt \
18 system_specific/FROM_SOURCE 33 system_specific/FROM_SOURCE \
34 handbook/html
diff --git a/doc/doxygen/.gitignore b/doc/doxygen/.gitignore
new file mode 100644
index 000000000..6000c5c92
--- /dev/null
+++ b/doc/doxygen/.gitignore
@@ -0,0 +1,4 @@
1version.doxy
2gnunet.tag
3html/
4xml/
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..bfde393ae 100644
--- a/doc/doxygen/gnunet.doxy
+++ b/doc/doxygen/gnunet.doxy
@@ -1,17 +1,132 @@
1# Doxyfile 1.5.6 1# Doxyfile 1.8.17
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 (\" \").
2 15
3#--------------------------------------------------------------------------- 16#---------------------------------------------------------------------------
4# Project related configuration options 17# Project related configuration options
5#--------------------------------------------------------------------------- 18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the configuration
21# file that follow. The default is UTF-8 which is also the encoding used for all
22# text before the first occurrence of this tag. Doxygen uses libiconv (or the
23# iconv built into libc) for the transcoding. See
24# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25# The default value is: UTF-8.
26
6DOXYFILE_ENCODING = UTF-8 27DOXYFILE_ENCODING = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
7PROJECT_NAME = GNUnet 35PROJECT_NAME = GNUnet
8PROJECT_NUMBER = 0.11.x 36
9PROJECT_LOGO = logo.png 37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41# PROJECT_NUMBER = 0.16.x
42@INCLUDE = "version.doxy"
43
44# Using the PROJECT_BRIEF tag one can provide an optional one line description
45# for a project that appears at the top of each page and should give viewer a
46# quick idea about the purpose of the project. Keep the description short.
47
48PROJECT_BRIEF =
49
50# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
51# in the documentation. The maximum height of the logo should not exceed 55
52# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
53# the logo to the output directory.
54
55PROJECT_LOGO = gnunet-logo-no-text-small.png
56
57# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
58# into which the generated documentation will be written. If a relative path is
59# entered, it will be relative to the location where doxygen was started. If
60# left blank the current directory will be used.
61
10OUTPUT_DIRECTORY = . 62OUTPUT_DIRECTORY = .
63
64# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
65# directories (in 2 levels) under the output directory of each output format and
66# will distribute the generated files over these directories. Enabling this
67# option can be useful when feeding doxygen a huge amount of source files, where
68# putting all generated files in the same directory would otherwise causes
69# performance problems for the file system.
70# The default value is: NO.
71
11CREATE_SUBDIRS = YES 72CREATE_SUBDIRS = YES
73
74# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
75# characters to appear in the names of generated files. If set to NO, non-ASCII
76# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
77# U+3044.
78# The default value is: NO.
79
80ALLOW_UNICODE_NAMES = NO
81
82# The OUTPUT_LANGUAGE tag is used to specify the language in which all
83# documentation generated by doxygen is written. Doxygen will use this
84# information to generate all constant output in the proper language.
85# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
86# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
87# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
88# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
89# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
90# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
91# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
92# Ukrainian and Vietnamese.
93# The default value is: English.
94
12OUTPUT_LANGUAGE = English 95OUTPUT_LANGUAGE = English
96
97# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
98# documentation generated by doxygen is written. Doxygen will use this
99# information to generate all generated output in the proper direction.
100# Possible values are: None, LTR, RTL and Context.
101# The default value is: None.
102
103OUTPUT_TEXT_DIRECTION = None
104
105# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
106# descriptions after the members that are listed in the file and class
107# documentation (similar to Javadoc). Set to NO to disable this.
108# The default value is: YES.
109
13BRIEF_MEMBER_DESC = YES 110BRIEF_MEMBER_DESC = YES
111
112# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
113# description of a member or function before the detailed description
114#
115# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
116# brief descriptions will be completely suppressed.
117# The default value is: YES.
118
14REPEAT_BRIEF = YES 119REPEAT_BRIEF = YES
120
121# This tag implements a quasi-intelligent brief description abbreviator that is
122# used to form the text in various listings. Each string in this list, if found
123# as the leading text of the brief description, will be stripped from the text
124# and the result, after processing the whole list, is used as the annotated
125# text. Otherwise, the brief description is used as-is. If left blank, the
126# following values are used ($name is automatically replaced with the name of
127# the entity):The $name class, The $name widget, The $name file, is, provides,
128# specifies, contains, represents, a, an and the.
129
15ABBREVIATE_BRIEF = "The $name class" \ 130ABBREVIATE_BRIEF = "The $name class" \
16 "The $name widget" \ 131 "The $name widget" \
17 "The $name file" \ 132 "The $name file" \
@@ -23,79 +138,729 @@ ABBREVIATE_BRIEF = "The $name class" \
23 a \ 138 a \
24 an \ 139 an \
25 the 140 the
141
142# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
143# doxygen will generate a detailed section even if there is only a brief
144# description.
145# The default value is: NO.
146
26ALWAYS_DETAILED_SEC = NO 147ALWAYS_DETAILED_SEC = NO
148
149# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
150# inherited members of a class in the documentation of that class as if those
151# members were ordinary class members. Constructors, destructors and assignment
152# operators of the base classes will not be shown.
153# The default value is: NO.
154
27INLINE_INHERITED_MEMB = NO 155INLINE_INHERITED_MEMB = NO
156
157# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
158# before files name in the file list and in the header files. If set to NO the
159# shortest path that makes the file name unique will be used
160# The default value is: YES.
161
28FULL_PATH_NAMES = YES 162FULL_PATH_NAMES = YES
163
164# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
165# Stripping is only done if one of the specified strings matches the left-hand
166# part of the path. The tag can be used to show relative paths in the file list.
167# If left blank the directory from which doxygen is run is used as the path to
168# strip.
169#
170# Note that you can specify absolute paths here, but also relative paths, which
171# will be relative from the directory where doxygen is started.
172# This tag requires that the tag FULL_PATH_NAMES is set to YES.
173
29STRIP_FROM_PATH = ../.. 174STRIP_FROM_PATH = ../..
175
176# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
177# path mentioned in the documentation of a class, which tells the reader which
178# header file to include in order to use a class. If left blank only the name of
179# the header file containing the class definition is used. Otherwise one should
180# specify the list of include paths that are normally passed to the compiler
181# using the -I flag.
182
30STRIP_FROM_INC_PATH = ../../src/include \ 183STRIP_FROM_INC_PATH = ../../src/include \
31 src/include \ 184 src/include \
32 include 185 include
186
187# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
188# less readable) file names. This can be useful is your file systems doesn't
189# support long names like on DOS, Mac, or CD-ROM.
190# The default value is: NO.
191
33SHORT_NAMES = NO 192SHORT_NAMES = NO
193
194# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
195# first line (until the first dot) of a Javadoc-style comment as the brief
196# description. If set to NO, the Javadoc-style will behave just like regular Qt-
197# style comments (thus requiring an explicit @brief command for a brief
198# description.)
199# The default value is: NO.
200
34JAVADOC_AUTOBRIEF = YES 201JAVADOC_AUTOBRIEF = YES
202
203# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
204# such as
205# /***************
206# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
207# Javadoc-style will behave just like regular comments and it will not be
208# interpreted by doxygen.
209# The default value is: NO.
210
211JAVADOC_BANNER = NO
212
213# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
214# line (until the first dot) of a Qt-style comment as the brief description. If
215# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
216# requiring an explicit \brief command for a brief description.)
217# The default value is: NO.
218
35QT_AUTOBRIEF = NO 219QT_AUTOBRIEF = NO
220
221# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
222# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
223# a brief description. This used to be the default behavior. The new default is
224# to treat a multi-line C++ comment block as a detailed description. Set this
225# tag to YES if you prefer the old behavior instead.
226#
227# Note that setting this tag to YES also means that rational rose comments are
228# not recognized any more.
229# The default value is: NO.
230
36MULTILINE_CPP_IS_BRIEF = NO 231MULTILINE_CPP_IS_BRIEF = NO
232
233# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
234# documentation from any documented member that it re-implements.
235# The default value is: YES.
236
37INHERIT_DOCS = YES 237INHERIT_DOCS = YES
238
239# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
240# page for each member. If set to NO, the documentation of a member will be part
241# of the file/class/namespace that contains it.
242# The default value is: NO.
243
38SEPARATE_MEMBER_PAGES = NO 244SEPARATE_MEMBER_PAGES = NO
245
246# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
247# uses this value to replace tabs by spaces in code fragments.
248# Minimum value: 1, maximum value: 16, default value: 4.
249
39TAB_SIZE = 8 250TAB_SIZE = 8
251
252# This tag can be used to specify a number of aliases that act as commands in
253# the documentation. An alias has the form:
254# name=value
255# For example adding
256# "sideeffect=@par Side Effects:\n"
257# will allow you to put the command \sideeffect (or @sideeffect) in the
258# documentation, which will result in a user-defined paragraph with heading
259# "Side Effects:". You can put \n's in the value part of an alias to insert
260# newlines (in the resulting output). You can put ^^ in the value part of an
261# alias to insert a newline as if a physical newline was in the original file.
262# When you need a literal { or } or , in the value part of an alias you have to
263# escape them by means of a backslash (\), this can lead to conflicts with the
264# commands \{ and \} for these it is advised to use the version @{ and @} or use
265# a double escape (\\{ and \\})
266
40ALIASES = 267ALIASES =
268
269# This tag can be used to specify a number of word-keyword mappings (TCL only).
270# A mapping has the form "name=value". For example adding "class=itcl::class"
271# will allow you to use the command class in the itcl::class meaning.
272
273TCL_SUBST =
274
275# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
276# only. Doxygen will then generate output that is more tailored for C. For
277# instance, some of the names that are used will be different. The list of all
278# members will be omitted, etc.
279# The default value is: NO.
280
41OPTIMIZE_OUTPUT_FOR_C = YES 281OPTIMIZE_OUTPUT_FOR_C = YES
282
283# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
284# Python sources only. Doxygen will then generate output that is more tailored
285# for that language. For instance, namespaces will be presented as packages,
286# qualified scopes will look different, etc.
287# The default value is: NO.
288
42OPTIMIZE_OUTPUT_JAVA = NO 289OPTIMIZE_OUTPUT_JAVA = NO
290
291# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
292# sources. Doxygen will then generate output that is tailored for Fortran.
293# The default value is: NO.
294
43OPTIMIZE_FOR_FORTRAN = NO 295OPTIMIZE_FOR_FORTRAN = NO
296
297# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
298# sources. Doxygen will then generate output that is tailored for VHDL.
299# The default value is: NO.
300
44OPTIMIZE_OUTPUT_VHDL = NO 301OPTIMIZE_OUTPUT_VHDL = NO
302
303# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
304# sources only. Doxygen will then generate output that is more tailored for that
305# language. For instance, namespaces will be presented as modules, types will be
306# separated into more groups, etc.
307# The default value is: NO.
308
309OPTIMIZE_OUTPUT_SLICE = NO
310
311# Doxygen selects the parser to use depending on the extension of the files it
312# parses. With this tag you can assign which parser to use for a given
313# extension. Doxygen has a built-in mapping, but you can override or extend it
314# using this tag. The format is ext=language, where ext is a file extension, and
315# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
316# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
317# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
318# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
319# tries to guess whether the code is fixed or free formatted code, this is the
320# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
321# .inc files as Fortran files (default is PHP), and .f files as C (default is
322# Fortran), use: inc=Fortran f=C.
323#
324# Note: For files without extension you can use no_extension as a placeholder.
325#
326# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
327# the files are not read by doxygen.
328
329EXTENSION_MAPPING =
330
331# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
332# according to the Markdown format, which allows for more readable
333# documentation. See https://daringfireball.net/projects/markdown/ for details.
334# The output of markdown processing is further processed by doxygen, so you can
335# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
336# case of backward compatibilities issues.
337# The default value is: YES.
338
339MARKDOWN_SUPPORT = YES
340
341# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
342# to that level are automatically included in the table of contents, even if
343# they do not have an id attribute.
344# Note: This feature currently applies only to Markdown headings.
345# Minimum value: 0, maximum value: 99, default value: 5.
346# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
347
348TOC_INCLUDE_HEADINGS = 5
349
350# When enabled doxygen tries to link words that correspond to documented
351# classes, or namespaces to their corresponding documentation. Such a link can
352# be prevented in individual cases by putting a % sign in front of the word or
353# globally by setting AUTOLINK_SUPPORT to NO.
354# The default value is: YES.
355
356AUTOLINK_SUPPORT = YES
357
358# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
359# to include (a tag file for) the STL sources as input, then you should set this
360# tag to YES in order to let doxygen match functions declarations and
361# definitions whose arguments contain STL classes (e.g. func(std::string);
362# versus func(std::string) {}). This also make the inheritance and collaboration
363# diagrams that involve STL classes more complete and accurate.
364# The default value is: NO.
365
45BUILTIN_STL_SUPPORT = NO 366BUILTIN_STL_SUPPORT = NO
367
368# If you use Microsoft's C++/CLI language, you should set this option to YES to
369# enable parsing support.
370# The default value is: NO.
371
46CPP_CLI_SUPPORT = NO 372CPP_CLI_SUPPORT = NO
373
374# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
375# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
376# will parse them like normal C++ but will assume all classes use public instead
377# of private inheritance when no explicit protection keyword is present.
378# The default value is: NO.
379
47SIP_SUPPORT = NO 380SIP_SUPPORT = NO
381
382# For Microsoft's IDL there are propget and propput attributes to indicate
383# getter and setter methods for a property. Setting this option to YES will make
384# doxygen to replace the get and set methods by a property in the documentation.
385# This will only work if the methods are indeed getting or setting a simple
386# type. If this is not the case, or you want to show the methods anyway, you
387# should set this option to NO.
388# The default value is: YES.
389
48IDL_PROPERTY_SUPPORT = YES 390IDL_PROPERTY_SUPPORT = YES
391
392# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
393# tag is set to YES then doxygen will reuse the documentation of the first
394# member in the group (if any) for the other members of the group. By default
395# all members of a group must be documented explicitly.
396# The default value is: NO.
397
49DISTRIBUTE_GROUP_DOC = NO 398DISTRIBUTE_GROUP_DOC = NO
399
400# If one adds a struct or class to a group and this option is enabled, then also
401# any nested class or struct is added to the same group. By default this option
402# is disabled and one has to add nested compounds explicitly via \ingroup.
403# The default value is: NO.
404
405GROUP_NESTED_COMPOUNDS = NO
406
407# Set the SUBGROUPING tag to YES to allow class member groups of the same type
408# (for instance a group of public functions) to be put as a subgroup of that
409# type (e.g. under the Public Functions section). Set it to NO to prevent
410# subgrouping. Alternatively, this can be done per class using the
411# \nosubgrouping command.
412# The default value is: YES.
413
50SUBGROUPING = YES 414SUBGROUPING = YES
415
416# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
417# are shown inside the group in which they are included (e.g. using \ingroup)
418# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
419# and RTF).
420#
421# Note that this feature does not work in combination with
422# SEPARATE_MEMBER_PAGES.
423# The default value is: NO.
424
425INLINE_GROUPED_CLASSES = NO
426
427# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
428# with only public data fields or simple typedef fields will be shown inline in
429# the documentation of the scope in which they are defined (i.e. file,
430# namespace, or group documentation), provided this scope is documented. If set
431# to NO, structs, classes, and unions are shown on a separate page (for HTML and
432# Man pages) or section (for LaTeX and RTF).
433# The default value is: NO.
434
435INLINE_SIMPLE_STRUCTS = NO
436
437# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
438# enum is documented as struct, union, or enum with the name of the typedef. So
439# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
440# with name TypeT. When disabled the typedef will appear as a member of a file,
441# namespace, or class. And the struct will be named TypeS. This can typically be
442# useful for C code in case the coding convention dictates that all compound
443# types are typedef'ed and only the typedef is referenced, never the tag name.
444# The default value is: NO.
445
51TYPEDEF_HIDES_STRUCT = NO 446TYPEDEF_HIDES_STRUCT = NO
447
448# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
449# cache is used to resolve symbols given their name and scope. Since this can be
450# an expensive process and often the same symbol appears multiple times in the
451# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
452# doxygen will become slower. If the cache is too large, memory is wasted. The
453# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
454# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
455# symbols. At the end of a run doxygen will report the cache usage and suggest
456# the optimal cache size from a speed point of view.
457# Minimum value: 0, maximum value: 9, default value: 0.
458
459LOOKUP_CACHE_SIZE = 0
460
52#--------------------------------------------------------------------------- 461#---------------------------------------------------------------------------
53# Build related configuration options 462# Build related configuration options
54#--------------------------------------------------------------------------- 463#---------------------------------------------------------------------------
464
465# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
466# documentation are documented, even if no documentation was available. Private
467# class members and static file members will be hidden unless the
468# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
469# Note: This will also disable the warnings about undocumented members that are
470# normally produced when WARNINGS is set to YES.
471# The default value is: NO.
472
55EXTRACT_ALL = YES 473EXTRACT_ALL = YES
474
475# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
476# be included in the documentation.
477# The default value is: NO.
478
56EXTRACT_PRIVATE = YES 479EXTRACT_PRIVATE = YES
480
481# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
482# methods of a class will be included in the documentation.
483# The default value is: NO.
484
485EXTRACT_PRIV_VIRTUAL = NO
486
487# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
488# scope will be included in the documentation.
489# The default value is: NO.
490
491EXTRACT_PACKAGE = NO
492
493# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
494# included in the documentation.
495# The default value is: NO.
496
57EXTRACT_STATIC = YES 497EXTRACT_STATIC = YES
498
499# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
500# locally in source files will be included in the documentation. If set to NO,
501# only classes defined in header files are included. Does not have any effect
502# for Java sources.
503# The default value is: YES.
504
58EXTRACT_LOCAL_CLASSES = YES 505EXTRACT_LOCAL_CLASSES = YES
506
507# This flag is only useful for Objective-C code. If set to YES, local methods,
508# which are defined in the implementation section but not in the interface are
509# included in the documentation. If set to NO, only methods in the interface are
510# included.
511# The default value is: NO.
512
59EXTRACT_LOCAL_METHODS = YES 513EXTRACT_LOCAL_METHODS = YES
514
515# If this flag is set to YES, the members of anonymous namespaces will be
516# extracted and appear in the documentation as a namespace called
517# 'anonymous_namespace{file}', where file will be replaced with the base name of
518# the file that contains the anonymous namespace. By default anonymous namespace
519# are hidden.
520# The default value is: NO.
521
60EXTRACT_ANON_NSPACES = YES 522EXTRACT_ANON_NSPACES = YES
523
524# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
525# undocumented members inside documented classes or files. If set to NO these
526# members will be included in the various overviews, but no documentation
527# section is generated. This option has no effect if EXTRACT_ALL is enabled.
528# The default value is: NO.
529
61HIDE_UNDOC_MEMBERS = NO 530HIDE_UNDOC_MEMBERS = NO
531
532# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
533# undocumented classes that are normally visible in the class hierarchy. If set
534# to NO, these classes will be included in the various overviews. This option
535# has no effect if EXTRACT_ALL is enabled.
536# The default value is: NO.
537
62HIDE_UNDOC_CLASSES = NO 538HIDE_UNDOC_CLASSES = NO
539
540# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
541# declarations. If set to NO, these declarations will be included in the
542# documentation.
543# The default value is: NO.
544
63HIDE_FRIEND_COMPOUNDS = NO 545HIDE_FRIEND_COMPOUNDS = NO
546
547# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
548# documentation blocks found inside the body of a function. If set to NO, these
549# blocks will be appended to the function's detailed documentation block.
550# The default value is: NO.
551
64HIDE_IN_BODY_DOCS = NO 552HIDE_IN_BODY_DOCS = NO
553
554# The INTERNAL_DOCS tag determines if documentation that is typed after a
555# \internal command is included. If the tag is set to NO then the documentation
556# will be excluded. Set it to YES to include the internal documentation.
557# The default value is: NO.
558
65INTERNAL_DOCS = YES 559INTERNAL_DOCS = YES
560
561# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
562# names in lower-case letters. If set to YES, upper-case letters are also
563# allowed. This is useful if you have classes or files whose names only differ
564# in case and if your file system supports case sensitive file names. Windows
565# (including Cygwin) ands Mac users are advised to set this option to NO.
566# The default value is: system dependent.
567
66CASE_SENSE_NAMES = YES 568CASE_SENSE_NAMES = YES
569
570# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
571# their full class and namespace scopes in the documentation. If set to YES, the
572# scope will be hidden.
573# The default value is: NO.
574
67HIDE_SCOPE_NAMES = NO 575HIDE_SCOPE_NAMES = NO
576
577# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
578# append additional text to a page's title, such as Class Reference. If set to
579# YES the compound reference will be hidden.
580# The default value is: NO.
581
582HIDE_COMPOUND_REFERENCE= NO
583
584# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
585# the files that are included by a file in the documentation of that file.
586# The default value is: YES.
587
68SHOW_INCLUDE_FILES = YES 588SHOW_INCLUDE_FILES = YES
589
590# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
591# grouped member an include statement to the documentation, telling the reader
592# which file to include in order to use the member.
593# The default value is: NO.
594
595SHOW_GROUPED_MEMB_INC = NO
596
597# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
598# files with double quotes in the documentation rather than with sharp brackets.
599# The default value is: NO.
600
601FORCE_LOCAL_INCLUDES = NO
602
603# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
604# documentation for inline members.
605# The default value is: YES.
606
69INLINE_INFO = YES 607INLINE_INFO = YES
608
609# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
610# (detailed) documentation of file and class members alphabetically by member
611# name. If set to NO, the members will appear in declaration order.
612# The default value is: YES.
613
70SORT_MEMBER_DOCS = NO 614SORT_MEMBER_DOCS = NO
615
616# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
617# descriptions of file, namespace and class members alphabetically by member
618# name. If set to NO, the members will appear in declaration order. Note that
619# this will also influence the order of the classes in the class list.
620# The default value is: NO.
621
71SORT_BRIEF_DOCS = NO 622SORT_BRIEF_DOCS = NO
623
624# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
625# (brief and detailed) documentation of class members so that constructors and
626# destructors are listed first. If set to NO the constructors will appear in the
627# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
628# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
629# member documentation.
630# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
631# detailed member documentation.
632# The default value is: NO.
633
634SORT_MEMBERS_CTORS_1ST = NO
635
636# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
637# of group names into alphabetical order. If set to NO the group names will
638# appear in their defined order.
639# The default value is: NO.
640
72SORT_GROUP_NAMES = YES 641SORT_GROUP_NAMES = YES
642
643# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
644# fully-qualified names, including namespaces. If set to NO, the class list will
645# be sorted only by class name, not including the namespace part.
646# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
647# Note: This option applies only to the class list, not to the alphabetical
648# list.
649# The default value is: NO.
650
73SORT_BY_SCOPE_NAME = NO 651SORT_BY_SCOPE_NAME = NO
652
653# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
654# type resolution of all parameters of a function it will reject a match between
655# the prototype and the implementation of a member function even if there is
656# only one candidate or it is obvious which candidate to choose by doing a
657# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
658# accept a match between prototype and implementation in such cases.
659# The default value is: NO.
660
661STRICT_PROTO_MATCHING = NO
662
663# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
664# list. This list is created by putting \todo commands in the documentation.
665# The default value is: YES.
666
74GENERATE_TODOLIST = YES 667GENERATE_TODOLIST = YES
668
669# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
670# list. This list is created by putting \test commands in the documentation.
671# The default value is: YES.
672
75GENERATE_TESTLIST = YES 673GENERATE_TESTLIST = YES
674
675# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
676# list. This list is created by putting \bug commands in the documentation.
677# The default value is: YES.
678
76GENERATE_BUGLIST = YES 679GENERATE_BUGLIST = YES
680
681# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
682# the deprecated list. This list is created by putting \deprecated commands in
683# the documentation.
684# The default value is: YES.
685
77GENERATE_DEPRECATEDLIST= YES 686GENERATE_DEPRECATEDLIST= YES
687
688# The ENABLED_SECTIONS tag can be used to enable conditional documentation
689# sections, marked by \if <section_label> ... \endif and \cond <section_label>
690# ... \endcond blocks.
691
78ENABLED_SECTIONS = 692ENABLED_SECTIONS =
693
694# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
695# initial value of a variable or macro / define can have for it to appear in the
696# documentation. If the initializer consists of more lines than specified here
697# it will be hidden. Use a value of 0 to hide initializers completely. The
698# appearance of the value of individual variables and macros / defines can be
699# controlled using \showinitializer or \hideinitializer command in the
700# documentation regardless of this setting.
701# Minimum value: 0, maximum value: 10000, default value: 30.
702
79MAX_INITIALIZER_LINES = 30 703MAX_INITIALIZER_LINES = 30
704
705# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
706# the bottom of the documentation of classes and structs. If set to YES, the
707# list will mention the files that were used to generate the documentation.
708# The default value is: YES.
709
80SHOW_USED_FILES = YES 710SHOW_USED_FILES = YES
711
712# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
713# will remove the Files entry from the Quick Index and from the Folder Tree View
714# (if specified).
715# The default value is: YES.
716
81SHOW_FILES = YES 717SHOW_FILES = YES
718
719# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
720# page. This will remove the Namespaces entry from the Quick Index and from the
721# Folder Tree View (if specified).
722# The default value is: YES.
723
82SHOW_NAMESPACES = YES 724SHOW_NAMESPACES = YES
725
726# The FILE_VERSION_FILTER tag can be used to specify a program or script that
727# doxygen should invoke to get the current version for each file (typically from
728# the version control system). Doxygen will invoke the program by executing (via
729# popen()) the command command input-file, where command is the value of the
730# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
731# by doxygen. Whatever the program writes to standard output is used as the file
732# version. For an example see the documentation.
733
83FILE_VERSION_FILTER = 734FILE_VERSION_FILTER =
735
736# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
737# by doxygen. The layout file controls the global structure of the generated
738# output files in an output format independent way. To create the layout file
739# that represents doxygen's defaults, run doxygen with the -l option. You can
740# optionally specify a file name after the option, if omitted DoxygenLayout.xml
741# will be used as the name of the layout file.
742#
743# Note that if you run doxygen from a directory containing a file called
744# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
745# tag is left empty.
746
747LAYOUT_FILE =
748
749# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
750# the reference definitions. This must be a list of .bib files. The .bib
751# extension is automatically appended if omitted. This requires the bibtex tool
752# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
753# For LaTeX the style of the bibliography can be controlled using
754# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
755# search path. See also \cite for info how to create references.
756
757CITE_BIB_FILES =
758
84#--------------------------------------------------------------------------- 759#---------------------------------------------------------------------------
85# configuration options related to warning and progress messages 760# Configuration options related to warning and progress messages
86#--------------------------------------------------------------------------- 761#---------------------------------------------------------------------------
762
763# The QUIET tag can be used to turn on/off the messages that are generated to
764# standard output by doxygen. If QUIET is set to YES this implies that the
765# messages are off.
766# The default value is: NO.
767
87QUIET = YES 768QUIET = YES
769
770# The WARNINGS tag can be used to turn on/off the warning messages that are
771# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
772# this implies that the warnings are on.
773#
774# Tip: Turn warnings on while writing the documentation.
775# The default value is: YES.
776
88WARNINGS = YES 777WARNINGS = YES
778
779# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
780# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
781# will automatically be disabled.
782# The default value is: YES.
783
89WARN_IF_UNDOCUMENTED = YES 784WARN_IF_UNDOCUMENTED = YES
785
786# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
787# potential errors in the documentation, such as not documenting some parameters
788# in a documented function, or documenting parameters that don't exist or using
789# markup commands wrongly.
790# The default value is: YES.
791
90WARN_IF_DOC_ERROR = YES 792WARN_IF_DOC_ERROR = YES
793
794# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
795# are documented, but have no documentation for their parameters or return
796# value. If set to NO, doxygen will only warn about wrong or incomplete
797# parameter documentation, but not about the absence of documentation. If
798# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
799# The default value is: NO.
800
91WARN_NO_PARAMDOC = YES 801WARN_NO_PARAMDOC = YES
802
803# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
804# a warning is encountered.
805# The default value is: NO.
806
807WARN_AS_ERROR = NO
808
809# The WARN_FORMAT tag determines the format of the warning messages that doxygen
810# can produce. The string should contain the $file, $line, and $text tags, which
811# will be replaced by the file and line number from which the warning originated
812# and the warning text. Optionally the format may contain $version, which will
813# be replaced by the version of the file (if it could be obtained via
814# FILE_VERSION_FILTER)
815# The default value is: $file:$line: $text.
816
92WARN_FORMAT = "$file:$line: $text" 817WARN_FORMAT = "$file:$line: $text"
818
819# The WARN_LOGFILE tag can be used to specify a file to which warning and error
820# messages should be written. If left blank the output is written to standard
821# error (stderr).
822
93WARN_LOGFILE = 823WARN_LOGFILE =
824
94#--------------------------------------------------------------------------- 825#---------------------------------------------------------------------------
95# configuration options related to the input files 826# Configuration options related to the input files
96#--------------------------------------------------------------------------- 827#---------------------------------------------------------------------------
97INPUT = ../../src ../../contrib ../../doc 828
829# The INPUT tag is used to specify the files and/or directories that contain
830# documented source files. You may enter file names like myfile.cpp or
831# directories like /usr/src/myproject. Separate the files or directories with
832# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
833# Note: If this tag is empty the current directory is searched.
834
835INPUT = ../../src \
836 ../../contrib \
837 ../../doc
838
839# This tag can be used to specify the character encoding of the source files
840# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
841# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
842# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
843# possible encodings.
844# The default value is: UTF-8.
845
98INPUT_ENCODING = UTF-8 846INPUT_ENCODING = UTF-8
847
848# If the value of the INPUT tag contains directories, you can use the
849# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
850# *.h) to filter out the source-files in the directories.
851#
852# Note that for custom extensions or not directly supported extensions you also
853# need to set EXTENSION_MAPPING for the extension otherwise the files are not
854# read by doxygen.
855#
856# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
857# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
858# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
859# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
860# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
861# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd,
862# *.vhdl, *.ucf, *.qsf and *.ice.
863
99FILE_PATTERNS = *.c \ 864FILE_PATTERNS = *.c \
100 *.cc \ 865 *.cc \
101 *.cxx \ 866 *.cxx \
@@ -145,161 +910,1682 @@ FILE_PATTERNS = *.c \
145 *.F \ 910 *.F \
146 *.VHD \ 911 *.VHD \
147 *.VHDL 912 *.VHDL
913
914# The RECURSIVE tag can be used to specify whether or not subdirectories should
915# be searched for input files as well.
916# The default value is: NO.
917
148RECURSIVE = YES 918RECURSIVE = YES
919
920# The EXCLUDE tag can be used to specify files and/or directories that should be
921# excluded from the INPUT source files. This way you can easily exclude a
922# subdirectory from a directory tree whose root is specified with the INPUT tag.
923#
924# Note that relative paths are relative to the directory from which doxygen is
925# run.
926
149EXCLUDE = 927EXCLUDE =
928
929# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
930# directories that are symbolic links (a Unix file system feature) are excluded
931# from the input.
932# The default value is: NO.
933
150EXCLUDE_SYMLINKS = NO 934EXCLUDE_SYMLINKS = NO
151EXCLUDE_PATTERNS = */test_* */.svn/* */.git/* */perf_* .* 935
936# If the value of the INPUT tag contains directories, you can use the
937# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
938# certain files from those directories.
939#
940# Note that the wildcards are matched against the file with absolute path, so to
941# exclude all test directories for example use the pattern */test/*
942
943EXCLUDE_PATTERNS = */test_* \
944 */.svn/* \
945 */.git/* \
946 */perf_* \
947 .*
948
949# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
950# (namespaces, classes, functions, etc.) that should be excluded from the
951# output. The symbol name can be a fully qualified name, a word, or if the
952# wildcard * is used, a substring. Examples: ANamespace, AClass,
953# AClass::ANamespace, ANamespace::*Test
954#
955# Note that the wildcards are matched against the file with absolute path, so to
956# exclude all test directories use the pattern */test/*
957
152EXCLUDE_SYMBOLS = 958EXCLUDE_SYMBOLS =
959
960# The EXAMPLE_PATH tag can be used to specify one or more files or directories
961# that contain example code fragments that are included (see the \include
962# command).
963
153EXAMPLE_PATH = 964EXAMPLE_PATH =
965
966# If the value of the EXAMPLE_PATH tag contains directories, you can use the
967# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
968# *.h) to filter out the source-files in the directories. If left blank all
969# files are included.
970
154EXAMPLE_PATTERNS = * 971EXAMPLE_PATTERNS = *
972
973# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
974# searched for input files to be used with the \include or \dontinclude commands
975# irrespective of the value of the RECURSIVE tag.
976# The default value is: NO.
977
155EXAMPLE_RECURSIVE = NO 978EXAMPLE_RECURSIVE = NO
979
980# The IMAGE_PATH tag can be used to specify one or more files or directories
981# that contain images that are to be included in the documentation (see the
982# \image command).
983
156IMAGE_PATH = 984IMAGE_PATH =
985
986# The INPUT_FILTER tag can be used to specify a program that doxygen should
987# invoke to filter for each input file. Doxygen will invoke the filter program
988# by executing (via popen()) the command:
989#
990# <filter> <input-file>
991#
992# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
993# name of an input file. Doxygen will then use the output that the filter
994# program writes to standard output. If FILTER_PATTERNS is specified, this tag
995# will be ignored.
996#
997# Note that the filter must not add or remove lines; it is applied before the
998# code is scanned, but not when the output code is generated. If lines are added
999# or removed, the anchors will not be placed correctly.
1000#
1001# Note that for custom extensions or not directly supported extensions you also
1002# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1003# properly processed by doxygen.
1004
157INPUT_FILTER = 1005INPUT_FILTER =
1006
1007# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1008# basis. Doxygen will compare the file name with each pattern and apply the
1009# filter if there is a match. The filters are a list of the form: pattern=filter
1010# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1011# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1012# patterns match the file name, INPUT_FILTER is applied.
1013#
1014# Note that for custom extensions or not directly supported extensions you also
1015# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1016# properly processed by doxygen.
1017
158FILTER_PATTERNS = 1018FILTER_PATTERNS =
1019
1020# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1021# INPUT_FILTER) will also be used to filter the input files that are used for
1022# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1023# The default value is: NO.
1024
159FILTER_SOURCE_FILES = NO 1025FILTER_SOURCE_FILES = NO
1026
1027# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1028# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1029# it is also possible to disable source filtering for a specific pattern using
1030# *.ext= (so without naming a filter).
1031# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1032
1033FILTER_SOURCE_PATTERNS =
1034
1035# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1036# is part of the input, its contents will be placed on the main page
1037# (index.html). This can be useful if you have a project on for instance GitHub
1038# and want to reuse the introduction page also for the doxygen output.
1039
1040USE_MDFILE_AS_MAINPAGE =
1041
160#--------------------------------------------------------------------------- 1042#---------------------------------------------------------------------------
161# configuration options related to source browsing 1043# Configuration options related to source browsing
162#--------------------------------------------------------------------------- 1044#---------------------------------------------------------------------------
1045
1046# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1047# generated. Documented entities will be cross-referenced with these sources.
1048#
1049# Note: To get rid of all source code in the generated output, make sure that
1050# also VERBATIM_HEADERS is set to NO.
1051# The default value is: NO.
1052
163SOURCE_BROWSER = YES 1053SOURCE_BROWSER = YES
1054
1055# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1056# classes and enums directly into the documentation.
1057# The default value is: NO.
1058
164INLINE_SOURCES = YES 1059INLINE_SOURCES = YES
1060
1061# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1062# special comment blocks from generated source code fragments. Normal C, C++ and
1063# Fortran comments will always remain visible.
1064# The default value is: YES.
1065
165STRIP_CODE_COMMENTS = YES 1066STRIP_CODE_COMMENTS = YES
1067
1068# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1069# entity all documented functions referencing it will be listed.
1070# The default value is: NO.
1071
166REFERENCED_BY_RELATION = YES 1072REFERENCED_BY_RELATION = YES
1073
1074# If the REFERENCES_RELATION tag is set to YES then for each documented function
1075# all documented entities called/used by that function will be listed.
1076# The default value is: NO.
1077
167REFERENCES_RELATION = YES 1078REFERENCES_RELATION = YES
1079
1080# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1081# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1082# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1083# link to the documentation.
1084# The default value is: YES.
1085
168REFERENCES_LINK_SOURCE = YES 1086REFERENCES_LINK_SOURCE = YES
1087
1088# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1089# source code will show a tooltip with additional information such as prototype,
1090# brief description and links to the definition and documentation. Since this
1091# will make the HTML file larger and loading of large files a bit slower, you
1092# can opt to disable this feature.
1093# The default value is: YES.
1094# This tag requires that the tag SOURCE_BROWSER is set to YES.
1095
1096SOURCE_TOOLTIPS = YES
1097
1098# If the USE_HTAGS tag is set to YES then the references to source code will
1099# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1100# source browser. The htags tool is part of GNU's global source tagging system
1101# (see https://www.gnu.org/software/global/global.html). You will need version
1102# 4.8.6 or higher.
1103#
1104# To use it do the following:
1105# - Install the latest version of global
1106# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1107# - Make sure the INPUT points to the root of the source tree
1108# - Run doxygen as normal
1109#
1110# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1111# tools must be available from the command line (i.e. in the search path).
1112#
1113# The result: instead of the source browser generated by doxygen, the links to
1114# source code will now point to the output of htags.
1115# The default value is: NO.
1116# This tag requires that the tag SOURCE_BROWSER is set to YES.
1117
169USE_HTAGS = NO 1118USE_HTAGS = NO
1119
1120# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1121# verbatim copy of the header file for each class for which an include is
1122# specified. Set to NO to disable this.
1123# See also: Section \class.
1124# The default value is: YES.
1125
170VERBATIM_HEADERS = YES 1126VERBATIM_HEADERS = YES
1127
1128# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1129# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1130# cost of reduced performance. This can be particularly helpful with template
1131# rich C++ code for which doxygen's built-in parser lacks the necessary type
1132# information.
1133# Note: The availability of this option depends on whether or not doxygen was
1134# generated with the -Duse_libclang=ON option for CMake.
1135# The default value is: NO.
1136
1137CLANG_ASSISTED_PARSING = NO
1138
1139# If clang assisted parsing is enabled you can provide the compiler with command
1140# line options that you would normally use when invoking the compiler. Note that
1141# the include paths will already be set by doxygen for the files and directories
1142# specified with INPUT and INCLUDE_PATH.
1143# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1144
1145CLANG_OPTIONS =
1146
1147# If clang assisted parsing is enabled you can provide the clang parser with the
1148# path to the compilation database (see:
1149# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1150# were built. This is equivalent to specifying the "-p" option to a clang tool,
1151# such as clang-check. These options will then be passed to the parser.
1152# Note: The availability of this option depends on whether or not doxygen was
1153# generated with the -Duse_libclang=ON option for CMake.
1154
1155CLANG_DATABASE_PATH =
1156
171#--------------------------------------------------------------------------- 1157#---------------------------------------------------------------------------
172# configuration options related to the alphabetical class index 1158# Configuration options related to the alphabetical class index
173#--------------------------------------------------------------------------- 1159#---------------------------------------------------------------------------
1160
1161# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1162# compounds will be generated. Enable this if the project contains a lot of
1163# classes, structs, unions or interfaces.
1164# The default value is: YES.
1165
174ALPHABETICAL_INDEX = YES 1166ALPHABETICAL_INDEX = YES
1167
1168# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1169# which the alphabetical index list will be split.
1170# Minimum value: 1, maximum value: 20, default value: 5.
1171# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1172
175COLS_IN_ALPHA_INDEX = 3 1173COLS_IN_ALPHA_INDEX = 3
1174
1175# In case all classes in a project start with a common prefix, all classes will
1176# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1177# can be used to specify a prefix (or a list of prefixes) that should be ignored
1178# while generating the index headers.
1179# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1180
176IGNORE_PREFIX = GNUNET_ 1181IGNORE_PREFIX = GNUNET_
1182
177#--------------------------------------------------------------------------- 1183#---------------------------------------------------------------------------
178# configuration options related to the HTML output 1184# Configuration options related to the HTML output
179#--------------------------------------------------------------------------- 1185#---------------------------------------------------------------------------
1186
1187# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1188# The default value is: YES.
1189
180GENERATE_HTML = YES 1190GENERATE_HTML = YES
1191
1192# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1193# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1194# it.
1195# The default directory is: html.
1196# This tag requires that the tag GENERATE_HTML is set to YES.
1197
181HTML_OUTPUT = html 1198HTML_OUTPUT = html
1199
1200# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1201# generated HTML page (for example: .htm, .php, .asp).
1202# The default value is: .html.
1203# This tag requires that the tag GENERATE_HTML is set to YES.
1204
182HTML_FILE_EXTENSION = .html 1205HTML_FILE_EXTENSION = .html
1206
1207# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1208# each generated HTML page. If the tag is left blank doxygen will generate a
1209# standard header.
1210#
1211# To get valid HTML the header file that includes any scripts and style sheets
1212# that doxygen needs, which is dependent on the configuration options used (e.g.
1213# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1214# default header using
1215# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1216# YourConfigFile
1217# and then modify the file new_header.html. See also section "Doxygen usage"
1218# for information on how to generate the default header that doxygen normally
1219# uses.
1220# Note: The header is subject to change so you typically have to regenerate the
1221# default header when upgrading to a newer version of doxygen. For a description
1222# of the possible markers and block names see the documentation.
1223# This tag requires that the tag GENERATE_HTML is set to YES.
1224
183HTML_HEADER = 1225HTML_HEADER =
1226
1227# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1228# generated HTML page. If the tag is left blank doxygen will generate a standard
1229# footer. See HTML_HEADER for more information on how to generate a default
1230# footer and what special commands can be used inside the footer. See also
1231# section "Doxygen usage" for information on how to generate the default footer
1232# that doxygen normally uses.
1233# This tag requires that the tag GENERATE_HTML is set to YES.
1234
184HTML_FOOTER = 1235HTML_FOOTER =
1236
1237# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1238# sheet that is used by each HTML page. It can be used to fine-tune the look of
1239# the HTML output. If left blank doxygen will generate a default style sheet.
1240# See also section "Doxygen usage" for information on how to generate the style
1241# sheet that doxygen normally uses.
1242# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1243# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1244# obsolete.
1245# This tag requires that the tag GENERATE_HTML is set to YES.
1246
185HTML_STYLESHEET = 1247HTML_STYLESHEET =
186GENERATE_HTMLHELP = NO 1248
1249# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1250# cascading style sheets that are included after the standard style sheets
1251# created by doxygen. Using this option one can overrule certain style aspects.
1252# This is preferred over using HTML_STYLESHEET since it does not replace the
1253# standard style sheet and is therefore more robust against future updates.
1254# Doxygen will copy the style sheet files to the output directory.
1255# Note: The order of the extra style sheet files is of importance (e.g. the last
1256# style sheet in the list overrules the setting of the previous ones in the
1257# list). For an example see the documentation.
1258# This tag requires that the tag GENERATE_HTML is set to YES.
1259
1260HTML_EXTRA_STYLESHEET =
1261
1262# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1263# other source files which should be copied to the HTML output directory. Note
1264# that these files will be copied to the base HTML output directory. Use the
1265# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1266# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1267# files will be copied as-is; there are no commands or markers available.
1268# This tag requires that the tag GENERATE_HTML is set to YES.
1269
1270HTML_EXTRA_FILES =
1271
1272# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1273# will adjust the colors in the style sheet and background images according to
1274# this color. Hue is specified as an angle on a colorwheel, see
1275# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1276# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1277# purple, and 360 is red again.
1278# Minimum value: 0, maximum value: 359, default value: 220.
1279# This tag requires that the tag GENERATE_HTML is set to YES.
1280
1281HTML_COLORSTYLE_HUE = 220
1282
1283# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1284# in the HTML output. For a value of 0 the output will use grayscales only. A
1285# value of 255 will produce the most vivid colors.
1286# Minimum value: 0, maximum value: 255, default value: 100.
1287# This tag requires that the tag GENERATE_HTML is set to YES.
1288
1289HTML_COLORSTYLE_SAT = 100
1290
1291# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1292# luminance component of the colors in the HTML output. Values below 100
1293# gradually make the output lighter, whereas values above 100 make the output
1294# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1295# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1296# change the gamma.
1297# Minimum value: 40, maximum value: 240, default value: 80.
1298# This tag requires that the tag GENERATE_HTML is set to YES.
1299
1300HTML_COLORSTYLE_GAMMA = 80
1301
1302# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1303# page will contain the date and time when the page was generated. Setting this
1304# to YES can help to show when doxygen was last run and thus if the
1305# documentation is up to date.
1306# The default value is: NO.
1307# This tag requires that the tag GENERATE_HTML is set to YES.
1308
1309HTML_TIMESTAMP = NO
1310
1311# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1312# documentation will contain a main index with vertical navigation menus that
1313# are dynamically created via JavaScript. If disabled, the navigation index will
1314# consists of multiple levels of tabs that are statically embedded in every HTML
1315# page. Disable this option to support browsers that do not have JavaScript,
1316# like the Qt help browser.
1317# The default value is: YES.
1318# This tag requires that the tag GENERATE_HTML is set to YES.
1319
1320HTML_DYNAMIC_MENUS = YES
1321
1322# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1323# documentation will contain sections that can be hidden and shown after the
1324# page has loaded.
1325# The default value is: NO.
1326# This tag requires that the tag GENERATE_HTML is set to YES.
1327
1328HTML_DYNAMIC_SECTIONS = NO
1329
1330# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1331# shown in the various tree structured indices initially; the user can expand
1332# and collapse entries dynamically later on. Doxygen will expand the tree to
1333# such a level that at most the specified number of entries are visible (unless
1334# a fully collapsed tree already exceeds this amount). So setting the number of
1335# entries 1 will produce a full collapsed tree by default. 0 is a special value
1336# representing an infinite number of entries and will result in a full expanded
1337# tree by default.
1338# Minimum value: 0, maximum value: 9999, default value: 100.
1339# This tag requires that the tag GENERATE_HTML is set to YES.
1340
1341HTML_INDEX_NUM_ENTRIES = 100
1342
1343# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1344# generated that can be used as input for Apple's Xcode 3 integrated development
1345# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1346# 10.5 (Leopard). To create a documentation set, doxygen will generate a
1347# Makefile in the HTML output directory. Running make will produce the docset in
1348# that directory and running make install will install the docset in
1349# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1350# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1351# genXcode/_index.html for more information.
1352# The default value is: NO.
1353# This tag requires that the tag GENERATE_HTML is set to YES.
1354
187GENERATE_DOCSET = NO 1355GENERATE_DOCSET = NO
1356
1357# This tag determines the name of the docset feed. A documentation feed provides
1358# an umbrella under which multiple documentation sets from a single provider
1359# (such as a company or product suite) can be grouped.
1360# The default value is: Doxygen generated docs.
1361# This tag requires that the tag GENERATE_DOCSET is set to YES.
1362
188DOCSET_FEEDNAME = "GNUnet Source Documentation" 1363DOCSET_FEEDNAME = "GNUnet Source Documentation"
1364
1365# This tag specifies a string that should uniquely identify the documentation
1366# set bundle. This should be a reverse domain-name style string, e.g.
1367# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1368# The default value is: org.doxygen.Project.
1369# This tag requires that the tag GENERATE_DOCSET is set to YES.
1370
189DOCSET_BUNDLE_ID = org.gnunet 1371DOCSET_BUNDLE_ID = org.gnunet
190HTML_DYNAMIC_SECTIONS = NO 1372
1373# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1374# the documentation publisher. This should be a reverse domain-name style
1375# string, e.g. com.mycompany.MyDocSet.documentation.
1376# The default value is: org.doxygen.Publisher.
1377# This tag requires that the tag GENERATE_DOCSET is set to YES.
1378
1379DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1380
1381# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1382# The default value is: Publisher.
1383# This tag requires that the tag GENERATE_DOCSET is set to YES.
1384
1385DOCSET_PUBLISHER_NAME = Publisher
1386
1387# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1388# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1389# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1390# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1391# Windows.
1392#
1393# The HTML Help Workshop contains a compiler that can convert all HTML output
1394# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1395# files are now used as the Windows 98 help format, and will replace the old
1396# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1397# HTML files also contain an index, a table of contents, and you can search for
1398# words in the documentation. The HTML workshop also contains a viewer for
1399# compressed HTML files.
1400# The default value is: NO.
1401# This tag requires that the tag GENERATE_HTML is set to YES.
1402
1403GENERATE_HTMLHELP = NO
1404
1405# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1406# file. You can add a path in front of the file if the result should not be
1407# written to the html output directory.
1408# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1409
191CHM_FILE = 1410CHM_FILE =
1411
1412# The HHC_LOCATION tag can be used to specify the location (absolute path
1413# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1414# doxygen will try to run the HTML help compiler on the generated index.hhp.
1415# The file has to be specified with full path.
1416# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1417
192HHC_LOCATION = 1418HHC_LOCATION =
1419
1420# The GENERATE_CHI flag controls if a separate .chi index file is generated
1421# (YES) or that it should be included in the master .chm file (NO).
1422# The default value is: NO.
1423# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1424
193GENERATE_CHI = NO 1425GENERATE_CHI = NO
1426
1427# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1428# and project file content.
1429# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1430
194CHM_INDEX_ENCODING = 1431CHM_INDEX_ENCODING =
1432
1433# The BINARY_TOC flag controls whether a binary table of contents is generated
1434# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1435# enables the Previous and Next buttons.
1436# The default value is: NO.
1437# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1438
195BINARY_TOC = NO 1439BINARY_TOC = NO
1440
1441# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1442# the table of contents of the HTML help documentation and to the tree view.
1443# The default value is: NO.
1444# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1445
196TOC_EXPAND = NO 1446TOC_EXPAND = NO
1447
1448# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1449# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1450# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1451# (.qch) of the generated HTML documentation.
1452# The default value is: NO.
1453# This tag requires that the tag GENERATE_HTML is set to YES.
1454
1455GENERATE_QHP = NO
1456
1457# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1458# the file name of the resulting .qch file. The path specified is relative to
1459# the HTML output folder.
1460# This tag requires that the tag GENERATE_QHP is set to YES.
1461
1462QCH_FILE =
1463
1464# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1465# Project output. For more information please see Qt Help Project / Namespace
1466# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1467# The default value is: org.doxygen.Project.
1468# This tag requires that the tag GENERATE_QHP is set to YES.
1469
1470QHP_NAMESPACE = org.doxygen.Project
1471
1472# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1473# Help Project output. For more information please see Qt Help Project / Virtual
1474# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1475# folders).
1476# The default value is: doc.
1477# This tag requires that the tag GENERATE_QHP is set to YES.
1478
1479QHP_VIRTUAL_FOLDER = doc
1480
1481# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1482# filter to add. For more information please see Qt Help Project / Custom
1483# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1484# filters).
1485# This tag requires that the tag GENERATE_QHP is set to YES.
1486
1487QHP_CUST_FILTER_NAME =
1488
1489# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1490# custom filter to add. For more information please see Qt Help Project / Custom
1491# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1492# filters).
1493# This tag requires that the tag GENERATE_QHP is set to YES.
1494
1495QHP_CUST_FILTER_ATTRS =
1496
1497# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1498# project's filter section matches. Qt Help Project / Filter Attributes (see:
1499# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1500# This tag requires that the tag GENERATE_QHP is set to YES.
1501
1502QHP_SECT_FILTER_ATTRS =
1503
1504# The QHG_LOCATION tag can be used to specify the location of Qt's
1505# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1506# generated .qhp file.
1507# This tag requires that the tag GENERATE_QHP is set to YES.
1508
1509QHG_LOCATION =
1510
1511# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1512# generated, together with the HTML files, they form an Eclipse help plugin. To
1513# install this plugin and make it available under the help contents menu in
1514# Eclipse, the contents of the directory containing the HTML and XML files needs
1515# to be copied into the plugins directory of eclipse. The name of the directory
1516# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1517# After copying Eclipse needs to be restarted before the help appears.
1518# The default value is: NO.
1519# This tag requires that the tag GENERATE_HTML is set to YES.
1520
1521GENERATE_ECLIPSEHELP = NO
1522
1523# A unique identifier for the Eclipse help plugin. When installing the plugin
1524# the directory name containing the HTML and XML files should also have this
1525# name. Each documentation set should have its own identifier.
1526# The default value is: org.doxygen.Project.
1527# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1528
1529ECLIPSE_DOC_ID = org.doxygen.Project
1530
1531# If you want full control over the layout of the generated HTML pages it might
1532# be necessary to disable the index and replace it with your own. The
1533# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1534# of each HTML page. A value of NO enables the index and the value YES disables
1535# it. Since the tabs in the index contain the same information as the navigation
1536# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1537# The default value is: NO.
1538# This tag requires that the tag GENERATE_HTML is set to YES.
1539
197DISABLE_INDEX = NO 1540DISABLE_INDEX = NO
198ENUM_VALUES_PER_LINE = 4 1541
1542# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1543# structure should be generated to display hierarchical information. If the tag
1544# value is set to YES, a side panel will be generated containing a tree-like
1545# index structure (just like the one that is generated for HTML Help). For this
1546# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1547# (i.e. any modern browser). Windows users are probably better off using the
1548# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1549# further fine-tune the look of the index. As an example, the default style
1550# sheet generated by doxygen has an example that shows how to put an image at
1551# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1552# the same information as the tab index, you could consider setting
1553# DISABLE_INDEX to YES when enabling this option.
1554# The default value is: NO.
1555# This tag requires that the tag GENERATE_HTML is set to YES.
1556
199GENERATE_TREEVIEW = NONE 1557GENERATE_TREEVIEW = NONE
1558
1559# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1560# doxygen will group on one line in the generated HTML documentation.
1561#
1562# Note that a value of 0 will completely suppress the enum values from appearing
1563# in the overview section.
1564# Minimum value: 0, maximum value: 20, default value: 4.
1565# This tag requires that the tag GENERATE_HTML is set to YES.
1566
1567ENUM_VALUES_PER_LINE = 4
1568
1569# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1570# to set the initial width (in pixels) of the frame in which the tree is shown.
1571# Minimum value: 0, maximum value: 1500, default value: 250.
1572# This tag requires that the tag GENERATE_HTML is set to YES.
1573
200TREEVIEW_WIDTH = 250 1574TREEVIEW_WIDTH = 250
1575
1576# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1577# external symbols imported via tag files in a separate window.
1578# The default value is: NO.
1579# This tag requires that the tag GENERATE_HTML is set to YES.
1580
1581EXT_LINKS_IN_WINDOW = NO
1582
1583# Use this tag to change the font size of LaTeX formulas included as images in
1584# the HTML documentation. When you change the font size after a successful
1585# doxygen run you need to manually remove any form_*.png images from the HTML
1586# output directory to force them to be regenerated.
1587# Minimum value: 8, maximum value: 50, default value: 10.
1588# This tag requires that the tag GENERATE_HTML is set to YES.
1589
201FORMULA_FONTSIZE = 10 1590FORMULA_FONTSIZE = 10
1591
1592# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1593# generated for formulas are transparent PNGs. Transparent PNGs are not
1594# supported properly for IE 6.0, but are supported on all modern browsers.
1595#
1596# Note that when changing this option you need to delete any form_*.png files in
1597# the HTML output directory before the changes have effect.
1598# The default value is: YES.
1599# This tag requires that the tag GENERATE_HTML is set to YES.
1600
1601FORMULA_TRANSPARENT = YES
1602
1603# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1604# to create new LaTeX commands to be used in formulas as building blocks. See
1605# the section "Including formulas" for details.
1606
1607FORMULA_MACROFILE =
1608
1609# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1610# https://www.mathjax.org) which uses client side JavaScript for the rendering
1611# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1612# installed or if you want to formulas look prettier in the HTML output. When
1613# enabled you may also need to install MathJax separately and configure the path
1614# to it using the MATHJAX_RELPATH option.
1615# The default value is: NO.
1616# This tag requires that the tag GENERATE_HTML is set to YES.
1617
1618USE_MATHJAX = NO
1619
1620# When MathJax is enabled you can set the default output format to be used for
1621# the MathJax output. See the MathJax site (see:
1622# http://docs.mathjax.org/en/latest/output.html) for more details.
1623# Possible values are: HTML-CSS (which is slower, but has the best
1624# compatibility), NativeMML (i.e. MathML) and SVG.
1625# The default value is: HTML-CSS.
1626# This tag requires that the tag USE_MATHJAX is set to YES.
1627
1628MATHJAX_FORMAT = HTML-CSS
1629
1630# When MathJax is enabled you need to specify the location relative to the HTML
1631# output directory using the MATHJAX_RELPATH option. The destination directory
1632# should contain the MathJax.js script. For instance, if the mathjax directory
1633# is located at the same level as the HTML output directory, then
1634# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1635# Content Delivery Network so you can quickly see the result without installing
1636# MathJax. However, it is strongly recommended to install a local copy of
1637# MathJax from https://www.mathjax.org before deployment.
1638# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1639# This tag requires that the tag USE_MATHJAX is set to YES.
1640
1641MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1642
1643# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1644# extension names that should be enabled during MathJax rendering. For example
1645# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1646# This tag requires that the tag USE_MATHJAX is set to YES.
1647
1648MATHJAX_EXTENSIONS =
1649
1650# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1651# of code that will be used on startup of the MathJax code. See the MathJax site
1652# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1653# example see the documentation.
1654# This tag requires that the tag USE_MATHJAX is set to YES.
1655
1656MATHJAX_CODEFILE =
1657
1658# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1659# the HTML output. The underlying search engine uses javascript and DHTML and
1660# should work on any modern browser. Note that when using HTML help
1661# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1662# there is already a search function so this one should typically be disabled.
1663# For large projects the javascript based search engine can be slow, then
1664# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1665# search using the keyboard; to jump to the search box use <access key> + S
1666# (what the <access key> is depends on the OS and browser, but it is typically
1667# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1668# key> to jump into the search results window, the results can be navigated
1669# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1670# the search. The filter options can be selected when the cursor is inside the
1671# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1672# to select a filter and <Enter> or <escape> to activate or cancel the filter
1673# option.
1674# The default value is: YES.
1675# This tag requires that the tag GENERATE_HTML is set to YES.
1676
1677SEARCHENGINE = YES
1678
1679# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1680# implemented using a web server instead of a web client using JavaScript. There
1681# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1682# setting. When disabled, doxygen will generate a PHP script for searching and
1683# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1684# and searching needs to be provided by external tools. See the section
1685# "External Indexing and Searching" for details.
1686# The default value is: NO.
1687# This tag requires that the tag SEARCHENGINE is set to YES.
1688
1689SERVER_BASED_SEARCH = NO
1690
1691# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1692# script for searching. Instead the search results are written to an XML file
1693# which needs to be processed by an external indexer. Doxygen will invoke an
1694# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1695# search results.
1696#
1697# Doxygen ships with an example indexer (doxyindexer) and search engine
1698# (doxysearch.cgi) which are based on the open source search engine library
1699# Xapian (see: https://xapian.org/).
1700#
1701# See the section "External Indexing and Searching" for details.
1702# The default value is: NO.
1703# This tag requires that the tag SEARCHENGINE is set to YES.
1704
1705EXTERNAL_SEARCH = NO
1706
1707# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1708# which will return the search results when EXTERNAL_SEARCH is enabled.
1709#
1710# Doxygen ships with an example indexer (doxyindexer) and search engine
1711# (doxysearch.cgi) which are based on the open source search engine library
1712# Xapian (see: https://xapian.org/). See the section "External Indexing and
1713# Searching" for details.
1714# This tag requires that the tag SEARCHENGINE is set to YES.
1715
1716SEARCHENGINE_URL =
1717
1718# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1719# search data is written to a file for indexing by an external tool. With the
1720# SEARCHDATA_FILE tag the name of this file can be specified.
1721# The default file is: searchdata.xml.
1722# This tag requires that the tag SEARCHENGINE is set to YES.
1723
1724SEARCHDATA_FILE = searchdata.xml
1725
1726# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1727# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1728# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1729# projects and redirect the results back to the right project.
1730# This tag requires that the tag SEARCHENGINE is set to YES.
1731
1732EXTERNAL_SEARCH_ID =
1733
1734# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1735# projects other than the one defined by this configuration file, but that are
1736# all added to the same external search index. Each project needs to have a
1737# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1738# to a relative location where the documentation can be found. The format is:
1739# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1740# This tag requires that the tag SEARCHENGINE is set to YES.
1741
1742EXTRA_SEARCH_MAPPINGS =
1743
202#--------------------------------------------------------------------------- 1744#---------------------------------------------------------------------------
203# configuration options related to the LaTeX output 1745# Configuration options related to the LaTeX output
204#--------------------------------------------------------------------------- 1746#---------------------------------------------------------------------------
1747
1748# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1749# The default value is: YES.
1750
205GENERATE_LATEX = NO 1751GENERATE_LATEX = NO
1752
1753# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1754# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1755# it.
1756# The default directory is: latex.
1757# This tag requires that the tag GENERATE_LATEX is set to YES.
1758
206LATEX_OUTPUT = latex 1759LATEX_OUTPUT = latex
1760
1761# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1762# invoked.
1763#
1764# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1765# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1766# chosen this is overwritten by pdflatex. For specific output languages the
1767# default can have been set differently, this depends on the implementation of
1768# the output language.
1769# This tag requires that the tag GENERATE_LATEX is set to YES.
1770
207LATEX_CMD_NAME = latex 1771LATEX_CMD_NAME = latex
1772
1773# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1774# index for LaTeX.
1775# Note: This tag is used in the Makefile / make.bat.
1776# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1777# (.tex).
1778# The default file is: makeindex.
1779# This tag requires that the tag GENERATE_LATEX is set to YES.
1780
208MAKEINDEX_CMD_NAME = makeindex 1781MAKEINDEX_CMD_NAME = makeindex
1782
1783# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1784# generate index for LaTeX. In case there is no backslash (\) as first character
1785# it will be automatically added in the LaTeX code.
1786# Note: This tag is used in the generated output file (.tex).
1787# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1788# The default value is: makeindex.
1789# This tag requires that the tag GENERATE_LATEX is set to YES.
1790
1791LATEX_MAKEINDEX_CMD = makeindex
1792
1793# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1794# documents. This may be useful for small projects and may help to save some
1795# trees in general.
1796# The default value is: NO.
1797# This tag requires that the tag GENERATE_LATEX is set to YES.
1798
209COMPACT_LATEX = YES 1799COMPACT_LATEX = YES
1800
1801# The PAPER_TYPE tag can be used to set the paper type that is used by the
1802# printer.
1803# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1804# 14 inches) and executive (7.25 x 10.5 inches).
1805# The default value is: a4.
1806# This tag requires that the tag GENERATE_LATEX is set to YES.
1807
210PAPER_TYPE = a4 1808PAPER_TYPE = a4
1809
1810# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1811# that should be included in the LaTeX output. The package can be specified just
1812# by its name or with the correct syntax as to be used with the LaTeX
1813# \usepackage command. To get the times font for instance you can specify :
1814# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1815# To use the option intlimits with the amsmath package you can specify:
1816# EXTRA_PACKAGES=[intlimits]{amsmath}
1817# If left blank no extra packages will be included.
1818# This tag requires that the tag GENERATE_LATEX is set to YES.
1819
211EXTRA_PACKAGES = 1820EXTRA_PACKAGES =
1821
1822# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1823# generated LaTeX document. The header should contain everything until the first
1824# chapter. If it is left blank doxygen will generate a standard header. See
1825# section "Doxygen usage" for information on how to let doxygen write the
1826# default header to a separate file.
1827#
1828# Note: Only use a user-defined header if you know what you are doing! The
1829# following commands have a special meaning inside the header: $title,
1830# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1831# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1832# string, for the replacement values of the other commands the user is referred
1833# to HTML_HEADER.
1834# This tag requires that the tag GENERATE_LATEX is set to YES.
1835
212LATEX_HEADER = 1836LATEX_HEADER =
1837
1838# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1839# generated LaTeX document. The footer should contain everything after the last
1840# chapter. If it is left blank doxygen will generate a standard footer. See
1841# LATEX_HEADER for more information on how to generate a default footer and what
1842# special commands can be used inside the footer.
1843#
1844# Note: Only use a user-defined footer if you know what you are doing!
1845# This tag requires that the tag GENERATE_LATEX is set to YES.
1846
1847LATEX_FOOTER =
1848
1849# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1850# LaTeX style sheets that are included after the standard style sheets created
1851# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1852# will copy the style sheet files to the output directory.
1853# Note: The order of the extra style sheet files is of importance (e.g. the last
1854# style sheet in the list overrules the setting of the previous ones in the
1855# list).
1856# This tag requires that the tag GENERATE_LATEX is set to YES.
1857
1858LATEX_EXTRA_STYLESHEET =
1859
1860# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1861# other source files which should be copied to the LATEX_OUTPUT output
1862# directory. Note that the files will be copied as-is; there are no commands or
1863# markers available.
1864# This tag requires that the tag GENERATE_LATEX is set to YES.
1865
1866LATEX_EXTRA_FILES =
1867
1868# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1869# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1870# contain links (just like the HTML output) instead of page references. This
1871# makes the output suitable for online browsing using a PDF viewer.
1872# The default value is: YES.
1873# This tag requires that the tag GENERATE_LATEX is set to YES.
1874
213PDF_HYPERLINKS = YES 1875PDF_HYPERLINKS = YES
1876
1877# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1878# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1879# higher quality PDF documentation.
1880# The default value is: YES.
1881# This tag requires that the tag GENERATE_LATEX is set to YES.
1882
214USE_PDFLATEX = YES 1883USE_PDFLATEX = YES
1884
1885# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1886# command to the generated LaTeX files. This will instruct LaTeX to keep running
1887# if errors occur, instead of asking the user for help. This option is also used
1888# when generating formulas in HTML.
1889# The default value is: NO.
1890# This tag requires that the tag GENERATE_LATEX is set to YES.
1891
215LATEX_BATCHMODE = NO 1892LATEX_BATCHMODE = NO
1893
1894# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1895# index chapters (such as File Index, Compound Index, etc.) in the output.
1896# The default value is: NO.
1897# This tag requires that the tag GENERATE_LATEX is set to YES.
1898
216LATEX_HIDE_INDICES = NO 1899LATEX_HIDE_INDICES = NO
1900
1901# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1902# code with syntax highlighting in the LaTeX output.
1903#
1904# Note that which sources are shown also depends on other settings such as
1905# SOURCE_BROWSER.
1906# The default value is: NO.
1907# This tag requires that the tag GENERATE_LATEX is set to YES.
1908
1909LATEX_SOURCE_CODE = NO
1910
1911# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1912# bibliography, e.g. plainnat, or ieeetr. See
1913# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1914# The default value is: plain.
1915# This tag requires that the tag GENERATE_LATEX is set to YES.
1916
1917LATEX_BIB_STYLE = plain
1918
1919# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1920# page will contain the date and time when the page was generated. Setting this
1921# to NO can help when comparing the output of multiple runs.
1922# The default value is: NO.
1923# This tag requires that the tag GENERATE_LATEX is set to YES.
1924
1925LATEX_TIMESTAMP = NO
1926
1927# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1928# path from which the emoji images will be read. If a relative path is entered,
1929# it will be relative to the LATEX_OUTPUT directory. If left blank the
1930# LATEX_OUTPUT directory will be used.
1931# This tag requires that the tag GENERATE_LATEX is set to YES.
1932
1933LATEX_EMOJI_DIRECTORY =
1934
217#--------------------------------------------------------------------------- 1935#---------------------------------------------------------------------------
218# configuration options related to the RTF output 1936# Configuration options related to the RTF output
219#--------------------------------------------------------------------------- 1937#---------------------------------------------------------------------------
1938
1939# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1940# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1941# readers/editors.
1942# The default value is: NO.
1943
220GENERATE_RTF = NO 1944GENERATE_RTF = NO
1945
1946# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1947# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1948# it.
1949# The default directory is: rtf.
1950# This tag requires that the tag GENERATE_RTF is set to YES.
1951
221RTF_OUTPUT = rtf 1952RTF_OUTPUT = rtf
1953
1954# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1955# documents. This may be useful for small projects and may help to save some
1956# trees in general.
1957# The default value is: NO.
1958# This tag requires that the tag GENERATE_RTF is set to YES.
1959
222COMPACT_RTF = NO 1960COMPACT_RTF = NO
1961
1962# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1963# contain hyperlink fields. The RTF file will contain links (just like the HTML
1964# output) instead of page references. This makes the output suitable for online
1965# browsing using Word or some other Word compatible readers that support those
1966# fields.
1967#
1968# Note: WordPad (write) and others do not support links.
1969# The default value is: NO.
1970# This tag requires that the tag GENERATE_RTF is set to YES.
1971
223RTF_HYPERLINKS = NO 1972RTF_HYPERLINKS = NO
1973
1974# Load stylesheet definitions from file. Syntax is similar to doxygen's
1975# configuration file, i.e. a series of assignments. You only have to provide
1976# replacements, missing definitions are set to their default value.
1977#
1978# See also section "Doxygen usage" for information on how to generate the
1979# default style sheet that doxygen normally uses.
1980# This tag requires that the tag GENERATE_RTF is set to YES.
1981
224RTF_STYLESHEET_FILE = 1982RTF_STYLESHEET_FILE =
1983
1984# Set optional variables used in the generation of an RTF document. Syntax is
1985# similar to doxygen's configuration file. A template extensions file can be
1986# generated using doxygen -e rtf extensionFile.
1987# This tag requires that the tag GENERATE_RTF is set to YES.
1988
225RTF_EXTENSIONS_FILE = 1989RTF_EXTENSIONS_FILE =
1990
1991# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1992# with syntax highlighting in the RTF output.
1993#
1994# Note that which sources are shown also depends on other settings such as
1995# SOURCE_BROWSER.
1996# The default value is: NO.
1997# This tag requires that the tag GENERATE_RTF is set to YES.
1998
1999RTF_SOURCE_CODE = NO
2000
226#--------------------------------------------------------------------------- 2001#---------------------------------------------------------------------------
227# configuration options related to the man page output 2002# Configuration options related to the man page output
228#--------------------------------------------------------------------------- 2003#---------------------------------------------------------------------------
2004
2005# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2006# classes and files.
2007# The default value is: NO.
2008
229GENERATE_MAN = NO 2009GENERATE_MAN = NO
2010
2011# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2012# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2013# it. A directory man3 will be created inside the directory specified by
2014# MAN_OUTPUT.
2015# The default directory is: man.
2016# This tag requires that the tag GENERATE_MAN is set to YES.
2017
230MAN_OUTPUT = man 2018MAN_OUTPUT = man
2019
2020# The MAN_EXTENSION tag determines the extension that is added to the generated
2021# man pages. In case the manual section does not start with a number, the number
2022# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2023# optional.
2024# The default value is: .3.
2025# This tag requires that the tag GENERATE_MAN is set to YES.
2026
231MAN_EXTENSION = .3 2027MAN_EXTENSION = .3
2028
2029# The MAN_SUBDIR tag determines the name of the directory created within
2030# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2031# MAN_EXTENSION with the initial . removed.
2032# This tag requires that the tag GENERATE_MAN is set to YES.
2033
2034MAN_SUBDIR =
2035
2036# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2037# will generate one additional man file for each entity documented in the real
2038# man page(s). These additional files only source the real man page, but without
2039# them the man command would be unable to find the correct page.
2040# The default value is: NO.
2041# This tag requires that the tag GENERATE_MAN is set to YES.
2042
232MAN_LINKS = NO 2043MAN_LINKS = NO
2044
233#--------------------------------------------------------------------------- 2045#---------------------------------------------------------------------------
234# configuration options related to the XML output 2046# Configuration options related to the XML output
235#--------------------------------------------------------------------------- 2047#---------------------------------------------------------------------------
236GENERATE_XML = NO 2048
2049# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2050# captures the structure of the code including all documentation.
2051# The default value is: NO.
2052
2053GENERATE_XML = YES
2054
2055# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2056# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2057# it.
2058# The default directory is: xml.
2059# This tag requires that the tag GENERATE_XML is set to YES.
2060
237XML_OUTPUT = xml 2061XML_OUTPUT = xml
238XML_SCHEMA = 2062
239XML_DTD = 2063# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2064# listings (including syntax highlighting and cross-referencing information) to
2065# the XML output. Note that enabling this will significantly increase the size
2066# of the XML output.
2067# The default value is: YES.
2068# This tag requires that the tag GENERATE_XML is set to YES.
2069
240XML_PROGRAMLISTING = YES 2070XML_PROGRAMLISTING = YES
2071
2072# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2073# namespace members in file scope as well, matching the HTML output.
2074# The default value is: NO.
2075# This tag requires that the tag GENERATE_XML is set to YES.
2076
2077XML_NS_MEMB_FILE_SCOPE = NO
2078
2079#---------------------------------------------------------------------------
2080# Configuration options related to the DOCBOOK output
2081#---------------------------------------------------------------------------
2082
2083# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2084# that can be used to generate PDF.
2085# The default value is: NO.
2086
2087GENERATE_DOCBOOK = NO
2088
2089# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2090# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2091# front of it.
2092# The default directory is: docbook.
2093# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2094
2095DOCBOOK_OUTPUT = docbook
2096
2097# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2098# program listings (including syntax highlighting and cross-referencing
2099# information) to the DOCBOOK output. Note that enabling this will significantly
2100# increase the size of the DOCBOOK output.
2101# The default value is: NO.
2102# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2103
2104DOCBOOK_PROGRAMLISTING = NO
2105
241#--------------------------------------------------------------------------- 2106#---------------------------------------------------------------------------
242# configuration options for the AutoGen Definitions output 2107# Configuration options for the AutoGen Definitions output
243#--------------------------------------------------------------------------- 2108#---------------------------------------------------------------------------
2109
2110# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2111# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2112# the structure of the code including all documentation. Note that this feature
2113# is still experimental and incomplete at the moment.
2114# The default value is: NO.
2115
244GENERATE_AUTOGEN_DEF = NO 2116GENERATE_AUTOGEN_DEF = NO
2117
245#--------------------------------------------------------------------------- 2118#---------------------------------------------------------------------------
246# configuration options related to the Perl module output 2119# Configuration options related to the Perl module output
247#--------------------------------------------------------------------------- 2120#---------------------------------------------------------------------------
2121
2122# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2123# file that captures the structure of the code including all documentation.
2124#
2125# Note that this feature is still experimental and incomplete at the moment.
2126# The default value is: NO.
2127
248GENERATE_PERLMOD = NO 2128GENERATE_PERLMOD = NO
2129
2130# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2131# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2132# output from the Perl module output.
2133# The default value is: NO.
2134# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2135
249PERLMOD_LATEX = NO 2136PERLMOD_LATEX = NO
2137
2138# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2139# formatted so it can be parsed by a human reader. This is useful if you want to
2140# understand what is going on. On the other hand, if this tag is set to NO, the
2141# size of the Perl module output will be much smaller and Perl will parse it
2142# just the same.
2143# The default value is: YES.
2144# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2145
250PERLMOD_PRETTY = YES 2146PERLMOD_PRETTY = YES
2147
2148# The names of the make variables in the generated doxyrules.make file are
2149# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2150# so different doxyrules.make files included by the same Makefile don't
2151# overwrite each other's variables.
2152# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2153
251PERLMOD_MAKEVAR_PREFIX = 2154PERLMOD_MAKEVAR_PREFIX =
2155
252#--------------------------------------------------------------------------- 2156#---------------------------------------------------------------------------
253# Configuration options related to the preprocessor 2157# Configuration options related to the preprocessor
254#--------------------------------------------------------------------------- 2158#---------------------------------------------------------------------------
2159
2160# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2161# C-preprocessor directives found in the sources and include files.
2162# The default value is: YES.
2163
255ENABLE_PREPROCESSING = YES 2164ENABLE_PREPROCESSING = YES
2165
2166# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2167# in the source code. If set to NO, only conditional compilation will be
2168# performed. Macro expansion can be done in a controlled way by setting
2169# EXPAND_ONLY_PREDEF to YES.
2170# The default value is: NO.
2171# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2172
256MACRO_EXPANSION = YES 2173MACRO_EXPANSION = YES
2174
2175# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2176# the macro expansion is limited to the macros specified with the PREDEFINED and
2177# EXPAND_AS_DEFINED tags.
2178# The default value is: NO.
2179# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2180
257EXPAND_ONLY_PREDEF = NO 2181EXPAND_ONLY_PREDEF = NO
2182
2183# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2184# INCLUDE_PATH will be searched if a #include is found.
2185# The default value is: YES.
2186# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2187
258SEARCH_INCLUDES = YES 2188SEARCH_INCLUDES = YES
2189
2190# The INCLUDE_PATH tag can be used to specify one or more directories that
2191# contain include files that are not input files but should be processed by the
2192# preprocessor.
2193# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2194
259INCLUDE_PATH = 2195INCLUDE_PATH =
2196
2197# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2198# patterns (like *.h and *.hpp) to filter out the header-files in the
2199# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2200# used.
2201# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2202
260INCLUDE_FILE_PATTERNS = 2203INCLUDE_FILE_PATTERNS =
261PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" 2204
2205# The PREDEFINED tag can be used to specify one or more macro names that are
2206# defined before the preprocessor is started (similar to the -D option of e.g.
2207# gcc). The argument of the tag is a list of macros of the form: name or
2208# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2209# is assumed. To prevent a macro definition from being undefined via #undef or
2210# recursively expanded use the := operator instead of the = operator.
2211# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2212
2213PREDEFINED = "GNUNET_UNUSED=" \
2214 "GNUNET_PACKED="
2215
2216# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2217# tag can be used to specify a list of macro names that should be expanded. The
2218# macro definition that is found in the sources will be used. Use the PREDEFINED
2219# tag if you want to use a different macro definition that overrules the
2220# definition found in the source code.
2221# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2222
262EXPAND_AS_DEFINED = 2223EXPAND_AS_DEFINED =
2224
2225# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2226# remove all references to function-like macros that are alone on a line, have
2227# an all uppercase name, and do not end with a semicolon. Such function macros
2228# are typically used for boiler-plate code, and will confuse the parser if not
2229# removed.
2230# The default value is: YES.
2231# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2232
263SKIP_FUNCTION_MACROS = YES 2233SKIP_FUNCTION_MACROS = YES
2234
264#--------------------------------------------------------------------------- 2235#---------------------------------------------------------------------------
265# Configuration::additions related to external references 2236# Configuration options related to external references
266#--------------------------------------------------------------------------- 2237#---------------------------------------------------------------------------
2238
2239# The TAGFILES tag can be used to specify one or more tag files. For each tag
2240# file the location of the external documentation should be added. The format of
2241# a tag file without this location is as follows:
2242# TAGFILES = file1 file2 ...
2243# Adding location for the tag files is done as follows:
2244# TAGFILES = file1=loc1 "file2 = loc2" ...
2245# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2246# section "Linking to external documentation" for more information about the use
2247# of tag files.
2248# Note: Each tag file must have a unique name (where the name does NOT include
2249# the path). If a tag file is not located in the directory in which doxygen is
2250# run, you must also specify the path to the tagfile here.
2251
267TAGFILES = 2252TAGFILES =
2253
2254# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2255# tag file that is based on the input files it reads. See section "Linking to
2256# external documentation" for more information about the usage of tag files.
2257
268GENERATE_TAGFILE = gnunet.tag 2258GENERATE_TAGFILE = gnunet.tag
2259
2260# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2261# the class index. If set to NO, only the inherited external classes will be
2262# listed.
2263# The default value is: NO.
2264
269ALLEXTERNALS = NO 2265ALLEXTERNALS = NO
2266
2267# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2268# in the modules index. If set to NO, only the current project's groups will be
2269# listed.
2270# The default value is: YES.
2271
270EXTERNAL_GROUPS = YES 2272EXTERNAL_GROUPS = YES
271PERL_PATH = /usr/bin/perl 2273
2274# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2275# the related pages index. If set to NO, only the current project's pages will
2276# be listed.
2277# The default value is: YES.
2278
2279EXTERNAL_PAGES = YES
2280
272#--------------------------------------------------------------------------- 2281#---------------------------------------------------------------------------
273# Configuration options related to the dot tool 2282# Configuration options related to the dot tool
274#--------------------------------------------------------------------------- 2283#---------------------------------------------------------------------------
2284
2285# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2286# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2287# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2288# disabled, but it is recommended to install and use dot, since it yields more
2289# powerful graphs.
2290# The default value is: YES.
2291
275CLASS_DIAGRAMS = YES 2292CLASS_DIAGRAMS = YES
276MSCGEN_PATH = 2293
2294# You can include diagrams made with dia in doxygen documentation. Doxygen will
2295# then run dia to produce the diagram and insert it in the documentation. The
2296# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2297# If left empty dia is assumed to be found in the default search path.
2298
2299DIA_PATH =
2300
2301# If set to YES the inheritance and collaboration graphs will hide inheritance
2302# and usage relations if the target is undocumented or is not a class.
2303# The default value is: YES.
2304
277HIDE_UNDOC_RELATIONS = YES 2305HIDE_UNDOC_RELATIONS = YES
2306
2307# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2308# available from the path. This tool is part of Graphviz (see:
2309# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2310# Bell Labs. The other options in this section have no effect if this option is
2311# set to NO
2312# The default value is: YES.
2313
278HAVE_DOT = YES 2314HAVE_DOT = YES
2315
2316# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2317# to run in parallel. When set to 0 doxygen will base this on the number of
2318# processors available in the system. You can set it explicitly to a value
2319# larger than 0 to get control over the balance between CPU load and processing
2320# speed.
2321# Minimum value: 0, maximum value: 32, default value: 0.
2322# This tag requires that the tag HAVE_DOT is set to YES.
2323
2324DOT_NUM_THREADS = 0
2325
2326# When you want a differently looking font in the dot files that doxygen
2327# generates you can specify the font name using DOT_FONTNAME. You need to make
2328# sure dot is able to find the font, which can be done by putting it in a
2329# standard location or by setting the DOTFONTPATH environment variable or by
2330# setting DOT_FONTPATH to the directory containing the font.
2331# The default value is: Helvetica.
2332# This tag requires that the tag HAVE_DOT is set to YES.
2333
279DOT_FONTNAME = FreeSans 2334DOT_FONTNAME = FreeSans
2335
2336# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2337# dot graphs.
2338# Minimum value: 4, maximum value: 24, default value: 10.
2339# This tag requires that the tag HAVE_DOT is set to YES.
2340
2341DOT_FONTSIZE = 10
2342
2343# By default doxygen will tell dot to use the default font as specified with
2344# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2345# the path where dot can find it using this tag.
2346# This tag requires that the tag HAVE_DOT is set to YES.
2347
280DOT_FONTPATH = 2348DOT_FONTPATH =
2349
2350# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2351# each documented class showing the direct and indirect inheritance relations.
2352# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2353# The default value is: YES.
2354# This tag requires that the tag HAVE_DOT is set to YES.
2355
281CLASS_GRAPH = YES 2356CLASS_GRAPH = YES
2357
2358# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2359# graph for each documented class showing the direct and indirect implementation
2360# dependencies (inheritance, containment, and class references variables) of the
2361# class with other documented classes.
2362# The default value is: YES.
2363# This tag requires that the tag HAVE_DOT is set to YES.
2364
282COLLABORATION_GRAPH = YES 2365COLLABORATION_GRAPH = YES
2366
2367# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2368# groups, showing the direct groups dependencies.
2369# The default value is: YES.
2370# This tag requires that the tag HAVE_DOT is set to YES.
2371
283GROUP_GRAPHS = YES 2372GROUP_GRAPHS = YES
2373
2374# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2375# collaboration diagrams in a style similar to the OMG's Unified Modeling
2376# Language.
2377# The default value is: NO.
2378# This tag requires that the tag HAVE_DOT is set to YES.
2379
284UML_LOOK = NO 2380UML_LOOK = NO
2381
2382# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2383# class node. If there are many fields or methods and many nodes the graph may
2384# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2385# number of items for each type to make the size more manageable. Set this to 0
2386# for no limit. Note that the threshold may be exceeded by 50% before the limit
2387# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2388# but if the number exceeds 15, the total amount of fields shown is limited to
2389# 10.
2390# Minimum value: 0, maximum value: 100, default value: 10.
2391# This tag requires that the tag HAVE_DOT is set to YES.
2392
2393UML_LIMIT_NUM_FIELDS = 10
2394
2395# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2396# collaboration graphs will show the relations between templates and their
2397# instances.
2398# The default value is: NO.
2399# This tag requires that the tag HAVE_DOT is set to YES.
2400
285TEMPLATE_RELATIONS = NO 2401TEMPLATE_RELATIONS = NO
2402
2403# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2404# YES then doxygen will generate a graph for each documented file showing the
2405# direct and indirect include dependencies of the file with other documented
2406# files.
2407# The default value is: YES.
2408# This tag requires that the tag HAVE_DOT is set to YES.
2409
286INCLUDE_GRAPH = YES 2410INCLUDE_GRAPH = YES
2411
2412# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2413# set to YES then doxygen will generate a graph for each documented file showing
2414# the direct and indirect include dependencies of the file with other documented
2415# files.
2416# The default value is: YES.
2417# This tag requires that the tag HAVE_DOT is set to YES.
2418
287INCLUDED_BY_GRAPH = YES 2419INCLUDED_BY_GRAPH = YES
2420
2421# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2422# dependency graph for every global function or class method.
2423#
2424# Note that enabling this option will significantly increase the time of a run.
2425# So in most cases it will be better to enable call graphs for selected
2426# functions only using the \callgraph command. Disabling a call graph can be
2427# accomplished by means of the command \hidecallgraph.
2428# The default value is: NO.
2429# This tag requires that the tag HAVE_DOT is set to YES.
2430
288CALL_GRAPH = YES 2431CALL_GRAPH = YES
2432
2433# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2434# dependency graph for every global function or class method.
2435#
2436# Note that enabling this option will significantly increase the time of a run.
2437# So in most cases it will be better to enable caller graphs for selected
2438# functions only using the \callergraph command. Disabling a caller graph can be
2439# accomplished by means of the command \hidecallergraph.
2440# The default value is: NO.
2441# This tag requires that the tag HAVE_DOT is set to YES.
2442
289CALLER_GRAPH = YES 2443CALLER_GRAPH = YES
2444
2445# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2446# hierarchy of all classes instead of a textual one.
2447# The default value is: YES.
2448# This tag requires that the tag HAVE_DOT is set to YES.
2449
290GRAPHICAL_HIERARCHY = YES 2450GRAPHICAL_HIERARCHY = YES
2451
2452# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2453# dependencies a directory has on other directories in a graphical way. The
2454# dependency relations are determined by the #include relations between the
2455# files in the directories.
2456# The default value is: YES.
2457# This tag requires that the tag HAVE_DOT is set to YES.
2458
291DIRECTORY_GRAPH = YES 2459DIRECTORY_GRAPH = YES
2460
2461# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2462# generated by dot. For an explanation of the image formats see the section
2463# output formats in the documentation of the dot tool (Graphviz (see:
2464# http://www.graphviz.org/)).
2465# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2466# to make the SVG files visible in IE 9+ (other browsers do not have this
2467# requirement).
2468# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2469# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2470# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2471# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2472# png:gdiplus:gdiplus.
2473# The default value is: png.
2474# This tag requires that the tag HAVE_DOT is set to YES.
2475
292DOT_IMAGE_FORMAT = svg 2476DOT_IMAGE_FORMAT = svg
2477
2478# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2479# enable generation of interactive SVG images that allow zooming and panning.
2480#
2481# Note that this requires a modern browser other than Internet Explorer. Tested
2482# and working are Firefox, Chrome, Safari, and Opera.
2483# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2484# the SVG files visible. Older versions of IE do not have SVG support.
2485# The default value is: NO.
2486# This tag requires that the tag HAVE_DOT is set to YES.
2487
293INTERACTIVE_SVG = NO 2488INTERACTIVE_SVG = NO
2489
2490# The DOT_PATH tag can be used to specify the path where the dot tool can be
2491# found. If left blank, it is assumed the dot tool can be found in the path.
2492# This tag requires that the tag HAVE_DOT is set to YES.
2493
294DOT_PATH = 2494DOT_PATH =
2495
2496# The DOTFILE_DIRS tag can be used to specify one or more directories that
2497# contain dot files that are included in the documentation (see the \dotfile
2498# command).
2499# This tag requires that the tag HAVE_DOT is set to YES.
2500
295DOTFILE_DIRS = 2501DOTFILE_DIRS =
2502
2503# The MSCFILE_DIRS tag can be used to specify one or more directories that
2504# contain msc files that are included in the documentation (see the \mscfile
2505# command).
2506
2507MSCFILE_DIRS =
2508
2509# The DIAFILE_DIRS tag can be used to specify one or more directories that
2510# contain dia files that are included in the documentation (see the \diafile
2511# command).
2512
2513DIAFILE_DIRS =
2514
2515# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2516# path where java can find the plantuml.jar file. If left blank, it is assumed
2517# PlantUML is not used or called during a preprocessing step. Doxygen will
2518# generate a warning when it encounters a \startuml command in this case and
2519# will not generate output for the diagram.
2520
2521PLANTUML_JAR_PATH =
2522
2523# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2524# configuration file for plantuml.
2525
2526PLANTUML_CFG_FILE =
2527
2528# When using plantuml, the specified paths are searched for files specified by
2529# the !include statement in a plantuml block.
2530
2531PLANTUML_INCLUDE_PATH =
2532
2533# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2534# that will be shown in the graph. If the number of nodes in a graph becomes
2535# larger than this value, doxygen will truncate the graph, which is visualized
2536# by representing a node as a red box. Note that doxygen if the number of direct
2537# children of the root node in a graph is already larger than
2538# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2539# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2540# Minimum value: 0, maximum value: 10000, default value: 50.
2541# This tag requires that the tag HAVE_DOT is set to YES.
2542
296DOT_GRAPH_MAX_NODES = 50 2543DOT_GRAPH_MAX_NODES = 50
2544
2545# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2546# generated by dot. A depth value of 3 means that only nodes reachable from the
2547# root by following a path via at most 3 edges will be shown. Nodes that lay
2548# further from the root node will be omitted. Note that setting this option to 1
2549# or 2 may greatly reduce the computation time needed for large code bases. Also
2550# note that the size of a graph can be further restricted by
2551# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2552# Minimum value: 0, maximum value: 1000, default value: 0.
2553# This tag requires that the tag HAVE_DOT is set to YES.
2554
297MAX_DOT_GRAPH_DEPTH = 10 2555MAX_DOT_GRAPH_DEPTH = 10
2556
2557# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2558# background. This is disabled by default, because dot on Windows does not seem
2559# to support this out of the box.
2560#
2561# Warning: Depending on the platform used, enabling this option may lead to
2562# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2563# read).
2564# The default value is: NO.
2565# This tag requires that the tag HAVE_DOT is set to YES.
2566
298DOT_TRANSPARENT = YES 2567DOT_TRANSPARENT = YES
2568
2569# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2570# files in one run (i.e. multiple -o and -T options on the command line). This
2571# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2572# this, this feature is disabled by default.
2573# The default value is: NO.
2574# This tag requires that the tag HAVE_DOT is set to YES.
2575
299DOT_MULTI_TARGETS = YES 2576DOT_MULTI_TARGETS = YES
2577
2578# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2579# explaining the meaning of the various boxes and arrows in the dot generated
2580# graphs.
2581# The default value is: YES.
2582# This tag requires that the tag HAVE_DOT is set to YES.
2583
300GENERATE_LEGEND = YES 2584GENERATE_LEGEND = YES
2585
2586# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2587# files that are used to generate the various graphs.
2588# The default value is: YES.
2589# This tag requires that the tag HAVE_DOT is set to YES.
2590
301DOT_CLEANUP = YES 2591DOT_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/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..be7a810f8 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -5,16 +5,6 @@ gnunet.conf.5: gnunet.conf.5.in Makefile
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
@@ -46,6 +36,27 @@ endif
46endif 36endif
47 37
48man_MANS = \ 38man_MANS = \
39 gnunet.1 \
40 gnunet.2 \
41 gnunet.3 \
42 gnunet.4 \
43 gnunet.5 \
44 gnunet.6 \
45 gnunet.7 \
46 gnunet.8 \
47 gnunet.9 \
48 gana.1 \
49 gana.2 \
50 gana.3 \
51 gana.4 \
52 gana.5 \
53 gnunet-dev.1 \
54 gnunet-dev.2 \
55 gnunet-dev.3 \
56 gnunet-dev.4 \
57 gnunet-dev.5 \
58 gnunet-dev.6 \
59 lsd.1 \
49 gnunet.conf.5 \ 60 gnunet.conf.5 \
50 gnunet-arm.1 \ 61 gnunet-arm.1 \
51 gnunet-ats.1 \ 62 gnunet-ats.1 \
@@ -71,6 +82,7 @@ man_MANS = \
71 gnunet-namecache.1 \ 82 gnunet-namecache.1 \
72 gnunet-namestore.1 \ 83 gnunet-namestore.1 \
73 gnunet-namestore-fcfsd.1 \ 84 gnunet-namestore-fcfsd.1 \
85 gnunet-namestore-dbtool.1 \
74 gnunet-nat.1 \ 86 gnunet-nat.1 \
75 gnunet-nat-auto.1 \ 87 gnunet-nat-auto.1 \
76 gnunet-nat-server.1 \ 88 gnunet-nat-server.1 \
@@ -95,10 +107,6 @@ man_MANS = \
95 gnunet-vpn.1 \ 107 gnunet-vpn.1 \
96 gnunet-zoneimport.1 108 gnunet-zoneimport.1
97 109
98if TEXI2MDOC_GENERATION
99man_MANS += gnunet-tutorial.7 gnunet-documentation.7
100endif
101
102EXTRA_DIST = ${man_MANS} \ 110EXTRA_DIST = ${man_MANS} \
103 gnunet.conf.5.in \ 111 gnunet.conf.5.in \
104 produce_html.sh.in \ 112 produce_html.sh.in \
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-namestore-dbtool.1 b/doc/man/gnunet-namestore-dbtool.1
new file mode 100644
index 000000000..af882209b
--- /dev/null
+++ b/doc/man/gnunet-namestore-dbtool.1
@@ -0,0 +1,87 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2022 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 September 30, 2022
25.Dt GNUNET-NAMESTORE-DBTOOL 1
26.Os
27.Sh NAME
28.Nm gnunet-namestore-dbtool
29.Nd manipulate GNU Name System (GNS) namestore database
30.Sh SYNOPSIS
31.Nm
32.Op Fl i | -initialize
33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
34.Op Fl r | -reset
35.Op Fl h | -help
36.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl p Ar PLUGIN | Fl -plugin= Ns Ar PLUGIN
38.Op Fl v | -version
39.Sh DESCRIPTION
40.Nm
41can be used to initialize or reset the namestore database.
42.Pp
43The options are as follows:
44.Bl -tag -width indent
45.It Fl i | -initialize
46Desired operation is initialization of a database.
47.It Fl p Ar PLUGINNAME | Fl -plugin= Ns Ar PLUGINNAME
48Use the plugin PLUGINNAME.
49.It Fl r | -reset
50Desired operation is reset and reinitialization of a database
51.It Fl h | -help
52Print short help on options.
53.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
54Use LOGLEVEL for logging.
55Valid values are DEBUG, INFO, WARNING and ERROR.
56.It Fl v | -version
57Print GNUnet version number.
58.El
59.\".Sh EXAMPLES
60.\".Sh FILES
61.Sh SEE ALSO
62.Xr gnunet-gns 1 ,
63.Xr gnunet-namestore 1
64.sp
65The full documentation for GNUnet is maintained as a Texinfo manual.
66If the
67.Xr info 1
68and gnunet programs are properly installed at your site, the command
69.Pp
70.Dl info gnunet
71.Pp
72should give you access to the complete handbook,
73.Pp
74.Dl info gnunet-c-tutorial
75.Pp
76will give you access to a tutorial for developers.
77.sp
78Depending on your installation, this information is also available in
79.Xr gnunet 7 and
80.Xr gnunet-c-tutorial 7 .
81.\".Sh HISTORY
82.\".Sh AUTHORS
83.Sh BUGS
84Report bugs by using
85.Lk https://bugs.gnunet.org
86or by sending electronic mail to
87.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index a3c6e8ece..3145842a4 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -90,7 +90,7 @@ defaults to
90is missing too 90is missing too
91.Fl -dir-printf 91.Fl -dir-printf
92defaults to 92defaults to
93.Ql #%n:\engnunet-download -o "%f" -R %u\en\en Ns 93.Ql #%n:\engnunet-download -o Qo %f Qc -R %u\en\en Ns
94\&. 94\&.
95.It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT 95.It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT
96Write the search results according to 96Write the search results according to
@@ -171,7 +171,7 @@ character followed by any other character not listed above is treated as an ordi
171If missing, 171If missing,
172.Fl -printf 172.Fl -printf
173defaults to 173defaults to
174.Ql #%n:\engnunet-download -o "%f" %u\en\en Ns 174.Ql #%n:\engnunet-download -o Qo %f Qc %u\en\en Ns
175\&. 175\&.
176.It Fl h | -help 176.It Fl h | -help
177Print the help page. 177Print the help page.
@@ -251,8 +251,8 @@ argument is required).
251.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY 251.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY
252Automatically timeout search after 252Automatically timeout search after
253.Ar DELAY . 253.Ar DELAY .
254The 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
255Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second). 255.Qo 500 ms Qc . Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second).
256If 0 or omitted 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.
257.It Fl v | -version 257.It Fl v | -version
258print the version number 258print the version number
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 5f91a646e..c8905f2c1 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/old/handbook/chapters/developer.texi
@@ -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 f93645114..f93645114 100644
--- a/doc/handbook/chapters/installation.texi
+++ b/doc/old/handbook/chapters/installation.texi
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 180589829..180589829 100644
--- a/doc/handbook/chapters/philosophy.texi
+++ b/doc/old/handbook/chapters/philosophy.texi
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 0b44ab57c..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:
244
245@example
246$ sudo systemctl enable NetworkManager-dispatcher.service
247$ sudo systemctl start NetworkManager-dispatcher.service
248@end example
249
250Then, create a script /etc/NetworkManager/dispatch.h/10-dns2-gns.sh:
251
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.
195 288
289@node Integration with Browsers (SOCKS proxy)
290@subsection Integration with Browsers (SOCKS proxy)
196 291
197While we recommend integrating GNS using the NSS module in the 292While we recommend integrating GNS using the DNS2GNS service or the
198GNU libc Name Service Switch, you can also integrate GNS 293NSSwitch plugin, you can also
199directly with your browser via the @code{gnunet-gns-proxy}. 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
@@ -2365,16 +2460,16 @@ that will terminate at the respective peer's service.
2365@section Using the GNUnet Messenger 2460@section Using the GNUnet Messenger
2366 2461
2367The GNUnet Messenger subsystem allows decentralized message-based 2462The GNUnet Messenger subsystem allows decentralized message-based
2368communication inside of so called rooms. Each room can be hosted by 2463communication inside of so called rooms. Each room can be relayed by
2369a 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
2370to 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
2371to 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.
2372 2467
2373Messages in a room will be distributed between all peers hosting the 2468Messages in a room will be distributed between all peers relaying the
2374room or being internally (in context of the messenger service) connected 2469room or being internally (in context of the messenger service) connected
2375to 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
2376peer locally which is hosting the respective room or is internally 2471peer locally which is relaying the respective room or is internally
2377connected to such a hosting peer. 2472connected to such a relaying peer.
2378 2473
2379The Messenger service is built on the CADET subsystem to make internal 2474The Messenger service is built on the CADET subsystem to make internal
2380connections between peers using a reliable and encrypted transmission. 2475connections between peers using a reliable and encrypted transmission.
@@ -2411,9 +2506,9 @@ library designed for messenger applications.
2411@node Entering a room 2506@node Entering a room
2412@subsection Entering a room 2507@subsection Entering a room
2413 2508
2414You 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
2415Optionally you can provide any IDENTITY which can represent a local ego by 2510peer. Optionally you can provide any IDENTITY which can represent a local
2416its name. 2511ego by its name.
2417 2512
2418@example 2513@example
2419$ gnunet-messenger [-e IDENTITY] -d PEERIDENTITY -r ROOMKEY 2514$ gnunet-messenger [-e IDENTITY] -d PEERIDENTITY -r ROOMKEY
@@ -2441,14 +2536,14 @@ be distributed as your name for the service in any case.
2441@subsection Opening a room 2536@subsection Opening a room
2442 2537
2443You 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
2444out the '-d' parameter and the PEERIDENTITY of the hosting peer. 2539out the '-d' parameter and the PEERIDENTITY of the relaying peer.
2445 2540
2446@example 2541@example
2447$ gnunet-messenger [-e IDENTITY] -r ROOMKEY 2542$ gnunet-messenger [-e IDENTITY] -r ROOMKEY
2448@end example 2543@end example
2449 2544
2450Providing 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
2451will 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
2452through 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.
2453 2548
2454If 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..7f6699dd2 100644
--- a/doc/tutorial/examples/001.c
+++ b/doc/old/tutorial/examples/001.c
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..26d918fb0 100644
--- a/doc/tutorial/examples/009.c
+++ b/doc/old/tutorial/examples/009.c
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..cb21d78ab 100644
--- a/doc/tutorial/examples/012.c
+++ b/doc/old/tutorial/examples/012.c
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..1696234b0 100644
--- a/doc/tutorial/examples/testbed_test.c
+++ b/doc/old/tutorial/examples/testbed_test.c
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 f849e116a..f849e116a 100644
--- a/doc/tutorial/tutorial.texi
+++ b/doc/old/tutorial/tutorial.texi