From 54e39849f1e60eb043f9d8f0904acf3c79d96a1c Mon Sep 17 00:00:00 2001 From: James Rayner Date: Sat, 8 Aug 2009 00:23:45 +1000 Subject: Patch from Jim Pryor --- doc/ethernet-subr.html | 99 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ethernet.html | 87 ++++++++++++++++++++++++++++++++++++++++++++ doc/wireless | 7 +++- doc/wireless-dbus | 6 ++- doc/wireless-dbus.html | 53 +++++++++++++++++++++++++++ doc/wireless.html | 63 ++++++++++++++++++++++++++++++++ 6 files changed, 312 insertions(+), 3 deletions(-) create mode 100644 doc/ethernet-subr.html create mode 100644 doc/ethernet.html create mode 100644 doc/wireless-dbus.html create mode 100644 doc/wireless.html (limited to 'doc') 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 @@ +

ethernet-iproute Connection manual

Description

This connection method uses the iproute suite of tools and dhcpcd to gain an IP address.

Options

INTERFACE (required)
The wireless interface to configure
IP (required)
Can be either 'static' or 'dhcp'. Static requires at least one of ADDR or IPCFG.
ADDR (requires IP of 'static')
A single IP address to configure a static IP. For example:
GATEWAY (requires IP of 'static')
Set specified gateway
IPCFG
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.

DNS

DNS
Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers.
SEARCH
"search" line for /etc/resolv.conf
DOMAIN
"domain" line for /etc/resolv.conf
HOSTNAME
Set the system hostname. Ensure any hostname is correctly referenced in /etc/hosts.

DHCP

DHCP_OPTIONS
String. Any extra arguments to pass to the dhcp client, presently dhcpcd.
DHCP_TIMEOUT
Integer. Maximum time to try for a DHCP IP. Default is 10 seconds.

802.11x Authentication

AUTH8021X
Use 802.11x authentication. Enable with 'yes'.
WPA_CONF (required for an AUTH8021X of 'yes' only)
Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'
WPA_OPTS (optional for an AUTH8021X of 'yes')
Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwired'.

Examples

Using ADDR and GATEWAY to set static IP and gateway

IP="static"
+ADDR="192.168.1.23"
+GATEWAY="192.168.1.1"
+

Using IPCFG to set a static IP and gateway with custom DNS

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")
+
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 @@ +

ethernet Manual

Description

This connection method uses the unmaintained net-tools (ifconfig) and dhcpcd to gain an IP address.

Options

INTERFACE (required)
The wireless interface to configure
IP (required)
Can be either 'static' or 'dhcp'. Static requires IFOPTS at least.
IFOPTS
Arguments to pass to 'ifconfig'.
GATEWAY (requires IP of 'static')
Set specified gateway

DNS

DNS
Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers.
DNS1, DNS2 (deprecated)
Specify first and second nameservers.
SEARCH
"search" line for /etc/resolv.conf
DOMAIN
"domain" line for /etc/resolv.conf
HOSTNAME
Set the system hostname. Ensure any hostname is correctly referenced in /etc/hosts.

DHCP

DHCLIENT
yes/no. Use dhclient instead of dhcpcd. Defaults to no.
DHCP_OPTIONS
String. Any extra arguments to pass to the dhcp client, presently dhcpcd.
DHCP_TIMEOUT
Integer. Maximum time to try for a DHCP IP. Default is 10 seconds.

802.11x Authentication

AUTH8021X
Use 802.11x authentication. Enable with 'yes'.
WPA_CONF (required for an AUTH8021X of 'yes' only)
Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'
WPA_OPTS (optional for an AUTH8021X of 'yes')
Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwired'.

Examples

See /etc/network.d/examples

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 @@ +

'wireless-dbus' Connection manual

Description

This connection method uses wpa_supplicant's dbus interface to configure a wireless network connection.

This connection uses the 'ethernet-iproute' connection after successful association and thus supports all of it's options.

Options

INTERFACE (required)
The wireless interface to configure
SECURITY (required)
One of 'wpa', 'wep', 'none' or 'wpa-config'
KEY (required for SECURITY of 'wpa' or 'wep' only)
Wireless encryption key.
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.

WPA options

WPA_CONF (for SECURITY of 'wpa-config' only)
Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'
WPA_DRIVER
wpa_supplicant driver to be used. Defaults to 'wext'
WPA_OPTS
Extra arguments for wpa_supplicant not specified otherwise.
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 @@ +

'wireless' Connection manual

Description

This connection method uses wireless_tools and wpa_supplicant to configure a wireless network connection.

The new 'wireless-dbus' connection method is preferred over this

This connection uses the 'ethernet' connection after successful association and thus supports all of it's options.

Options

INTERFACE (required)
The wireless interface to configure
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 (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)
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'.
IWCONFIG (optional)
Arguments to pass to iwconfig before attempting to configure the connection. For example, BSSID.

WPA options

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"
-- cgit v1.2.3-24-g4f1b