]> git.ipfire.org Git - people/ms/network.git/blob - man/network-port-batman-adv-port.8.in
batman-adv: Add documentation.
[people/ms/network.git] / man / network-port-batman-adv-port.8.in
1 .TH network-port-batman-adv-port 8 "11 Mar 2013" "@VERSION@" "network man page"
2
3 .SH NAME
4 network-port-batman-adv-port \- Network Configuration Control Program
5
6 .SH SYNOPSIS
7 \fBnetwork [OPTIONS] port create batman-adv-port ...\fR
8 .P
9 Parameters may be edited with the following command:
10 .P
11 \fBnetwork [OPTIONS] port <port> edit ...\fR
12
13 .SH DESCRIPTION
14 This hook configures a wireless device that is then used as a port
15 in the batman-adv hook.
16
17 .SH OPTIONS
18 The \fBbatman-adv-port\fR hook offers various configuration options:
19
20 \fB--address\fR = ...
21 .RS 4
22 Define the MAC address of the interface. If no address is defined,
23 a random one will be generated.
24 .RE
25 .PP
26
27 \fB--channel\fR = [0-9]+
28 .RS 4
29 Set the channel number of the channel that should be used for
30 the wireless network.
31 .RE
32 .PP
33
34 \fB--country-code\fR = ...
35 .RS 4
36 Set the country code for the wireless interface.
37 .RE
38 .PP
39
40 \fB--phy\fR = ...
41 .RS 4
42 Use this wireless phy to create the interface.
43 .RE
44 .PP
45
46 \fB--ssid\fR = ...
47 .RS 4
48 Define the ESSID of the wireless network.
49 .RE
50 .PP
51
52 \fB--mesh-id\fR = ...
53 .RS 4
54 Define the mesh id or BSSID of the wireless network.
55 .RE
56 .PP
57
58 .SH SEE ALSO
59 network(8), network-port-batman-adv(8)
60
61 .SH AUTHOR
62 Michael Tremer (michael.tremer@ipfire.org)