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
  47 @dircategory Networking
  48 @direntry
  49 * GNUnet: (gnunet).       Framework for secure peer-to-peer networking
  50 @end direntry
  51
  52 @titlepage
  53 @title GNUnet Reference Manual
  54 @subtitle Installing, configuring, using and contributing to GNUnet
  55 @author The GNUnet Developers
  56
  57 @page
  58 @vskip 0pt plus 1filll
  59 Edition @value{EDITION} @*
  60 @value{UPDATED} @*
  61
  62 @insertcopying
  63 @end titlepage
  64
  65 @summarycontents
  66 @contents
  67
  68 @node Top
  69 @top Introduction
  70
  71 This document is the Reference Manual for GNUnet version @value{VERSION}.
  72
  73 @menu
  74
  75 * Terminology::                     Terminology used throughout the Manual
  76 * Philosophy::                      About GNUnet
  77 @c * Vocabulary::                      Vocabulary
  78 * GNUnet Installation Handbook::    How to install GNUnet
  79 * Using GNUnet::                    Using GNUnet
  80 @c * Configuration Handbook::          Configuring GNUnet
  81 * GNUnet Contributors Handbook::    Contributing to GNUnet
  82 * GNUnet Developer Handbook::       Developing GNUnet
  83 * GNU Free Documentation License::  The license of this manual
  84 * GNU General Public License::      The license of this manual
  85 * Concept Index::                   Concepts
  86 * Programming Index::               Data types, functions, and variables
  87
  88 @detailmenu
  89  --- The Detailed Node Listing ---
  90
  91 Terminology
  92
  93 * General Terminology::
  94 * Typography::
  95
  96 Philosophy
  97
  98 * Design Goals::
  99 * Security and Privacy::
 100 * Versatility::
 101 * Practicality::
 102 * Key Concepts::
 103 * Authentication::
 104 * Accounting to Encourage Resource Sharing::
 105 * Confidentiality::
 106 * Anonymity::
 107 * Deniability::
 108 * Peer Identities::
 109 * Zones in the GNU Name System (GNS Zones)::
 110 * Egos::
 111 * Backup of Identities and Egos::
 112 * Revocation::
 113
 114 @c Vocabulary
 115 @c
 116 @c * Definitions abbreviations and acronyms::
 117 @c * Words and characters::
 118 @c * Technical Assumptions::
 119
 120 GNUnet Installation Handbook
 121
 122 * Dependencies::
 123 * Pre-installation notes::
 124 * Generic installation instructions::
 125 * Build instructions for Ubuntu 12.04 using Git::
 126 * Build instructions for software builds from source::
 127 * Build Instructions for Microsoft Windows Platforms::
 128 * Build instructions for Debian 7.5::
 129 * Installing GNUnet from Git on Ubuntu 14.4::
 130 * Build instructions for Debian 8::
 131 * Outdated build instructions for previous revisions::
 132 @c * Portable GNUnet::
 133 * The graphical configuration interface::
 134 * How to start and stop a GNUnet peer::
 135
 136 Using GNUnet
 137
 138 * Checking the Installation::
 139 * First steps - File-sharing::
 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 @c Configuration Handbook
 148
 149 GNUnet Contributors Handbook
 150
 151 * Contributing to GNUnet::
 152 * Licenses of contributions::
 153 * Copyright Assignment::
 154 * Contributing to the Reference Manual::
 155
 156 GNUnet Developer Handbook
 157
 158 * Developer Introduction::
 159 * Code overview::
 160 * System Architecture::
 161 * Subsystem stability::
 162 * Naming conventions and coding style guide::
 163 * Build-system::
 164 * Developing extensions for GNUnet using the gnunet-ext template::
 165 * Writing testcases::
 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/terminology.texi
 200 @c *********************************************************************
 201
 202 @c *********************************************************************
 203 @include chapters/philosophy.texi
 204 @c *********************************************************************
 205
 206 @c WIP:
 207 @c @include chapters/vocabulary.texi
 208
 209 @c *********************************************************************
 210 @include chapters/installation.texi
 211 @c *********************************************************************
 212
 213 @c *********************************************************************
 214 @include chapters/user.texi
 215 @c *********************************************************************
 216
 217 @c WIP:
 218 @c @include chapters/configuration.texi
 219
 220 @include chapters/contributing.texi
 221
 222 @c *********************************************************************
 223 @include chapters/developer.texi
 224 @c For now in its own Book:
 225 @c @include gnunet-c-tutorial.texi
 226 @c *********************************************************************
 227
 228 @c *********************************************************************
 229 @node GNU Free Documentation License
 230 @appendix GNU Free Documentation License
 231 @cindex license, GNU Free Documentation License
 232 @include fdl-1.3.texi
 233
 234 @c *********************************************************************
 235 @node GNU General Public License
 236 @appendix GNU General Public License
 237 @cindex license, GNU General Public License
 238 @include gpl-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 @printindex fn
 250
 251 @bye