From d60f370571af5413b6512b1dd40c7ace0e98ef54 Mon Sep 17 00:00:00 2001 From: James Rayner Date: Tue, 12 May 2009 23:14:40 +1000 Subject: Add documentation for both types of ethernet and wireless connections --- doc/.html | 0 doc/ethernet | 46 ++++++++++++++++++++++++++++++++++++++++++++++ doc/ethernet-subr | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/wireless | 33 +++++++++++++++++++++++++++++++++ doc/wireless-dbus | 29 +++++++++++++++++++++++++++++ 5 files changed, 162 insertions(+) create mode 100644 doc/.html create mode 100644 doc/ethernet create mode 100644 doc/ethernet-subr create mode 100644 doc/wireless create mode 100644 doc/wireless-dbus (limited to 'doc') diff --git a/doc/.html b/doc/.html new file mode 100644 index 0000000..e69de29 diff --git a/doc/ethernet b/doc/ethernet new file mode 100644 index 0000000..9ede84b --- /dev/null +++ b/doc/ethernet @@ -0,0 +1,46 @@ +% ETHERNET netcfg manuals +% Arch Linux +% + +# 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/ethernet-subr b/doc/ethernet-subr new file mode 100644 index 0000000..761505a --- /dev/null +++ b/doc/ethernet-subr @@ -0,0 +1,54 @@ +% ETHERNET-IPROUTE netcfg manuals +% Arch Linux +% + +# 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/wireless b/doc/wireless new file mode 100644 index 0000000..20ced91 --- /dev/null +++ b/doc/wireless @@ -0,0 +1,33 @@ +% WIRELESS netcfg manuals +% Arch Linux +% + +# '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 (required) +: Name of 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'. diff --git a/doc/wireless-dbus b/doc/wireless-dbus new file mode 100644 index 0000000..918256d --- /dev/null +++ b/doc/wireless-dbus @@ -0,0 +1,29 @@ +% WIRELESS-DBUS netcfg manuals +% Arch Linux +% + +# '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 (required) +: Name of 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. -- cgit v1.2.3-24-g4f1b