Update README from webpage
authorJoachim Breitner <mail@joachim-breitner.de>
Sun, 28 Sep 2003 19:01:45 +0000 (21:01 +0200)
committerJoachim Breitner <mail@joachim-breitner.de>
Mon, 21 Oct 2013 21:12:47 +0000 (23:12 +0200)
README

diff --git a/README b/README
index 579e482..2e87e42 100644 (file)
--- a/README
+++ b/README
@@ -1,67 +1,78 @@
-UDP Broadcast Packet Relay
-==============================
 
-This program listens for packets on a specified UDP broadcast.
-When a packet is received, it sends that packet to all
-specified interfaces but the one it came from as though it
-originated from the original sender.  
+   Download Back to my Website
 
-The primary purpose of this is to allow games on machines on
-separated local networks (Ethernet, WLAN) that use udp broadcasts
-to find each other to do so.
+                          UDP Broadcast Packet Relay
+
+   This program listens for packets on a specified UDP broadcast port.
+   When a packet is received, it sends that packet to all specified
+   interfaces but the one it came from as though it originated from the
+   original sender.
+
+   The primary purpose of this is to allow games on machines on separated
+   local networks (Ethernet, WLAN) that use udp broadcasts to find each
+   other to do so.
+
+   It also works on ppp links, so you can log in from windows boxes (e.g.
+   using pptp) and play LAN-based games together. Currently, you have to
+   care about upcoming or downgoing interfaces yourself.
 
 INSTALL
--------
-make ; cp udp-broadcast-relay /some/where
 
+   make ; cp udp-broadcast-relay /some/where
 
 USAGE
------
-/some/where/udp-broadcast-relay [-d] [-f] id udp-port eth0 eth1 ...
 
-udp-broadcast-relay must be run as boot to be able to create a raw
-socket (necessary) to send packets though they originated from the
-original sender)
+   /some/where/udp-broadcast-relay id udp-port eth0 eth1...
 
+   udp-broadcast-relay must be run as boot to be able to create a raw
+   socket (necessary) to send packets as though they originated from the
+   original sender.
 
 COMPATIBILITY
--------------
-- I run debian woody with Linux 2.4.20, and here it works.
 
+     * I run debian woody with Linux 2.4.20, and here it works.
 
 EXAMPLE
--------
-/some/where/udp-broadcast-relay 6112  # forward Warcraft 3 broadcast packets
 
+   /some/where/udp-broadcast-relay -f 1 6112 eth0 eth1 # forward Warcraft
+   3 broadcast packets
 
 BUGS/CRITICISM/PATCHES/ETC
---------------------------
-web:   http://www.joachim-breitner.de/udp_forward_relay/
-e-mail: Joachim Breitner <mail@joachim-breitner.de>
+
+   web
+          http://www.joachim-breitner.de/udp_broadcast_relay/
+
+   e-mail
+          Joachim Breitner <mail@joachim-breitner.de>
 
 HISTORY
-------
-0.3    2003-09-28
-       Sending packets to ppp addresses too
-0.2    2003-09-18      
-       Flags for debugging and forking
-       Compilefixes, Makefile-Target "clean"
-0.1    2003-09-15
-       Initial rewrite of udp_broadcast_fw
+
+   0.3 2003-09-28
+          Sending packets also to ppp addresses
+
+   0.2 2003-09-18
+          Flags for debugging and forking, Compilefixes, Makefile-Target
+          "clean"
+
+   0.1 2003-09-15
+          Initial rewrite of udp_broadcast_fw
 
 CREDITS
--------
-This is based upon udp_broadcast_fw:
-Web: http://www.serverquery.com/udp_broadcast_fw/
-Email: Nathan O'Sullivan <nathan@ausgamers.com>
+
+   This is based upon udp_broadcast_fw:
+   Web: http://www.serverquery.com/udp_broadcast_fw/
+   Email: Nathan O'Sullivan
 
 HISTORY of udp_broadcast_fw
--------
-0.1.1 - 19 Feb 02
-       Moved fork() code to just before main loop so that errors would appear
-0.1   - 18 Feb 02
-       Initial release
+
+   0.1.1 - 19 Feb 02
+          Moved fork() code to just before main loop so that errors would
+          appear
+
+   0.1 - 18 Feb 02
+          Initial release
 
 LICENSE
--------
-This code is made available under the GPL. Read COPYING for more info.
+
+   This code is made available under the GPL. Read the COPYING file
+   inside the archive for more info.