aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/build.tex2
-rw-r--r--docs/network-scripts.tex5
-rw-r--r--docs/network.tex35
3 files changed, 37 insertions, 5 deletions
diff --git a/docs/build.tex b/docs/build.tex
index 213ddae873..3a9088afce 100644
--- a/docs/build.tex
+++ b/docs/build.tex
@@ -293,7 +293,7 @@ directly as the Nth argument to \texttt{BuildPackage}.
\begin{itemize}
\item \texttt{SECTION} \\
- The type of package (currently unused)
+ The section of package (currently unused)
\item \texttt{CATEGORY} \\
Which menu it appears in menuconfig: Network, Sound, Utilities, Multimedia ...
\item \texttt{TITLE} \\
diff --git a/docs/network-scripts.tex b/docs/network-scripts.tex
index 4903358c25..4e713953a8 100644
--- a/docs/network-scripts.tex
+++ b/docs/network-scripts.tex
@@ -33,8 +33,9 @@ After running \texttt{scan\_interfaces}, the following functions are available:
\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>() {
diff --git a/docs/network.tex b/docs/network.tex
index bb23fa5244..c7e80c68f1 100644
--- a/docs/network.tex
+++ b/docs/network.tex
@@ -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}