hostapd: Always qoute SSID

[people/ms/network.git] / man / network-zone-modem.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-zone-modem">
	<refentryinfo>
		<title>network-zone-modem</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-zone-modem</refentrytitle>
		<manvolnum>8</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>network-zone-modem</refname>
		<refpurpose>Network Configuration Control Program</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>network zone new <replaceable>ZONE</replaceable> modem ...</command>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>Description</title>

		<para>
			The modem hook uses a serial interface to establish a PPP session to an
			Internet Service Provider. This method is used by 56k modems and mobile
			networks like LTE, GSM and 3G.
		</para>
	</refsect1>

	<refsect1>
		<title>Options</title>

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

		<variablelist>
			<varlistentry>
				<term>
					<option>--device=<replaceable>DEVICE</replaceable></option>
				</term>

				<listitem>
					<para>
						Sets the serial device that is used to connect.
					</para>
					<para>
						Example: /dev/ttyUSB0
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--monitor-device=<replaceable>DEVICE</replaceable></option>
				</term>

				<listitem>
					<para>
						The optional monitor device is used to collect status
						information like signal strength and link quality while
						the connection is established.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--imsi=<replaceable>IMSI</replaceable></option>
				</term>

				<listitem>
					<para>
						Set the IMSI of the SIM card inside the wireless modem
						to identify it when it is plugged in at runtime.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--pin=<replaceable>PIN</replaceable></option>
				</term>

				<listitem>
					<para>
						The PIN number of the SIM card.
					</para>
					<para>
						This will be used to unlock the SIM card when it
						is locked.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--apn=<replaceable>APN</replaceable></option>
				</term>

				<listitem>
					<para>
						Sets the Access Point Name (<replaceable>APN</replaceable>)
						that the modem connects to.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--phone-number=<replaceable>PHONE-NUMBER</replaceable></option>
				</term>

				<listitem>
					<para>
						Sets the phone number that is dialed by the modem when
						the connection is to be established.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--username=<replaceable>USERNAME</replaceable></option>
				</term>

				<listitem>
					<para>
						Sets the username for authentication.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--password=<replaceable>PASSWORD</replaceable></option>
				</term>

				<listitem>
					<para>
						Sets the password for authentication.
					</para>
					<para>
						Use the <option>--auth=</option> option to transmit it
						in a secure manner to the provider.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--baudrate=<emphasis>921600</emphasis></option>
				</term>

				<listitem>
					<para>
						The baudrate for the serial link to the modem.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--mtu=<emphasis>N</emphasis></option>
				</term>

				<listitem>
					<para>
						Sets the default MTU of the PPP connection.
					</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>
					<option>--auth=[chap|pap]</option>
				</term>

				<listitem>
					<para>
						Define the authentication method that is used to
						authenticate against your provider.
						The default is to use the provider's preference.
					</para>
					<itemizedlist>
						<listitem>
							<para>
								<emphasis>Challange-Handshake Authentication Protocol</emphasis>
								(chap) is the preferred secure method.
							</para>
						</listitem>
						<listitem>
							<para>
								<emphasis>Password Authentication Protocol</emphasis>
								(pap) sends the plaintext password to the authentication
								server which is the reason why it should be avoided to use PAP.
							</para>
						</listitem>
					</itemizedlist>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

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

		<para>
			<citerefentry>
				<refentrytitle>network</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>,
			<citerefentry>
				<refentrytitle>network-zone</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>
		</para>
	</refsect1>
</refentry>