Show help for zone creation

[people/stevee/network.git] / man / network-port-batman-adv-port.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-port">
	<refentryinfo>
		<title>network-port-batman-adv-port</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-port</refentrytitle>
		<manvolnum>8</manvolnum>
	</refmeta>

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

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

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

	<refsect1>
		<title>Description</title>

		<para>
			This hook configures a wireless device that is then used as a port
			in the <emphasis>batman-adv</emphasis> hook.
		</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>--channel=<replaceable>NUMBER</replaceable></option>
				</term>

				<listitem>
					<para>
						Set the channel number of the channel that should be used
						for the wireless network.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--phy=<replaceable>PHY</replaceable></option>
				</term>

				<listitem>
					<para>
						Use this wireless phy to create the interface.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--ssid=<replaceable>SSID</replaceable></option>
				</term>

				<listitem>
					<para>
						Define the ESSID of the wireless network.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--mesh-id=<replaceable>MESH-ID</replaceable></option>
				</term>

				<listitem>
					<para>
						Define the mesh id or BSSID of the wireless network.
					</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</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>
		</para>
	</refsect1>
</refentry>