summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJames Rayner <james@archlinux.org>2009-10-19 14:52:29 +0200
committerJames Rayner <james@archlinux.org>2009-10-19 14:52:29 +0200
commitea1a71895e6b8776cc5f69372836feecbb767df0 (patch)
tree3ec2b8faa76b3ef84783903d4fba94b29f61e0b3 /doc
parent8f4bd8e28b4cad92388eb3afdd3860822baa797b (diff)
downloadnetctl-ea1a71895e6b8776cc5f69372836feecbb767df0.tar.gz
netctl-ea1a71895e6b8776cc5f69372836feecbb767df0.tar.xz
Documentation update
Diffstat (limited to 'doc')
-rw-r--r--doc/ethernet46
-rw-r--r--doc/ethernet-subr54
-rw-r--r--doc/wireless38
-rw-r--r--doc/wireless-dbus31
4 files changed, 0 insertions, 169 deletions
diff --git a/doc/ethernet b/doc/ethernet
deleted file mode 100644
index 9ede84b..0000000
--- a/doc/ethernet
+++ /dev/null
@@ -1,46 +0,0 @@
-% 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
deleted file mode 100644
index 761505a..0000000
--- a/doc/ethernet-subr
+++ /dev/null
@@ -1,54 +0,0 @@
-% 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
deleted file mode 100644
index e1f649e..0000000
--- a/doc/wireless
+++ /dev/null
@@ -1,38 +0,0 @@
-% 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 (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"
-
diff --git a/doc/wireless-dbus b/doc/wireless-dbus
deleted file mode 100644
index 886ea16..0000000
--- a/doc/wireless-dbus
+++ /dev/null
@@ -1,31 +0,0 @@
-% 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 (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
-: 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.