doc/handbook/gnunet.texi

   1 \input texinfo
   2 @c -*-texinfo-*-
   3 @setfilename gnunet.info
   4 @documentencoding UTF-8
   5 @settitle GNUnet Reference Manual
   6 @c @exampleindent 2
   7
   8 @c macros for backwards compatibility
   9 @macro geq{}
  10 >=
  11 @end macro
  12
  13 @c Set Versions which might be used in more than one place:
  14 @set GNUFTP-URL https://ftp.gnu.org/gnu/gnunet
  15 @set PYPI-URL https://pypi.python.org/packages/source
  16 @set GNURL-VERSION-CURRENT 7.55.1
  17 @set GNUNET-DIST-URL https://gnunet.org/sites/default/files/
  18 @include version.texi
  19 @c @set OPENPGP-SIGNING-KEY-ID
  20
  21 @copying
  22 Copyright @copyright{} 2001-2018 GNUnet e.V.
  23
  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''.
  30
  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}.
  33
  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''.
  38
  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}.
  41 @end copying
  42
  43 @c TODO: Improve this and improve https://directory.fsf.org/wiki/Gnunet
  44 @c NOTE FOR TRANSLATORS: Due to en.wikipedia.org being the wikipedia
  45 @c                       which is more up to date than others, refrain
  46 @c                       from using localized wikipedia unless you are
  47 @c                       sure the articles content is good enough. For
  48 @c                       example the german wikipedia entry for GNUnet
  49 @c                       is in a terrible shape, but the en.wikipedia.org
  50 @c                       entry is still acceptable (although in need of
  51 @c                       updates).
  52
  53 @dircategory Networking
  54 @direntry
  55 * GNUnet: (gnunet).       Framework for secure peer-to-peer networking
  56 @end direntry
  57
  58 @titlepage
  59 @title GNUnet Reference Manual
  60 @subtitle Installing, configuring, using and contributing to GNUnet
  61 @author The GNUnet Developers
  62
  63 @page
  64 @vskip 0pt plus 1filll
  65 Edition @value{EDITION} @*
  66
  67 @insertcopying
  68 @end titlepage
  69
  70 @summarycontents
  71 @contents
  72
  73 @node Top
  74 @top Introduction
  75
  76 This document is the Reference Manual for GNUnet version @value{VERSION}.
  77
  78 @menu
  79
  80 * Preface::                         Chapter 0
  81 * Philosophy::                      About GNUnet
  82 * Key Concepts::                    Key concepts of GNUnet
  83 @c * Vocabulary::                      Vocabulary
  84 * Installing GNUnet::               Installing GNUnet
  85 * Using GNUnet::                    Using GNUnet
  86 @c * Configuration Handbook::          Configuring GNUnet
  87 * GNUnet Contributors Handbook::    Contributing to GNUnet
  88 * GNUnet Developer Handbook::       Developing GNUnet
  89 * GNU Free Documentation License::  The license of this manual
  90 * GNU General Public License::
  91 * GNU Affero General Public License::
  92 * Concept Index::                   Concepts
  93 * Programming Index::               Data types, functions, and variables
  94
  95 @detailmenu
  96  --- The Detailed Node Listing ---
  97
  98 Preface
  99
 100 * About this book
 101 * Contributing to this book
 102 * Introduction
 103 * Typography::
 104
 105 Philosophy
 106
 107 * Design Principles::
 108 * Privacy and Anonymity::
 109 * Practicality::
 110
 111 Key Concepts
 112
 113 * Authentication::
 114 * Accounting to Encourage Resource Sharing::
 115 * Confidentiality::
 116 * Anonymity::
 117 * Deniability::
 118 * Peer Identities::
 119 * Zones in the GNU Name System (GNS Zones)::
 120 * Egos::
 121 * Backup of Identities and Egos::
 122 * Revocation::
 123
 124 Installing GNUnet
 125 * Installing dependencies::
 126 * Getting the Source Code::
 127 * Create @code{gnunet} user and group::
 128 * Preparing and Compiling the Source Code::
 129 * Installation::
 130 * MOVED FROM USER Checking the Installation::
 131 * MOVED FROM USER The graphical configuration interface::
 132 * MOVED FROM USER Config Leftovers::
 133
 134 Using GNUnet
 135
 136 * Start and stop GNUnet::
 137 * First steps - Using the GNU Name System::
 138 * First steps - Using GNUnet Conversation::
 139 * First steps - Using the GNUnet VPN::
 140 * File-sharing::
 141 * The GNU Name System::
 142 * Using the Virtual Public Network::
 143
 144 GNUnet Contributors Handbook
 145
 146 * Contributing to GNUnet::
 147 * Licenses of contributions::
 148 * Copyright Assignment::
 149 * Contributing to the Reference Manual::
 150 * Contributing testcases::
 151
 152 GNUnet Developer Handbook
 153
 154 * Developer Introduction::
 155 * Internal dependencies::
 156 * Code overview::
 157 * System Architecture::
 158 * Subsystem stability::
 159 * Naming conventions and coding style guide::
 160 * Build-system::
 161 * Developing extensions for GNUnet using the gnunet-ext template::
 162 * Writing testcases::
 163 * Building GNUnet and its dependencies::
 164 * TESTING library::
 165 * Performance regression analysis with Gauger::
 166 * TESTBED Subsystem::
 167 * libgnunetutil::
 168 * Automatic Restart Manager (ARM)::
 169 * TRANSPORT Subsystem::
 170 * NAT library::
 171 * Distance-Vector plugin::
 172 * SMTP plugin::
 173 * Bluetooth plugin::
 174 * WLAN plugin::
 175 * ATS Subsystem::
 176 * CORE Subsystem::
 177 * CADET Subsystem::
 178 * NSE Subsystem::
 179 * HOSTLIST Subsystem::
 180 * IDENTITY Subsystem::
 181 * NAMESTORE Subsystem::
 182 * PEERINFO Subsystem::
 183 * PEERSTORE Subsystem::
 184 * SET Subsystem::
 185 * STATISTICS Subsystem::
 186 * Distributed Hash Table (DHT)::
 187 * GNU Name System (GNS)::
 188 * GNS Namecache::
 189 * REVOCATION Subsystem::
 190 * File-sharing (FS) Subsystem::
 191 * REGEX Subsystem::
 192
 193 @end detailmenu
 194 @end menu
 195
 196 @c *********************************************************************
 197 @include chapters/preface.texi
 198 @c *********************************************************************
 199
 200 @c *********************************************************************
 201 @include chapters/philosophy.texi
 202 @c *********************************************************************
 203
 204 @c *********************************************************************
 205 @include chapters/keyconcepts.texi
 206 @c *********************************************************************
 207
 208 @c *********************************************************************
 209 @include chapters/installation.texi
 210 @c *********************************************************************
 211
 212 @c *********************************************************************
 213 @include chapters/user.texi
 214 @c *********************************************************************
 215
 216 @include chapters/contributing.texi
 217
 218 @c *********************************************************************
 219 @include chapters/developer.texi
 220 @c *********************************************************************
 221
 222 @c *********************************************************************
 223 @node GNU Free Documentation License
 224 @appendix GNU Free Documentation License
 225 @cindex license, GNU Free Documentation License
 226 @include fdl-1.3.texi
 227
 228 @c *********************************************************************
 229 @node GNU General Public License
 230 @appendix GNU General Public License
 231 @cindex license, GNU General Public License
 232 @include gpl-3.0.texi
 233
 234 @c *********************************************************************
 235 @node GNU Affero General Public License
 236 @appendix GNU Affero General Public License
 237 @cindex license, GNU Affero General Public License
 238 @include agpl-3.0.texi
 239
 240 @c *********************************************************************
 241 @node Concept Index
 242 @unnumbered Concept Index
 243 @printindex cp
 244
 245 @node Programming Index
 246 @unnumbered Programming Index
 247 @syncodeindex tp fn
 248 @syncodeindex vr fn
 249 @syncodeindex pg fn
 250 @printindex fn
 251
 252 @bye