man/network-zone-wireless.xml

   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-zone-wireless">
   6         <refentryinfo>
   7                 <title>network-zone-wireless</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-zone-wireless</refentrytitle>
  22                 <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>network-zone-wireless</refname>
  27                 <refpurpose>Network Configuration Control Program</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>network zone new <replaceable>ZONE</replaceable> wireless ...</command>
  33                 </cmdsynopsis>
  34         </refsynopsisdiv>
  35
  36         <refsect1>
  37                 <title>Description</title>
  38
  39                 <para>
  40                         The wireless hook uses a WiFi interface and connects to a
  41                         wireless access point in station mode.
  42                 </para>
  43         </refsect1>
  44
  45         <refsect1>
  46                 <title>Options</title>
  47
  48                 <para>
  49                         The following options are understood:
  50                 </para>
  51
  52                 <variablelist>
  53                         <varlistentry>
  54                                 <term>
  55                                         <option>--phy=<replaceable>PHY</replaceable></option>
  56                                 </term>
  57
  58                                 <listitem>
  59                                         <para>
  60                                                 Takes the MAC address or name of the physical layer
  61                                                 that is used to create a virtual wireless interface.
  62                                         </para>
  63                                 </listitem>
  64                         </varlistentry>
  65
  66                         <varlistentry>
  67                                 <term>
  68                                         <option>--address=<replaceable>ADDRESS</replaceable></option>
  69                                 </term>
  70
  71                                 <listitem>
  72                                         <para>
  73                                                 Define a MAC address that is used for the virtual
  74                                                 wireless device. This parameter is optional and
  75                                                 a random MAC address will be generated when omitted.
  76                                         </para>
  77                                 </listitem>
  78                         </varlistentry>
  79
  80                         <varlistentry>
  81                                 <term>
  82                                         <option>--ssid=<replaceable>SSID</replaceable></option>
  83                                 </term>
  84
  85                                 <listitem>
  86                                         <para>
  87                                                 Connect to this SSID.
  88                                         </para>
  89                                 </listitem>
  90                         </varlistentry>
  91
  92                         <varlistentry>
  93                                 <term>
  94                                         <option>--encryption-mode=<replaceable>ALGO</replaceable></option>
  95                                 </term>
  96
  97                                 <listitem>
  98                                         <para>
  99                                                 Sets the encryption mode that is used to connect to the
 100                                                 wireless network.
 101                                         </para>
 102                                         <para>
 103                                                 <replaceable>ALGO</replaceable> can be one of the following:
 104                                         </para>
 105                                         <itemizedlist>
 106                                                 <listitem>
 107                                                         <para>
 108                                                                 <emphasis>WPA2-PSK</emphasis>
 109                                                                 WPA2 with pre-shared key
 110                                                         </para>
 111                                                 </listitem>
 112                                                 <listitem>
 113                                                         <para>
 114                                                                 <emphasis>WPA2-PSK-SHA256</emphasis>
 115                                                                 WPA2 with pre-shared key and stronger hash
 116                                                         </para>
 117                                                 </listitem>
 118                                                 <listitem>
 119                                                         <para>
 120                                                                 <emphasis>WPA-PSK</emphasis>
 121                                                                 WPA with pre-shared key
 122                                                         </para>
 123                                                 </listitem>
 124                                                 <listitem>
 125                                                         <para>
 126                                                                 <emphasis>WPA-PSK-SHA256</emphasis>
 127                                                                 WPA with pre-shared key and stronger hash
 128                                                         </para>
 129                                                 </listitem>
 130                                                 <listitem>
 131                                                         <para>
 132                                                                 <emphasis>WEP</emphasis>
 133                                                                 WEP
 134                                                         </para>
 135                                                 </listitem>
 136                                                 <listitem>
 137                                                         <para>
 138                                                                 <emphasis>8021X</emphasis>
 139                                                                 IEEE802.1X Wireless Enterprise
 140                                                         </para>
 141                                                 </listitem>
 142                                                 <listitem>
 143                                                         <para>
 144                                                                 <emphasis>NONE</emphasis>
 145                                                                 No encryption
 146                                                         </para>
 147                                                 </listitem>
 148                                         </itemizedlist>
 149                                 </listitem>
 150                         </varlistentry>
 151                 </variablelist>
 152         </refsect1>
 153
 154         <refsect1>
 155                 <title>See Also</title>
 156
 157                 <para>
 158                         <citerefentry>
 159                                 <refentrytitle>network</refentrytitle>
 160                                 <manvolnum>8</manvolnum>
 161                         </citerefentry>,
 162                         <citerefentry>
 163                                 <refentrytitle>network-zone</refentrytitle>
 164                                 <manvolnum>8</manvolnum>
 165                         </citerefentry>
 166                 </para>
 167         </refsect1>
 168 </refentry>