summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-03-02 17:26:24 +0100
committerChristian Grothoff <christian@grothoff.org>2021-03-02 17:26:24 +0100
commitf48a3bd14482f508ad47cfd9d62fbaa11938b275 (patch)
tree96142906bee7632520f34e1ad8a7a365f6e48348 /doc
parent45ceb4fdf94566a67dbeac28cebb0f3154b843cf (diff)
parentc666bf95d0ba0a6eddcf0e6953b05ef375f6a75e (diff)
Merge branch 'master' of git+ssh://gnunet.org/gnunet
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/handbook/Makefile.am40
-rw-r--r--doc/handbook/chapters/user.texi109
-rw-r--r--doc/tutorial/Makefile.am21
4 files changed, 31 insertions, 141 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index eb23b534b..a9ad69954 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,6 @@
# This Makefile.am is in the public domain
+
+
if DOCUMENTATION
SUBDIRS = doxygen handbook tutorial
endif
diff --git a/doc/handbook/Makefile.am b/doc/handbook/Makefile.am
index 0435796a9..d7bcab696 100644
--- a/doc/handbook/Makefile.am
+++ b/doc/handbook/Makefile.am
@@ -3,25 +3,8 @@ docdir = $(datadir)/doc/gnunet/
infoimagedir = $(infodir)/images
-if ACTIVATE_TEXINFO4
-# NOTE: While GNU makeinfo 6.5 supports --css-ref=URL,
-# makeinfo 4.8 (in NetBSD 8.0, macOS, and maybe other
-# base) does only support --css-include=FILE.
-# The only difference is a shorter html output and
-# in 6.5 the ability to use refs instead of include.
-# We prefer not to break builds in this case, so
-# we use the include version which is backwards compatible
-# and upwards compatible, while the ref variant is neither.
-AM_MAKEINFOHTMLFLAGS = --no-split --css-include=style.css --css-include=manual.css
-else
-# In the 5.x version they added `--split=chapters|sections` in
-# addition to `--split=nodes`.
-# Hold on to your hats: In version 6.5 this is already removed, ffs.
-# GNU Texinfo, please be more consistent than 1 version in switches.
-# This however is compatible to version 5.2. Thanks, I hate it.
-# AM_MAKEINFOHTMLFLAGS = --split=sections --css-ref="../style.css" --css-ref="../manual.css"
-AM_MAKEINFOHTMLFLAGS = --no-split --css-ref="../style.css" --css-ref="../manual.css"
-endif
+AM_MAKEINFOHTMLFLAGS = $(TEXINFO_HTMLFLAGS)
+
dist_infoimage_DATA = \
images/gnunet-gtk-0-10-gns-a-done.png \
@@ -78,6 +61,25 @@ gnunet_TEXINFOS = \
agpl-3.0.texi \
version.texi
+#if ACTIVATE_TEXINFO4
+# NOTE: While GNU makeinfo 6.5 supports --css-ref=URL,
+# makeinfo 4.8 (in NetBSD 8.0, macOS, and maybe other
+# base) does only support --css-include=FILE.
+# The only difference is a shorter html output and
+# in 6.5 the ability to use refs instead of include.
+# We prefer not to break builds in this case, so
+# we use the include version which is backwards compatible
+# and upwards compatible, while the ref variant is neither.
+#AM_MAKEINFOHTMLFLAGS = --no-split --css-include=style.css --css-include=manual.css
+#else
+# In the 5.x version they added `--split=chapters|sections` in
+# addition to `--split=nodes`.
+# Hold on to your hats: In version 6.5 this is already removed, ffs.
+# GNU Texinfo, please be more consistent than 1 version in switches.
+# This however is compatible to version 5.2. Thanks, I hate it.
+# AM_MAKEINFOHTMLFLAGS = --split=sections --css-ref="../style.css" --css-ref="../manual.css"
+#AM_MAKEINFOHTMLFLAGS = --split --css-ref="../style.css" --css-ref="../manual.css"
+#endif
EXTRA_DIST = \
$(gnunet_TEXINFOS) \
htmlxref.cnf \
diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi
index ebc1a7979..5d5d2fe14 100644
--- a/doc/handbook/chapters/user.texi
+++ b/doc/handbook/chapters/user.texi
@@ -1539,7 +1539,12 @@ authoritative zone (replacing ".+" with the name of the location
where the name was encountered) and hence generate a
valid GNS name.
-GNS currently supports the following record types:
+The GNS currently supports the record types as defined in
+@uref{https://git.gnunet.org/gana.git/tree/gnu-name-system-record-types/registry.rec, GANA}.
+In addition, GNS supports DNS record types, such as A, AAAA or TXT.
+
+In the following, we discuss GNS records with specific behaviour or special
+handling of DNS records.
@menu
* NICK::
@@ -1547,22 +1552,9 @@ GNS currently supports the following record types:
* BOX::
* LEHO::
* VPN::
-* A AAAA and TXT::
* CNAME::
* GNS2DNS::
* SOA SRV PTR and MX::
-* PLACE::
-* PHONE::
-* ID ATTR::
-* ID TOKEN::
-* ID TOKEN METADATA::
-* CREDENTIAL::
-* POLICY::
-* ATTRIBUTE::
-* ABE KEY::
-* ABE MASTER::
-* RECLAIM OIDC CLIENT::
-* RECLAIM OIDC REDIRECT::
@end menu
@node NICK
@@ -1658,11 +1650,6 @@ having the following lines in the @file{gnunet.conf} configuration file:
TCP_REDIRECTS = 80:localhost4:8080
@end example
-@node A AAAA and TXT
-@subsubsection A AAAA and TXT
-
-Those records work in exactly the same fashion as in traditional DNS.
-
@node CNAME
@subsubsection CNAME
@@ -1771,90 +1758,6 @@ $ gnunet-namestore -a -n mail -t MX -z bar -e 3600s -V \
> "10,mail.bar"
@end example
-@node PLACE
-@subsubsection PLACE
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for a social place.
-
-@node PHONE
-@subsubsection PHONE
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for a phone (of CONVERSATION).
-
-@node ID ATTR
-@subsubsection ID ATTR
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for identity attributes (of IDENTITY).
-
-@node ID TOKEN
-@subsubsection ID TOKEN
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for an identity token (of IDENTITY-TOKEN).
-
-@node ID TOKEN METADATA
-@subsubsection ID TOKEN METADATA
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for the private metadata of an identity token (of IDENTITY-TOKEN).
-
-@node CREDENTIAL
-@subsubsection CREDENTIAL
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for credential.
-
-@node POLICY
-@subsubsection POLICY
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for policies.
-
-@node ATTRIBUTE
-@subsubsection ATTRIBUTE
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for reverse lookups.
-
-@node ABE KEY
-@subsubsection ABE KEY
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for ABE records.
-
-@node ABE MASTER
-@subsubsection ABE MASTER
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for ABE master keys.
-
-@node RECLAIM OIDC CLIENT
-@subsubsection RECLAIM OIDC CLIENT
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for reclaim OIDC clients.
-
-@node RECLAIM OIDC REDIRECT
-@subsubsection RECLAIM OIDC REDIRECT
-
-@c TODO describe record type and give an example of how and
-@c when to use it
-Record type for reclaim OIDC redirect URIs.
-
@node Synchronizing with legacy DNS
@subsection Synchronizing with legacy DNS
diff --git a/doc/tutorial/Makefile.am b/doc/tutorial/Makefile.am
index d0307ecb5..afe4aa6c0 100644
--- a/doc/tutorial/Makefile.am
+++ b/doc/tutorial/Makefile.am
@@ -1,25 +1,8 @@
# This Makefile.am is in the public domain
docdir = $(datadir)/doc/gnunet/
-if ACTIVATE_TEXINFO4
-# NOTE: While GNU makeinfo 6.5 supports --css-ref=URL,
-# makeinfo 4.8 (in NetBSD 8.0, macOS, and maybe other
-# base) does only support --css-include=FILE.
-# The only difference is a shorter html output and
-# in 6.5 the ability to use refs instead of include.
-# We prefer not to break builds in this case, so
-# we use the include version which is backwards compatible
-# and upwards compatible, while the ref variant is neither.
-AM_MAKEINFOHTMLFLAGS = --no-split --css-include=style.css --css-include=manual.css
-else
-# In the 5.x version they added `--split=chapters|sections` in
-# addition to `--split=nodes`.
-# Hold on to your hats: In version 6.5 this is already removed, ffs.
-# GNU Texinfo, please be more consistent than 1 version in switches.
-# This however is compatible to version 5.2. Thanks, I hate it.
-# AM_MAKEINFOHTMLFLAGS = --split=sections --css-ref="../style.css" --css-ref="../manual.css"
-AM_MAKEINFOHTMLFLAGS = --split --css-ref="../style.css" --css-ref="../manual.css"
-endif
+AM_MAKEINFOHTMLFLAGS = $(TEXINFO_HTMLFLAGS)
+
gnunet_tutorial_examples = \
examples/001.c \