Rationalize source tree hierarchy.

17 files changed, 219 insertions, 0 deletions

diff --git a/docs/examples/bridge b/docs/examples/bridge
new file mode 100644
index 0000000..bd422fa
--- /dev/null
+++ b/docs/examples/bridge
@@ -0,0 +1,9 @@
+INTERFACE="br0"
+CONNECTION="bridge"
+DESCRIPTION="Example Bridge connection"
+BRIDGE_INTERFACES="eth0 eth1 tap0"
+IP="dhcp"
+## sets forward delay time
+#FWD_DELAY=0
+## sets max age of hello message
+#MAX_AGE=10
diff --git a/docs/examples/ethernet-dhcp b/docs/examples/ethernet-dhcp
new file mode 100644
index 0000000..0719632
--- /dev/null
+++ b/docs/examples/ethernet-dhcp
@@ -0,0 +1,9 @@
+CONNECTION='ethernet'
+DESCRIPTION='A basic dhcp ethernet connection using iproute'
+INTERFACE='eth0'
+IP='dhcp'
+## for DHCPv6
+#IP6='dhcp'
+## for IPv6 autoconfiguration
+#IP6='stateless'
+
diff --git a/docs/examples/ethernet-iproute b/docs/examples/ethernet-iproute
new file mode 100644
index 0000000..d22dd17
--- /dev/null
+++ b/docs/examples/ethernet-iproute
@@ -0,0 +1,7 @@
+CONNECTION='ethernet'
+DESCRIPTION='A more versatile static ethernet connection using iproute'
+INTERFACE='eth0'
+IP='static'
+# Any valid iproute command can be placed in this array
+IPCFG=('addr add dev eth0 192.168.1.23/24 brd +' 'route add default via 192.168.1.1') 
+DNS=('192.168.1.1')
diff --git a/docs/examples/ethernet-static b/docs/examples/ethernet-static
new file mode 100644
index 0000000..250896d
--- /dev/null
+++ b/docs/examples/ethernet-static
@@ -0,0 +1,14 @@
+CONNECTION='ethernet'
+DESCRIPTION='A basic static ethernet connection using iproute'
+INTERFACE='eth0'
+IP='static'
+ADDR='192.168.1.23'
+#ROUTES=('192.168.0.0/24 via 192.168.1.2')
+GATEWAY='192.168.1.1'
+DNS=('192.168.1.1')
+
+## For IPv6 static address configuration
+#IP6='static'
+#ADDR6=('1234:5678:9abc:def::1/64' '1234:3456::123/96')
+#ROUTES6=('abcd::1234')
+#GATEWAY6='1234:0:123::abcd'
diff --git a/docs/examples/openvpn b/docs/examples/openvpn
new file mode 100644
index 0000000..b6106aa
--- /dev/null
+++ b/docs/examples/openvpn
@@ -0,0 +1,5 @@
+CONNECTION="openvpn"
+INTERFACE="ignore"
+OVPN_CONFIG="/etc/openvpn/example/openvpn.conf"
+OVPN_PID_FILE="/tmp/openvpn.example.pid"
+OVPN_FLAGS=""
diff --git a/docs/examples/ppp b/docs/examples/ppp
new file mode 100644
index 0000000..dfb6bc1
--- /dev/null
+++ b/docs/examples/ppp
@@ -0,0 +1,4 @@
+CONNECTION='ppp'
+INTERFACE='ignore'
+PEER='provider'
+PPP_TIMEOUT=10
diff --git a/docs/examples/tuntap b/docs/examples/tuntap
new file mode 100644
index 0000000..2917875
--- /dev/null
+++ b/docs/examples/tuntap
@@ -0,0 +1,6 @@
+INTERFACE='tun0'
+CONNECTION='tuntap'
+MODE='tun'
+USER='nobody'
+GROUP='nobody'
+
diff --git a/docs/examples/vlan-dhcp b/docs/examples/vlan-dhcp
new file mode 100644
index 0000000..8c6ad23
--- /dev/null
+++ b/docs/examples/vlan-dhcp
@@ -0,0 +1,5 @@
+INTERFACE="eth0.55"
+VLAN_PHYS_DEV="eth0"
+VLAN_ID="55"
+CONNECTION="vlan"
+IP="dhcp"
diff --git a/docs/examples/vlan-static b/docs/examples/vlan-static
new file mode 100644
index 0000000..b7b9753
--- /dev/null
+++ b/docs/examples/vlan-static
@@ -0,0 +1,12 @@
+INTERFACE="eth0.11"
+VLAN_PHYS_DEV="eth0"
+VLAN_ID="11"
+CONNECTION="vlan"
+IP="static"
+ADDR="192.168.0.100"
+NETMASK="255.255.255.0"
+GATEWAY="192.168.0.1"
+DNS=("192.168.0.2")
+HOSTNAME="myhost"
+DOMAIN="mydomain.com"
+SEARCH="mydomain.com"
diff --git a/docs/examples/wireless-open b/docs/examples/wireless-open
new file mode 100644
index 0000000..db8d6ef
--- /dev/null
+++ b/docs/examples/wireless-open
@@ -0,0 +1,8 @@
+CONNECTION='wireless'
+DESCRIPTION='A simple opened wireless connection'
+INTERFACE='wlan0'
+SECURITY='none'
+ESSID='MyNetwork'
+IP='dhcp'
+# Uncomment this if your ssid is hidden
+#HIDDEN=yes
diff --git a/docs/examples/wireless-wep b/docs/examples/wireless-wep
new file mode 100644
index 0000000..b16f65e
--- /dev/null
+++ b/docs/examples/wireless-wep
@@ -0,0 +1,11 @@
+CONNECTION='wireless'
+DESCRIPTION='A simple WEP encrypted wireless connection'
+INTERFACE='wlan0'
+SECURITY='wep'
+ESSID='MyNetwork'
+KEY='1234567890'
+IP='dhcp'
+# Uncomment this if your ssid is hidden
+#HIDDEN=yes
+## Uncomment if you are using an ad-hoc connection
+#ADHOC=1
diff --git a/docs/examples/wireless-wep-string-key b/docs/examples/wireless-wep-string-key
new file mode 100644
index 0000000..ebc4b0a
--- /dev/null
+++ b/docs/examples/wireless-wep-string-key
@@ -0,0 +1,9 @@
+CONNECTION='wireless'
+DESCRIPTION='A simple WEP encrypted wireless connection'
+INTERFACE='wlan0'
+SECURITY='wep'
+ESSID='MyNetwork'
+KEY='s: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
new file mode 100644
index 0000000..20f5509
--- /dev/null
+++ b/docs/examples/wireless-wpa
@@ -0,0 +1,9 @@
+CONNECTION='wireless'
+DESCRIPTION='A simple WPA encrypted wireless connection'
+INTERFACE='wlan0'
+SECURITY='wpa'
+ESSID='MyNetwork'
+KEY='WirelessKey'
+IP='dhcp' 
+# Uncomment this if your ssid is hidden
+#HIDDEN=yes
diff --git a/docs/examples/wireless-wpa-config b/docs/examples/wireless-wpa-config
new file mode 100644
index 0000000..955d845
--- /dev/null
+++ b/docs/examples/wireless-wpa-config
@@ -0,0 +1,8 @@
+CONNECTION='wireless'
+DESCRIPTION='A wpa_supplicant configuration based wireless connection'
+INTERFACE='wlan0'
+SECURITY='wpa-config'
+WPA_CONF='/etc/wpa_supplicant.conf'
+IP='dhcp' 
+# Uncomment this if your ssid is hidden
+#HIDDEN=yes
diff --git a/docs/examples/wireless-wpa-configsection b/docs/examples/wireless-wpa-configsection
new file mode 100644
index 0000000..d6cc8ad
--- /dev/null
+++ b/docs/examples/wireless-wpa-configsection
@@ -0,0 +1,17 @@
+CONNECTION='wireless'
+INTERFACE=wlan0
+SECURITY='wpa-configsection'
+# Uncomment this if your ssid is hidden
+#HIDDEN=yes
+IP='dhcp'
+CONFIGSECTION='
+    ssid="University"
+    key_mgmt=WPA-EAP
+    eap=TTLS
+    group=TKIP
+    pairwise=TKIP CCMP
+    anonymous_identity="anonymous"
+    identity="myusername"
+    password="mypassword"
+    priority=1
+    phase2="auth=PAP"'
diff --git a/docs/examples/wireless-wpa-static b/docs/examples/wireless-wpa-static
new file mode 100644
index 0000000..25da514
--- /dev/null
+++ b/docs/examples/wireless-wpa-static
@@ -0,0 +1,12 @@
+CONNECTION='wireless'
+DESCRIPTION='A simple WPA encrypted wireless connection using a static IP'
+INTERFACE='wlan0'
+SECURITY='wpa'
+ESSID='MyNetwork'
+KEY='WirelessKey'
+IP='static' # Any other CONNECTION='ethernet' options may be used.
+ADDR='192.168.1.23'
+GATEWAY='192.168.1.1'
+DNS=('192.168.1.1')
+# Uncomment this if your ssid is hidden
+#HIDDEN=yes
diff --git a/docs/man/netcfg.8 b/docs/man/netcfg.8
new file mode 100644
index 0000000..5bbab66
--- /dev/null
+++ b/docs/man/netcfg.8
@@ -0,0 +1,74 @@
+.TH NETCFG 8 "AUGUST 2009" "Arch Linux" "Network Scripts"
+.\" groff -man -Tascii foo.1 
+.SH NAME
+netcfg \- start/stop/control network profiles
+.SH SYNOPSIS
+netcfg [\fIoptions\fR] \fBprofile\fR
+
+netcfg \fBprofile\fR
+.SH DESCRIPTION
+\fBnetcfg\fP is used to configure and manage network connections via profiles. It has pluggable support for a range of connection types, such as wireless, ethernet. ppp. It is also capable of starting/stopping many to one connections, that is, multiple connections within the same profile, optionally with bonding. 
+
+It may be run at boot, by enabling the \fI/etc/rc.d/net-profiles\fP daemon in \fI/etc/rc.conf\fP \fBDAEMONS\fP line. After boot time, it may be used to start profiles, simply by passing only the profile name.
+
+.SH OPTIONS
+.TP
+.B \-c, check-iface \fIprofile\fP
+Start the specified profile, only if it's interface is not currently up.
+.TP
+.B \-d, down \fIprofile\fP
+Stop the specified profile
+.TP
+.B \-r, reconnect \fIprofile\fP
+Disconnect and reconnect the specified profile
+.TP
+.B \-i, iface-down \fBinterface\fP
+Stop the profile up on the specified interface.
+.TP
+.B \-a, all-down 
+Stop all connected profiles
+.TP
+.B      all-suspend
+Suspend and store the name of all active profiles.
+.TP
+.B      all-resume
+Reconnect any profiles that have been suspended.
+.TP
+.B      current
+Report currently running profiles
+.TP
+.B \-l, list
+List all available profiles
+.TP
+.B \-v, --version
+Display version information and exit
+.TP
+.B \-h, --help
+Display help message and exit
+
+.SH FILES 
+.TP
+.I /usr/lib/network/
+Currently installed network profile types.
+.TP
+.I /etc/network.d/examples 
+Example configurations for this script
+.TP
+.I /etc/network.d/hooks
+See /usr/share/doc/netcfg/contrib for examples.
+
+.SH ENVIRONMENT VARIABLES
+.TP
+.I NETCFG_DEBUG
+Set to 'yes' to activate debugging output.
+
+.SH BUGS
+None, hopefully, but if you do find one of these elusive things, please submit at http://bugs.archlinux.org/ or email one of the authors below.
+.SH AUTHOR
+James Rayner <james@archlinux.org>
+
+Others listed in AUTHORS file in source.
+.SH SEE ALSO
+.BR ethernet (5), 
+.BR iwconfig (8),
+.BR wireless (5)