release/src/router/pptpd/README.bcrelay

   1 BCrelay v0.5 by Richard de Vroede <r.devroede@linvision.com>
   2 Original program by: TheyCallMeLuc(at)yahoo.com.au
   3 -------------------------------------------------------------------------------
   4 Index
   5 1. License
   6 2. What is it?
   7 3. Usage
   8 4. Contact
   9
  10 -------------------------------------------------------------------------------
  11 1. License
  12
  13 This program is free software; you can redistribute it and/or
  14 modify it under the terms of the GNU General Public License
  15 as published by the Free Software Foundation; either version 2
  16 of the License, or (at your option) any later version.
  17
  18 This program is distributed in the hope that it will be useful,
  19 but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 GNU General Public License for more details.
  22
  23 You should have received a copy of the GNU General Public License
  24 along with this program; if not, write to the Free Software
  25 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  26 Your copy is available at: http://www.gnu.org/licenses/gpl.html
  27
  28 -------------------------------------------------------------------------------
  29 2. What is it?
  30
  31 A broadcast packet repeater. This packet repeater (currently designed
  32 for udp packets) will listen for broadcast packets. When it receives
  33 the packets on the incoming interface, it will then re-broadcast them
  34 to the outgoing interface.
  35
  36 -------------------------------------------------------------------------------
  37 3. Usage
  38
  39 Usage: /usr/sbin/bcrelay [options], where options are:
  40
  41  [-d] [--daemon]           Run as daemon.
  42  [-h] [--help]             Displays this help message.
  43  [-i] [--incoming]         Defines from which interface broadcasts will be
  44                            relayed.
  45  [-o] [--outgoing]         Defines to which interface broadcasts will be
  46                            relayed.
  47  [-s] [--ipsec]            Defines an ipsec tunnel to be relayed to.
  48                            Since ipsec tunnels terminate on the same
  49                            interface, we need to define the broadcast
  50                            address of the other end-point of the
  51                            tunnel.  This is done as ipsec0:x.x.x.255
  52  [-v] [--version]          Displays the BCrelay version number.
  53
  54 Logs and debugging go to syslog as DAEMON.
  55
  56 Interfaces can be specified as regexpressions, ie. ppp[0-9]+
  57
  58 -------------------------------------------------------------------------------
  59 4. Contact
  60
  61 All comments, patches, improvements can be mailed to me, or the
  62 mailing list.  If it makes sense, I will update this package.
  63
  64 Richard de Vroede          : r.devroede@linvision.com
  65 Original author            : TheyCallMeLuc@yahoo.com.au
  66 Poptop Mailinglist         : poptop-server@lists.sourceforge.net
  67 Official Poptop website    : http://www.poptop.org
  68 SourceForge Poptop website : http://sourgeforge.net/projects/poptop
  69
  70 -------------------------------------------------------------------------------
  71
  72