[gnunet-scheme] 180/324: doc: Start writing some documentation.

[gnunet]

This is an automated email from the git hooks/post-receive script.

maxime-devos pushed a commit to branch master
in repository gnunet-scheme.

commit b168a090090a5c280ceda016707382d4235fdbcb
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sat Aug 14 19:12:02 2021 +0200

    doc: Start writing some documentation.
    
    * doc/fdl.tm: New file.
    * doc/scheme-gnunet.tm: New file.
---
 doc/fdl.tm           | 473 +++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/scheme-gnunet.tm | 269 +++++++++++++++++++++++++++++
 2 files changed, 742 insertions(+)

diff --git a/doc/fdl.tm b/doc/fdl.tm
new file mode 100644
index 0000000..d2f7cfb
--- /dev/null
+++ b/doc/fdl.tm
@@ -0,0 +1,473 @@
+<TeXmacs|1.99.16>
+
+<style|generic>
+
+<\body>
+  <center|Version 1.3, 3 November 2008>
+
+  Copyright \<copyright\> 2000, 2001, 2002, 2007, 2008 Free Software
+  Foundation, Inc. \<less\><hlink|https://fsf.org/|https://fsf.org/>\<gtr\>
+
+  Everyone is permitted to copy and distribute verbatim copies of this
+  license document, but changing it is not allowed.
+
+  <section*|<label|fdlsection0>0. <with|font-shape|small-caps|Preamble>>
+
+  The purpose of this License is to make a manual, textbook, or other
+  functional and useful document ``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.
+
+  <section*|<label|fdlsection1>1. <with|font-shape|small-caps|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, LaTeX 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.
+
+  <section*|<label|fdlsection2>2. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdlsection3>3. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdlsection4>4. <with|font-shape|small-caps|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-Alpha>
+    <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.
+  </enumerate-Alpha>
+
+  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\Vfor
+  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.
+
+  <section*|<label|fdlsection5>5. <with|font-shape|small-caps|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".
+
+  <section*|<label|fdlsection6>6. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdlsection7>7. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdlsection8>8. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdlsection9>9. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdlsection10>10. <with|font-shape|small-caps|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 
<hlink|https://www.gnu.org/licenses/|https://www.gnu.org/licenses/>.
+
+  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.
+
+  <section*|<label|fdlsection11>11. <with|font-shape|small-caps|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.
+
+  <section*|<label|fdladdendum><with|font-shape|small-caps|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:
+
+  <\code>
+    \ \ \ \ Copyright (C) \ YEAR \ 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".
+  </code>
+
+  If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+  replace the ``with \<ldots\> Texts.'' line with this:
+
+  <\code>
+    \ \ \ \ with the Invariant Sections being LIST THEIR TITLES, with the
+
+    \ \ \ \ Front-Cover Texts being LIST, and with the Back-Cover Texts being
+    LIST.
+  </code>
+
+  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.
+</body>
+
+<\initial>
+  <\collection>
+    <associate|preamble|false>
+    <associate|save-aux|false>
+  </collection>
+</initial>
diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
new file mode 100644
index 0000000..1e805a8
--- /dev/null
+++ b/doc/scheme-gnunet.tm
@@ -0,0 +1,269 @@
+<TeXmacs|2.1>
+
+<style|<tuple|tmmanual|british|doc>>
+
+<\body>
+  <doc-data|<doc-title|Scheme-GNUnet 
manual>|<doc-author|<author-data|<author-name|Maxime
+  Devos>|<author-email|maximedevos@telenet.be>>>>
+
+  Copyright (C) 2021 Maxime Devos
+
+  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.<space|1em>A copy
+  of the license is included in the section entitled \<#2018\>GNU Free
+  Documentation License\<#2019\>.
+
+  \;
+
+  <chapter|Installation and configuration guide>
+
+  TODO<chapter|Application guide>
+
+  TODO<chapter|Programming guide>
+
+  <section|Concurrency>
+
+  Scheme-GNUnet uses <code*|guile-fibers> for concurrency, but supports
+  POSIX-style threading as well, using the <code*|(ice-9 threads)> Guile
+  module. More concretely, this means <code*|spawn-fiber> is used by default
+  for starting asynchronuous computations and public procedures accept an
+  optional <scm|#:spawn> argument accepting a procedure like
+  <code*|spawn-fiber> or <code*|call-with-new-thread>.
+  \<#2018\>Conditions\<#2019\> can be used for synchronising concurrent
+  computations, see the documentation of <code*|guile-fibers> for details.
+
+  <paragraph|Repeated conditions>Scheme-GNUnet has a variant of fibers
+  conditions, named \<#2018\>repeated conditions\<#2019\>, in the module
+  <scm|(gnu gnunet concurrency repeated-condition)>.<space|1em>It is
+  unfortunately ill-documented.
+
+  <section|Configuration>
+
+  <section|Manipulation of network structures>
+
+  <index|network structure><index|netstruct>The modules <scm|(gnu gnunet
+  netstruct procedural)> and <scm|(gnu gnunet netstruct syntactic)> can be
+  used for formatting messages to be sent over the network or to a
+  service.<space|1em>The macros <scm|define-type><index|define-type> and
+  <scm|structure/packed><index|structure/packed> can be used to define new
+  structures, like this:
+
+  <\scm-code>
+    (define-type /:msg:nse:estimate/example
+
+    \ \ (structure/packed
+
+    \ \ \ (properties '((message-symbol msg:nse:estimate)))
+
+    \ \ \ (synopsis "Network size estimate")
+
+    \ \ \ (documentation "Some explanation")
+
+    \ \ \ (field (header /:message-header))
+
+    \ \ \ (field (size-estimate ieee-double/big)
+
+    \ \ \ \ \ \ \ \ \ \ (synopsis "Timestamp for when the estimate was
+    made"))))
+  </scm-code>
+
+  This example is taken from the <scm|(gnu gnunet nse struct)> module and
+  oversimplified.<space|1em>All its components will gradually
+  explained.<space|1em>First, what actually is a network
+  structure?<space|1em>This question is ambigious, because \<#2018\>network
+  structure\<#2019\> can refer to either the <with|font-shape|italic|value>
+  or the <with|font-shape|italic|type>.<space|1em>The
+  <with|font-shape|italic|value> is a sequence of octets, i.e., a sequence of
+  numbers in the closed range 0\U255.<space|1em>The
+  <with|font-shape|italic|type> describes how the
+  <with|font-shape|italic|value> is structured.
+
+  As an example, consider figure <reference|networkstructex>.<space|1em>There,
+  the value is <scm|0 0 0 4 0 0 1 65 64 51 238 123 71 27 58 149> and the type
+  is <scm|/:msg:nse:estimate/example>.
+
+  <big-figure|<tree|<scm|/:msg:nse:estimate/example>|<tree|<scm|header>
+  <scm|/:message-header>|<tree|<scm|size> <scm|u32/big>|0 0 0
+  4>|<tree|<scm|type> <scm|u32/big>|0 0 1 65>>|<tree|<scm|size-estimate>
+  <scm|ieee-double/big>|64 51 238 123 71 27 58 149>>|A network structure,
+  both <with|font-shape|italic|value> and
+  <with|font-shape|italic|type>.<label|networkstructex>>
+
+  This value has a <with|font-shape|italic|header> with a
+  <with|font-shape|italic|size> \<#2018\>0 0 0 4\<#2019\> of type
+  <scm|u32/big>, so the <with|font-shape|italic|size> is 4.<space|1em>The
+  <with|font-shape|italic|header> also has a <with|font-shape|italic|type>
+  \<#2018\>0 0 1 65\<#2019\> of type <scm|u32/big>, so the type is
+  <math|256\<times\>1+65=321>.<space|1em>The value also has a
+  <with|font-shape|italic|size estimate> of type
+  <scm|ieee-double/big>.<space|1em>The octets <scm|64 51 238 123 71 27 58
+  149>, \ interpreted as an IEEE doubles, form the number
+  <math|19.93\<ldots\>>.
+
+  <subsection|Documentation>
+
+  A network structure can optionally have embedded
+  documentation.<space|1em>More specifically, network structures can
+  optionally have the <with|font-shape|italic|synopsis><index|synopsis>,
+  <with|font-shape|italic|documentation><index|documentation> and
+  <with|font-shape|italic|properties><index|properties> set.<space|1em>The
+  <with|font-shape|italic|synopsis> is a short description of what the
+  network structure represents, typically a one-liner.<space|1em>The
+  <with|font-shape|italic|documentation> can be more detailed, explaining how
+  the structure works, can be used, is used and should be used.<space|1em>The
+  <with|font-shape|italic|properties> form a free-formed association list.
+
+  The synopsis, documentation and properties can be set on structured created
+  with <scm|structure/packed> and individual fields and can be accessed with
+  the procedures <scm|documentation>, <scm|synopsis> and <scm|properties>.
+
+  <subsection|Reading and writing>
+
+  The procedures <scm|read%><index|read%>, <scm|set%!><index|set%!>,
+  <scm|sizeof><index|sizeof> and <scm|select><index|select> from <scm|(gnu
+  gnunet netstruct procedural)> or the like-named macros from <scm|(gnu
+  gnunet netstruct syntactic)> can be used for reading and writing network
+  structures.<space|1em>The macros from <scm|syntactic> behave like the
+  procedures from <scm|procedural> with some optimisations at expansion
+  time.<space|1em>The procedures will be demonstrated with the
+  <scm|/:msg:nse:estimate/example> network structure defined previously.
+
+  First, create a memory slice with <scm|make-slice/read-write> from
+  <scm|(gnu gnunet utils bv-slice)>.<space|1em>The required size can be
+  determinded with <scm|(sizeof /:msg:nse:estimate/example
+  '())>.<space|1em>The role of <scm|'()> will be explained later.
+
+  <\scm-code>
+    (import (gnu gnunet netstruct procedural)
+
+    \ \ \ \ \ \ \ \ (gnu gnunet netstruct syntactic)
+
+    \ \ \ \ \ \ \ \ (gnu gnunet utils bv-slice)
+
+    \ \ \ \ \ \ \ \ (gnu gnunet util struct))
+
+    \;
+
+    (define-type /:msg:nse:estimate/example
+
+    \ \ (structure/packed
+
+    \ \ \ (field (header /:message-header))
+
+    \ \ \ (field (size-estimate ieee-double/big))))
+
+    \;
+
+    (define message
+
+    \ \ (make-slice/read-write (sizeof /:msg:nse:estimate/example '())))
+  </scm-code>
+
+  The fields of <scm|message> can be set with <scm|(set%! netstruct '(field
+  ...) slice value)>.<space|1em>The following code sets all the fields:
+
+  <\scm-code>
+    (set%! /:msg:nse:estimate/example '(header size) message
+
+    \ \ \ \ \ \ \ (sizeof /:msg:nse:estimate/example '()))
+
+    (set%! /:msg:nse:estimate/example '(header type) message 165)
+
+    (set%! /:msg:nse:estimate/example '(size-estimate) message 19.2)
+  </scm-code>
+
+  The size of an individual field can be determined with <scm|(sizeof
+  netstruct '(field ...))>.<space|1em>For example, the following code
+  determines the size of the \<#2018\>size\<#2019\> field in the header:
+
+  <\scm-code>
+    (sizeof /:msg:nse:estimate/example '(header size)) ; 4
+  </scm-code>
+
+  The fields can also be read:
+
+  <\scm-code>
+    (read% /:msg:nse:estimate/example '(header size) message) ; 12
+
+    (read% /:msg:nse:estimate/example '(header type) message) ; 165
+
+    (read% /:msg:nse:estimate/example '(size-estimate) message) ; 19.2
+  </scm-code>
+
+  <subsection|Primitive types>
+
+  There are a number of pre-defined types.<space|1em>First, there is
+  <scm|u8>, a single octet that is interpreted as an integer in the closed
+  range <math|<around*|[|0,255|]>>.<space|1em>There are also types
+  <scm|uN/endian> for <math|N\<in\><around*|{|16,32,64|}>> and
+  <math|endian\<in\><around*|{|little,big|}>>, which interprets <math|N/8>
+  octets as integers in the closed range 
<math|<around*|[|0,2<rsup|N>-1|]>>.<space|1em>The
+  types <scm|ieee-double/big> and <scm|ieee-double/little> are 8 octets long
+  and represent floating-point numbers in IEEE 754 format
+  (\<#2018\>binary64\<#2019\>).
+
+  <subsection|Packing>
+
+  In contrast to C structures, Scheme-GNUnet network structures are always
+  packed \V there are no \<#2018\>gaps\<#2019\> between fields.
+
+  <section|Communication with services>
+
+  To connect with a GNUnet service \V this applies to both the C and Scheme
+  implementation, the GNUnet service must bind a local domain
+  socket<\footnote>
+    The C implementation supports Internet sockets as well.
+  </footnote> somewhere on the file system and the client (possibly another
+  service) must connect to it.<space|1em>Connections to a service can be made
+  with the <scm|connect/fibers> procedure from <scm|(gnu gnunet mq-impl
+  stream)>, like this:
+
+  <\scm-code>
+    (define mq (connect/fibers config "nse" handlers error-handler))
+  </scm-code>
+
+  TODO information about message handlers, error handler <text-dots>
+
+  <section|Estimation of the size of the network>
+
+  GNUnet has a service that roughly estimates the size of the network \U
+  i.e., the number of peers
+
+  <chapter|Implementation details>
+
+  TODO<appendix|GNU Free Documentation License>
+
+  <include|fdl.tm>
+
+  <\the-index|idx>
+    <index+1|define-type|<pageref|auto-10>>
+
+    <index+1|documentation|<pageref|auto-15>>
+
+    <index+1|netstruct|<pageref|auto-9>>
+
+    <index+1|network structure|<pageref|auto-8>>
+
+    <index+1|properties|<pageref|auto-16>>
+
+    <index+1|read%|<pageref|auto-18>>
+
+    <index+1|select|<pageref|auto-21>>
+
+    <index+1|set%!|<pageref|auto-19>>
+
+    <index+1|sizeof|<pageref|auto-20>>
+
+    <index+1|structure/packed|<pageref|auto-11>>
+
+    <index+1|synopsis|<pageref|auto-14>>
+  </the-index>
+</body>
+
+<\initial>
+  <\collection>
+    <associate|save-aux|false>
+  </collection>
+</initial>
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.