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