git.meshlink.io Git - meshlink/blob - doc/meshlink.texi

   1 \input texinfo   @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename meshlink.info
   4 @settitle MeshLink Manual
   5 @setchapternewpage odd
   6 @c %**end of header
   7
   8 @include include.texi
   9
  10 @ifinfo
  11 @dircategory Networking tools
  12 @direntry
  13 * MeshLink: (MeshLink).              The MeshLink library.
  14 @end direntry
  15
  16 This is the info manual for the MeshLink library version @value{VERSION}.
  17
  18 Copyright @copyright{} 2014 Guus Sliepen <guus@@meshlink.io>.
  19
  20 Permission is granted to make and distribute verbatim copies of this
  21 manual provided the copyright notice and this permission notice are
  22 preserved on all copies.
  23
  24 Permission is granted to copy and distribute modified versions of this
  25 manual under the conditions for verbatim copying, provided that the
  26 entire resulting derived work is distributed under the terms of a
  27 permission notice identical to this one.
  28 @end ifinfo
  29
  30 @afourpaper
  31 @paragraphindent none
  32 @finalout
  33
  34 @titlepage
  35 @title The MeshLink library
  36 @author Guus Sliepen
  37
  38 @page
  39 @vskip 0pt plus 1filll
  40 This is the info manual for the MeshLink library version @value{VERSION}.
  41
  42 Copyright @copyright{} 2014 Guus Sliepen <guus@@meshlink.io>
  43
  44 Permission is granted to make and distribute verbatim copies of this
  45 manual provided the copyright notice and this permission notice are
  46 preserved on all copies.
  47
  48 Permission is granted to copy and distribute modified versions of this
  49 manual under the conditions for verbatim copying, provided that the
  50 entire resulting derived work is distributed under the terms of a
  51 permission notice identical to this one.
  52 @end titlepage
  53
  54 @ifnottex
  55 @c ==================================================================
  56 @node Top
  57 @top Top
  58
  59 @menu
  60 * Introduction::
  61 * About us::
  62 * Concept Index::               All used terms explained
  63 @end menu
  64 @end ifnottex
  65
  66 @c ==================================================================
  67 @node    Introduction
  68 @chapter Introduction
  69
  70 The MeshLink library allows applications that link to it to connect to other
  71 instances of itself, and exchange messages in a secure way. MeshLink provides
  72 end-to-end encryption and authentication of messages with perfect forward
  73 secrecy. The MeshLink library starts its own thread which handles all network
  74 communications. The application only needs to register callbacks to get
  75 notified of incoming messages and other important events.
  76
  77 This manual will contain information on how to compile the MeshLink library itself,
  78 as well as how to integrate the MeshLink library into your own applications.
  79
  80
  81 @c ==================================================================
  82 @node    About us
  83 @chapter About us
  84
  85
  86 @menu
  87 * Contact information::
  88 * Authors::
  89 @end menu
  90
  91
  92 @c ==================================================================
  93 @node    Contact information
  94 @section Contact information
  95
  96 The MeshLink website is at @url{http://meshlink.io/}.
  97
  98
  99 @c ==================================================================
 100 @node    Authors
 101 @section Authors
 102
 103 @table @asis
 104 @item Guus Sliepen (@email{guus@@meshlink.io})
 105 @end table
 106
 107 @c ==================================================================
 108 @node    Concept Index
 109 @unnumbered Concept Index
 110
 111 @c ==================================================================
 112 @printindex cp
 113
 114 @c ==================================================================
 115 @contents
 116 @bye