netifd: update to the latest version, adds many fixes
[openwrt/openwrt.git] / docs / network-scripts.tex
index 79a8853..7ace975 100644 (file)
@@ -4,7 +4,7 @@ To be able to access the network functions, you need to include
 the necessary shell scripts by running:
 
 \begin{Verbatim}
-. /etc/functions.sh      # common functions
+. /lib/functions.sh      # common functions
 include /lib/network     # include /lib/network/*.sh
 scan_interfaces          # read and parse the network config
 \end{Verbatim}
@@ -22,30 +22,31 @@ after \texttt{scan\_interfaces} might not return the same result as running it b
 After running \texttt{scan\_interfaces}, the following functions are available:
 
 \begin{itemize}
-       \item{\texttt{find\_config \textit{interface}}} \\
-               looks for a network configuration that includes
-               the specified network interface.
+    \item{\texttt{find\_config \textit{interface}}} \\
+        looks for a network configuration that includes
+        the specified network interface.
 
-       \item{\texttt{setup\_interface \textit{interface [config] [protocol]}}} \\
-         will set up the specified interface, optionally overriding the network configuration
-         name or the protocol that it uses.
+    \item{\texttt{setup\_interface \textit{interface [config] [protocol]}}} \\
+      will set up the specified interface, optionally overriding the network configuration
+      name or the protocol that it uses.
 \end{itemize}
 
 \subsubsection{Writing protocol handlers}
 
-You can add custom protocol handlers by adding shell scripts to
-\texttt{/lib/network}. They provide the following two shell functions:
+You can add custom protocol handlers (e.g: PPPoE, PPPoA, ATM, PPTP ...)
+by adding shell scripts to \texttt{/lib/network}. They provide the following
+two shell functions:
 
 \begin{Verbatim}
 scan_<protocolname>() {
-       local config="$1"
-       # change the interface names if necessary
+    local config="$1"
+    # change the interface names if necessary
 }
 
 setup_interface_<protocolname>() {
-       local interface="\$1"
-       local config="\$2"
-       # set up the interface
+    local interface="$1"
+    local config="$2"
+    # set up the interface
 }
 \end{Verbatim}