qi-hardware/openwrt-xburst
1
0
Fork 0
mirror of git://projects.qi-hardware.com/openwrt-xburst.git synced 2024-11-24 00:30:16 +02:00
Code

add documentation for /etc/config/wireless and improve formatting

Browse Source 
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@5149 3c298f89-4303-0410-b956-a3cf2f4a3e73
This commit is contained in:
nbd 2006-10-16 02:38:08 +00:00
parent 26448e3894
commit a1aab420f0
4 changed files with 133 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -1,4 +1,4 @@
openwrt.pdf: Makefile openwrt.tex config.tex network.tex network-scripts.tex openwrt.pdf: Makefile openwrt.tex config.tex network.tex network-scripts.tex network-scripts.tex wireless.tex
$(MAKE) cleanup $(MAKE) cleanup
pdflatex openwrt.tex pdflatex openwrt.tex
pdflatex openwrt.tex pdflatex openwrt.tex

4
docs/config.tex
View File

@ -9,8 +9,8 @@ it was written under.
Syntax: Syntax:
\begin{Verbatim} \begin{Verbatim}
config <type> [<name>] # Section config <type> [<name>] # Section
option <name> <value> # Option option <name> <value> # Option
\end{Verbatim} \end{Verbatim}
Every parameter needs to be a single string and is formatted exactly Every parameter needs to be a single string and is formatted exactly

60
docs/openwrt.tex
View File

@ -10,39 +10,33 @@
\tableofcontents \tableofcontents
\chapter{The Router} \chapter{The Router}
\section{Getting started} \section{Getting started}
\subsection{Installation} \subsection{Installation}
\subsection{Initial configuration} \subsection{Initial configuration}
\subsection{Failsafe mode} \subsection{Failsafe mode}
\section{Configuring OpenWrt} \section{Configuring OpenWrt}
\subsection{Network} \subsection{Network}
\include{network} \input{network}
\subsection{Wireless}
\subsection{Wireless} \input{wireless}
\section{Advanced configuration}
\section{Advanced configuration} \input{config}
\include{config} \subsection{Hotplug}
\subsection{Init scripts}
\subsection{Hotplug} \input{init-scripts}
\subsection{Init scripts} \subsection{Network scripts}
\include{init-scripts} \input{network-scripts}
\subsection{Network scripts}
\include{network-scripts}
\chapter{Development issues} \chapter{Development issues}
\section{The build system} \section{The build system}
\subsection{Building an image} \subsection{Building an image}
\subsection{Integrating packages} \subsection{Integrating packages}
\subsection{Creating packages} \subsection{Creating packages}
\section{Extra tools}
\section{Extra tools} \subsection{Image Builder}
\subsection{Image Builder} \subsection{SDK}
\subsection{SDK} \section{Adding platform support}
\section{Debugging and debricking}
\section{Adding platform support} \subsection{Adding a serial port}
\section{Debugging and debricking} \subsection{JTAG}
\subsection{Adding a serial port}
\subsection{JTAG}
\end{document} \end{document}

103
docs/wireless.tex Normal file
View File

@ -0,0 +1,103 @@
The WiFi settings are configured in the file \texttt{/etc/config/wireless}
(currently supported on Broadcom only). When booting the router for the first time
it should detect your card and create a sample configuration that looks like this:
\begin{Verbatim}
config wifi-device wl0
option type broadcom
option channel 5
config wifi-iface
option device wl0
option mode ap
option ssid OpenWrt
option hidden 0
option encryption none
\end{Verbatim}
There are two types of config sections in this file. The '\texttt{wifi-device}' refers to
the physical wifi interface and '\texttt{wifi-iface}' configures a virtual interface on top
of that (if supported by the driver).
\paragraph{Options for the \texttt{wifi-device}:}
\begin{itemize}
\item \texttt{type} \\
The driver to use for this interface.
\item \texttt{country} \\
The country code used to determine the regulatory settings.
\item \texttt{channel} \\
The wifi channel (1-14, depending on your country setting).
\item \texttt{maxassoc} \\
Maximum number of associated clients
\end{itemize}
\paragraph{Options for the \texttt{wifi-iface}:}
\begin{itemize}
\item \texttt{mode} \\
Operating mode:
\begin{itemize}
\item \texttt{ap} \\
Access point mode
\item \texttt{sta} \\
Client mode
\item \texttt{adhoc} \\
Ad-Hoc mode
\item \texttt{wds} \\
WDS point-to-point link
\end{itemize}
\item \texttt{network} \\
Selects the interface section from \texttt{/etc/config/network} to be
used with this interface
\item \texttt{encryption} \\
Encryption setting. Accepts the following values:
\begin{itemize}
\item \texttt{psk}, \texttt{psk2} \\
WPA(2) Pre-shared Key
\item \texttt{wpa}, \texttt{wpa2} \\
WPA(2) RADIUS
\end{itemize}
\item \texttt{key} (wpa and psk) \\
Either the WPA key (PSK mode) or the RADIUS shared secret (WPA RADIUS mode)
\item \texttt{server} (wpa) \\
The RADIUS server address
\item \texttt{port} (wpa) \\
The RADIUS server port
\end{itemize}
\paragraph{Limitations:}
\begin{itemize}
\item \textbf{Broadcom}: \\
Only the following mode combinations are supported:
\begin{itemize}
\item 1x \texttt{sta}, 0-3x \texttt{ap}
\item 1-4x \texttt{ap}
\item 1x \texttt{adhoc}
\end{itemize}
WDS links can only be used in pure AP mode and can't use WEP (except when sharing the
settings with the master interface, which is done automatically).
\end{itemize}