--- /dev/null
+.\" -*-nroff-*-
+.\".
+.\" Manual for the peer database file format
+.\"
+.\" (c) 2008 Straylight/Edgeware
+.\"
+.
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of Trivial IP Encryption (TrIPE).
+.\"
+.\" TrIPE is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" TrIPE is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with TrIPE; if not, write to the Free Software Foundation,
+.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+.
+.\"--------------------------------------------------------------------------
+.so ../defs.man.in \"@@@PRE@@@
+.
+.\"--------------------------------------------------------------------------
+.TH peers.cdb 5 "27 March 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.
+.\"--------------------------------------------------------------------------
+.SH "NAME"
+.
+peers.cdb \- compiled peer database
+.
+.\"--------------------------------------------------------------------------
+.SH "DESCRIPTION"
+.
+The
+.B \*(/c/peers.cdb
+file is a
+.BR cdb (5)
+format database containing information about peers in the TrIPE network,
+and how to connect to them. It is set up by the
+.BR tripe-newpeers (8)
+program based on input in a
+.BR peers.in (5)
+file or files.
+.SS "Database records"
+The database contains four kinds of records. The type of record can be
+inferred from the first character of the record's key.
+.hP \*o
+.I "Peer records"
+have keys of the form
+.BI P name \fR.
+The record consists of a collection of key-value
+pairs in the
+.B form-urlencoded
+format specified by RFC1866, except that key-value pairs are separated
+by semicolon
+.RB ` ; '
+characters. Some of the keys have meaning to various tools and
+services; others are available for local use.
+.hP \*o
+.I "User records"
+have keys of the form
+.BI U name \fR.
+The record consists of a peer name (i.e., a name for which a
+.BI P name
+record exists); all characters are significant. User records are used
+by the
+.BR connect (8)
+service to map between user names presented to its
+.B PASSIVE
+command and peer names. No particular relationship between TrIPE user
+names and system users is necessary.
+.hP \*o
+.I "Local records"
+have keys of the form
+.BI $ key \fR.
+The record consists of key-value pairs in
+.B form-urlencoded
+format, just as for peer records. Their meaning is currently not
+defined.
+.hP \*o
+.I "Special records"
+have keys of the form
+.BI % key \fR.
+The record format is idiosyncratic. The special records currently
+defined are described below.
+.SS "Special records"
+The following special records are defined.
+.TP
+.B %AUTO
+The record contains a list of a space-separated list of peer names
+(i.e., names for which a
+.BI P name
+record exists). It is read by the
+.BR connect (8)
+service as a list of peers for which active connections should be made
+automatically.
+.
+.\"--------------------------------------------------------------------------
+.SH "SEE ALSO"
+.
+.BR cdb (5),
+.BR tripe (8).
+.PP
+.BR tripe-newpeers (8),
+.BR peers.in (5),
+.BR connect (8).
+.
+.\"--------------------------------------------------------------------------
+.SH "AUTHOR"
+.
+Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------
~mdw / tripe / blobdiff