diff options
| -rw-r--r-- | docs/.gitignore | 3 | ||||
| -rw-r--r-- | docs/netcfg-profiles.txt | 59 |
2 files changed, 38 insertions, 24 deletions
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..3e5dd9b --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +*.1 +*.5 +*.8 diff --git a/docs/netcfg-profiles.txt b/docs/netcfg-profiles.txt index 12a13d7..6724ff2 100644 --- a/docs/netcfg-profiles.txt +++ b/docs/netcfg-profiles.txt @@ -62,9 +62,10 @@ Ethernet options reference ## Description This connection method uses the iproute suite of tools and dhcpcd to gain an IP address. -## Options IP (required for IPv4) -: Can be either 'static' or 'dhcp'. Static requires at least one of ADDR or IPCFG. +: Can be either 'static' or 'dhcp'. Static requires at least one of ADDR or IPCFG. + +## IPv4 options ADDR (requires IP of 'static') : A single IP address to configure a static IP. For example: GATEWAY (requires IP of 'static') @@ -72,13 +73,14 @@ GATEWAY (requires IP of 'static') NETMASK (requires IP of 'static') : Set specified netmask. Defaults to 24 ROUTES -: An array of custom routes (<address range> via <gateway>) +: An array of custom routes (of the form *address range* via *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. IFOPTS (deprecated, requires IP of 'static') -: Arguments to pass to 'ifconfig'. This allows you to use the syntax for the older 'ifconfig' tool. Retained for compatability. +: Arguments to pass to 'ifconfig'. This allows you to use the syntax + for the older 'ifconfig' tool. Retained for compatability. ## IPv6 options IP6 (required for IPv6) : Either 'dhcp', 'dhcp-noaddr', 'stateless', 'static'. Leave unset to disable IPv6. @@ -88,9 +90,9 @@ GATEWAY6 (for IP6=static) : The gateway address for IPv6 routing. ROUTES6 : An array of custom routes (of the form *address range* via *gateway*) -### DNS +### DNS configuration DNS -: Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers. +: Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers. SEARCH : "search" line for /etc/resolv.conf DOMAIN @@ -99,7 +101,7 @@ HOSTNAME : Set the system hostname. Ensure any hostname is correctly referenced in /etc/hosts. DNS1, DNS2 (deprecated) : First and second DNS servers for /etc/resolv.conf -### DHCP +### DHCP configuration DHCP_OPTIONS (ipv4) : String. Any extra arguments to pass to the dhcp client, presently dhcpcd. DHCP_TIMEOUT @@ -111,13 +113,13 @@ DHCLIENT_OPTIONS (ipv4) DHCLIENT6_OPTIONS (ipv6) : String. Extra options to pass to dhclient for IPv6. ### 802.11x Authentication -AUTH8021X -: Use 802.11x authentication. Enable with 'yes'. +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'. + option here must specify wpa_supplicant driver. Defaults to '-Dwired'. ## Examples ### Using ADDR and GATEWAY to set static IP and gateway @@ -125,7 +127,7 @@ WPA_OPTS (optional for an AUTH8021X of 'yes') 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" @@ -139,7 +141,7 @@ 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. +successful association and thus supports all of its options. ## Options SECURITY (required for security of 'wep', 'wpa', 'wpa-configsection' or 'wpa-config') @@ -155,26 +157,35 @@ HIDDEN (optional) ADHOC (optional) : Define this to use ad-hoc mode for wireless. TIMEOUT (optional) -: Time to wait for association. Defaults to 15 seconds. +: 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. +: 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 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_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. +: 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. +: 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 (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. +: 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. |