Import udp-broadcast-relay-0.3.tar.gz
[udp-broadcast-relay.git] / README
1 UDP Broadcast Packet Relay
2 ==============================
3
4 This program listens for packets on a specified UDP broadcast.
5 When a packet is received, it sends that packet to all
6 specified interfaces but the one it came from as though it
7 originated from the original sender.  
8
9 The primary purpose of this is to allow games on machines on
10 separated local networks (Ethernet, WLAN) that use udp broadcasts
11 to find each other to do so.
12
13 INSTALL
14 -------
15 make ; cp udp-broadcast-relay /some/where
16
17
18 USAGE
19 -----
20 /some/where/udp-broadcast-relay [-d] [-f] id udp-port eth0 eth1 ...
21
22 udp-broadcast-relay must be run as boot to be able to create a raw
23 socket (necessary) to send packets though they originated from the
24 original sender)
25
26
27 COMPATIBILITY
28 -------------
29 - I run debian woody with Linux 2.4.20, and here it works.
30
31
32 EXAMPLE
33 -------
34 /some/where/udp-broadcast-relay 6112  # forward Warcraft 3 broadcast packets
35
36
37 BUGS/CRITICISM/PATCHES/ETC
38 --------------------------
39 web:    http://www.joachim-breitner.de/udp_forward_relay/
40 e-mail: Joachim Breitner <mail@joachim-breitner.de>
41
42 HISTORY
43 ------
44 0.3     2003-09-28
45         Sending packets to ppp addresses too
46 0.2     2003-09-18      
47         Flags for debugging and forking
48         Compilefixes, Makefile-Target "clean"
49 0.1     2003-09-15
50         Initial rewrite of udp_broadcast_fw
51
52 CREDITS
53 -------
54 This is based upon udp_broadcast_fw:
55 Web: http://www.serverquery.com/udp_broadcast_fw/
56 Email: Nathan O'Sullivan <nathan@ausgamers.com>
57
58 HISTORY of udp_broadcast_fw
59 -------
60 0.1.1 - 19 Feb 02
61         Moved fork() code to just before main loop so that errors would appear
62 0.1   - 18 Feb 02
63         Initial release
64
65 LICENSE
66 -------
67 This code is made available under the GPL. Read COPYING for more info.