qi-hardware/openwrt-xburst
1
0
Fork 0
mirror of git://projects.qi-hardware.com/openwrt-xburst.git synced 2024-11-27 17:15:00 +02:00
Code

[docs] comment and fix some parts of the documentation, thanks to Harsh Trivedi

Browse Source 
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@16387 3c298f89-4303-0410-b956-a3cf2f4a3e73
This commit is contained in:
florian 2009-06-08 20:35:05 +00:00
parent be7e0b8c3a
commit 61646d6b09
3 changed files with 37 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/build.tex
View File

@ -293,7 +293,7 @@ directly as the Nth argument to \texttt{BuildPackage}.
\begin{itemize} \begin{itemize}
\item \texttt{SECTION} \\ \item \texttt{SECTION} \\
The type of package (currently unused) The section of package (currently unused)
\item \texttt{CATEGORY} \\ \item \texttt{CATEGORY} \\
Which menu it appears in menuconfig: Network, Sound, Utilities, Multimedia ... Which menu it appears in menuconfig: Network, Sound, Utilities, Multimedia ...
\item \texttt{TITLE} \\ \item \texttt{TITLE} \\

5
docs/network-scripts.tex
View File

@ -33,8 +33,9 @@ After running \texttt{scan\_interfaces}, the following functions are available:
\subsubsection{Writing protocol handlers} \subsubsection{Writing protocol handlers}
You can add custom protocol handlers by adding shell scripts to You can add custom protocol handlers (e.g: PPPoE, PPPoA, ATM, PPTP ...)
\texttt{/lib/network}. They provide the following two shell functions: by adding shell scripts to \texttt{/lib/network}. They provide the following
two shell functions:
\begin{Verbatim} \begin{Verbatim}
scan_<protocolname>() { scan_<protocolname>() {

35
docs/network.tex
View File

@ -22,7 +22,12 @@ of interfaces and add:
\end{Verbatim} \end{Verbatim}
It is possible to use VLAN tagging on an interface simply by adding the VLAN IDs 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 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'} 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 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. \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) DHCP currently only accepts \texttt{ipaddr} (IP address to request from the server)
and \texttt{hostname} (client hostname identify as) - both are optional. 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: PPP based protocols (\texttt{pppoe}, \texttt{pptp}, ...) accept these options:
\begin{itemize} \begin{itemize}
\item{username} \\ \item{username} \\
@ -55,6 +76,16 @@ PPP based protocols (\texttt{pppoe}, \texttt{pptp}, ...) accept these options:
\end{itemize} \end{itemize}
For all protocol types, you can also specify the MTU by using the \texttt{mtu} option. 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} \subsubsection{Setting up static routes}