diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ethernet-subr.html | 99 | ||||
| -rw-r--r-- | doc/ethernet.html | 87 | ||||
| -rw-r--r-- | doc/wireless | 7 | ||||
| -rw-r--r-- | doc/wireless-dbus | 6 | ||||
| -rw-r--r-- | doc/wireless-dbus.html | 53 | ||||
| -rw-r--r-- | doc/wireless.html | 63 |
6 files changed, 312 insertions, 3 deletions
diff --git a/doc/ethernet-subr.html b/doc/ethernet-subr.html new file mode 100644 index 0000000..3d74cf8 --- /dev/null +++ b/doc/ethernet-subr.html @@ -0,0 +1,99 @@ +<h1 id="ethernet-iproute-connection-manual" +>ethernet-iproute Connection manual</h1 +><h2 id="description" +>Description</h2 +><p +>This connection method uses the iproute suite of tools and dhcpcd to gain an IP address.</p +><h2 id="options" +>Options</h2 +><dl +><dt + >INTERFACE (required)</dt + ><dd + >The wireless interface to configure</dd + ><dt + >IP (required)</dt + ><dd + >Can be either 'static' or 'dhcp'. Static requires at least one of ADDR or IPCFG.</dd + ><dt + >ADDR (requires IP of 'static')</dt + ><dd + >A single IP address to configure a static IP. For example:</dd + ><dt + >GATEWAY (requires IP of 'static')</dt + ><dd + >Set specified gateway</dd + ><dt + >IPCFG</dt + ><dd + >Array of arguments to pass to 'ip'. The power of this options is that it allows both simple and complicated routing configurations, within the framework of netcfg.</dd + ></dl +><h3 id="dns" +>DNS</h3 +><dl +><dt + >DNS</dt + ><dd + >Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers.</dd + ><dt + >SEARCH</dt + ><dd + >"search" line for /etc/resolv.conf</dd + ><dt + >DOMAIN</dt + ><dd + >"domain" line for /etc/resolv.conf</dd + ><dt + >HOSTNAME</dt + ><dd + >Set the system hostname. Ensure any hostname is correctly referenced in /etc/hosts.</dd + ></dl +><h3 id="dhcp" +>DHCP</h3 +><dl +><dt + >DHCP_OPTIONS</dt + ><dd + >String. Any extra arguments to pass to the dhcp client, presently dhcpcd.</dd + ><dt + >DHCP_TIMEOUT</dt + ><dd + >Integer. Maximum time to try for a DHCP IP. Default is 10 seconds.</dd + ></dl +><h3 id="x-authentication" +>802.11x Authentication</h3 +><dl +><dt + >AUTH8021X</dt + ><dd + >Use 802.11x authentication. Enable with 'yes'.</dd + ><dt + >WPA_CONF (required for an AUTH8021X of 'yes' only)</dt + ><dd + >Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'</dd + ><dt + >WPA_OPTS (optional for an AUTH8021X of 'yes')</dt + ><dd + >Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwired'.</dd + ></dl +><h2 id="examples" +>Examples</h2 +><h3 id="using-addr-and-gateway-to-set-static-ip-and-gateway" +>Using ADDR and GATEWAY to set static IP and gateway</h3 +><pre +><code + >IP="static" +ADDR="192.168.1.23" +GATEWAY="192.168.1.1" +</code + ></pre +><h3 id="using-ipcfg-to-set-a-static-ip-and-gateway-with-custom-dns" +>Using IPCFG to set a static IP and gateway with custom DNS</h3 +><pre +><code + >IP="static" +IPCFG=("addr add dev eth0 192.168.1.23/24 brd +" "route add default via 192.168.1.1") +DNS=("208.67.222.222" "208.67.220.220") +</code + ></pre +> diff --git a/doc/ethernet.html b/doc/ethernet.html new file mode 100644 index 0000000..b2ab91a --- /dev/null +++ b/doc/ethernet.html @@ -0,0 +1,87 @@ +<h1 id="ethernet-manual" +>ethernet Manual</h1 +><h2 id="description" +>Description</h2 +><p +>This connection method uses the unmaintained net-tools (ifconfig) and dhcpcd to gain an IP address.</p +><h2 id="options" +>Options</h2 +><dl +><dt + >INTERFACE (required)</dt + ><dd + >The wireless interface to configure</dd + ><dt + >IP (required)</dt + ><dd + >Can be either 'static' or 'dhcp'. Static requires IFOPTS at least.</dd + ><dt + >IFOPTS</dt + ><dd + >Arguments to pass to 'ifconfig'.</dd + ><dt + >GATEWAY (requires IP of 'static')</dt + ><dd + >Set specified gateway</dd + ></dl +><h3 id="dns" +>DNS</h3 +><dl +><dt + >DNS</dt + ><dd + >Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers.</dd + ><dt + >DNS1, DNS2 (deprecated)</dt + ><dd + >Specify first and second nameservers.</dd + ><dt + >SEARCH</dt + ><dd + >"search" line for /etc/resolv.conf</dd + ><dt + >DOMAIN</dt + ><dd + >"domain" line for /etc/resolv.conf</dd + ><dt + >HOSTNAME</dt + ><dd + >Set the system hostname. Ensure any hostname is correctly referenced in /etc/hosts.</dd + ></dl +><h3 id="dhcp" +>DHCP</h3 +><dl +><dt + >DHCLIENT</dt + ><dd + >yes/no. Use dhclient instead of dhcpcd. Defaults to no.</dd + ><dt + >DHCP_OPTIONS</dt + ><dd + >String. Any extra arguments to pass to the dhcp client, presently dhcpcd.</dd + ><dt + >DHCP_TIMEOUT</dt + ><dd + >Integer. Maximum time to try for a DHCP IP. Default is 10 seconds.</dd + ></dl +><h3 id="x-authentication" +>802.11x Authentication</h3 +><dl +><dt + >AUTH8021X</dt + ><dd + >Use 802.11x authentication. Enable with 'yes'.</dd + ><dt + >WPA_CONF (required for an AUTH8021X of 'yes' only)</dt + ><dd + >Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'</dd + ><dt + >WPA_OPTS (optional for an AUTH8021X of 'yes')</dt + ><dd + >Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwired'.</dd + ></dl +><h2 id="examples" +>Examples</h2 +><p +>See /etc/network.d/examples</p +> diff --git a/doc/wireless b/doc/wireless index 20ced91..e1f649e 100644 --- a/doc/wireless +++ b/doc/wireless @@ -17,8 +17,10 @@ SECURITY (required for security of 'wep', 'wpa' or 'wpa-config') : One of 'wpa', 'wep', 'none' or 'wpa-config'. Defaults to 'none' KEY (required for SECURITY of 'wpa' or 'wep' only) : Wireless encryption key. -ESSID (required) +ESSID (this or AP is required) : Name of network to connect to. +AP (this or ESSID is required) +: AP of the network to connect to. TIMEOUT (optional) : Time to wait for association. Defaults to 15 seconds. SCAN (optional) @@ -31,3 +33,6 @@ WPA_CONF (for SECURITY of 'wpa-config' only) : Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf' WPA_OPTS : Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwext'. +WPA_GROUP +: Group that has authority for on-the-fly config files created when SECURITY="wpa" + diff --git a/doc/wireless-dbus b/doc/wireless-dbus index 918256d..bddd565 100644 --- a/doc/wireless-dbus +++ b/doc/wireless-dbus @@ -15,8 +15,10 @@ SECURITY (required) : One of 'wpa', 'wep', 'none' or 'wpa-config' KEY (required for SECURITY of 'wpa' or 'wep' only) : Wireless encryption key. -ESSID (required) -: Name of network to connect to. +ESSID (this or AP is required) +: Name of network to connect to. Note that for "wireless-dbus" profiles this is always a Gnu regexp (as interpreted by "expr"). +AP (this or ESSID is required) +: AP of the network to connect to. TIMEOUT : Time to wait for association. Defaults to 15 seconds. diff --git a/doc/wireless-dbus.html b/doc/wireless-dbus.html new file mode 100644 index 0000000..a2d2aea --- /dev/null +++ b/doc/wireless-dbus.html @@ -0,0 +1,53 @@ +<h1 id="wireless-dbus-connection-manual" +>'wireless-dbus' Connection manual</h1 +><h2 id="description" +>Description</h2 +><p +>This connection method uses wpa_supplicant's dbus interface to configure a wireless network connection.</p +><p +>This connection uses the 'ethernet-iproute' 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)</dt + ><dd + >One of 'wpa', 'wep', 'none' or 'wpa-config'</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. Note that for "wireless-dbus" profiles this is always a Gnu regexp (as interpreted by "expr").</dd + ><dt + >AP (this or ESSID is required)</dt + ><dd + >AP of the network to connect to.</dd + ><dt + >TIMEOUT</dt + ><dd + >Time to wait for association. Defaults to 15 seconds.</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_DRIVER</dt + ><dd + >wpa_supplicant driver to be used. Defaults to 'wext'</dd + ><dt + >WPA_OPTS</dt + ><dd + >Extra arguments for wpa_supplicant not specified otherwise.</dd + ></dl +> 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="wpa"</dd + ></dl +> |