summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/examples/tunnel-he-ipv611
-rw-r--r--docs/examples/wireless-wpa5
-rw-r--r--docs/netcfg-profiles.txt23
3 files changed, 38 insertions, 1 deletions
diff --git a/docs/examples/tunnel-he-ipv6 b/docs/examples/tunnel-he-ipv6
new file mode 100644
index 0000000..21b4579
--- /dev/null
+++ b/docs/examples/tunnel-he-ipv6
@@ -0,0 +1,11 @@
+CONNECTION='tunnel'
+DESCRIPTION='A example ipv6 tunnel with Hurricane Electric'
+
+INTERFACE='he-ipv6'
+MODE='sit'
+REMOTE='216.66.80.26'
+#LOCAL='172.16.0.1'
+
+IP6='static'
+ADDR6='2001:470:1f08:d87::2/64'
+ROUTES6=('::/0')
diff --git a/docs/examples/wireless-wpa b/docs/examples/wireless-wpa
index 20f5509..e2511f3 100644
--- a/docs/examples/wireless-wpa
+++ b/docs/examples/wireless-wpa
@@ -2,8 +2,13 @@ CONNECTION='wireless'
DESCRIPTION='A simple WPA encrypted wireless connection'
INTERFACE='wlan0'
SECURITY='wpa'
+
ESSID='MyNetwork'
+## Uncomment if the supplied ESSID is hexadecimal
+#ESSID_TYPE='hex'
KEY='WirelessKey'
+
IP='dhcp'
+
# Uncomment this if your ssid is hidden
#HIDDEN=yes
diff --git a/docs/netcfg-profiles.txt b/docs/netcfg-profiles.txt
index 84cde8f..ae2391d 100644
--- a/docs/netcfg-profiles.txt
+++ b/docs/netcfg-profiles.txt
@@ -46,6 +46,8 @@ bridge
: Network bridge setup using **brctl**(8).
tuntap
: TUN/TAP interfaces.
+tunnel
+: Tunnel interfaces.
vlan
: VLAN setup.
openvpn
@@ -157,7 +159,12 @@ SECURITY (required for security of 'wep', 'wpa', 'wpa-configsection' or 'wpa-con
KEY (required for SECURITY of 'wpa' or 'wep' only)
: Wireless encryption key.
ESSID (this or AP is required)
-: Name of network to connect to.
+: Name of network to connect to, or hexadecimal digits (see
+ 'ESSID_TYPE')
+ESSID_TYPE (optional, defaults to 'ascii')
+: Set to 'ascii' or 'hex', if set to 'hex', ESSID will be interpreted
+ as an hexadecimal SSID and written unquoted to the wpa_supplicant
+ configuration file.
AP (this or ESSID is required)
: AP (BSSID) of the network to connect to.
HIDDEN (optional)
@@ -241,6 +248,20 @@ VLAN_PHYS_DEV
VLAN_ID
: See **ip**(8).
+Options for 'tunnel' connections
+================================
+
+Standard 'ethernet' options apply for IP configuration.
+
+INTERFACE
+: The name of the tunnel interface.
+MODE
+: The tunnel type (e.g. 'sit'). See **ip**(8) for available modes.
+LOCAL
+: The address of the local end of the tunnel.
+REMOTE
+: The address of the remote end of the tunnel.
+
Options for 'openvpn' connections
================================