Fix spelling errors (from lintian)
[grml-network.git] / man / grml-bridge.8
1 .TH grml-bridge 8
2 .SH "NAME"
3 grml-bridge \- set up your box as bridge
4 .SH SYNOPSIS
5 .B grml-bridge
6 .RI " start|stop|restart|info "
7 .SH DESCRIPTION
8 This manual page documents briefly the
9 .B grml-bridge
10 command.
11 .SH USAGE
12 Configure setup via configuration file /etc/grml/routersetup.
13 To specify which DEVICES should be bridged, use BRIDGE_DEVICES, e.g.
14
15   BRIDGE_DEVICES="eth0 eth1"
16
17 would bridge device eth0 and eth1. 
18 Note: The auto interface name is not allowed here!
19
20 To specify the name of the bridge, use BRIDGE_NAME, e.g.
21
22   BRIDGE_NAME="br0"
23
24 Note: this entry is optional, per default the name br0 is chosen.
25
26 If you want do disable Spanning Tree Protocol (STP) on your bridge, just set BRIDGE_STP to no, e.g.
27
28   BRIDGE_STP="no"
29
30 Per default stp is on.
31
32 Example Configuration file:
33
34   ,----[ /etc/grml/routersetup ]
35   | # Bridges eth0 and ath0 together
36   | BRIDGE_DEVICES="eth0 ath0"
37   |
38   | # Bridge name is grml-bridge
39   | BRIDGE_NAME="grml-bridge"
40   |
41   | # Disable stp
42   | BRIDGE_STP="no"
43   `----
44
45 Start the bridge:
46
47   ,----
48   | # grml-bridge start
49   `----
50
51 Now, your bridging device is up and running. Now you have to set the ip address of
52 your bridged devices to 0.0.0.0. You can do this with following command:
53
54   ,----
55   | source /etc/grml/routersetup
56   | for i in $BRIDGED_DEVICES ; do ifconfig $i 0.0.0.0 ; done
57   `----
58
59 Now your bridge is working. If you want that your bridge is reachable, please
60 give your bridge an IP address. You can do this for example with
61
62   ,----
63   | ifconfig grml-bridge 192.168.0.1
64   `----
65
66 Stop the bridge:
67
68   ,----
69   | # grml-bridge stop
70   `----
71
72 Note, your devices do not have an ip address, so you have to give them an ip address. You can do this with
73
74   ,----
75   | ifconfig eth1 $IP_ADDR
76   `----
77
78 .SH SEE ALSO
79 .BR grml-ap (8),
80 .BR grml-router (8).
81 .SH AUTHOR
82 grml-bridge was written by Ulrich Dangel <mru@grml.org> and Michael Prokop <mika@grml.org>.
83 .PP
84 This manual page was written by Michael Prokop
85 <mika@grml.org> for the Debian project (but may be used by others).