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