summaryrefslogtreecommitdiffstats
path: root/doc/ethernet-subr
diff options
context:
space:
mode:
authorJames Rayner <james@archlinux.org>2009-05-12 15:14:40 +0200
committerJames Rayner <james@archlinux.org>2009-05-12 15:14:40 +0200
commitd60f370571af5413b6512b1dd40c7ace0e98ef54 (patch)
tree936ab49e9e9d637ed02438dbd0e336831a8f28ea /doc/ethernet-subr
parentdd485367068c8451787045e14bc7ce8a1257135d (diff)
downloadnetctl-d60f370571af5413b6512b1dd40c7ace0e98ef54.tar.gz
netctl-d60f370571af5413b6512b1dd40c7ace0e98ef54.tar.xz
Add documentation for both types of ethernet and wireless connections
Diffstat (limited to 'doc/ethernet-subr')
-rw-r--r--doc/ethernet-subr54
1 files changed, 54 insertions, 0 deletions
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")