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

some basic cleanup, stylistic change for config files, and slight fixes

Browse Source 
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@5455 3c298f89-4303-0410-b956-a3cf2f4a3e73
This commit is contained in:
pavlov 2006-11-06 23:37:55 +00:00
parent 495294a4df
commit d9219238b0
6 changed files with 187 additions and 187 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
docs/build.tex
View File

@ -58,10 +58,10 @@ which can be used to monitor svn commits and browse the sources.
There are four key directories in the base: There are four key directories in the base:
\begin{itemize} \begin{itemize}
\item tools \item tools
\item toolchain \item toolchain
\item package \item package
\item target \item target
\end{itemize} \end{itemize}
\texttt{tools} and \texttt{toolchain} refer to common tools which will be \texttt{tools} and \texttt{toolchain} refer to common tools which will be
@ -100,12 +100,12 @@ firmware image. Similar to the linux kernel config, almost every option has thre
\texttt{y/m/n} which are represented as follows: \texttt{y/m/n} which are represented as follows:
\begin{itemize} \begin{itemize}
\item{\texttt{<*>} (pressing y)} \\ \item{\texttt{<*>} (pressing y)} \\
This will be included in the firmware image This will be included in the firmware image
\item{\texttt{<M>} (pressing m)} \\ \item{\texttt{<M>} (pressing m)} \\
This will be compiled but not included (for later install) This will be compiled but not included (for later install)
\item{\texttt{< >} (pressing n)} \\ \item{\texttt{< >} (pressing n)} \\
This will not be compiled This will not be compiled
\end{itemize} \end{itemize}
After you've finished with the menu configuration, exit and when prompted, save your After you've finished with the menu configuration, exit and when prompted, save your
@ -143,8 +143,8 @@ incredibly easy to port software to OpenWrt. If you look at a typical package di
in OpenWrt you'll find two things: in OpenWrt you'll find two things:
\begin{itemize} \begin{itemize}
\item \texttt{package/\textit{<name>}/Makefile} \item \texttt{package/\textit{<name>}/Makefile}
\item \texttt{package/\textit{<name>}/patches} \item \texttt{package/\textit{<name>}/patches}
\end{itemize} \end{itemize}
The patches directory is optional and typically contains bug fixes or optimizations to The patches directory is optional and typically contains bug fixes or optimizations to
@ -193,9 +193,9 @@ define Build/Configure
endef endef
define Package/bridge/install define Package/bridge/install
install -m0755 -d $(1)/usr/sbin install -m0755 -d $(1)/usr/sbin
install -m0755 $(PKG_BUILD_DIR)/brctl/brctl \ install -m0755 $(PKG_BUILD_DIR)/brctl/brctl \
$(1)/usr/sbin/ $(1)/usr/sbin/
endef endef
$(eval $(call BuildPackage,bridge)) $(eval $(call BuildPackage,bridge))
@ -206,22 +206,22 @@ As you can see, there's not much work to be done; everything is hidden in other
and abstracted to the point where you only need to specify a few variables. and abstracted to the point where you only need to specify a few variables.
\begin{itemize} \begin{itemize}
\item \texttt{PKG\_NAME} \\ \item \texttt{PKG\_NAME} \\
The name of the package, as seen via menuconfig and ipkg The name of the package, as seen via menuconfig and ipkg
\item \texttt{PKG\_VERSION} \\ \item \texttt{PKG\_VERSION} \\
The upstream version number that we're downloading The upstream version number that we're downloading
\item \texttt{PKG\_RELEASE} \\ \item \texttt{PKG\_RELEASE} \\
The version of this package Makefile The version of this package Makefile
\item \texttt{PKG\_BUILD\_DIR} \\ \item \texttt{PKG\_BUILD\_DIR} \\
Where to compile the package Where to compile the package
\item \texttt{PKG\_SOURCE} \\ \item \texttt{PKG\_SOURCE} \\
The filename of the original sources The filename of the original sources
\item \texttt{PKG\_SOURCE\_URL} \\ \item \texttt{PKG\_SOURCE\_URL} \\
Where to download the sources from Where to download the sources from
\item \texttt{PKG\_MD5SUM} \\ \item \texttt{PKG\_MD5SUM} \\
A checksum to validate the download A checksum to validate the download
\item \texttt{PKG\_CAT} \\ \item \texttt{PKG\_CAT} \\
How to decompress the sources (zcat, bzcat, unzip) How to decompress the sources (zcat, bzcat, unzip)
\end{itemize} \end{itemize}
The \texttt{PKG\_*} variables define where to download the package from; The \texttt{PKG\_*} variables define where to download the package from;
@ -241,24 +241,24 @@ directly as the Nth argument to \texttt{BuildPackage}.
\texttt{BuildPackage} uses the following defines: \texttt{BuildPackage} uses the following defines:
\textbf{\texttt{Package/\textit{<name>}}:} \\ \textbf{\texttt{Package/\textit{<name>}}:} \\
\texttt{\textit{<name>}} matches the argument passed to buildroot, this describes \texttt{\textit{<name>}} matches the argument passed to buildroot, this describes
the package the menuconfig and ipkg entries. Within \texttt{Package/\textit{<name>}} the package the menuconfig and ipkg entries. Within \texttt{Package/\textit{<name>}}
you can define the following variables: you can define the following variables:
\begin{itemize} \begin{itemize}
\item \texttt{SECTION} \\ \item \texttt{SECTION} \\
The type of package (currently unused) The type of package (currently unused)
\item \texttt{CATEGORY} \\ \item \texttt{CATEGORY} \\
Which menu it appears in menuconfig Which menu it appears in menuconfig
\item \texttt{TITLE} \\ \item \texttt{TITLE} \\
A short description of the package A short description of the package
\item \texttt{URL} \\ \item \texttt{URL} \\
Where to find the original software Where to find the original software
\item \texttt{MAINTAINER} (optional) \\ \item \texttt{MAINTAINER} (optional) \\
Who to contact concerning the package Who to contact concerning the package
\item \texttt{DEPENDS} (optional) \\ \item \texttt{DEPENDS} (optional) \\
Which packages must be built/installed before this package Which packages must be built/installed before this package
\end{itemize} \end{itemize}
\textbf{\texttt{Package/\textit{<name>}/conffiles} (optional):} \\ \textbf{\texttt{Package/\textit{<name>}/conffiles} (optional):} \\
A list of config files installed by this package, one file per line. A list of config files installed by this package, one file per line.
@ -306,8 +306,8 @@ shortcuts you can take. Instead of waiting for make to get to your package, you
run one of the following: run one of the following:
\begin{itemize} \begin{itemize}
\item \texttt{make package/\textit{<name>}-clean V=99} \item \texttt{make package/\textit{<name>}-clean V=99}
\item \texttt{make package/\textit{<name>}-install V=99} \item \texttt{make package/\textit{<name>}-install V=99}
\end{itemize} \end{itemize}
Another nice trick is that if the source directory under \texttt{build\_\textit{<arch>}} Another nice trick is that if the source directory under \texttt{build\_\textit{<arch>}}

12
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
@ -36,13 +36,13 @@ need to define the following shell functions before running \texttt{config\_load
\begin{Verbatim} \begin{Verbatim}
config_cb() { config_cb() {
local type="$1" local type="$1"
local name="$2" local name="$2"
# commands to be run for every section # commands to be run for every section
} }
option_cb() { option_cb() {
# commands to be run for every option # commands to be run for every option
} }
\end{Verbatim} \end{Verbatim}

12
docs/init-scripts.tex
View File

@ -34,14 +34,14 @@ script, which is optional and defaults to \texttt{50}. Changing it requires runn
You can also override these standard init script functions: You can also override these standard init script functions:
\begin{itemize} \begin{itemize}
\item \texttt{boot()} \\ \item \texttt{boot()} \\
Commands to be run at boot time. Defaults to \texttt{start()} Commands to be run at boot time. Defaults to \texttt{start()}
\item \texttt{restart()} \\ \item \texttt{restart()} \\
Restart your service. Defaults to \texttt{stop(); start()} Restart your service. Defaults to \texttt{stop(); start()}
\item \texttt{reload()} \\ \item \texttt{reload()} \\
Reload the configuration files for your service. Defaults to \texttt{restart()} Reload the configuration files for your service. Defaults to \texttt{restart()}
\end{itemize} \end{itemize}

22
docs/network-scripts.tex
View File

@ -22,13 +22,13 @@ after \texttt{scan\_interfaces} might not return the same result as running it b
After running \texttt{scan\_interfaces}, the following functions are available: After running \texttt{scan\_interfaces}, the following functions are available:
\begin{itemize} \begin{itemize}
\item{\texttt{find\_config \textit{interface}}} \\ \item{\texttt{find\_config \textit{interface}}} \\
looks for a network configuration that includes looks for a network configuration that includes
the specified network interface. the specified network interface.
\item{\texttt{setup\_interface \textit{interface [config] [protocol]}}} \\ \item{\texttt{setup\_interface \textit{interface [config] [protocol]}}} \\
will set up the specified interface, optionally overriding the network configuration will set up the specified interface, optionally overriding the network configuration
name or the protocol that it uses. name or the protocol that it uses.
\end{itemize} \end{itemize}
\subsubsection{Writing protocol handlers} \subsubsection{Writing protocol handlers}
@ -38,14 +38,14 @@ You can add custom protocol handlers by adding shell scripts to
\begin{Verbatim} \begin{Verbatim}
scan_<protocolname>() { scan_<protocolname>() {
local config="$1" local config="$1"
# change the interface names if necessary # change the interface names if necessary
} }
setup_interface_<protocolname>() { setup_interface_<protocolname>() {
local interface="\$1" local interface="$1"
local config="\$2" local config="$2"
# set up the interface # set up the interface
} }
\end{Verbatim} \end{Verbatim}

6
docs/network.tex
View File

@ -61,9 +61,9 @@ The switch configuration is set by adding a \texttt{'switch'} config section.
Example: Example:
\begin{Verbatim} \begin{Verbatim}
config switch eth0 config switch "eth0"
option vlan0 "1 2 3 4 5*" option vlan0 "1 2 3 4 5*"
option vlan1 "0 5" option vlan1 "0 5"
\end{Verbatim} \end{Verbatim}
On Broadcom hardware the section name needs to be eth0, as the switch driver On Broadcom hardware the section name needs to be eth0, as the switch driver

108
docs/wireless.tex
View File

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