summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJouke Witteveen <j.witteveen@gmail.com>2015-01-12 16:07:22 +0100
committerJouke Witteveen <j.witteveen@gmail.com>2015-01-13 01:08:33 +0100
commit1f727e70efefc7a22dd86932f9be35a8727cf114 (patch)
tree788793cd7ee0de61ea7c3d127a501d26dcfa6a9c /docs
parentcf675b4ab8e56267b56e2d8bc2a30f87f3502abb (diff)
downloadnetctl-1f727e70efefc7a22dd86932f9be35a8727cf114.tar.gz
netctl-1f727e70efefc7a22dd86932f9be35a8727cf114.tar.xz
Minor documentation fixes
Diffstat (limited to 'docs')
-rw-r--r--docs/examples/ethernet-custom2
-rw-r--r--docs/examples/ethernet-dhcp3
-rw-r--r--docs/examples/mobile_ppp4
-rw-r--r--docs/examples/wireless-wep11
-rw-r--r--docs/examples/wireless-wep-string-key9
-rw-r--r--docs/examples/wireless-wpa4
-rw-r--r--docs/netctl.1.txt4
-rw-r--r--docs/netctl.profile.5.txt7
-rw-r--r--docs/netctl.special.7.txt4
9 files changed, 27 insertions, 21 deletions
diff --git a/docs/examples/ethernet-custom b/docs/examples/ethernet-custom
index d3a7b14..563fac0 100644
--- a/docs/examples/ethernet-custom
+++ b/docs/examples/ethernet-custom
@@ -5,3 +5,5 @@ IP=static
# Any valid iproute command can be placed in this array
IPCustom=('addr add dev eth0 192.168.1.23/24 brd +' 'route add default via 192.168.1.1')
DNS=('192.168.1.1')
+# Set a priority for automatic profile selection
+#Priority=10
diff --git a/docs/examples/ethernet-dhcp b/docs/examples/ethernet-dhcp
index 412ff88..b7eb872 100644
--- a/docs/examples/ethernet-dhcp
+++ b/docs/examples/ethernet-dhcp
@@ -2,7 +2,10 @@ Description='A basic dhcp ethernet connection'
Interface=eth0
Connection=ethernet
IP=dhcp
+#DHCPClient=dhcpcd
+#DHCPReleaseOnStop=no
## for DHCPv6
#IP6=dhcp
+#DHCP6Client=dhclient
## for IPv6 autoconfiguration
#IP6=stateless
diff --git a/docs/examples/mobile_ppp b/docs/examples/mobile_ppp
index 383e000..67036f1 100644
--- a/docs/examples/mobile_ppp
+++ b/docs/examples/mobile_ppp
@@ -14,11 +14,9 @@ Connection=mobile_ppp
# The access point name you are connecting to
AccessPointName=apn
-# If your device has a PIN code, set it here. Defaults to None
+# If your device has a PIN code, set it here. Defaults to 'None'
#Pin=None
# Mode can be one of 3Gpref, 3Gonly, GPRSpref, GPRSonly, None
# These only work for Huawei USB modems; all other devices should use None
Mode=3Gpref
-
-# vim:ft=dosini
diff --git a/docs/examples/wireless-wep b/docs/examples/wireless-wep
index afbd3e3..fd92d01 100644
--- a/docs/examples/wireless-wep
+++ b/docs/examples/wireless-wep
@@ -1,12 +1,17 @@
Description='A simple WEP encrypted wireless connection'
Interface=wlan0
Connection=wireless
+
Security=wep
+IP=dhcp
+
ESSID='MyNetwork'
-# Prepend \" to hexadecimal keys
+# Prepend \" to hexadecimal keys, but not to string keys
Key=\"1234567890abcdef
-IP=dhcp
+#Key='WirelessKey'
# Uncomment this if your ssid is hidden
#Hidden=yes
-# Uncomment if you are using an ad-hoc connection
+# Uncomment this if you are using an ad-hoc connection
#AdHoc=yes
+# Set a priority for automatic profile selection
+#Priority=10
diff --git a/docs/examples/wireless-wep-string-key b/docs/examples/wireless-wep-string-key
deleted file mode 100644
index e4c6af4..0000000
--- a/docs/examples/wireless-wep-string-key
+++ /dev/null
@@ -1,9 +0,0 @@
-Description='A simple WEP encrypted wireless connection'
-Interface=wlan0
-Connection=wireless
-Security=wep
-ESSID='MyNetwork'
-Key='Wireless Key'
-IP=dhcp
-# Uncomment this if your ssid is hidden
-#Hidden=yes
diff --git a/docs/examples/wireless-wpa b/docs/examples/wireless-wpa
index bb9fe36..779c817 100644
--- a/docs/examples/wireless-wpa
+++ b/docs/examples/wireless-wpa
@@ -1,8 +1,8 @@
Description='A simple WPA encrypted wireless connection'
Interface=wlan0
Connection=wireless
-Security=wpa
+Security=wpa
IP=dhcp
ESSID='MyNetwork'
@@ -12,3 +12,5 @@ ESSID='MyNetwork'
Key='WirelessKey'
# Uncomment this if your ssid is hidden
#Hidden=yes
+# Set a priority for automatic profile selection
+#Priority=10
diff --git a/docs/netctl.1.txt b/docs/netctl.1.txt
index 1f8b8cf..dc9f3bf 100644
--- a/docs/netctl.1.txt
+++ b/docs/netctl.1.txt
@@ -89,7 +89,9 @@ On success 0 is returned, a non-zero failure code otherwise.
ENVIRONMENT
-----------
'$NETCTL_DEBUG'::
- If set to +"yes"+, debugging output is generated.
+ If set to +"yes"+, debugging output is generated. +
+ The value of this variable is independent of the value of the
+ variable with the same name in profiles.
'$NETCTL_STATE_FILE'::
The location of the state file. Defaults to
'/var/lib/netctl/netctl.state'.
diff --git a/docs/netctl.profile.5.txt b/docs/netctl.profile.5.txt
index 212bbb7..6ad93a0 100644
--- a/docs/netctl.profile.5.txt
+++ b/docs/netctl.profile.5.txt
@@ -108,6 +108,9 @@ GENERAL OPTIONS
selection. Defaults to `++no++' for wireless and DHCP enabled
connections and to `++yes++' otherwise.
+'NETCTL_DEBUG='::
+ Set to `++yes++' to generate debugging output.
+
IP OPTIONS
----------
@@ -133,7 +136,7 @@ network. In particular, these connection types are +ethernet+,
'Gateway=' [requires 'IP=static']::
An IP routing gateway address.
-'Routes='::
+'Routes=()'::
An array of custom routes of the form +
`**<address range>** via **<gateway>**'.
@@ -146,7 +149,7 @@ network. In particular, these connection types are +ethernet+,
'Gateway6=' [requires 'IP6=static' or 'IP6=stateless']::
An IPv6 routing gateway address.
-'Routes6='::
+'Routes6=()'::
An array of custom routes of the form +
`**<address range>** via **<gateway>**'.
diff --git a/docs/netctl.special.7.txt b/docs/netctl.special.7.txt
index c61290c..a4e0911 100644
--- a/docs/netctl.special.7.txt
+++ b/docs/netctl.special.7.txt
@@ -46,8 +46,8 @@ netctl-sleep.service::
netctl-auto@<interface>.service::
This unit issues a scan on the interface it is used for and tries to
start a profile for a network it finds. It is targeted at wireless
- interfaces. Profile specific values for WPADriver are ignored, but
- it is possible to specify WPADriver in an interface hook
+ interfaces. Profile specific values for 'WPADriver' are ignored, but
+ it is possible to specify 'WPADriver=' in an interface hook
('/etc/netctl/interfaces/<interface>'). +
Use *netctl-auto*(1) instead of *netctl(1)* to control the automatic
profile selection when using this unit.