summaryrefslogtreecommitdiffstats
path: root/docs/wireless
diff options
context:
space:
mode:
authorRémy Oudompheng <remy@archlinux.org>2011-07-14 12:06:59 +0200
committerRémy Oudompheng <remy@archlinux.org>2011-07-14 12:06:59 +0200
commit25cfdc655d6e8eee89d48862029b96f07cade243 (patch)
treeabdf3ec9d6340924fd0c1bcf25ebea97707eb598 /docs/wireless
parent0fe676b10a8c13fd8e552f7fb56bc845aac7dd9b (diff)
downloadnetctl-25cfdc655d6e8eee89d48862029b96f07cade243.tar.gz
netctl-25cfdc655d6e8eee89d48862029b96f07cade243.tar.xz
Documentation overhaul.
Merge ethernet and wireless into a single netcfg-profiles.txt file aimed at gathering documentation for all connection types and profile writing. Signed-off-by: Rémy Oudompheng <remy@archlinux.org>
Diffstat (limited to 'docs/wireless')
-rw-r--r--docs/wireless47
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/wireless b/docs/wireless
deleted file mode 100644
index 2e466c7..0000000
--- a/docs/wireless
+++ /dev/null
@@ -1,47 +0,0 @@
-% WIRELESS netcfg manuals
-% Arch Linux
-%
-
-# Wireless options reference
-## Description
-This connection method uses wpa_supplicant to configure a wireless network connection. 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', 'wpa-configsection' or 'wpa-config')
-: One of 'wpa', 'wep', 'none', 'wpa-configsection' 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 (BSSID) of the network to connect to.
-HIDDEN (optional)
-: Define this to connect to hidden ESSIDs.
-ADHOC (optional)
-: Define this to use ad-hoc mode for wireless.
-TIMEOUT (optional)
-: Time to wait for association. Defaults to 15 seconds.
-SCAN (optional)
-: yes/no Scan for a wireless network rather than blindly attempting to connect. Hidden SSID networks do not appear in a scan.
-IWCONFIG (optional, deprecated)
-: Run iwconfig with these options before attempting to configure the connection.
-
-### 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.
-WPA_GROUP
-: Group that has authority to configure wpa_supplicant via it's control interface. Used in any configuration that is generated by netcfg.
-WPA_COUNTRY (optional, nl80211 based drivers)
-: The country where the device will be used. This allows wpa_supplicant to enforce any local regulatory limitations and will allow all appropriate channels/frequencies for your device.
-WPA_DRIVER (optional)
-: A comma-separated list of wpa_supplicant driver interfaces to try. Defaults to 'nl80211,wext'.
-
-### rfkill (Radio Kill Switch) options
-RFKILL
-: hard/soft A switch with physical on/off state that cannot be controlled via software is considered a 'hard' switch. Any switch that can be controlled via software is considered 'soft'.
-RFKILL_NAME
-: Some switches sysfs entries are not linked with the interface. To match them up, configure the name from /sys/class/rfkill/rfkillX/name here so that netcfg can identify which to control.