doc/index.texi

   1 \input texinfo
   2 @documentencoding UTF-8
   3 @settitle NNCP
   4
   5 @copying
   6 This manual is for NNCP (Node to Node copy) --  collection of utilities
   7 simplifying secure store-and-forward files and mail exchanging.
   8
   9 Copyright @copyright{} 2016-2017 @email{stargrave@@stargrave.org, Sergey Matveev}
  10
  11 @quotation
  12 Permission is granted to copy, distribute and/or modify this document
  13 under the terms of the GNU Free Documentation License, Version 1.3
  14 or any later version published by the Free Software Foundation;
  15 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  16 A copy of the license is included in the section entitled "Copying conditions".
  17 @end quotation
  18 @end copying
  19
  20 @node Top
  21 @top NNCP
  22
  23 NNCP (Node to Node copy) is a collection of utilities simplifying
  24 secure store-and-forward files and mail exchanging.
  25
  26 This utilities are intended to help build up small size (dozens of
  27 nodes) ad-hoc @url{https://en.wikipedia.org/wiki/Friend-to-friend,
  28 friend-to-friend} (F2F) statically routed
  29 @url{https://en.wikipedia.org/wiki/Darknet, darknet} networks for
  30 fire-and-forget secure reliable files, file requests and Internet mail
  31 transmission. All packets are integrity checked,
  32 @url{https://en.wikipedia.org/wiki/End-to-end_encryption, end-to-end}
  33 encrypted, explicitly authenticated by known participants public keys.
  34 @url{https://en.wikipedia.org/wiki/Onion_routing, Onion encryption} is
  35 applied to relayed packets. Each node acts both as a client and server,
  36 can use push and poll behaviour model.
  37
  38 Out-of-box offline @url{https://en.wikipedia.org/wiki/Sneakernet,
  39 sneakernet/floppynet}, @url{https://en.wikipedia.org/wiki/Dead_drop,
  40 dead drops} and @url{https://en.wikipedia.org/wiki/Air_gap_(networking),
  41 air-gapped} computers support. But online TCP daemon with full-duplex
  42 resumable data transmission exists.
  43
  44 NNCP is @url{https://www.gnu.org/philosophy/pragmatic.html, copylefted}
  45 @url{https://www.gnu.org/philosophy/free-sw.html, free software}
  46 licenced under @url{https://www.gnu.org/licenses/gpl-3.0.html, GPLv3+}.
  47 It should work on all @url{https://en.wikipedia.org/wiki/POSIX,
  48 POSIX}-compatible systems. Easy integration with existing
  49 @url{https://en.wikipedia.org/wiki/SMTP, SMTP} servers. Single
  50 @url{http://yaml.org/, YAML} configuration file.
  51
  52 @menu
  53 * Comparison with existing solutions: Comparison.
  54 * Use cases::
  55 * Workflow::
  56 * Configuration file: Configuration.
  57 * Commands::
  58 * Spool directory: Spool.
  59 * Log format: Log.
  60 * Packet format: Packet.
  61 * Sync protocol: Sync.
  62 * Copying conditions: Copying.
  63 @end menu
  64
  65 @include comparison.texi
  66 @include usecases.texi
  67 @include workflow.texi
  68 @include cfg.texi
  69 @include cmds.texi
  70 @include spool.texi
  71 @include log.texi
  72 @include pkt.texi
  73 @include sp.texi
  74
  75 @node Copying
  76 @unnumbered Copying conditions
  77
  78 @insertcopying
  79 @verbatiminclude fdl.txt
  80
  81 @bye