5 @setfilename gnunet.info
6 @documentencoding UTF-8
7 @settitle GNUnet Reference Manual
14 @c Set Versions which might be used in more than one place:
15 @set GNUFTP-URL https://ftp.gnu.org/gnu/gnunet
16 @set PYPI-URL https://pypi.python.org/packages/source
17 @set GNURL-VERSION-CURRENT 7.55.1
18 @set GNUNET-DIST-URL https://gnunet.org/sites/default/files/
19 @c @set OPENPGP-SIGNING-KEY-ID
22 Copyright @copyright{} 2001-2017 GNUnet e.V.
24 Permission is granted to copy, distribute and/or modify this document
25 under the terms of the GNU Free Documentation License, Version 1.3 or
26 any later version published by the Free Software Foundation; with no
27 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
28 copy of the license is included in the section entitled ``GNU Free
29 Documentation License''.
31 A copy of the license is also available from the Free Software
32 Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
34 Alternately, this document is also available under the General
35 Public License, version 3 or later, as published by the Free Software
36 Foundation. A copy of the license is included in the section entitled
37 ``GNU General Public License''.
39 A copy of the license is also available from the Free Software
40 Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
43 @c TODO: Improve this and improve https://directory.fsf.org/wiki/Gnunet
45 @dircategory Networking
47 * GNUnet: (gnunet). Framework for secure peer-to-peer networking
51 @title GNUnet Reference Manual
52 @subtitle Installing, configuring, using and contributing to GNUnet
53 @author The GNUnet Developers
56 @vskip 0pt plus 1filll
57 Edition @value{EDITION} @*
69 This document is the Reference Manual for GNUnet version @value{VERSION}.
73 * Philosophy:: About GNUnet
74 * Vocabulary:: Vocabulary
75 * GNUnet Installation Handbook:: How to install GNUnet
76 * Using GNUnet:: Using GNUnet
77 * Configuration Handbook:: Configuring GNUnet
78 * GNUnet Contributors Handbook:: Contributing to GNUnet
79 * GNUnet Developer Handbook:: Developing GNUnet
80 * GNU Free Documentation License:: The license of this manual
81 * GNU General Public License:: The license of this manual
82 * Concept Index:: Concepts
83 * Programming Index:: Data types, functions, and variables
86 --- The Detailed Node Listing ---
91 * Security and Privacy::
96 * Accounting to Encourage Resource Sharing::
101 * Zones in the GNU Name System (GNS Zones)::
103 * Backup of Identities and Egos::
108 * Definitions abbreviations and acronyms::
109 * Words and characters::
110 * Technical Assumptions::
112 GNUnet Installation Handbook
115 * Pre-installation notes::
116 * Generic installation instructions::
117 * Build instructions for Ubuntu 12.04 using Git::
118 * Build instructions for software builds from source::
119 * Build Instructions for Microsoft Windows Platforms::
120 * Build instructions for Debian 7.5::
121 * Installing GNUnet from Git on Ubuntu 14.4::
122 * Build instructions for Debian 8::
123 * Outdated build instructions for previous revisions::
124 @c * Portable GNUnet::
125 * The graphical configuration interface::
126 * How to start and stop a GNUnet peer::
130 * Checking the Installation::
131 * First steps - File-sharing::
132 * First steps - Using the GNU Name System::
133 * First steps - Using GNUnet Conversation::
134 * First steps - Using the GNUnet VPN::
136 * The GNU Name System::
137 * Using the Virtual Public Network::
139 Configuration Handbook
141 GNUnet Contributors Handbook
143 * Contributing to GNUnet::
144 * Licenses of contributions::
145 * Copyright Assignment::
146 * Contributing to the Reference Manual::
148 GNUnet Developer Handbook
150 * Developer Introduction::
152 * System Architecture::
153 * Subsystem stability::
154 * Naming conventions and coding style guide::
156 * Developing extensions for GNUnet using the gnunet-ext template::
157 * Writing testcases::
159 * Performance regression analysis with Gauger::
160 * TESTBED Subsystem::
162 * Automatic Restart Manager (ARM)::
163 * TRANSPORT Subsystem::
165 * Distance-Vector plugin::
173 * HOSTLIST Subsystem::
174 * IDENTITY Subsystem::
175 * NAMESTORE Subsystem::
176 * PEERINFO Subsystem::
177 * PEERSTORE Subsystem::
179 * STATISTICS Subsystem::
180 * Distributed Hash Table (DHT)::
181 * GNU Name System (GNS)::
183 * REVOCATION Subsystem::
184 * File-sharing (FS) Subsystem::
190 @c *********************************************************************
191 @include chapters/philosophy.texi
192 @c *********************************************************************
194 @include chapters/vocabulary.texi
196 @c *********************************************************************
197 @include chapters/installation.texi
198 @c *********************************************************************
200 @c *********************************************************************
201 @include chapters/user.texi
202 @c *********************************************************************
204 @include chapters/configuration.texi
206 @include chapters/contributing.texi
208 @c *********************************************************************
209 @include chapters/developer.texi
210 @c @include gnunet-c-tutorial.texi
211 @c *********************************************************************
213 @c *********************************************************************
214 @node GNU Free Documentation License
215 @appendix GNU Free Documentation License
216 @cindex license, GNU Free Documentation License
217 @include fdl-1.3.texi
219 @c *********************************************************************
220 @node GNU General Public License
221 @appendix GNU General Public License
222 @cindex license, GNU General Public License
223 @include gpl-3.0.texi
225 @c *********************************************************************
227 @unnumbered Concept Index
230 @node Programming Index
231 @unnumbered Programming Index