d40523bc8524f45f617c09cecb73a8d56864032f
[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 udp-port
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 2116  # 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.1     2003-09-15
45         Initial rewrite of udp_broadcast_fw
46
47 CREDITS
48 -------
49 This is based upon udp_broadcast_fw:
50 Web: http://www.serverquery.com/udp_broadcast_fw/
51 Email: Nathan O'Sullivan <nathan@ausgamers.com>
52
53 HISTORY of udp_broadcast_fw
54 -------
55 0.1.1 - 19 Feb 02
56         Moved fork() code to just before main loop so that errors would appear
57 0.1   - 18 Feb 02
58         Initial release
59
60 LICENSE
61 -------
62 This code is made available under the GPL. Read COPYING for more info.