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 @urefbreakstyle before
  10 @c %**end of header
  11
  12 @include version.texi
  13
  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
  20
  21 @copying
  22 Copyright @copyright{} 2001-2017 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
  45 @dircategory Networking
  46 @direntry
  47 * GNUnet: (gnunet).       Framework for secure peer-to-peer networking
  48 @end direntry
  49
  50 @titlepage
  51 @title GNUnet Reference Manual
  52 @subtitle Installing, configuring, using and contributing to GNUnet
  53 @author The GNUnet Developers
  54
  55 @page
  56 @vskip 0pt plus 1filll
  57 Edition @value{EDITION} @*
  58 @value{UPDATED} @*
  59
  60 @insertcopying
  61 @end titlepage
  62
  63 @summarycontents
  64 @contents
  65
  66 @node Top
  67 @top Introduction
  68
  69 This document is the Reference Manual for GNUnet version @value{VERSION}.
  70
  71 @menu
  72
  73 * Philosophy::                      About GNUnet
  74 @c * Vocabulary::                      Vocabulary
  75 * GNUnet Installation Handbook::    How to install GNUnet
  76 * Using GNUnet::                    Using GNUnet
  77 @c * 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
  84
  85 @detailmenu
  86  --- The Detailed Node Listing ---
  87
  88 Philosophy
  89
  90 * Design Goals::
  91 * Security and Privacy::
  92 * Versatility::
  93 * Practicality::
  94 * Key Concepts::
  95 * Authentication::
  96 * Accounting to Encourage Resource Sharing::
  97 * Confidentiality::
  98 * Anonymity::
  99 * Deniability::
 100 * Peer Identities::
 101 * Zones in the GNU Name System (GNS Zones)::
 102 * Egos::
 103 * Backup of Identities and Egos::
 104 * Revocation::
 105
 106 @c Vocabulary
 107 @c
 108 @c * Definitions abbreviations and acronyms::
 109 @c * Words and characters::
 110 @c * Technical Assumptions::
 111
 112 GNUnet Installation Handbook
 113
 114 * Dependencies::
 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::
 127
 128 Using GNUnet
 129
 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::
 135 * File-sharing::
 136 * The GNU Name System::
 137 * Using the Virtual Public Network::
 138
 139 @c Configuration Handbook
 140
 141 GNUnet Contributors Handbook
 142
 143 * Contributing to GNUnet::
 144 * Licenses of contributions::
 145 * Copyright Assignment::
 146 * Contributing to the Reference Manual::
 147
 148 GNUnet Developer Handbook
 149
 150 * Developer Introduction::
 151 * Code overview::
 152 * System Architecture::
 153 * Subsystem stability::
 154 * Naming conventions and coding style guide::
 155 * Build-system::
 156 * Developing extensions for GNUnet using the gnunet-ext template::
 157 * Writing testcases::
 158 * TESTING library::
 159 * Performance regression analysis with Gauger::
 160 * TESTBED Subsystem::
 161 * libgnunetutil::
 162 * Automatic Restart Manager (ARM)::
 163 * TRANSPORT Subsystem::
 164 * NAT library::
 165 * Distance-Vector plugin::
 166 * SMTP plugin::
 167 * Bluetooth plugin::
 168 * WLAN plugin::
 169 * ATS Subsystem::
 170 * CORE Subsystem::
 171 * CADET Subsystem::
 172 * NSE Subsystem::
 173 * HOSTLIST Subsystem::
 174 * IDENTITY Subsystem::
 175 * NAMESTORE Subsystem::
 176 * PEERINFO Subsystem::
 177 * PEERSTORE Subsystem::
 178 * SET Subsystem::
 179 * STATISTICS Subsystem::
 180 * Distributed Hash Table (DHT)::
 181 * GNU Name System (GNS)::
 182 * GNS Namecache::
 183 * REVOCATION Subsystem::
 184 * File-sharing (FS) Subsystem::
 185 * REGEX Subsystem::
 186
 187 @end detailmenu
 188 @end menu
 189
 190 @c *********************************************************************
 191 @include chapters/philosophy.texi
 192 @c *********************************************************************
 193
 194 @c WIP:
 195 @c @include chapters/vocabulary.texi
 196
 197 @c *********************************************************************
 198 @include chapters/installation.texi
 199 @c *********************************************************************
 200
 201 @c *********************************************************************
 202 @include chapters/user.texi
 203 @c *********************************************************************
 204
 205 @c WIP:
 206 @c @include chapters/configuration.texi
 207
 208 @include chapters/contributing.texi
 209
 210 @c *********************************************************************
 211 @include chapters/developer.texi
 212 @c For now in its own Book:
 213 @c @include gnunet-c-tutorial.texi
 214 @c *********************************************************************
 215
 216 @c *********************************************************************
 217 @node GNU Free Documentation License
 218 @appendix GNU Free Documentation License
 219 @cindex license, GNU Free Documentation License
 220 @include fdl-1.3.texi
 221
 222 @c *********************************************************************
 223 @node GNU General Public License
 224 @appendix GNU General Public License
 225 @cindex license, GNU General Public License
 226 @include gpl-3.0.texi
 227
 228 @c *********************************************************************
 229 @node Concept Index
 230 @unnumbered Concept Index
 231 @printindex cp
 232
 233 @node Programming Index
 234 @unnumbered Programming Index
 235 @syncodeindex tp fn
 236 @syncodeindex vr fn
 237 @printindex fn
 238
 239 @bye