init: Introduce the peer database.

[tripe] / peerdb / tripe-newpeers.8.in

diff --git a/peerdb/tripe-newpeers.8.in b/peerdb/tripe-newpeers.8.in
new file mode 100644 (file)
index 0000000..17d0055
--- /dev/null
+++ b/peerdb/tripe-newpeers.8.in
@@ -0,0 +1,111 @@
+.\" -*-nroff-*-
+.\".
+.\" Manual for the peer database compiler
+.\"
+.\" (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 tripe-newpeers 8 "11 December 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.
+.\"--------------------------------------------------------------------------
+.SH "NAME"
+.
+tripe-newpeers \- compile peer database from sources
+.
+.\"--------------------------------------------------------------------------
+.SH "SYNOPSIS"
+.
+.B tripe-newpeers
+.RB [ \-c
+.IR cdb-file ]
+.IR input ...
+.
+.\"--------------------------------------------------------------------------
+.SH "DESCRIPTION"
+.
+The
+.BR tripe-newpeers (8)
+program reads in a number of configuration files in
+.BR peers.in (5)
+format, and writes a compiled version of the resulting database.  The
+program accepts the following options.
+.TP
+.B "\-h, \-\-help"
+Write a help message to standard output, and exit.
+.TP
+.B "\-v, \-\-version"
+Write the program's version number to standard output, and exit.
+.TP
+.BI "\-c, \-\-cdb=" cdb-file
+Write a compiled database in
+.BR cdb (5)
+format to
+.IR cdb-file .
+.PP
+In the absence of a
+.B \-c
+option,
+.B tripe-newpeers
+will write a textual representation of its database to standard output.
+The textual representation consists of a sequence of lines of the form
+.IP
+.IB key : value
+.PP
+This is unambiguous as long as peer names don't contain colons, since
+the values do not contain newlines.
+.PP
+The program reads all of the
+.I input
+configuration files listed on its command line.  If an
+.I input
+file name is
+.B \-
+then standard input is read.  If no filenames are given, and standard
+input is not a terminal, then standard input is read.  If no filenames
+are given and standard input
+.I is
+a terminal then an error message is issued.  The configuration files are
+all merged together as if they had been a single file.  The output
+database is constructed as described in
+.BR peers.in (5).
+.
+.\"--------------------------------------------------------------------------
+.SH "SEE ALSO"
+.
+.BR cdb (5),
+.BR tripe (8).
+.PP
+.BR peers.in (5),
+.BR peers.cdb (5),
+.BR connect (8).
+.BR watch (8).
+.BR tripe-ifup (8).
+.
+.\"--------------------------------------------------------------------------
+.SH "AUTHOR"
+.
+Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------