chiark - git - mdw - tripe/blob - peerdb/peers.cdb.5.in

   1 .\" -*-nroff-*-
   2 .\".
   3 .\" Manual for the peer database file format
   4 .\"
   5 .\" (c) 2008 Straylight/Edgeware
   6 .\"
   7 .
   8 .\"----- Licensing notice ---------------------------------------------------
   9 .\"
  10 .\" This file is part of Trivial IP Encryption (TrIPE).
  11 .\"
  12 .\" TrIPE is free software; you can redistribute it and/or modify
  13 .\" it under the terms of the GNU General Public License as published by
  14 .\" the Free Software Foundation; either version 2 of the License, or
  15 .\" (at your option) any later version.
  16 .\"
  17 .\" TrIPE is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public License
  23 .\" along with TrIPE; if not, write to the Free Software Foundation,
  24 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25 .
  26 .\"--------------------------------------------------------------------------
  27 .so ../defs.man.in \"@@@PRE@@@
  28 .
  29 .\"--------------------------------------------------------------------------
  30 .TH peers.cdb 5 "27 March 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
  31 .
  32 .\"--------------------------------------------------------------------------
  33 .SH "NAME"
  34 .
  35 peers.cdb \- compiled peer database
  36 .
  37 .\"--------------------------------------------------------------------------
  38 .SH "DESCRIPTION"
  39 .
  40 The
  41 .B \*(/c/peers.cdb
  42 file is a
  43 .BR cdb (5)
  44 format database containing information about peers in the TrIPE network,
  45 and how to connect to them.  It is set up by the
  46 .BR tripe-newpeers (8)
  47 program based on input in a
  48 .BR peers.in (5)
  49 file or files.
  50 .SS "Database records"
  51 The database contains four kinds of records.  The type of record can be
  52 inferred from the first character of the record's key.
  53 .hP \*o
  54 .I "Peer records"
  55 have keys of the form
  56 .BI P name \fR.
  57 The record consists of a collection of key-value
  58 pairs in the
  59 .B form-urlencoded
  60 format specified by RFC1866, except that key-value pairs are separated
  61 by semicolon
  62 .RB ` ; '
  63 characters.  Some of the keys have meaning to various tools and
  64 services; others are available for local use.
  65 .hP \*o
  66 .I "User records"
  67 have keys of the form
  68 .BI U name \fR.
  69 The record consists of a peer name (i.e., a name for which a
  70 .BI P name
  71 record exists); all characters are significant.  User records are used
  72 by the
  73 .BR connect (8)
  74 service to map between user names presented to its
  75 .B PASSIVE
  76 command and peer names.  No particular relationship between TrIPE user
  77 names and system users is necessary.
  78 .hP \*o
  79 .I "Local records"
  80 have keys of the form
  81 .BI $ key \fR.
  82 The record consists of key-value pairs in
  83 .B form-urlencoded
  84 format, just as for peer records.  Their meaning is currently not
  85 defined.
  86 .hP \*o
  87 .I "Special records"
  88 have keys of the form
  89 .BI % key \fR.
  90 The record format is idiosyncratic.  The special records currently
  91 defined are described below.
  92 .SS "Special records"
  93 The following special records are defined.
  94 .TP
  95 .B %AUTO
  96 The record contains a list of a space-separated list of peer names
  97 (i.e., names for which a
  98 .BI P name
  99 record exists).  It is read by the
 100 .BR connect (8)
 101 service as a list of peers for which active connections should be made
 102 automatically.
 103 .
 104 .\"--------------------------------------------------------------------------
 105 .SH "SEE ALSO"
 106 .
 107 .BR cdb (5),
 108 .BR tripe (8).
 109 .PP
 110 .BR tripe-newpeers (8),
 111 .BR peers.in (5),
 112 .BR connect (8).
 113 .
 114 .\"--------------------------------------------------------------------------
 115 .SH "AUTHOR"
 116 .
 117 Mark Wooding, <mdw@distorted.org.uk>
 118 .
 119 .\"----- That's all, folks --------------------------------------------------