1 files changed, 63 insertions, 0 deletions
diff --git a/doc/wireless.html b/doc/wireless.html
new file mode 100644
index 0000000..d78d7b6
--- /dev/null
+++ b/doc/wireless.html
@@ -0,0 +1,63 @@
+<h1 id="wireless-connection-manual"
+>'wireless' Connection manual</h1
+><h2 id="description"
+>Description</h2
+><p
+>This connection method uses wireless_tools and wpa_supplicant to configure a wireless network connection.</p
+><p
+>The new 'wireless-dbus' connection method is preferred over this</p
+><p
+>This connection uses the 'ethernet' connection after successful association and thus supports all of it's options.</p
+><h2 id="options"
+>Options</h2
+><dl
+><dt
+  >INTERFACE (required)</dt
+  ><dd
+  >The wireless interface to configure</dd
+  ><dt
+  >SECURITY (required for security of 'wep', 'wpa' or 'wpa-config')</dt
+  ><dd
+  >One of 'wpa', 'wep', 'none' or 'wpa-config'. Defaults to 'none'</dd
+  ><dt
+  >KEY (required for SECURITY of 'wpa' or 'wep' only)</dt
+  ><dd
+  >Wireless encryption key.</dd
+  ><dt
+  >ESSID (this or AP is required)</dt
+  ><dd
+  >Name of network to connect to.</dd
+  ><dt
+  >AP (this or ESSID is required)</dt
+  ><dd
+  >AP of the network to connect to.</dd
+  ><dt
+  >TIMEOUT (optional)</dt
+  ><dd
+  >Time to wait for association. Defaults to 15 seconds.</dd
+  ><dt
+  >SCAN (optional)</dt
+  ><dd
+  >Scan for a wireless network rather than blindly attempting to connect. Hidden SSID networks do not appear in a scan. Enable with 'yes'. Defaults to 'no'.</dd
+  ><dt
+  >IWCONFIG (optional)</dt
+  ><dd
+  >Arguments to pass to iwconfig before attempting to configure the connection. For example, BSSID.</dd
+  ></dl
+><h3 id="wpa-options"
+>WPA options</h3
+><dl
+><dt
+  >WPA_CONF (for SECURITY of 'wpa-config' only)</dt
+  ><dd
+  >Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'</dd
+  ><dt
+  >WPA_OPTS</dt
+  ><dd
+  >Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwext'.</dd
+  ><dt
+  >WPA_GROUP</dt
+  ><dd
+  >Group that has authority for on-the-fly config files created when SECURITY=&quot;wpa&quot;</dd
+  ></dl
+>