Browse Source

doc/documentation split into doc/tutorial and doc/handbook for clarity and to avoid automake freakout

Christian Grothoff 5 years ago
parent
commit
7101471b5f
92 changed files with 701 additions and 84 deletions
  1. 7 6
      configure.ac
  2. 1 0
      contrib/.gitignore
  3. 1 1
      doc/Makefile.am
  4. 0 0
      doc/handbook/.gitignore
  5. 3 47
      doc/handbook/Makefile.am
  6. 0 0
      doc/handbook/TODO
  7. 0 0
      doc/handbook/agpl-3.0.texi
  8. 0 0
      doc/handbook/chapters/configuration.texi
  9. 0 0
      doc/handbook/chapters/contributing.texi
  10. 0 0
      doc/handbook/chapters/developer.texi
  11. 0 0
      doc/handbook/chapters/installation.texi
  12. 0 0
      doc/handbook/chapters/keyconcepts.texi
  13. 0 0
      doc/handbook/chapters/philosophy.texi
  14. 0 0
      doc/handbook/chapters/preface.texi
  15. 0 0
      doc/handbook/chapters/user.texi
  16. 0 0
      doc/handbook/chapters/vocabulary.texi
  17. 0 0
      doc/handbook/docstyle.css
  18. 0 0
      doc/handbook/fdl-1.3.texi
  19. 0 0
      doc/handbook/gendocs.sh
  20. 0 0
      doc/handbook/gendocs_template
  21. 0 0
      doc/handbook/gendocs_template_min
  22. 0 0
      doc/handbook/gnunet.texi
  23. 0 0
      doc/handbook/gpl-3.0.texi
  24. 0 0
      doc/handbook/htmlxref.cnf
  25. 0 0
      doc/handbook/images/daemon_lego_block.png
  26. 0 0
      doc/handbook/images/daemon_lego_block.svg
  27. 0 0
      doc/handbook/images/gns.dot
  28. 0 0
      doc/handbook/images/gns.eps
  29. 0 0
      doc/handbook/images/gns.jpg
  30. 0 0
      doc/handbook/images/gnunet-0-10-peerinfo.png
  31. 0 0
      doc/handbook/images/gnunet-fs-gtk-0-10-star-tab.png
  32. 0 0
      doc/handbook/images/gnunet-gtk-0-10-download-area.png
  33. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-menu.png
  34. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png
  35. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-publish-select.png
  36. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png
  37. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png
  38. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-publish.png
  39. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-published.png
  40. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs-search.png
  41. 0 0
      doc/handbook/images/gnunet-gtk-0-10-fs.png
  42. 0 0
      doc/handbook/images/gnunet-gtk-0-10-gns-a-done.png
  43. 0 0
      doc/handbook/images/gnunet-gtk-0-10-gns-a.png
  44. 0 0
      doc/handbook/images/gnunet-gtk-0-10-gns.png
  45. 0 0
      doc/handbook/images/gnunet-gtk-0-10-identity.png
  46. 0 0
      doc/handbook/images/gnunet-gtk-0-10-search-selected.png
  47. 0 0
      doc/handbook/images/gnunet-gtk-0-10-traffic.png
  48. 0 0
      doc/handbook/images/gnunet-namestore-gtk-phone.png
  49. 0 0
      doc/handbook/images/gnunet-namestore-gtk-vpn.png
  50. 0 0
      doc/handbook/images/gnunet-setup-exit.png
  51. 0 0
      doc/handbook/images/gnunet-tutorial-service.png
  52. 0 0
      doc/handbook/images/gnunet-tutorial-system.png
  53. 0 0
      doc/handbook/images/iceweasel-preferences.png
  54. 0 0
      doc/handbook/images/iceweasel-proxy.png
  55. 0 0
      doc/handbook/images/lego_stack.svg
  56. 0 0
      doc/handbook/images/service_lego_block.png
  57. 0 0
      doc/handbook/images/service_lego_block.svg
  58. 0 0
      doc/handbook/images/service_stack.png
  59. 0 0
      doc/handbook/images/structure.dot
  60. 0 0
      doc/handbook/index.html
  61. 0 0
      doc/handbook/run-gendocs.sh
  62. 145 0
      doc/tutorial/Makefile.am
  63. 0 0
      doc/tutorial/examples/001.c
  64. 0 0
      doc/tutorial/examples/002.c
  65. 0 0
      doc/tutorial/examples/003.c
  66. 0 0
      doc/tutorial/examples/004.c
  67. 0 0
      doc/tutorial/examples/005.c
  68. 0 0
      doc/tutorial/examples/006.c
  69. 0 0
      doc/tutorial/examples/007.c
  70. 0 0
      doc/tutorial/examples/008.c
  71. 0 0
      doc/tutorial/examples/009.c
  72. 0 0
      doc/tutorial/examples/010.c
  73. 0 0
      doc/tutorial/examples/011.c
  74. 0 0
      doc/tutorial/examples/012.c
  75. 0 0
      doc/tutorial/examples/013.1.c
  76. 0 0
      doc/tutorial/examples/013.c
  77. 0 0
      doc/tutorial/examples/014.c
  78. 0 0
      doc/tutorial/examples/015.c
  79. 0 0
      doc/tutorial/examples/016.c
  80. 0 0
      doc/tutorial/examples/017.c
  81. 0 0
      doc/tutorial/examples/018.c
  82. 0 0
      doc/tutorial/examples/019.c
  83. 0 0
      doc/tutorial/examples/020.c
  84. 0 0
      doc/tutorial/examples/021.c
  85. 0 0
      doc/tutorial/examples/022.c
  86. 0 0
      doc/tutorial/examples/023.c
  87. 0 0
      doc/tutorial/examples/024.c
  88. 0 0
      doc/tutorial/examples/025.Makefile.am
  89. 0 0
      doc/tutorial/examples/026.c
  90. 0 0
      doc/tutorial/examples/testbed_test.c
  91. 505 0
      doc/tutorial/fdl-1.3.texi
  92. 39 30
      doc/tutorial/gnunet-tutorial.texi

+ 7 - 6
configure.ac

@@ -878,7 +878,7 @@ there_can_only_be_one=1
 
 working_libidn1=0
 working_libidn2=0
-AS_IF([test $my_with_libidn2 = 1],
+AS_IF([test x$my_with_libidn2 = x1],
       [AC_MSG_NOTICE([Checking for libidn2])
        AC_CHECK_LIB([idn2],
                     [idn2_to_unicode_8z8z],
@@ -890,8 +890,8 @@ AS_IF([test $my_with_libidn2 = 1],
                      [MISSING_DEPS="${MISSING_DEPS}${MISSING_SEP}libidn2"
                      MISSING_SEP=", "])])
 AM_CONDITIONAL(HAVE_LIBIDN2, test x$working_libidn2 = x1)
-AS_IF([test $working_libidn2 = 0],
-      [AS_IF([test $my_with_libidn = 1],
+AS_IF([test x$working_libidn2 = x0],
+      [AS_IF([test x$my_with_libidn = x1],
              [AC_MSG_NOTICE([Checking for libidn])
               AC_CHECK_LIB([idn],
                            [idna_to_ascii_8z],
@@ -901,7 +901,7 @@ AS_IF([test $working_libidn2 = 0],
                                                 [1],
                                                 [Define to 1 if you have 'libidn' (-lidn).])],
                              [there_can_only_be_one=0])],
-             [AS_IF([test $my_with_libidn2 = 1],
+             [AS_IF([test x$my_with_libidn2 = x1],
                     [there_can_only_be_one=0
                      AC_MSG_FAILURE([* There can only be one libidn.
                                      * Provide either libidn >= 1.13
@@ -912,7 +912,7 @@ AS_IF([test $working_libidn2 = 0],
                                      * --with-libidn])])])])
 AM_CONDITIONAL(HAVE_LIBIDN, test x$working_libidn1 = x1)
 
-AS_IF([test $there_can_only_be_one = 0],
+AS_IF([test x$there_can_only_be_one = x0],
       [AC_MSG_FAILURE([Missing dependencies: $MISSING_DEPS])])
 
 # test for zlib
@@ -1752,7 +1752,8 @@ contrib/Makefile
 doc/Makefile
 doc/man/Makefile
 doc/doxygen/Makefile
-doc/documentation/Makefile
+doc/handbook/Makefile
+doc/tutorial/Makefile
 m4/Makefile
 po/Makefile.in
 src/Makefile

+ 1 - 0
contrib/.gitignore

@@ -6,3 +6,4 @@ gnunet_pyexpect.py
 gnunet_pyexpect.pyc
 pydiffer.pyc
 test_gnunet_prefix
+timeout_watchdog

+ 1 - 1
doc/Makefile.am

@@ -1,6 +1,6 @@
 # This Makefile.am is in the public domain
 if DOCUMENTATION
-  SUBDIRS = man doxygen documentation
+  SUBDIRS = man doxygen handbook tutorial
 endif
 if !DOCUMENTATION
   SUBDIRS = man doxygen

+ 0 - 0
doc/documentation/.gitignore → doc/handbook/.gitignore


+ 3 - 47
doc/documentation/Makefile.am → doc/handbook/Makefile.am

@@ -77,38 +77,8 @@ dist_infoimage_DATA =                           		\
 # dvi-local: ps-local
 
 
-gnunet_tutorial_examples =					\
-	tutorial-examples/001.c							\
-	tutorial-examples/002.c							\
-	tutorial-examples/003.c							\
-	tutorial-examples/004.c							\
-	tutorial-examples/005.c							\
-	tutorial-examples/006.c							\
-	tutorial-examples/007.c							\
-	tutorial-examples/008.c							\
-	tutorial-examples/009.c							\
-	tutorial-examples/010.c							\
-	tutorial-examples/011.c							\
-	tutorial-examples/012.c							\
-	tutorial-examples/013.c							\
-	tutorial-examples/013.1.c							\
-	tutorial-examples/014.c							\
-	tutorial-examples/015.c							\
-	tutorial-examples/016.c							\
-	tutorial-examples/017.c							\
-	tutorial-examples/018.c							\
-	tutorial-examples/019.c							\
-	tutorial-examples/020.c							\
-	tutorial-examples/021.c							\
-	tutorial-examples/022.c							\
-	tutorial-examples/023.c							\
-	tutorial-examples/024.c							\
-	tutorial-examples/025.Makefile.am					\
-	tutorial-examples/026.c
-
 info_TEXINFOS = 						\
-	gnunet.texi						\
-	gnunet-c-tutorial.texi
+	gnunet.texi	
 
 gnunet_TEXINFOS = 						\
 	chapters/developer.texi 				\
@@ -120,11 +90,11 @@ gnunet_TEXINFOS = 						\
 	chapters/configuration.texi				\
 	chapters/contributing.texi				\
 	fdl-1.3.texi 						\
-	gpl-3.0.texi
+	gpl-3.0.texi						\
+	version.texi
 
 EXTRA_DIST =							\
 	$(gnunet_TEXINFOS)					\
-	$(gnunet_tutorial_examples)				\
 	htmlxref.cnf						\
 	gversion.texi
 	run-gendocs.sh						\
@@ -136,7 +106,6 @@ EXTRA_DIST =							\
 
 DISTCLEANFILES = 						\
 	gnunet.cps						\
-	gnunet-c-tutorial.cps					\
 	chapters/developer.cps					\
 	chapters/installation.cps				\
 	chapter/philosophy.cps					\
@@ -170,10 +139,6 @@ version.texi/replacement/revert:
 	@echo "@set EDITION GPACKAGE_VERSION" >> gversion.texi
 
 if SECTION7
-gnunet-c-tutorial.7: version.texi/replacement
-	@echo Attempting to output an mdoc formatted section 7 document
-	@texi2mdoc -I$(pwd):$(pwd)/chapters gnunet-c-tutorial.texi > ../man/gnunet-c-tutorial.7
-
 gnunet-documentation.7: version.texi/replacement
 	@echo Attempting to output an mdoc formatted section 7 document
 	@texi2mdoc -I$(pwd):$(pwd)/chapters gnunet.texi > ../man/gnunet-documentation.7
@@ -192,11 +157,8 @@ doc-all-install:
 	@mkdir -p $(DESTDIR)/$(infoimagedir)
 	@mkdir -p $(DESTDIR)/$(infodir)
 	@install -m 0755 gnunet.pdf $(DESTDIR)/$(docdir)
-	@install -m 0755 gnunet-c-tutorial.pdf $(DESTDIR)/$(docdir)
-	@install -m 0755 gnunet-c-tutorial.info $(DESTDIR)/$(infodir)
 	@install -m 0755 gnunet.info $(DESTDIR)/$(infodir)
 	@install gnunet.html $(DESTDIR)/$(docdir)
-	@install gnunet-c-tutorial.html $(DESTDIR)/$(docdir)
 
 doc-gendoc-install:
 	@mkdir -p $(DESTDIR)/$(docdir)
@@ -206,11 +168,8 @@ doc-gendoc-install:
 
 dev-build: version.texi/replacement
 	@makeinfo --pdf gnunet.texi
-	@makeinfo --pdf gnunet-c-tutorial.texi
 	@makeinfo --html gnunet.texi
-	@makeinfo --html gnunet-c-tutorial.texi
 	@makeinfo --no-split gnunet.texi
-	@makeinfo --no-split gnunet-c-tutorial.texi
 
 # TODO: Add more to clean.
 clean: version.texi/replacement/revert
@@ -220,9 +179,6 @@ clean: version.texi/replacement/revert
 	@rm -f gnunet.info-1
 	@rm -f gnunet.info-2
 	@rm -f gnunet.info-3
-	@rm -f gnunet-c-tutorial.pdf
-	@rm -f gnunet-c-tutorial.info
-	@rm -f gnunet-c-tutorial.html
 	@rm -fr gnunet.t2p
 	@rm -fr gnunet-c-tutorial.t2p
 	@rm -fr manual

+ 0 - 0
doc/documentation/TODO → doc/handbook/TODO


+ 0 - 0
doc/documentation/agpl-3.0.texi → doc/handbook/agpl-3.0.texi


+ 0 - 0
doc/documentation/chapters/configuration.texi → doc/handbook/chapters/configuration.texi


+ 0 - 0
doc/documentation/chapters/contributing.texi → doc/handbook/chapters/contributing.texi


+ 0 - 0
doc/documentation/chapters/developer.texi → doc/handbook/chapters/developer.texi


+ 0 - 0
doc/documentation/chapters/installation.texi → doc/handbook/chapters/installation.texi


+ 0 - 0
doc/documentation/chapters/keyconcepts.texi → doc/handbook/chapters/keyconcepts.texi


+ 0 - 0
doc/documentation/chapters/philosophy.texi → doc/handbook/chapters/philosophy.texi


+ 0 - 0
doc/documentation/chapters/preface.texi → doc/handbook/chapters/preface.texi


+ 0 - 0
doc/documentation/chapters/user.texi → doc/handbook/chapters/user.texi


+ 0 - 0
doc/documentation/chapters/vocabulary.texi → doc/handbook/chapters/vocabulary.texi


+ 0 - 0
doc/documentation/docstyle.css → doc/handbook/docstyle.css


+ 0 - 0
doc/documentation/fdl-1.3.texi → doc/handbook/fdl-1.3.texi


+ 0 - 0
doc/documentation/gendocs.sh → doc/handbook/gendocs.sh


+ 0 - 0
doc/documentation/gendocs_template → doc/handbook/gendocs_template


+ 0 - 0
doc/documentation/gendocs_template_min → doc/handbook/gendocs_template_min


+ 0 - 0
doc/documentation/gnunet.texi → doc/handbook/gnunet.texi


+ 0 - 0
doc/documentation/gpl-3.0.texi → doc/handbook/gpl-3.0.texi


+ 0 - 0
doc/documentation/htmlxref.cnf → doc/handbook/htmlxref.cnf


+ 0 - 0
doc/documentation/images/daemon_lego_block.png → doc/handbook/images/daemon_lego_block.png


+ 0 - 0
doc/documentation/images/daemon_lego_block.svg → doc/handbook/images/daemon_lego_block.svg


+ 0 - 0
doc/documentation/images/gns.dot → doc/handbook/images/gns.dot


+ 0 - 0
doc/documentation/images/gns.eps → doc/handbook/images/gns.eps


+ 0 - 0
doc/documentation/images/gns.jpg → doc/handbook/images/gns.jpg


+ 0 - 0
doc/documentation/images/gnunet-0-10-peerinfo.png → doc/handbook/images/gnunet-0-10-peerinfo.png


+ 0 - 0
doc/documentation/images/gnunet-fs-gtk-0-10-star-tab.png → doc/handbook/images/gnunet-fs-gtk-0-10-star-tab.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-download-area.png → doc/handbook/images/gnunet-gtk-0-10-download-area.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-menu.png → doc/handbook/images/gnunet-gtk-0-10-fs-menu.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-publish-editing.png → doc/handbook/images/gnunet-gtk-0-10-fs-publish-editing.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-publish-select.png → doc/handbook/images/gnunet-gtk-0-10-fs-publish-select.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-publish-with-file.png → doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-publish-with-file_0.png → doc/handbook/images/gnunet-gtk-0-10-fs-publish-with-file_0.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-publish.png → doc/handbook/images/gnunet-gtk-0-10-fs-publish.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-published.png → doc/handbook/images/gnunet-gtk-0-10-fs-published.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs-search.png → doc/handbook/images/gnunet-gtk-0-10-fs-search.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-fs.png → doc/handbook/images/gnunet-gtk-0-10-fs.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-gns-a-done.png → doc/handbook/images/gnunet-gtk-0-10-gns-a-done.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-gns-a.png → doc/handbook/images/gnunet-gtk-0-10-gns-a.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-gns.png → doc/handbook/images/gnunet-gtk-0-10-gns.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-identity.png → doc/handbook/images/gnunet-gtk-0-10-identity.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-search-selected.png → doc/handbook/images/gnunet-gtk-0-10-search-selected.png


+ 0 - 0
doc/documentation/images/gnunet-gtk-0-10-traffic.png → doc/handbook/images/gnunet-gtk-0-10-traffic.png


+ 0 - 0
doc/documentation/images/gnunet-namestore-gtk-phone.png → doc/handbook/images/gnunet-namestore-gtk-phone.png


+ 0 - 0
doc/documentation/images/gnunet-namestore-gtk-vpn.png → doc/handbook/images/gnunet-namestore-gtk-vpn.png


+ 0 - 0
doc/documentation/images/gnunet-setup-exit.png → doc/handbook/images/gnunet-setup-exit.png


+ 0 - 0
doc/documentation/images/gnunet-tutorial-service.png → doc/handbook/images/gnunet-tutorial-service.png


+ 0 - 0
doc/documentation/images/gnunet-tutorial-system.png → doc/handbook/images/gnunet-tutorial-system.png


+ 0 - 0
doc/documentation/images/iceweasel-preferences.png → doc/handbook/images/iceweasel-preferences.png


+ 0 - 0
doc/documentation/images/iceweasel-proxy.png → doc/handbook/images/iceweasel-proxy.png


+ 0 - 0
doc/documentation/images/lego_stack.svg → doc/handbook/images/lego_stack.svg


+ 0 - 0
doc/documentation/images/service_lego_block.png → doc/handbook/images/service_lego_block.png


+ 0 - 0
doc/documentation/images/service_lego_block.svg → doc/handbook/images/service_lego_block.svg


+ 0 - 0
doc/documentation/images/service_stack.png → doc/handbook/images/service_stack.png


+ 0 - 0
doc/documentation/images/structure.dot → doc/handbook/images/structure.dot


+ 0 - 0
doc/documentation/index.html → doc/handbook/index.html


+ 0 - 0
doc/documentation/run-gendocs.sh → doc/handbook/run-gendocs.sh


+ 145 - 0
doc/tutorial/Makefile.am

@@ -0,0 +1,145 @@
+# This Makefile.am is in the public domain
+docdir = $(datadir)/doc/gnunet/
+
+#DOT_FILES = images/$(wildcard *.dot)
+
+#DOT_VECTOR_GRAPHICS =								\
+#	$(DOT_FILES:%.dot=%.eps)						\
+#	$(DOT_FILES:%.dot=%.pdf)
+
+AM_MAKEINFOHTMLFLAGS = --no-split --css-ref=docstyle.css
+
+#DOT_OPTIONS =									\
+#	-Gratio=.9 -Gnodesep=.005 -Granksep=.00005				\
+#	-Nfontsite=9 -Nheight=.1 -Nwidth=.1
+
+# .dot.png:
+# 	$(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
+# 	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
+
+# .dot.pdf:
+# 	$(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
+# 	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
+
+# .dot.eps:
+# 	$(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
+# 	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
+
+# .png.eps:
+# 	$(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
+# 	mv "$@-tmp.eps" "$@"
+
+# pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
+# info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
+# ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps)                \
+# 	$(top_srcdir)/%D%/images/coreutils-size-map.eps
+# dvi-local: ps-local
+
+
+gnunet_tutorial_examples =					\
+	examples/001.c							\
+	examples/002.c							\
+	examples/003.c							\
+	examples/004.c							\
+	examples/005.c							\
+	examples/006.c							\
+	examples/007.c							\
+	examples/008.c							\
+	examples/009.c							\
+	examples/010.c							\
+	examples/011.c							\
+	examples/012.c							\
+	examples/013.c							\
+	examples/013.1.c							\
+	examples/014.c							\
+	examples/015.c							\
+	examples/016.c							\
+	examples/017.c							\
+	examples/018.c							\
+	examples/019.c							\
+	examples/020.c							\
+	examples/021.c							\
+	examples/022.c							\
+	examples/023.c							\
+	examples/024.c							\
+	examples/025.Makefile.am					\
+	examples/026.c                                                  \
+	examples/testbed_test.c
+
+info_TEXINFOS = 						\
+	gnunet-tutorial.texi
+
+EXTRA_DIST =							\
+	$(gnunet_tutorial_examples)				\
+	htmlxref.cnf						\
+	run-gendocs.sh						\
+	docstyle.css
+
+
+DISTCLEANFILES = 						\
+	gnunet-tutorial.cps					\
+	fdl-1.3.cps						
+
+# XXX: is this sed invocation portable enough? otherwise try tr(1).
+version.texi/replacement: version.texi/replacement/revert
+	@sed -i "s/GPACKAGE_VERSION/$(PACKAGE_VERSION)/g" gversion.texi
+
+version.texi/replacement/revert:
+	@echo "@set VERSION GPACKAGE_VERSION" > gversion.texi
+	@echo "@set EDITION GPACKAGE_VERSION" >> gversion.texi
+
+if SECTION7
+gnunet-tutorial.7: version.texi/replacement
+	@echo Attempting to output an mdoc formatted section 7 document
+	@texi2mdoc -I$(pwd):$(pwd)/chapters gnunet-c-tutorial.texi > ../man/gnunet-c-tutorial.7
+# TODO: (Maybe) other outputs resulting from this.
+endif
+
+# FIXME: rm *.html and *.pdf
+#doc-clean:
+#	@rm *.aux *.log *.toc *.cp *.cps
+
+all: version.texi/replacement
+
+doc-all-install:
+	@mkdir -p $(DESTDIR)/$(docdir)
+	@mkdir -p $(DESTDIR)/$(infoimagedir)
+	@mkdir -p $(DESTDIR)/$(infodir)
+	@install -m 0755 gnunet-tutorial.pdf $(DESTDIR)/$(docdir)
+	@install -m 0755 gnunet-tutorial.info $(DESTDIR)/$(infodir)
+	@install gnunet-tutorial.html $(DESTDIR)/$(docdir)
+
+doc-gendoc-install:
+	@mkdir -p $(DESTDIR)/$(docdir)
+	@cp -r manual $(DESTDIR)/$(docdir)
+
+#	@cp -r images $(DESTDIR)/$(infoimagedir)
+
+dev-build: version.texi/replacement
+	@makeinfo --pdf gnunet-c-tutorial.texi
+	@makeinfo --html gnunet-c-tutorial.texi
+	@makeinfo --no-split gnunet-c-tutorial.texi
+
+# TODO: Add more to clean.
+clean: version.texi/replacement/revert
+	@rm -f gnunet-tutorial.pdf
+	@rm -f gnunet-tutorial.info
+	@rm -f gnunet-tutorial.html
+	@rm -fr gnunet-tutorial.t2p
+
+# CLEANFILES =						\
+# 	gnunet.log					\
+# 	gnunet-c-tutorial.log				\
+# 	$(wildcard *.aux)				\
+# 	$(wildcard *.toc)				\
+# 	$(wildcard *.cp)				\
+# 	$(wildcard *.cps)
+
+#.PHONY: version.texi
+# if HAVE_EXTENDED_DOCUMENTATION_BUILDING_PDF
+
+# if HAVE_EXTENDED_DOCUMENTATION_BUILDING_HTML
+
+# endif
+# endif
+# endif

+ 0 - 0
doc/documentation/tutorial-examples/001.c → doc/tutorial/examples/001.c


+ 0 - 0
doc/documentation/tutorial-examples/002.c → doc/tutorial/examples/002.c


+ 0 - 0
doc/documentation/tutorial-examples/003.c → doc/tutorial/examples/003.c


+ 0 - 0
doc/documentation/tutorial-examples/004.c → doc/tutorial/examples/004.c


+ 0 - 0
doc/documentation/tutorial-examples/005.c → doc/tutorial/examples/005.c


+ 0 - 0
doc/documentation/tutorial-examples/006.c → doc/tutorial/examples/006.c


+ 0 - 0
doc/documentation/tutorial-examples/007.c → doc/tutorial/examples/007.c


+ 0 - 0
doc/documentation/tutorial-examples/008.c → doc/tutorial/examples/008.c


+ 0 - 0
doc/documentation/tutorial-examples/009.c → doc/tutorial/examples/009.c


+ 0 - 0
doc/documentation/tutorial-examples/010.c → doc/tutorial/examples/010.c


+ 0 - 0
doc/documentation/tutorial-examples/011.c → doc/tutorial/examples/011.c


+ 0 - 0
doc/documentation/tutorial-examples/012.c → doc/tutorial/examples/012.c


+ 0 - 0
doc/documentation/tutorial-examples/013.1.c → doc/tutorial/examples/013.1.c


+ 0 - 0
doc/documentation/tutorial-examples/013.c → doc/tutorial/examples/013.c


+ 0 - 0
doc/documentation/tutorial-examples/014.c → doc/tutorial/examples/014.c


+ 0 - 0
doc/documentation/tutorial-examples/015.c → doc/tutorial/examples/015.c


+ 0 - 0
doc/documentation/tutorial-examples/016.c → doc/tutorial/examples/016.c


+ 0 - 0
doc/documentation/tutorial-examples/017.c → doc/tutorial/examples/017.c


+ 0 - 0
doc/documentation/tutorial-examples/018.c → doc/tutorial/examples/018.c


+ 0 - 0
doc/documentation/tutorial-examples/019.c → doc/tutorial/examples/019.c


+ 0 - 0
doc/documentation/tutorial-examples/020.c → doc/tutorial/examples/020.c


+ 0 - 0
doc/documentation/tutorial-examples/021.c → doc/tutorial/examples/021.c


+ 0 - 0
doc/documentation/tutorial-examples/022.c → doc/tutorial/examples/022.c


+ 0 - 0
doc/documentation/tutorial-examples/023.c → doc/tutorial/examples/023.c


+ 0 - 0
doc/documentation/tutorial-examples/024.c → doc/tutorial/examples/024.c


+ 0 - 0
doc/documentation/tutorial-examples/025.Makefile.am → doc/tutorial/examples/025.Makefile.am


+ 0 - 0
doc/documentation/tutorial-examples/026.c → doc/tutorial/examples/026.c


+ 0 - 0
doc/documentation/testbed_test.c → doc/tutorial/examples/testbed_test.c


+ 505 - 0
doc/tutorial/fdl-1.3.texi

@@ -0,0 +1,505 @@
+@c The GNU Free Documentation License.
+@center Version 1.3, 3 November 2008
+
+@c This file is intended to be included within another document,
+@c hence no sectioning command or @node.
+
+@display
+Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+@uref{http://fsf.org/}
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+@end display
+
+@enumerate 0
+@item
+PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document @dfn{free} in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+This License is a kind of ``copyleft'', which means that derivative
+works of the document must themselves be free in the same sense.  It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does.  But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book.  We recommend this License
+principally for works whose purpose is instruction or reference.
+
+@item
+APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License.  Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein.  The ``Document'', below,
+refers to any such manual or work.  Any member of the public is a
+licensee, and is addressed as ``you''.  You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+A ``Modified Version'' of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A ``Secondary Section'' is a named appendix or a front-matter section
+of the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could fall
+directly within that overall subject.  (Thus, if the Document is in
+part a textbook of mathematics, a Secondary Section may not explain
+any mathematics.)  The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The ``Invariant Sections'' are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License.  If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant.  The Document may contain zero
+Invariant Sections.  If the Document does not identify any Invariant
+Sections then there are none.
+
+The ``Cover Texts'' are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License.  A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A ``Transparent'' copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters.  A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text.  A copy that is not ``Transparent'' is called ``Opaque''.
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, La@TeX{} input
+format, SGML or XML using a publicly available
+DTD, and standard-conforming simple HTML,
+PostScript or PDF designed for human modification.  Examples
+of transparent image formats include PNG, XCF and
+JPG.  Opaque formats include proprietary formats that can be
+read and edited only by proprietary word processors, SGML or
+XML for which the DTD and/or processing tools are
+not generally available, and the machine-generated HTML,
+PostScript or PDF produced by some word processors for
+output purposes only.
+
+The ``Title Page'' means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page.  For works in
+formats which do not have any title page as such, ``Title Page'' means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+The ``publisher'' means any person or entity that distributes copies
+of the Document to the public.
+
+A section ``Entitled XYZ'' means a named subunit of the Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language.  (Here XYZ stands for a
+specific section name mentioned below, such as ``Acknowledgements'',
+``Dedications'', ``Endorsements'', or ``History''.)  To ``Preserve the Title''
+of such a section when you modify the Document means that it remains a
+section ``Entitled XYZ'' according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document.  These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+@item
+VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License.  You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute.  However, you may accept
+compensation in exchange for copies.  If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+@item
+COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover.  Both covers must also clearly and legibly identify
+you as the publisher of these copies.  The front cover must present
+the full title with all words of the title equally prominent and
+visible.  You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+@item
+MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it.  In addition, you must do these things in the Modified Version:
+
+@enumerate A
+@item
+Use in the Title Page (and on the covers, if any) a title distinct
+from that of the Document, and from those of previous versions
+(which should, if there were any, be listed in the History section
+of the Document).  You may use the same title as a previous version
+if the original publisher of that version gives permission.
+
+@item
+List on the Title Page, as authors, one or more persons or entities
+responsible for authorship of the modifications in the Modified
+Version, together with at least five of the principal authors of the
+Document (all of its principal authors, if it has fewer than five),
+unless they release you from this requirement.
+
+@item
+State on the Title page the name of the publisher of the
+Modified Version, as the publisher.
+
+@item
+Preserve all the copyright notices of the Document.
+
+@item
+Add an appropriate copyright notice for your modifications
+adjacent to the other copyright notices.
+
+@item
+Include, immediately after the copyright notices, a license notice
+giving the public permission to use the Modified Version under the
+terms of this License, in the form shown in the Addendum below.
+
+@item
+Preserve in that license notice the full lists of Invariant Sections
+and required Cover Texts given in the Document's license notice.
+
+@item
+Include an unaltered copy of this License.
+
+@item
+Preserve the section Entitled ``History'', Preserve its Title, and add
+to it an item stating at least the title, year, new authors, and
+publisher of the Modified Version as given on the Title Page.  If
+there is no section Entitled ``History'' in the Document, create one
+stating the title, year, authors, and publisher of the Document as
+given on its Title Page, then add an item describing the Modified
+Version as stated in the previous sentence.
+
+@item
+Preserve the network location, if any, given in the Document for
+public access to a Transparent copy of the Document, and likewise
+the network locations given in the Document for previous versions
+it was based on.  These may be placed in the ``History'' section.
+You may omit a network location for a work that was published at
+least four years before the Document itself, or if the original
+publisher of the version it refers to gives permission.
+
+@item
+For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
+the Title of the section, and preserve in the section all the
+substance and tone of each of the contributor acknowledgements and/or
+dedications given therein.
+
+@item
+Preserve all the Invariant Sections of the Document,
+unaltered in their text and in their titles.  Section numbers
+or the equivalent are not considered part of the section titles.
+
+@item
+Delete any section Entitled ``Endorsements''.  Such a section
+may not be included in the Modified Version.
+
+@item
+Do not retitle any existing section to be Entitled ``Endorsements'' or
+to conflict in title with any Invariant Section.
+
+@item
+Preserve any Warranty Disclaimers.
+@end enumerate
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant.  To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled ``Endorsements'', provided it contains
+nothing but endorsements of your Modified Version by various
+parties---for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version.  Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity.  If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+@item
+COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy.  If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled ``History''
+in the various original documents, forming one section Entitled
+``History''; likewise combine any sections Entitled ``Acknowledgements'',
+and any sections Entitled ``Dedications''.  You must delete all
+sections Entitled ``Endorsements.''
+
+@item
+COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+@item
+AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an ``aggregate'' if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+@item
+TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections.  You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers.  In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled ``Acknowledgements'',
+``Dedications'', or ``History'', the requirement (section 4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+@item
+TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void, and
+will automatically terminate your rights under this License.
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, receipt of a copy of some or all of the same material does
+not give you any rights to use it.
+
+@item
+FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation License from time to time.  Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.  See
+@uref{http://www.gnu.org/copyleft/}.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License ``or any later version'' applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation.  If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation.  If the Document
+specifies that a proxy can decide which future versions of this
+License can be used, that proxy's public statement of acceptance of a
+version permanently authorizes you to choose that version for the
+Document.
+
+@item
+RELICENSING
+
+``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works.  A
+public wiki that anybody can edit is an example of such a server.  A
+``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
+site means any set of copyrightable works thus published on the MMC
+site.
+
+``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
+license published by Creative Commons Corporation, a not-for-profit
+corporation with a principal place of business in San Francisco,
+California, as well as future copyleft versions of that license
+published by that same organization.
+
+``Incorporate'' means to publish or republish a Document, in whole or
+in part, as part of another Document.
+
+An MMC is ``eligible for relicensing'' if it is licensed under this
+License, and if all works that were first published under this License
+somewhere other than this MMC, and subsequently incorporated in whole
+or in part into the MMC, (1) had no cover texts or invariant sections,
+and (2) were thus incorporated prior to November 1, 2008.
+
+The operator of an MMC Site may republish an MMC contained in the site
+under CC-BY-SA on the same site at any time before August 1, 2009,
+provided the MMC is eligible for relicensing.
+
+@end enumerate
+
+@page
+@heading ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+@smallexample
+@group
+  Copyright (C)  @var{year}  @var{your name}.
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+  Texts.  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+@end group
+@end smallexample
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the ``with@dots{}Texts.''@: line with this:
+
+@smallexample
+@group
+    with the Invariant Sections being @var{list their titles}, with
+    the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
+    being @var{list}.
+@end group
+@end smallexample
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
+
+@c Local Variables:
+@c ispell-local-pdict: "ispell-dict"
+@c End:

+ 39 - 30
doc/documentation/gnunet-c-tutorial.texi → doc/tutorial/gnunet-tutorial.texi

@@ -1,8 +1,8 @@
 \input texinfo
 @c %**start of header
-@setfilename gnunet-c-tutorial.info
+@setfilename gnunet-tutorial.info
 @documentencoding UTF-8
-@settitle GNUnet C Tutorial
+@settitle GNUnet Tutorial
 @c @exampleindent 2
 @c %**end of header
 
@@ -78,6 +78,7 @@ how to contact the GNUnet team:
 * Introduction to GNUnet Architecture:: Introduction to GNUnet Architecture
 * First Steps with GNUnet::             First Steps with GNUnet
 * Developing Applications::             Developing Applications
+* GNU Free Documentation License::      The license of this manual
 
 @detailmenu
  --- The Detailed Node Listing ---
@@ -696,7 +697,7 @@ about them can be found in the testbed default configuration file
 With the testbed API, a sample test case can be structured as follows:
 
 @example
-@verbatiminclude testbed_test.c
+@verbatiminclude examples/testbed_test.c
 @end example
 
 @noindent
@@ -857,7 +858,7 @@ and a handle to the parsed configuration (and the configuration
 file name that was used, which is typically not needed):
 
 @example
-@verbatiminclude tutorial-examples/001.c
+@verbatiminclude examples/001.c
 @end example
 
 @menu
@@ -875,7 +876,7 @@ add a string-option and a binary flag (defaulting to @code{NULL} and
 @code{GNUNET\_NO} respectively):
 
 @example
-@verbatiminclude tutorial-examples/002.c
+@verbatiminclude examples/002.c
 @end example
 
 Issues such as displaying some helpful text describing options using
@@ -932,7 +933,7 @@ Before a client library can implement the application-specific protocol
 with the service, a connection must be created:
 
 @example
-@verbatiminclude tutorial-examples/003.c
+@verbatiminclude examples/003.c
 @end example
 
 @noindent
@@ -954,7 +955,7 @@ This header defines the size and the type of the
 message, the payload follows after this header.
 
 @example
-@verbatiminclude tutorial-examples/004.c
+@verbatiminclude examples/004.c
 @end example
 
 @noindent
@@ -962,7 +963,7 @@ Existing message types are defined in @file{gnunet\_protocols.h}.
 A common way to create a message is with an envelope:
 
 @example
-@verbatiminclude tutorial-examples/005.c
+@verbatiminclude examples/005.c
 @end example
 
 @noindent
@@ -997,7 +998,7 @@ to process the message.  Note that the prefixes @code{check\_}
 and @code{handle\_} are mandatory.
 
 @example
-@verbatiminclude tutorial-examples/006.c
+@verbatiminclude examples/006.c
 @end example
 
 @noindent
@@ -1050,7 +1051,7 @@ The key API definition for creating a service is the
 @code{GNUNET\_SERVICE\_MAIN} macro:
 
 @example
-@verbatiminclude tutorial-examples/007.c
+@verbatiminclude examples/007.c
 @end example
 
 @noindent
@@ -1063,7 +1064,7 @@ A minimal version of the three central service funtions would look
 like this:
 
 @example
-@verbatiminclude tutorial-examples/008.c
+@verbatiminclude examples/008.c
 @end example
 
 @noindent
@@ -1101,7 +1102,7 @@ One of the first things any service that extends the P2P protocol
 typically does is connect to the @code{CORE} service using:
 
 @example
-@verbatiminclude tutorial-examples/009.c
+@verbatiminclude examples/009.c
 @end example
 
 @menu
@@ -1120,7 +1121,7 @@ be known to the service. This is notified by the @code{CORE}
 peer to the service:
 
 @example
-@verbatiminclude tutorial-examples/010.c
+@verbatiminclude examples/010.c
 @end example
 
 @noindent
@@ -1178,7 +1179,7 @@ peer and the service is no longer allowed to send messages to the peer.
 The disconnect callback looks like the following:
 
 @example
-@verbatiminclude tutorial-examples/011.c
+@verbatiminclude examples/011.c
 @end example
 
 @noindent
@@ -1202,7 +1203,7 @@ stored with PEERSTORE contains the following fields:
 
 The first step is to start a connection to the PEERSTORE service:
 @example
-@verbatiminclude tutorial-examples/012.c
+@verbatiminclude examples/012.c
 @end example
 
 The service handle @code{peerstore_handle} will be needed for
@@ -1221,7 +1222,7 @@ all subsequent PEERSTORE operations.
 To store a new record, use the following function:
 
 @example
-@verbatiminclude tutorial-examples/013.c
+@verbatiminclude examples/013.c
 @end example
 
 @noindent
@@ -1242,7 +1243,7 @@ operation. This handle can be used to cancel the store operation only
 before the continuation function is called:
 
 @example
-@verbatiminclude tutorial-examples/013.1.c
+@verbatiminclude examples/013.1.c
 @end example
 
 @node Retrieving records
@@ -1251,7 +1252,7 @@ before the continuation function is called:
 To retrieve stored records, use the following function:
 
 @example
-@verbatiminclude tutorial-examples/014.c
+@verbatiminclude examples/014.c
 @end example
 
 @noindent
@@ -1283,7 +1284,7 @@ stored under a specific key combination (subsystem, peerid, key).
 To start the monitoring, use the following function:
 
 @example
-@verbatiminclude tutorial-examples/015.c
+@verbatiminclude examples/015.c
 @end example
 
 @noindent
@@ -1293,7 +1294,7 @@ record. This will continue until the connection to the PEERSTORE
 service is broken or the watch operation is canceled:
 
 @example
-@verbatiminclude tutorial-examples/016.c
+@verbatiminclude examples/016.c
 @end example
 
 @node Disconnecting from PEERSTORE
@@ -1303,7 +1304,7 @@ When the connection to the PEERSTORE service is no longer needed,
 disconnect using the following function:
 
 @example
-@verbatiminclude tutorial-examples/017.c
+@verbatiminclude examples/017.c
 @end example
 
 @noindent
@@ -1321,7 +1322,7 @@ This section will explain how to use the DHT. Of course, the first
 thing to do is to connect to the DHT service:
 
 @example
-@verbatiminclude tutorial-examples/018.c
+@verbatiminclude examples/018.c
 @end example
 
 @noindent
@@ -1354,7 +1355,7 @@ errors, peers leaving and other unfavorable events, just make several
 PUT requests!
 
 @example
-@verbatiminclude tutorial-examples/019.c
+@verbatiminclude examples/019.c
 @end example
 
 @noindent
@@ -1380,7 +1381,7 @@ the callback will get a list of all the peers the data has travelled,
 both on the PUT path and on the GET path.
 
 @example
-@verbatiminclude tutorial-examples/020.c
+@verbatiminclude examples/020.c
 @end example
 
 @noindent
@@ -1425,7 +1426,7 @@ is zero.  The block group is typically used to filter duplicate
 replies.
 
 @example
-@verbatiminclude tutorial-examples/021.c
+@verbatiminclude examples/021.c
 @end example
 
 @noindent
@@ -1446,7 +1447,7 @@ should simply return @code{GNUNET\_SYSERR} (the DHT will still work
 just fine with such blocks).
 
 @example
-@verbatiminclude tutorial-examples/022.c
+@verbatiminclude examples/022.c
 @end example
 
 @node Initialization of the plugin
@@ -1459,7 +1460,7 @@ about and returns a struct with the functions that are to be used for
 validation and obtaining keys (the ones just defined above).
 
 @example
-@verbatiminclude tutorial-examples/023.c
+@verbatiminclude examples/023.c
 @end example
 
 @node Shutdown of the plugin
@@ -1470,7 +1471,7 @@ export a second function for cleaning up.  It usually does very
 little.
 
 @example
-@verbatiminclude tutorial-examples/024.c
+@verbatiminclude examples/024.c
 @end example
 
 @node Integration of the plugin with the build system
@@ -1482,7 +1483,7 @@ service SERVICE should contain a rule similar to this:
 @c must be improved.
 
 @example
-@verbatiminclude tutorial-examples/025.Makefile.am
+@verbatiminclude examples/025.Makefile.am
 @end example
 
 @noindent
@@ -1507,7 +1508,7 @@ messages. When an event happens, the appropiate callback is
 called with all the information about the event.
 
 @example
-@verbatiminclude tutorial-examples/026.c
+@verbatiminclude examples/026.c
 @end example
 
 @node Debugging with gnunet-arm
@@ -1556,4 +1557,12 @@ Exercise: Add a memory leak to your service and obtain a trace
 pointing to the leak using @command{valgrind} while running the service
 from @command{gnunet-service-arm}.
 
+
+@c *********************************************************************
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+@cindex license, GNU Free Documentation License
+@include fdl-1.3.texi
+
+
 @bye