[package] perf: depends on libelf1

[openwrt.git] / docs / network.tex

diff --git a/docs/network.tex b/docs/network.tex
index 1299425..e4efd8d 100644 (file)
--- a/docs/network.tex
+++ b/docs/network.tex
@@ -1,4 +1,4 @@
-The network configuration in Kamikaze is stored in \texttt{/etc/config/network}
+The network configuration is stored in \texttt{/etc/config/network}
 and is divided into interface configurations.
 Each interface configuration either refers directly to an ethernet/wifi
 interface (\texttt{eth0}, \texttt{wl0}, ..) or to a bridge containing multiple interfaces.
@@ -22,7 +22,12 @@ of interfaces and add:
 \end{Verbatim}
 
 It is possible to use VLAN tagging on an interface simply by adding the VLAN IDs
-to it, e.g. \texttt{eth0.1}. These can be nested as well.
+to it, e.g. \texttt{eth0.1}. These can be nested as well. See the switch section for
+this.
+
+\begin{Verbatim}
+config inter
+\end{Verbatim}
 
 This sets up a simple static configuration for \texttt{eth0}. \texttt{proto} specifies the
 protocol used for the interface. The default image usually provides \texttt{'none'}
@@ -31,11 +36,27 @@ packages.
 
 When using the \texttt{'static'} method like in the example, the  options \texttt{ipaddr} and
 \texttt{netmask} are mandatory, while \texttt{gateway} and \texttt{dns} are optional.
-You can specify more than one DNS server, separated with spaces.
+You can specify more than one DNS server, separated with spaces:
+
+\begin{Verbatim}
+config interface     "lan"
+    option ifname    "eth0"
+    option proto     "static"
+    ...
+    option dns       "192.168.1.254 192.168.1.253" (optional)
+\end{Verbatim}
 
 DHCP currently only accepts \texttt{ipaddr} (IP address to request from the server)
 and \texttt{hostname} (client hostname identify as) - both are optional.
 
+\begin{Verbatim}
+config interface     "lan"
+    option ifname    "eth0"
+    option proto     "dhcp"
+    option ipaddr    "192.168.1.1" (optional)
+    option hostname  "openwrt" (optional)
+\end{Verbatim}
+
 PPP based protocols (\texttt{pppoe}, \texttt{pptp}, ...) accept these options:
 \begin{itemize}
     \item{username} \\
@@ -55,6 +76,16 @@ PPP based protocols (\texttt{pppoe}, \texttt{pptp}, ...) accept these options:
 \end{itemize}
 
 For all protocol types, you can also specify the MTU by using the \texttt{mtu} option.
+A sample PPPoE config would look like this:
+
+\begin{Verbatim}
+config interface     "lan"
+    option ifname    "eth0"
+    option proto     "pppoe"
+    option username  "username"
+    option password  "openwrt"
+    option mtu      1492 (optional)
+\end{Verbatim}
 
 \subsubsection{Setting up static routes}
 
@@ -138,7 +169,6 @@ config 6tunnel
         option remoteip4        '1.0.0.1'
         option localip4         '1.0.0.2'
         option localip6         '2001::DEAD::BEEF::1'
-        option prefix           '/64'
 \end{Verbatim}
 
 \begin{itemize}
@@ -153,8 +183,6 @@ config 6tunnel
     \item{\texttt{'localip6'}:}
        IPv6 address to setup on your tunnel side
        This address is given by the tunnel broker
-    \item{\texttt{'prefix'}:}
-       IPv6 prefix to setup on the LAN.
 \end{itemize}
 
 Using the same package you can also setup an IPv6 bridged connection :
@@ -166,6 +194,8 @@ config 6bridge
 
 By default the script bridges the WAN interface with the LAN interface
 and uses ebtables to filter anything that is not IPv6 on the bridge.
+This configuration is particularly useful if your router is not
+IPv6 ND proxy capable (see: http://www.rfc-archive.org/getrfc.php?rfc=4389).
 
 
 IPv6 static addressing is also supported using a similar setup as