* Split out network related scripts into package grml-network,
[grml-scripts.git] / manpages / grml-ap.8
1 .TH grml-ap 8
2 .SH "NAME"
3 grml-ap \- set up your box as access point
4 .SH SYNOPSIS
5 .B grml-ap
6 .RI " start|stop|restart|info "
7 .SH DESCRIPTION
8 This manual page documents briefly the
9 .B grml-ap
10 command.
11 .SH NOTES
12 grml-ap uses the capabilities of your WLAN cards driver. Therefore
13 you need a card including drivers providing access point features.
14 atheros-based cards using the madwifi[-ng] drivers are known to work
15 very well.
16 .SH CONFIGURATION
17 Configure setup via configuration file /etc/grml/routersetup.
18 The variable AP_ESSID sets the essid of the accesspoint, if it is unset the essid grml-ap will be used by default.
19 The variable AP_ENC toggles the use of encryption; set it off (that is the default) if you do not want to use encryption at all or if you want to enable encryption set the encryption key via the AP_ENC variable.
20
21 .SH USAGE
22
23 On the server side (where running grml-ap):
24
25   ,----
26   | # grml-ap start
27   | # cat /etc/network/interfaces
28   | iface ap inet static
29   |   address 192.168.10.1
30   |   netmask 255.255.255.0
31   |   network 192.168.10.0
32   |   broadcast 192.168.10.255
33   | # ifup ath0=ap
34   | # grml-router start
35   `----
36
37 On the client side (assuming eth0 is your WLAN device):
38
39   ,----
40   | # cat /etc/network/interfaces
41   | iface ap inet static
42   |   address 192.168.10.2
43   |   netmask 255.255.255.0
44   |   network 192.168.10.0
45   |   broadcast 192.168.10.255
46   |   gateway 192.168.10.1
47   | # ifup eth0=ap
48   `----
49   
50 .SH SEE ALSO
51 .BR grml-bridge (8),
52 .BR grml-router (8).
53 .SH AUTHOR
54 grml-ap was written by Ulrich Dangel <schula@grml.org> and Michael Prokop <mika@grml.org>.
55 .PP
56 This manual page was written by Michael Prokop
57 <mika@grml.org> for the Debian project (but may be used by others).