[people/stevee/network.git] / man / network-port-batman-adv.xml

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="network-port-batman-adv">
	<refentryinfo>
		<title>network-port-batman-adv</title>
		<productname>network</productname>

		<authorgroup>
			<author>
				<contrib>Developer</contrib>
				<firstname>Michael</firstname>
				<surname>Tremer</surname>
				<email>michael.tremer@ipfire.org</email>
			</author>
		</authorgroup>
	</refentryinfo>

	<refmeta>
		<refentrytitle>network-port-batman-adv</refentrytitle>
		<manvolnum>8</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>network-port-batman-adv</refname>
		<refpurpose>Network Configuration Control Program</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>network port create batman-adv ...</command>
		</cmdsynopsis>

		<cmdsynopsis>
			<command>network <arg choice="plain">PORT</arg> edit ...</command>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>Description</title>

		<para>
			The batman-adv hook creates a batman-adv soft interface, which is
			used to bridge several hard interfaces (wireless adapters, etc.).
		</para>
	</refsect1>

	<refsect1>
		<title>Options</title>

		<para>
			The following options are understood:
		</para>

		<variablelist>
			<varlistentry>
				<term>
					<option>--address=<replaceable>ADDRESS</replaceable></option>
				</term>

				<listitem>
					<para>
						Define the MAC address of the interface. If no address
						is defined, a random one will be generated.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--slaves=<replaceable>SLAVES</replaceable></option>
					(only on create)
				</term>

				<listitem>
					<para>
						Define a lits of port, which should be used as slaves.
						All slaves must be <emphasis>batman-adv-port</emphasis>
						ports.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--add-slave=<replaceable>SLAVE</replaceable></option>
					(only on edit)
				</term>

				<listitem>
					<para>
						Adds an additional slave port.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--del-slave=<replaceable>SLAVE</replaceable></option>
					(only on edit)
				</term>

				<listitem>
					<para>
						Removes a slave port.
					</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

	<refsect1>
		<title>See Also</title>

		<para>
			<citerefentry>
				<refentrytitle>network</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>,
			<citerefentry>
				<refentrytitle>network-port</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>,
			<citerefentry>
				<refentrytitle>network-port-batman-adv-port</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>
		</para>
	</refsect1>
</refentry>
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">
	6	<refentryinfo>
	7	<title>network-port-batman-adv</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</refentrytitle>
	22	<manvolnum>8</manvolnum>
	23	</refmeta>
	24
	25	<refnamediv>
	26	<refname>network-port-batman-adv</refname>
	27	<refpurpose>Network Configuration Control Program</refpurpose>
	28	</refnamediv>
	29
	30	<refsynopsisdiv>
	31	<cmdsynopsis>
	32	<command>network port create batman-adv ...</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	The batman-adv hook creates a batman-adv soft interface, which is
	45	used to bridge several hard interfaces (wireless adapters, etc.).
	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>--slaves=<replaceable>SLAVES</replaceable></option>
73	(only on create)
74	</term>
75
76	<listitem>
77	<para>
78	Define a lits of port, which should be used as slaves.
79	All slaves must be <emphasis>batman-adv-port</emphasis>
80	ports.
81	</para>
82	</listitem>
83	</varlistentry>
84
85	<varlistentry>
86	<term>
87	<option>--add-slave=<replaceable>SLAVE</replaceable></option>
88	(only on edit)
89	</term>
90
91	<listitem>
92	<para>
93	Adds an additional slave port.
94	</para>
95	</listitem>
96	</varlistentry>
97
98	<varlistentry>
99	<term>
100	<option>--del-slave=<replaceable>SLAVE</replaceable></option>
101	(only on edit)
102	</term>
103
104	<listitem>
105	<para>
106	Removes a slave port.
107	</para>
108	</listitem>
109	</varlistentry>
110	</variablelist>
111	</refsect1>
112
113	<refsect1>
114	<title>See Also</title>
115
116	<para>
117	<citerefentry>
118	<refentrytitle>network</refentrytitle>
119	<manvolnum>8</manvolnum>
120	</citerefentry>,
121	<citerefentry>
122	<refentrytitle>network-port</refentrytitle>
123	<manvolnum>8</manvolnum>
124	</citerefentry>,
125	<citerefentry>
126	<refentrytitle>network-port-batman-adv-port</refentrytitle>
127	<manvolnum>8</manvolnum>
128	</citerefentry>
129	</para>
130	</refsect1>
131	</refentry>