diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/handbook/Makefile.am | 40 | ||||
-rw-r--r-- | doc/handbook/chapters/user.texi | 109 | ||||
-rw-r--r-- | doc/tutorial/Makefile.am | 21 |
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 @@ | |||
1 | # This Makefile.am is in the public domain | 1 | # This Makefile.am is in the public domain |
2 | |||
3 | |||
2 | if DOCUMENTATION | 4 | if DOCUMENTATION |
3 | SUBDIRS = doxygen handbook tutorial | 5 | SUBDIRS = doxygen handbook tutorial |
4 | endif | 6 | 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/ | |||
3 | 3 | ||
4 | infoimagedir = $(infodir)/images | 4 | infoimagedir = $(infodir)/images |
5 | 5 | ||
6 | if ACTIVATE_TEXINFO4 | 6 | AM_MAKEINFOHTMLFLAGS = $(TEXINFO_HTMLFLAGS) |
7 | # NOTE: While GNU makeinfo 6.5 supports --css-ref=URL, | 7 | |
8 | # makeinfo 4.8 (in NetBSD 8.0, macOS, and maybe other | ||
9 | # base) does only support --css-include=FILE. | ||
10 | # The only difference is a shorter html output and | ||
11 | # in 6.5 the ability to use refs instead of include. | ||
12 | # We prefer not to break builds in this case, so | ||
13 | # we use the include version which is backwards compatible | ||
14 | # and upwards compatible, while the ref variant is neither. | ||
15 | AM_MAKEINFOHTMLFLAGS = --no-split --css-include=style.css --css-include=manual.css | ||
16 | else | ||
17 | # In the 5.x version they added `--split=chapters|sections` in | ||
18 | # addition to `--split=nodes`. | ||
19 | # Hold on to your hats: In version 6.5 this is already removed, ffs. | ||
20 | # GNU Texinfo, please be more consistent than 1 version in switches. | ||
21 | # This however is compatible to version 5.2. Thanks, I hate it. | ||
22 | # AM_MAKEINFOHTMLFLAGS = --split=sections --css-ref="../style.css" --css-ref="../manual.css" | ||
23 | AM_MAKEINFOHTMLFLAGS = --no-split --css-ref="../style.css" --css-ref="../manual.css" | ||
24 | endif | ||
25 | 8 | ||
26 | dist_infoimage_DATA = \ | 9 | dist_infoimage_DATA = \ |
27 | images/gnunet-gtk-0-10-gns-a-done.png \ | 10 | images/gnunet-gtk-0-10-gns-a-done.png \ |
@@ -78,6 +61,25 @@ gnunet_TEXINFOS = \ | |||
78 | agpl-3.0.texi \ | 61 | agpl-3.0.texi \ |
79 | version.texi | 62 | version.texi |
80 | 63 | ||
64 | #if ACTIVATE_TEXINFO4 | ||
65 | # NOTE: While GNU makeinfo 6.5 supports --css-ref=URL, | ||
66 | # makeinfo 4.8 (in NetBSD 8.0, macOS, and maybe other | ||
67 | # base) does only support --css-include=FILE. | ||
68 | # The only difference is a shorter html output and | ||
69 | # in 6.5 the ability to use refs instead of include. | ||
70 | # We prefer not to break builds in this case, so | ||
71 | # we use the include version which is backwards compatible | ||
72 | # and upwards compatible, while the ref variant is neither. | ||
73 | #AM_MAKEINFOHTMLFLAGS = --no-split --css-include=style.css --css-include=manual.css | ||
74 | #else | ||
75 | # In the 5.x version they added `--split=chapters|sections` in | ||
76 | # addition to `--split=nodes`. | ||
77 | # Hold on to your hats: In version 6.5 this is already removed, ffs. | ||
78 | # GNU Texinfo, please be more consistent than 1 version in switches. | ||
79 | # This however is compatible to version 5.2. Thanks, I hate it. | ||
80 | # AM_MAKEINFOHTMLFLAGS = --split=sections --css-ref="../style.css" --css-ref="../manual.css" | ||
81 | #AM_MAKEINFOHTMLFLAGS = --split --css-ref="../style.css" --css-ref="../manual.css" | ||
82 | #endif | ||
81 | EXTRA_DIST = \ | 83 | EXTRA_DIST = \ |
82 | $(gnunet_TEXINFOS) \ | 84 | $(gnunet_TEXINFOS) \ |
83 | htmlxref.cnf \ | 85 | 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 | |||
1539 | where the name was encountered) and hence generate a | 1539 | where the name was encountered) and hence generate a |
1540 | valid GNS name. | 1540 | valid GNS name. |
1541 | 1541 | ||
1542 | GNS currently supports the following record types: | 1542 | The GNS currently supports the record types as defined in |
1543 | @uref{https://git.gnunet.org/gana.git/tree/gnu-name-system-record-types/registry.rec, GANA}. | ||
1544 | In addition, GNS supports DNS record types, such as A, AAAA or TXT. | ||
1545 | |||
1546 | In the following, we discuss GNS records with specific behaviour or special | ||
1547 | handling of DNS records. | ||
1543 | 1548 | ||
1544 | @menu | 1549 | @menu |
1545 | * NICK:: | 1550 | * NICK:: |
@@ -1547,22 +1552,9 @@ GNS currently supports the following record types: | |||
1547 | * BOX:: | 1552 | * BOX:: |
1548 | * LEHO:: | 1553 | * LEHO:: |
1549 | * VPN:: | 1554 | * VPN:: |
1550 | * A AAAA and TXT:: | ||
1551 | * CNAME:: | 1555 | * CNAME:: |
1552 | * GNS2DNS:: | 1556 | * GNS2DNS:: |
1553 | * SOA SRV PTR and MX:: | 1557 | * SOA SRV PTR and MX:: |
1554 | * PLACE:: | ||
1555 | * PHONE:: | ||
1556 | * ID ATTR:: | ||
1557 | * ID TOKEN:: | ||
1558 | * ID TOKEN METADATA:: | ||
1559 | * CREDENTIAL:: | ||
1560 | * POLICY:: | ||
1561 | * ATTRIBUTE:: | ||
1562 | * ABE KEY:: | ||
1563 | * ABE MASTER:: | ||
1564 | * RECLAIM OIDC CLIENT:: | ||
1565 | * RECLAIM OIDC REDIRECT:: | ||
1566 | @end menu | 1558 | @end menu |
1567 | 1559 | ||
1568 | @node NICK | 1560 | @node NICK |
@@ -1658,11 +1650,6 @@ having the following lines in the @file{gnunet.conf} configuration file: | |||
1658 | TCP_REDIRECTS = 80:localhost4:8080 | 1650 | TCP_REDIRECTS = 80:localhost4:8080 |
1659 | @end example | 1651 | @end example |
1660 | 1652 | ||
1661 | @node A AAAA and TXT | ||
1662 | @subsubsection A AAAA and TXT | ||
1663 | |||
1664 | Those records work in exactly the same fashion as in traditional DNS. | ||
1665 | |||
1666 | @node CNAME | 1653 | @node CNAME |
1667 | @subsubsection CNAME | 1654 | @subsubsection CNAME |
1668 | 1655 | ||
@@ -1771,90 +1758,6 @@ $ gnunet-namestore -a -n mail -t MX -z bar -e 3600s -V \ | |||
1771 | > "10,mail.bar" | 1758 | > "10,mail.bar" |
1772 | @end example | 1759 | @end example |
1773 | 1760 | ||
1774 | @node PLACE | ||
1775 | @subsubsection PLACE | ||
1776 | |||
1777 | @c TODO describe record type and give an example of how and | ||
1778 | @c when to use it | ||
1779 | Record type for a social place. | ||
1780 | |||
1781 | @node PHONE | ||
1782 | @subsubsection PHONE | ||
1783 | |||
1784 | @c TODO describe record type and give an example of how and | ||
1785 | @c when to use it | ||
1786 | Record type for a phone (of CONVERSATION). | ||
1787 | |||
1788 | @node ID ATTR | ||
1789 | @subsubsection ID ATTR | ||
1790 | |||
1791 | @c TODO describe record type and give an example of how and | ||
1792 | @c when to use it | ||
1793 | Record type for identity attributes (of IDENTITY). | ||
1794 | |||
1795 | @node ID TOKEN | ||
1796 | @subsubsection ID TOKEN | ||
1797 | |||
1798 | @c TODO describe record type and give an example of how and | ||
1799 | @c when to use it | ||
1800 | Record type for an identity token (of IDENTITY-TOKEN). | ||
1801 | |||
1802 | @node ID TOKEN METADATA | ||
1803 | @subsubsection ID TOKEN METADATA | ||
1804 | |||
1805 | @c TODO describe record type and give an example of how and | ||
1806 | @c when to use it | ||
1807 | Record type for the private metadata of an identity token (of IDENTITY-TOKEN). | ||
1808 | |||
1809 | @node CREDENTIAL | ||
1810 | @subsubsection CREDENTIAL | ||
1811 | |||
1812 | @c TODO describe record type and give an example of how and | ||
1813 | @c when to use it | ||
1814 | Record type for credential. | ||
1815 | |||
1816 | @node POLICY | ||
1817 | @subsubsection POLICY | ||
1818 | |||
1819 | @c TODO describe record type and give an example of how and | ||
1820 | @c when to use it | ||
1821 | Record type for policies. | ||
1822 | |||
1823 | @node ATTRIBUTE | ||
1824 | @subsubsection ATTRIBUTE | ||
1825 | |||
1826 | @c TODO describe record type and give an example of how and | ||
1827 | @c when to use it | ||
1828 | Record type for reverse lookups. | ||
1829 | |||
1830 | @node ABE KEY | ||
1831 | @subsubsection ABE KEY | ||
1832 | |||
1833 | @c TODO describe record type and give an example of how and | ||
1834 | @c when to use it | ||
1835 | Record type for ABE records. | ||
1836 | |||
1837 | @node ABE MASTER | ||
1838 | @subsubsection ABE MASTER | ||
1839 | |||
1840 | @c TODO describe record type and give an example of how and | ||
1841 | @c when to use it | ||
1842 | Record type for ABE master keys. | ||
1843 | |||
1844 | @node RECLAIM OIDC CLIENT | ||
1845 | @subsubsection RECLAIM OIDC CLIENT | ||
1846 | |||
1847 | @c TODO describe record type and give an example of how and | ||
1848 | @c when to use it | ||
1849 | Record type for reclaim OIDC clients. | ||
1850 | |||
1851 | @node RECLAIM OIDC REDIRECT | ||
1852 | @subsubsection RECLAIM OIDC REDIRECT | ||
1853 | |||
1854 | @c TODO describe record type and give an example of how and | ||
1855 | @c when to use it | ||
1856 | Record type for reclaim OIDC redirect URIs. | ||
1857 | |||
1858 | @node Synchronizing with legacy DNS | 1761 | @node Synchronizing with legacy DNS |
1859 | @subsection Synchronizing with legacy DNS | 1762 | @subsection Synchronizing with legacy DNS |
1860 | 1763 | ||
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 @@ | |||
1 | # This Makefile.am is in the public domain | 1 | # This Makefile.am is in the public domain |
2 | docdir = $(datadir)/doc/gnunet/ | 2 | docdir = $(datadir)/doc/gnunet/ |
3 | 3 | ||
4 | if ACTIVATE_TEXINFO4 | 4 | AM_MAKEINFOHTMLFLAGS = $(TEXINFO_HTMLFLAGS) |
5 | # NOTE: While GNU makeinfo 6.5 supports --css-ref=URL, | 5 | |
6 | # makeinfo 4.8 (in NetBSD 8.0, macOS, and maybe other | ||
7 | # base) does only support --css-include=FILE. | ||
8 | # The only difference is a shorter html output and | ||
9 | # in 6.5 the ability to use refs instead of include. | ||
10 | # We prefer not to break builds in this case, so | ||
11 | # we use the include version which is backwards compatible | ||
12 | # and upwards compatible, while the ref variant is neither. | ||
13 | AM_MAKEINFOHTMLFLAGS = --no-split --css-include=style.css --css-include=manual.css | ||
14 | else | ||
15 | # In the 5.x version they added `--split=chapters|sections` in | ||
16 | # addition to `--split=nodes`. | ||
17 | # Hold on to your hats: In version 6.5 this is already removed, ffs. | ||
18 | # GNU Texinfo, please be more consistent than 1 version in switches. | ||
19 | # This however is compatible to version 5.2. Thanks, I hate it. | ||
20 | # AM_MAKEINFOHTMLFLAGS = --split=sections --css-ref="../style.css" --css-ref="../manual.css" | ||
21 | AM_MAKEINFOHTMLFLAGS = --split --css-ref="../style.css" --css-ref="../manual.css" | ||
22 | endif | ||
23 | 6 | ||
24 | gnunet_tutorial_examples = \ | 7 | gnunet_tutorial_examples = \ |
25 | examples/001.c \ | 8 | examples/001.c \ |