chiark - git - mdw - tripe/blob - peerdb/tripe-newpeers.8.in

   1 .\" -*-nroff-*-
   2 .\".
   3 .\" Manual for the peer database compiler
   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 tripe-newpeers 8tripe "11 December 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
  31 .
  32 .\"--------------------------------------------------------------------------
  33 .SH "NAME"
  34 .
  35 tripe-newpeers \- compile peer database from sources
  36 .
  37 .\"--------------------------------------------------------------------------
  38 .SH "SYNOPSIS"
  39 .
  40 .B tripe-newpeers
  41 .RB [ \-c
  42 .IR cdb-file ]
  43 .IR input ...
  44 .
  45 .\"--------------------------------------------------------------------------
  46 .SH "DESCRIPTION"
  47 .
  48 The
  49 .BR tripe-newpeers (8)
  50 program reads in a number of configuration files in
  51 .BR peers.in (5)
  52 format, and writes a compiled version of the resulting database.  The
  53 program accepts the following options.
  54 .TP
  55 .B "\-h, \-\-help"
  56 Write a help message to standard output, and exit.
  57 .TP
  58 .B "\-v, \-\-version"
  59 Write the program's version number to standard output, and exit.
  60 .TP
  61 .BI "\-c, \-\-cdb=" cdb-file
  62 Write a compiled database in
  63 .BR cdb (5)
  64 format to
  65 .IR cdb-file .
  66 .PP
  67 In the absence of a
  68 .B \-c
  69 option,
  70 .B tripe-newpeers
  71 will write a textual representation of its database to standard output.
  72 The textual representation consists of a sequence of lines of the form
  73 .IP
  74 .IB key : value
  75 .PP
  76 This is unambiguous as long as peer names don't contain colons, since
  77 the values do not contain newlines.
  78 .PP
  79 The program reads all of the
  80 .I input
  81 configuration files listed on its command line.  If an
  82 .I input
  83 file name is
  84 .B \-
  85 then standard input is read.  If no filenames are given, and standard
  86 input is not a terminal, then standard input is read.  If no filenames
  87 are given and standard input
  88 .I is
  89 a terminal then an error message is issued.  The configuration files are
  90 all merged together as if they had been a single file.  The output
  91 database is constructed as described in
  92 .BR peers.in (5).
  93 .
  94 .\"--------------------------------------------------------------------------
  95 .SH "SEE ALSO"
  96 .
  97 .BR cdb (5),
  98 .BR tripe (8).
  99 .PP
 100 .BR peers.in (5),
 101 .BR peers.cdb (5),
 102 .BR connect (8).
 103 .BR watch (8).
 104 .BR tripe-ifup (8).
 105 .
 106 .\"--------------------------------------------------------------------------
 107 .SH "AUTHOR"
 108 .
 109 Mark Wooding, <mdw@distorted.org.uk>
 110 .
 111 .\"----- That's all, folks --------------------------------------------------