doc/documentation/gnunet.texi

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