]>
Commit | Line | Data |
---|---|---|
a2a6f759 MT |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-port-batman-adv-port"> | |
6 | <refentryinfo> | |
7 | <title>network-port-batman-adv-port</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-port-batman-adv-port</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-port-batman-adv-port</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network port create batman-adv-port ...</command> | |
33 | </cmdsynopsis> | |
34 | ||
35 | <cmdsynopsis> | |
36 | <command>network <arg choice="plain">PORT</arg> edit ...</command> | |
37 | </cmdsynopsis> | |
38 | </refsynopsisdiv> | |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
43 | <para> | |
44 | This hook configures a wireless device that is then used as a port | |
45 | in the <emphasis>batman-adv</emphasis> hook. | |
46 | </para> | |
47 | </refsect1> | |
48 | ||
49 | <refsect1> | |
50 | <title>Options</title> | |
51 | ||
52 | <para> | |
53 | The following options are understood: | |
54 | </para> | |
55 | ||
56 | <variablelist> | |
57 | <varlistentry> | |
58 | <term> | |
59 | <option>--address=<replaceable>ADDRESS</replaceable></option> | |
60 | </term> | |
61 | ||
62 | <listitem> | |
63 | <para> | |
64 | Define the MAC address of the interface. If no address | |
65 | is defined, a random one will be generated. | |
66 | </para> | |
67 | </listitem> | |
68 | </varlistentry> | |
69 | ||
70 | <varlistentry> | |
71 | <term> | |
72 | <option>--channel=<replaceable>NUMBER</replaceable></option> | |
73 | </term> | |
74 | ||
75 | <listitem> | |
76 | <para> | |
77 | Set the channel number of the channel that should be used | |
78 | for the wireless network. | |
79 | </para> | |
80 | </listitem> | |
81 | </varlistentry> | |
82 | ||
a2a6f759 MT |
83 | <varlistentry> |
84 | <term> | |
85 | <option>--phy=<replaceable>PHY</replaceable></option> | |
86 | </term> | |
87 | ||
88 | <listitem> | |
89 | <para> | |
90 | Use this wireless phy to create the interface. | |
91 | </para> | |
92 | </listitem> | |
93 | </varlistentry> | |
94 | ||
95 | <varlistentry> | |
96 | <term> | |
97 | <option>--ssid=<replaceable>SSID</replaceable></option> | |
98 | </term> | |
99 | ||
100 | <listitem> | |
101 | <para> | |
102 | Define the ESSID of the wireless network. | |
103 | </para> | |
104 | </listitem> | |
105 | </varlistentry> | |
106 | ||
107 | <varlistentry> | |
108 | <term> | |
109 | <option>--mesh-id=<replaceable>MESH-ID</replaceable></option> | |
110 | </term> | |
111 | ||
112 | <listitem> | |
113 | <para> | |
114 | Define the mesh id or BSSID of the wireless network. | |
115 | </para> | |
116 | </listitem> | |
117 | </varlistentry> | |
118 | </variablelist> | |
119 | </refsect1> | |
120 | ||
121 | <refsect1> | |
122 | <title>See Also</title> | |
123 | ||
124 | <para> | |
125 | <citerefentry> | |
126 | <refentrytitle>network</refentrytitle> | |
127 | <manvolnum>8</manvolnum> | |
128 | </citerefentry>, | |
129 | <citerefentry> | |
130 | <refentrytitle>network-port</refentrytitle> | |
131 | <manvolnum>8</manvolnum> | |
132 | </citerefentry>, | |
133 | <citerefentry> | |
134 | <refentrytitle>network-port-batman-adv</refentrytitle> | |
135 | <manvolnum>8</manvolnum> | |
136 | </citerefentry> | |
137 | </para> | |
138 | </refsect1> | |
139 | </refentry> |