SCM Repository

project home | /[freewrt]/branches/freewrt_1_0/docs/handbook/user/handbook.tex

Diff of /branches/freewrt_1_0/docs/handbook/user/handbook.tex

Parent Directory | Revision Log | View Patch Patch

-revision 2535 by wbx,
Tue May 15 06:09:26 2007 UTC
+revision 2536 by n0-1,
Thu May 17 20:25:52 2007 UTC
 Line 1
- \documentclass[12pt,a4paper,openany,smallheadings,
+ \documentclass[12pt,a4paper,openany,smallheadings,headinclude,headsepline,final]{scrreprt}
- headinclude,headsepline,final]{scrreprt}
+ %\usepackage{ucs} % Unicode support
- \usepackage[utf8]{inputenc}
+ \usepackage[utf8]{inputenc} % UTF-8 characters as input are allowed
- \usepackage{amsmath}
+ %\usepackage{amsmath}
- \usepackage{amsfonts}
+ %\usepackage{amsfonts}
- \usepackage{amssymb}
+ %\usepackage{amssymb}
- \usepackage{caption2}
+ %\usepackage{caption2}
- \usepackage[canadian]{babel}
+ \usepackage[english]{babel} % Sets the layout to English style
- \usepackage{varioref}
+ \usepackage{varioref} % Intelligent page references
- \usepackage{txfonts}
+ %\usepackage{txfonts}
- \usepackage[pdftex]{graphicx}
+ \usepackage[pdftex]{color} % Colour control for LaTeX documents
+ \usepackage[pdftex]{graphicx} % Enhanced support for graphics
  %\usepackage{listings}
- \usepackage{makeidx}
+ \usepackage{makeidx} % Standard LaTeX package for creating indexes
- \usepackage[T1]{fontenc}
+ \usepackage{longtable} % Allow tables to flow over page boundaries
+ \usepackage[T1]{fontenc} % T1-fonts
+ \usepackage{fancyvrb} % Sophisticated verbatim text
+ \usepackage[a4paper,rmargin=2cm,lmargin=2cm,tmargin=2.5cm,bmargin=3.5cm]{geometry} % Flexible and complete interface to document dimensions
+ \usepackage{fixltx2e, mparhack} % Patches for LaTeX; A workaround for a LaTeX bug in marginpars
+ \usepackage[nofancy]{svninfo} % Typeset Subversion Keywords
+ \usepackage{float} % Improved interface for floating objects
+ \usepackage{hyperref} % Extensive support for hypertext in LaTeX
- % fancy verbatim enables changing of font, fontsize, etc. in verbatim code
- % also set smaller font and a frame as default
- \usepackage{fancyvrb}
- \fvset{fontsize=\small, frame=single}
  % marvosym macht Pfeil kaputt, also sichern
  % line 28, /usr/share/texmf/tex/latex/marvosym/marvosym.sty
- \let\RescueRightarrow=\Rightarrow
+ %\let\RescueRightarrow=\Rightarrow
- \usepackage{marvosym}
+ %\usepackage{marvosym}
- \renewcommand{\Rightarrow}{\RescueRightarrow}
+ %\renewcommand{\Rightarrow}{\RescueRightarrow}
- \usepackage[pdftex]{color}
  \definecolor{skyblue}{rgb}{0,0.3323,0.5720}
- \usepackage[%
+ \restylefloat{figure}
- colorlinks=true,anchorcolor=red,
+ \hypersetup{
- breaklinks=true,linkcolor=blue,urlcolor=red,
+         colorlinks=true,anchorcolor=red,
- citecolor=skyblue,
+         breaklinks=true,linkcolor=blue,urlcolor=red,
- pdfauthor={The FreeWRT Team},
+         citecolor=skyblue,
- pdftitle={FreeWRT User Handbook},
+         pdfauthor={The FreeWRT Team},
- pdfcreator={tetex and VIM},
+         pdftitle={FreeWRT User Handbook},
- pdfsubject={Open Source},
+         pdfcreator={tetex and VIM},
- pdfview=FitV,
+         pdfsubject={Open Source},
- pdfstartview=FitV,
+         pdfview=FitV,
- pdfstartpage={1},
+         pdfstartview=FitV,
- pdfpagelayout=SinglePage,
+         pdfstartpage={1},
- pdfpagemode=None,
+         pdfpagelayout=SinglePage,
- pdfkeywords={FreeWRT}]{hyperref}
+         pdfpagemode=None,
- \usepackage{cancel}
+         pdfkeywords={FreeWRT}
+ }
+ \fvset{fontsize=\small, frame=single} % fancyvrb: set small font size and enable frames
+ %\usepackage{cancel}
  %\usepackage[final, activate, verbose=true]{microtype}
- \usepackage{ngerman}
+ %\usepackage{ngerman}
  %\usepackage{bookman}
  %\usepackage[a4paper,twoside,rmargin=2cm,lmargin=2cm,tmargin=2.5cm]{geometry}
- \usepackage[a4paper,rmargin=2cm,lmargin=2cm,tmargin=2.5cm,bmargin=3.5cm]{geometry}
+ %\usepackage[a4paper,rmargin=2cm,lmargin=2cm,tmargin=2.5cm,bmargin=3.5cm]{geometry}
  %\usepackage{ncntrsbk}
- \usepackage{float}
+ %\usepackage{float}
- \restylefloat{figure}
+ %\restylefloat{figure}
  %\bibliographystyle{alphadin}
- \bibliographystyle{alpha}
+ %\bibliographystyle{alpha}
- % Change Section, Chapter Layout
- % http://www.mackichan.com/index.html?techtalk/518.htm~mainFrame
- %\usepackage{sectsty}
- %\allsectionsfont{\raggedleft}
- %\chapterfont{\raggedleft}
- % BEGIN Fancy Header Extensions
- % Save Graphics in Latex box
- %\renewcommand{\headheight}{30pt} %Make height wider so picture is ok
- %\renewcommand{\footskip}{45pt} %Make height wider so picture is ok
- \usepackage{fixltx2e, mparhack}
  % Generate index in preamble
  \makeindex
  \begin{document}
+ \svnInfo $Id$
  \setlength{\marginparwidth}{10mm}
  \include{cover}
  \renewcommand{\thepage}{\roman{page}}
  \tableofcontents
  %Set Arabic Numbering 1,2,3,...
-Line 84 
 pdfkeywords={FreeWRT}]{hyperref}
+Line 81 
 pdfkeywords={FreeWRT}]{hyperref}
  \markboth{\large \thechapter.\ \normalsize \scshape #1}{}}
  \renewcommand{\sectionmark}[1]{\markright{\thesection.\ \scshape #1}}
- %Bilitz
- %\newcommand{\blitz}{ \mbox{\Huge \Lightning} }
- \newcommand{\blitz}{ \Lightning }
- \newcommand{\entspr}{\stackrel{\wedge}{=}}
+ % Create some new commands for designing the text
+ % applications
+ \newcommand{\app}[1]{%
+         \textsf{\textit{#1}}}
+ % terminology, vendor or product names
+ \newcommand{\term}[1]{%
+         \textsc{#1}}
+ % filenames and directories
+ \newcommand{\file}[1]{%
+         \textsf{#1}}
+ % user input
+ \newcommand{\command}[1]{%
+         \texttt{\textbf{#1}}}
+ % example code, output of applications
+ \newcommand{\code}[1]{%
+         \texttt{#1}}
+ % emphasized text (nicer than \emph{})
+ \newcommand{\strong}[1]{%
+         \textbf{#1}}
  \chapter{Introduction}
-Line 99 
 and functional Linux distribution for em
+Line 111 
 and functional Linux distribution for em
  code distribution, it does not provide any pre-compiled firmware for embedded
  systems. The latest version of this document is always available at the
  FreeWRT website. If you have any comments, criticism or found some wrong
- description, please send us an e-mail to freewrt-handbook@freewrt.org, we are
+ description, please send us an e-mail to
+ \href{mailto:freewrt-handbook@freewrt.org}{freewrt-handbook@freewrt.org}, we are
  always happy about getting feedback to this document, and will try to update
  or correct the issues mentioned by you.
- The FreeWRT User handbook is split into five distinct sections. Appliance
+ The FreeWRT User handbook is split into several distinct chapters.
- Development Kit covers the building of FreeWRT firmware images. The second
+ \nameref{ch:ADK} covers the building of FreeWRT firmware images.
- section, Installing FreeWRT, covers all aspects regarding the installation and
+ In \autoref{ch:installing}, \nameref{ch:installing}, all aspects regarding the
- deinstallation of FreeWRT firmware images. The third section is a detailed
+ installation and deinstallation of FreeWRT firmware images are covered.  The
- description of the startup process of FreeWRT.  The fourth section, Using FreeWRT,
+ next chapter, \nameref{ch:administration}, covers administrational tasks, such
- covers administrational tasks, such as network configuration, the FreeWRT
+ as network configuration, the FreeWRT configuration filesystem, package
- configuration filesystem, package management and update mechanism. The last
+ management and update mechanism. The last chapter, \nameref{ch:troubleshooting},
- section helps troubleshooting problems and recovering a bad firmware installation.
+ helps troubleshooting problems and recovering a bad firmware installation.  The
- The appendix contains board specific information. For FreeWRT 1.0 these are only
+ appendix contains board specific information.  For FreeWRT 1.0 these are only
  Broadcom based embedded systems.
  The intended audience for this handbook are advanced users with basic
-Line 122 
 administration) and is fully configured
+Line 135 
 administration) and is fully configured
  \section{Typographic Conventions}
- Examples starting with \# indicate a command that must be invoked as super
+ Examples starting with \code{\#} indicate a command that must be invoked as super
- user. You can use su to gain super user privileges.
+ user. You can use \command{su} to gain super user privileges.
- \begin{Verbatim}
+ \begin{Verbatim}[label=example for a command line with super user privileges]
  # fwcf commit
  \end{Verbatim}
- Examples starting with \$ indicate a command that can be invoked as a normal
+ Examples starting with \code{\$} indicate a command that can be invoked as a
- user.  The default user account on a freshly installed FreeWRT system is
+ normal user.  The default user account on a freshly installed FreeWRT system is
- ,,admin'', the password ,,FreeWRT''.
+ "\code{admin}", the password "\code{FreeWRT}".
- \begin{Verbatim}
+ \begin{Verbatim}[label=example for a command line as non-privileged user]
  $ cat /etc/banner
  \end{Verbatim}
- \chapter{Appliance Development Kit (ADK)}
+ %\chapter{Web Interface Builder (WIB)}\label{ch:WIB}
+ %
+ %FIXME It is named later in the text, but not explained what it is.  Probably
+ %this chapter can be joined with the chapter about ADK
+ \chapter{Appliance Development Kit (ADK)}\label{ch:ADK}
  The ADK is the core of FreeWRT and contains all scripts and sources to create
  firmware images for every supported embedded system. FreeWRT 1.0 supports the
  following embedded systems:
  \begin{itemize}
- \item Asus WL500g
+         \item Asus WL500g
- \item Asus WL500g deluxe
+         \item Asus WL500g deluxe
- \item Asus WL500g premium
+         \item Asus WL500g premium
- \item Linksys WRT54G v2.0
+         \item Linksys WRT54G v2.0
- \item Linksys WRT54G v2.2
+         \item Linksys WRT54G v2.2
- \item Linksys WRT54G v3.0
+         \item Linksys WRT54G v3.0
- \item Linksys WRT54G v3.1
+         \item Linksys WRT54G v3.1
- \item Linksys WRT54G v4.0
+         \item Linksys WRT54G v4.0
- \item Linksys WRT54GS v1.0
+         \item Linksys WRT54GS v1.0
- \item Linksys WRT54GS v1.1
+         \item Linksys WRT54GS v1.1
- \item Linksys WRT54GS v4
+         \item Linksys WRT54GS v4
- \item Linksys WRT54G3G
+         \item Linksys WRT54G3G
- \item Linksys WRT54GL
+         \item Linksys WRT54GL
- \item Netgear WGT634u
+         \item Netgear WGT634u
  \end{itemize}
  In this release we only support the Linux 2.4 kernel. The ADK contains over
-Line 171 
 needed to create a firmware for your emb
+Line 189 
 needed to create a firmware for your emb
  The list of supported GNU/Linux build systems is not an exclusive one, these are just the ones tested and verified. The other millions of linux distributions are very likely to work, too.
  \begin{itemize}
- \item Debian GNU/Linux
+         \item Debian GNU/Linux
- \item Gentoo Linux
+         \item Gentoo Linux
- \item OpenSuSE
+         \item OpenSuSE
- \item Ubuntu GNU/Linux
+         \item Ubuntu GNU/Linux
- \item Fedora Core
+         \item Fedora Core
- \item OpenBSD (partial support)\footnote{some addon packages does not compile}
+         \item OpenBSD (partial support)\footnote{some addon packages does not compile}
- \item MirOS BSD (partial support)\footnote{some addon packages does not compile}
+         \item MirOS BSD (partial support)\footnote{some addon packages does not compile}
  \end{itemize}
  Please install the following software, which is needed to build a basic
-Line 186 
 needed. The ADK host checks will warn yo
+Line 204 
 needed. The ADK host checks will warn yo
  compile a specific package.  Here is a list of the required software:
  \begin{itemize}
- \item gcc3 or higher
+         \item gcc3 or higher
- \item g++
+         \item g++
- \item binutils
+         \item binutils
- \item patch
+         \item patch
- \item gzip
+         \item gzip
- \item bzip2
+         \item bzip2
- \item unzip
+         \item unzip
- \item flex
+         \item flex
- \item bison
+         \item bison
- \item GNU make
+         \item GNU make
- \item zlib (+headers)
+         \item zlib (+headers)
- \item ncurses (+headers)
+         \item ncurses (+headers)
- \item (g)libc headers
+         \item (g)libc headers
- \item perl
+         \item perl
  \end{itemize}
  The ADK scripts will check for the required versions of these tools in advance.
-Line 212 
 needs a working internet connection.
+Line 230 
 needs a working internet connection.
  \section{Getting the source}
  Now go to a directory where you want to build the firmware. Depending on the
- features you select you will need about 2.5-5 GB free disk space. This
+ features you select you will need about 2.5--5 GB free disk space. This
  includes the ADK itself, any source archives which will be downloaded
  and their extracted copies (for compiling).
  To get the latest stable FreeWRT ADK try one of these commands:
- Via HTTP protocol:
+ \begin{Verbatim}[label=Check out the 1.0-branch of FreeWRT ADK via HTTP protocol]
- \begin{verbatim}
  $ svn co http://www.freewrt.org/svn/tags/freewrt_1_0_x freewrt
- \end{verbatim}
+ \end{Verbatim}
- Via subversion protocol:
+ \begin{Verbatim}[label=Check out the 1.0-branch of FreeWRT ADK via subversion protocol]
- \begin{verbatim}
  $ svn co svn://www.freewrt.org/itags/freewrt_1_0_x freewrt
- \end{verbatim}
+ \end{Verbatim}
- The value \dq{}x\dq{} is a place holder for the latest minor release number.
+ The value $x$ is a place holder for the latest minor release number.
  Take a look at our project page to find out which minor release number is the latest one.
  After successfully downloading, enter the directory:
-Line 240 
 This directory will be referred to as th
+Line 256 
 This directory will be referred to as th
  \section{Some Theory First}
  Building a FreeWRT firmware image is just like building a new Linux kernel,
- but a little more complex. There is a ncurses-based configuration menu at the
+ but a little more complex. There is a \app{ncurses}-based configuration menu at the
- beginning, the changes made are saved into a file named ,,.config'' in the ADK
+ beginning, the changes made are saved into a file named \file{.config} in the ADK
  root. The build is done by the various Makefiles, compiling and linking the
- sources together accordingly to the symbols defined in ,,.config''.
+ sources together accordingly to the symbols defined in \file{.config}.
  Unlike kernel compilation, FreeWRT needs to be cross-compiled. This
  leads to special premises, as most of the tools need to be specially build.
  But no panic, FreeWRT will do this all for you. In fact, this is done at the
- second run of \texttt{make} (the first one opens the configuration), and
+ second run of \command{make} (the first one opens the configuration), and
  therefore can be seen as part of the first firmware build.  For clarity
  though, we will discuss these two things separately.
-Line 258 
 After downloading the FreeWRT ADK, it's
+Line 274 
 After downloading the FreeWRT ADK, it's
  building of firmware images (for explanations see the chapter above).
  \subsection{Creating A Configuration}
- The first step is to run \texttt{make}. After checking some prerequisites (see
- ,,Troubleshooting'' below for aid in problems), a console based configuration
+ The first step is to run \command{make}. After checking some prerequisites (see
+ \nameref{ch:troubleshooting} below for aid in problems), a console based configuration
  menu should start. Theoretically no choices have to be made, but it's proven
  useful to at least:
  \begin{itemize}
- \item select a target (menu: ,,Embedded System'')
+         \item select a target (menu: \code{Embedded System})
- \item select the root filesystem type (menu: ,,Target Firmware type'')
+         \item select the root filesystem type (menu: \code{Target Firmware type})
  \end{itemize}
- Then quit saving changes. If you forgot that, just run \texttt{make} again, redo
+ Then quit saving changes. If you forgot that, just run \command{make} again, redo
  your changes, then save.
  \subsection{Building ADK}
  Now that you have a first minimal configuration, it is time to build the toolchain
- for cross-compiling. To do this, just enter {{{make}}} again. The build starts
+ for cross-compiling. To do this, just enter \command{make} again. The build starts
  downloading and compiling each needed part of the toolchain, and later continues
  with building the first firmware image. Later one can be taken as proof of a
  working ADK.
- Already experienced in compiling gcc? Then you know... If not, better be told
+ Already experienced in compiling \app{gcc}? Then you know\dots If not, better be told
  that it takes \underline{really long} to finish. In the meantime I suggest reading the
  next chapter dealing with internals about cross-compiling.
  \section{Details Of Cross-Compiling}
  A cross-compile toolchain exists of a set of tools: a compiler, linker, assembler,
- debugger and a c library. A cross-compile toolchain runs on your host system and
+ debugger and a C~library. A cross-compile toolchain runs on your host system and
  creates native binaries for your target system. A cross-compile toolchain is
  basically created in six steps:
  \begin{enumerate}
- \item Get and prepare the Kernel and C Library headers of your target system
+         \item Get and prepare the Kernel and C~library headers of your target system
- \item Compile the binutils package for your target
+         \item Compile the binutils package for your target
- \item Compile a static C compiler for your target
+         \item Compile a static C~compiler for your target
- \item Compile and install a C library for your target
+         \item Compile and install a C~library for your target
- \item Compile and install a full C/C++ compiler
+         \item Compile and install a full C/C++~compiler
- \item Compile and install the GNU debugger
+         \item Compile and install the GNU debugger
  \end{enumerate}
  The cross-compile toolchain is created in
- ,,staging\_dir\_\$(cpu\_arch)''\footnote{f.e. mipsel, which stands for MIPS Little
+ \file{staging\_dir\_\$(cpu\_arch)}\footnote{e.g. mipsel, which stands for MIPS
- Endian)}.  All the tools running on the host, but used to create, analyze or debug
+ Little Endian}. All the tools running on the host, but used to create, analyze or debug
  for the target are kept in this directory. All addon headers and libraries
  are installed to this directory.
  If you want to compile a simple application without using the ADK, just use the
- compiler directly (f.e. compiling a MIPS Little Endian application):
+ compiler directly (e.g. compiling a MIPS Little Endian application):
- \begin{verbatim}
+ \begin{Verbatim}[label=compile a simple application with the cross-compiler]
  ./staging_dir_mipsel/bin/mipsel-linux-uclibc-gcc -o myapp myapp.c
- \end{verbatim}
+ \end{Verbatim}
- Check with ,,file'' if you got a MIPS binary:
+ Check with the tool \app{file} if you got a MIPS binary:
- \begin{verbatim}
+ \begin{Verbatim}[label=check the binary with \app{file}]
  $ file myapp
  myapp: ELF 32-bit LSB MIPS-I executable, MIPS, version 1 (SYSV), dynamically
  linked (uses shared libs), not stripped
- \end{verbatim}
+ \end{Verbatim}
  \section{Building A FreeWRT Firmware Image}
  Your local copy of the FreeWRT ADK should now be prepared for building firmware
  images. The next step is to do an extensive configuration for the image you
- want to create. To start the configuration menu, type ,,\texttt{make menuconfig}''.
+ want to create. To start the configuration menu, type \command{make menuconfig}.
- When selecting packages, \texttt{<*>} means it will be inserted into the firmware
+ When selecting packages, \code{<*>} means it will be inserted into the firmware
- images and \texttt{<M>} means it will be build as an addon package which can be
+ images and \code{<M>} means it will be build as an addon package which can be
  installed later at runtime.
  The target device and filesystem should already been chosen by you to the right
- value, if not you will have to issue a ,,\texttt{make clean}'' before actually
+ value, if not you will have to issue a \command{make clean} before actually
  building the firmware image. Otherwise things get messed up. A smooth
  rebuild is a missing feature in the current ADK. For the packages, if unsure, you
  can just select one of the package collections. After that, you can still manually
  check the choices made by the collection and correct them if appropriate. Do not
  forget to save your configuration when leaving!
- After leaving the menubased configuration, type ,,\texttt{make}'' again to build
+ After leaving the menubased configuration, type \command{make} again to build
  the new FreeWRT firmware image. Depending on your package selections and
  underlying hardware, this will take different amounts of time. For your spare time
  there is the following chapter giving some explanation about what is done at this
-Line 344 
 point.
+Line 361 
 point.
  \section{Firmware Build Process In Detail}
  Just like when building the ADK's toolchain, the sources for the selected
- packages are downloaded from the internet first, then build using the
+ packages are downloaded from the internet first, then built using the
  cross-compiler and libraries of the ADK.
  The detailed order of firmware image building is:
  \begin{itemize}
- \item compile the Linux kernel and all supported kernel modules
+         \item compile the Linux kernel and all supported kernel modules
- \item compile all selected packages
+         \item compile all selected packages
- \item clean the target root directory
+         \item clean the target root directory
- \item install all packages to the target root directory
+         \item install all packages to the target root directory
- \item create the root filesystem image
+         \item create the root filesystem image
- \item create the firmware image (bootloader, kernel and root filesystem)
+         \item create the firmware image (bootloader, kernel and root filesystem)
  \end{itemize}
- The result of the build process is created in the ,,bin'' directory.
+ The result of the build process is created in the directory \file{bin/}.
  You will find a firmware image in the top level directory. Check the size of
- the bin-file to see if it is small enough to fit into flash memory of
+ the binary image file to see if it is small enough to fit into flash memory of
- your embedded system. Furthermore there is a ,,package'' directory, which
+ your embedded system. Furthermore there is a directory \file{package/}, which
- contains all base and addon packages.
+ contains all base and add--on packages.
  \section{Troubleshooting}
  This section deals with various tips for problems with the ADK installation.
  \subsection{Errors During Prerequisites Check}
- To re-issue the checks, use ,,make prereq''.
+ To re-issue the checks, use \command{make prereq}.
  \begin{itemize}
- \item GNU make 3.80 too old
+ \item GNU make 3.80 too old \\
     On a Fedora Core 4 hostsystem the first you'll get is
- \begin{verbatim}
+         \begin{Verbatim}[label=error message with too old GNU make]
     $ make
     GNU make 3.80 too old.
     Please install GNU make 3.81 or higher to continue.
-Line 381 
 To re-issue the checks, use ,,make prere
+Line 400 
 To re-issue the checks, use ,,make prere
     It is suggested to upgrade your copy of bison to
     GNU Bison 2.3 because of its bug fixes.
     make: *** [.prereq_done] Error 1
- \end{verbatim}
+         \end{Verbatim}
     it is quite a nice error that tells you to use more up to date software, but we can
-    anyhow give this hostsystem a try and tell make to ignore those errors/warnings:
+    anyhow give this hostsystem a try and tell make to ignore those
- \begin{verbatim}
+    errors/warnings running \command{make prereq-noerror}.
-      make prereq-noerror
- \end{verbatim}
  \end{itemize}
  \subsection{Compilation errors}
  If you encounter any compilation errors, then first try to reproduce the error.
- First update your ADK tree via ,,svn update'', to be sure that the error is not
+ First update your ADK tree via \command{svn update}, to be sure that the error is not
- already fixed in the subversion repository. After that do a ,,make clean \&\&
+ already fixed in the subversion repository. After that do a \command{make clean
- make'', to reproduce your problem.
+ \&\& make}, to reproduce your problem.
  If you can reproduce the problem, please file a bug report. Please always
  report following information:
  \begin{itemize}
- \item Operating system type and version
+         \item Operating system type and version
- \item GCC and Binutils versions of your host system
+         \item GCC and Binutils versions of your host system
- \item complete error message, not only the last 4 lines
+         \item complete error message, not only the last 4 lines
  \end{itemize}
- \chapter{Installing FreeWRT Firmware Images}
+ \chapter{Installing FreeWRT Firmware Images}\label{ch:installing}
  The FreeWRT ADK produces a single image holding both kernel and root
  filesystem. This image can be written into your hardware's builtin flash memory
  on serveral ways (ordered by needed skills, increasing downwards):
- \begin{itemize} % TODO: insert \ref's to jump to the appropriate section?
+ \begin{itemize}
- \item via the original firmware's web interface
+         \item via the original firmware's web interface
- \item via \texttt{mtd} when reflashing or migrating from another third party distribution
+         (\autoref{sec:webinterface})
- \item via network using a TFTP client
+         \item via \texttt{mtd} when reflashing or migrating from another third
+         party distribution (\autoref{sec:mtd})
+         \item via network using a TFTP client (\autoref{sec:tftp})
  \end{itemize}
  \section{Flashing The Firmware}
- \subsection{Web Interface Method}
+ \subsection{Web Interface Method}\label{sec:webinterface}
  The following text describes how to use the original firmware's web interface
- to flash FreeWRT. The object of demonstration is an Asus WL500gP, but this
+ to flash FreeWRT. The object of demonstration is an \term{Asus WL500gP}, but this
  guide should fit more or less fine for other systems, too.
- If you flash a router from Linksys, we strongly suggest to use the popular
+ If you flash a router from \term{Linksys}, we strongly suggest to use the popular
- \textbf{ping exploit} to allow recovery, if your image is broken or the flash
+ \term{ping exploit} to allow recovery, if your image is broken or the flash
  process was interrupted by a power shortage.
  There are some things that you should have done previously:
  \begin{itemize}
- \item read the special documentation page about your hardware in our wiki, some
+         \item read the special documentation page about your hardware in our wiki, some
-       systems need special precaution before flashing
+               systems need special precaution before flashing
- \item a firmware image has to be built (matching the used hardware, of course)
+         \item a firmware image has to be built (matching the used hardware, of course)
- \item the router has to be powered on
+         \item the router has to be powered on
- \item your computer needs to be connected to one of the LAN ports (using IP
+         \item your computer needs to be connected to one of the LAN ports
- address 192.168.1.2)
+                 (using IP address \file{192.168.1.2})
  \end{itemize}
  \parbox{17em}{
  After preparation is complete, open your favourite browser and type
- \texttt{192.168.1.1} into the address bar. You should reach the web interface's
+ \command{192.168.1.1} into the address bar. You should reach the web interface's
  startup page:
  }\hfill\parbox{20em}{\includegraphics[width=20em]{pics/asus-startup.png}} \\ [1em]
  \parbox{17em}{
- Then click \textit{System Setup}:
+ Then click on \code{System Setup}:
  }\hfill\parbox{20em}{\includegraphics[width=20em]{pics/asus-system_setup.png}} \\ [1em]
  \parbox{17em}{
- Then click \textit{Firmware Upgrade}, and enter the name of your firmware image
+ In the new menu click on \code{Firmware Upgrade}, and enter the name of your firmware image
  into the appropriate field:
  }\hfill\parbox{20em}{\includegraphics[width=20em]{pics/asus-fw_upgrade.png}} \\ [1em]
- Finally click \textit{Upload}. As the whole process of writing the image to
+ Finally click on \code{Upload}. As the whole process of writing the image to
- flash and rebooting (don't forget that it creates ssh hostkeys on first boot)
+ flash and rebooting (don't forget that it creates \app{ssh} hostkeys on first boot)
- takes quite long, better go and get a coffee or tea.
+ takes quite long (yes, a couple of minutes). Better go and get a coffee or tea.
- When everything went good, you can login using ssh. The default username is
+ When everything went well, you can login using \app{ssh}. The default username is
- \dq{}admin\dq{}. The default password for images created via WIB or ADK is
+ "\code{admin}". The default password for images created via WIB or ADK is
- \dq{}FreeWRT\dq{}. It is possible to change this password in the ADK, before image
+ "\code{FreeWRT}". It is possible to change this password in the ADK,
- creation.
+ before image creation.
- \subsection{\texttt{mtd} -- The Flash Utility}
+ \subsection{\texttt{mtd} -- The Flash Utility}\label{sec:mtd}
  For this method to work, you need to copy the file containing the firmware
- image to the router, preferably into /tmp, the memory filesystem should be
+ image to the router, preferably into \file{/tmp/}, the memory filesystem should be
- big enough to hold the full image. If not, use wget to get the image
+ big enough to hold the full image. If not, use \app{wget} to get the image
- via http or ftp and pipe the result into \texttt{mtd}.
+ via http or ftp and pipe the result into \app{mtd}.
- Then the image is written to flash using
+ Then the image is written to flash using \app{mtd}, optionally giving
- \texttt{mtd}, optionally giving additional options (see below).
+ additional options (see below).
- The \texttt{mtd} utility was written with simplicity and code size in mind.
+ The \app{mtd} utility was written with simplicity and code size in mind.
- It's features were derived from the mtd-utils, %TODO: insert \ref to homepage
+ It's features were derived from the
+ \href{http://sources.redhat.com/jffs2/}{\app{mtd-utils}},
  combining the needed parts into a single small tool providing all the
  functionality necessary for FreeWRT, and leaving everything out that's not.
- \texttt{mtd} provides the following features:
+ \app{mtd} provides the following features:
  \begin{description}
- \item[unlock] some chips need unlocking before they can be written to
+         \item[unlock] some chips need unlocking before they can be written to
- \item[erase] this is a filesystem independent method to delete all contents on
+         \item[erase] this is a filesystem independent method to delete all contents on
-         the flash. Basically this is like \texttt{format} in MS--DOS.
+                 the flash. Basically this is like \app{format} in MS--DOS.
- \item[write] this is generally the same functionality as using
+         \item[write] this is generally the same functionality as using
-         \texttt{dd} or \texttt{rawrite}, but \texttt{mtd} takes care of the quirks
+                 \app{dd} or \app{rawrite}, but \app{mtd} takes care of the quirks
-         that have to be paid attention to for correctly handling the type of flash
+                 that have to be paid attention to for correctly handling the type of flash
-         in use
+                 in use
  \end{description}
  Further it can request your system to reboot. Some of the features mentioned here can
-Line 490 
 the flash has been written.
+Line 510 
 the flash has been written.
  Mostly, similar to the sample usage shown in the help output should be all that has to be
  done to write the firmware to flash:
- \begin{Verbatim}
+ \begin{Verbatim}[label=write a previously downloaded new firmware-file into flash]
  # mtd -e linux -r write freewrt.bin linux &
  \end{Verbatim}
  Or via wget pipe:
- \begin{Verbatim}
+ \begin{Verbatim}[label=download and write a new firmware-file into flash]
  # wget -O - http://www.yourserver.com/freewrt.bin | mtd -e linux -r write - linux &
  \end{Verbatim}
- The parameters explained in detail: \\
+ The parameters explained in detail:
- \begin{tabular}{l|l}
+ \begin{description}
- -e linux & erase existing data in flash\\
+         \item[\command{-e linux}] erase existing data in flash
- -r & trigger rebooting right after finishing work\\
+         \item[\command{-r}] trigger rebooting right after finishing work
- write & write the firmware image contained in the file given as next parameter
+         \item[\command{write}] write the firmware image contained in the file given as
-                         to flash\\
+                 next parameter to flash
- freewrt.bin & the actual image to write - ignore the suffix, it is detected at
+         \item[\command{freewrt.bin}] the actual image to write -- ignore the suffix,
-                                 runtime\\
+                 it is detected at runtime
- linux & this is an abstract identifier for a certain partition in flash, so
+         \item[\command{linux}] this is an abstract identifier for a certain partition
- don't change this\\
+                 in flash, so don't change this
- \& & put the process into background, to prevent accidentally stopping\\
+         \item[\command{\&}] put the process into background, to prevent accidentally
- \end{tabular}
+                 stopping
+ \end{description}
- \subsection{Installation using TFTP}
+ \subsection{Installation using TFTP}\label{sec:tftp}
  All supported target devices are shipped with a builtin bootloader, comparable to
- the BIOS of x86--machines. This bootloader is used to bootstrap the system until
+ the BIOS of \term{x86} machines. This bootloader is used to bootstrap the system until
  it can boot a regular operating system. Besides the ability to load
  the executable code from flash, it can be received from another node in the
  local area network via the famous TFTP protocol.
- For doing this, there are two ways: \\
+ For doing this, there are two ways:
  \begin{itemize}
- \item the device acts as a client, asks the local dhcpd for a lease, the
+         \item the device acts as a client, asks the local \app{dhcpd} for a lease, the
- address of the next tftpd and the filename to download
+                 address of the next \app{tftpd} and the filename to download
- \item the device acts as a server, having a known IP address and waiting for
+         \item the device acts as a server, having a known IP address and waiting for
- any TFTP client to connect and send the file
+                 any TFTP client to connect and send the file
  \end{itemize}
  Most of the hardware supported by FreeWRT 1.0 uses the second method.  Only the
- device Netgear WGT634u is using the first method, the bootloader provides a
+ device \term{Netgear WGT634u} is using the first method, the bootloader provides a
  DHCP/TFTP client. Though this may be a little confusing to people being familiar
  with netboot technologies, it is definitely the easier way of doing it. Otherwise
  one had to setup both DHCP and TFTP servers and configure them right.
-Line 535 
 one had to setup both DHCP and TFTP serv
+Line 556 
 one had to setup both DHCP and TFTP serv
  The even quite simple task of sending the flash image to the target device is
  made even more easy by providing a little shell script for the job. Invocation
  is as follows:
- \begin{Verbatim}
+ \begin{Verbatim}[label=sending the new firmware via TFTP]
  $ ./scripts/flash.sh firmware.bin [address]
  \end{Verbatim}
- The second Parameter \textit{address} is used to specify a different IP address
+ The second Parameter \code{address} is used to specify a different IP address
- of the target device than the default \textit{192.168.1.1}.
+ of the target device than the default \file{192.168.1.1}.
- \textbf{Beware:} do not rename the firmware image before flashing it using the
+ \strong{Beware:} do not rename the firmware image before flashing it using the
  script as the original name is parsed to guess what hardware is to be flashed.
  To actually being able to flash the device, it has to wait for a tftp
-Line 549 
 connection when booting. To complicate i
+Line 570 
 connection when booting. To complicate i
  images and to improve bootup time, of course, this feature is disabled by
  default. The following list shows what has to be done for a certain device to
  get it to wait at boot: \\
- \begin{center}\begin{tabular}{l|l|l} % TODO: fill this table
+ \begin{center}
- \textbf{Target Device} & \textbf{Action to be taken} & \textbf{Comments} \\
+         \begin{tabular}{l|l|p{7cm}} % TODO: fill this table
- \hline
+                 \strong{Target Device} & \strong{Action to be taken} & \strong{Comments} \\
- All supported Linksys models & Ping Exploit & nvram variable boot\_wait needs to be on \\
+                 \hline
- All supported Asus models & Recovery mode & power off, push and hold the
+                 All supported Linksys models & Ping Exploit & nvram variable \code{boot\_wait} needs to be on \\
- reset button, power on, power led is flashing\\
+                 All supported Asus models & Recovery mode & power off
- \end{tabular}\end{center}
+                                                             $\rightarrow$ push and hold the reset button
+                                                             $\rightarrow$ power on
+                                                             $\rightarrow$ power led is flashing\\
+         \end{tabular}
+ \end{center}
- \chapter{FreeWRT Administration}
+ \chapter{FreeWRT Administration}\label{ch:administration}
  After the FreeWRT firmware image has been built by the ADK and later flashed
  onto the hardware, the resulting operating system has to be configured. This
-Line 566 
 guides for using FreeWRT in general, of
+Line 591 
 guides for using FreeWRT in general, of
  \section{Network Configuration}
- The device names for real network interfaces in Linux are named ethx (x is
+ The device names for real network interfaces in Linux are named \code{ethx} (\code{x} is
--9). If the device has a switch, the different ports are separated via VLAN
+ \code{0--9}). If the device has a switch, the different ports are separated via VLAN
- technology. The vlan interfaces are named ethx.y.  The network configuration in
+ technology. The vlan interfaces are named \code{ethx.y}.  The network configuration in
- FreeWRT is managed via Busybox's ifupdown implementation. Busybox's ip builtin
+ FreeWRT is managed via \app{Busybox}'s \app{ifupdown} implementation. \app{Busybox}'s builtin \app{ip}
- command configures the network interfaces. There is no \texttt{ifconfig} or \texttt{route}.
+ command configures the network interfaces. There is no \app{ifconfig} or \app{route}.
  To show all configured network interfaces use:
- \begin{Verbatim}
+ \begin{Verbatim}[label=show IP address]
  $ ip addr show
  \end{Verbatim}
  To show the kernel routing table use:
- \begin{Verbatim}
+ \begin{Verbatim}[label=show routing table]
  $ ip route show
  \end{Verbatim}
- All available network settings can be found in \texttt{/etc/network/interfaces}
+ All available network settings can be found in \file{/etc/network/interfaces}
  which has the common form:
- \begin{Verbatim}[label=/etc/network/interfaces]
+ \begin{Verbatim}[label=common form of \file{/etc/network/interfaces}]
  auto <iface-name>
  iface <iface-name> inet <method>
    <option-x> <value>
-Line 590 
 iface <iface-name> inet <method>
+Line 615 
 iface <iface-name> inet <method>
    <option-z> <value>
  \end{Verbatim}
- \texttt{auto <iface-name>} is optional and, if set, tells the "ifup" script to
+ \code{auto <iface-name>} is optional and, if set, tells the \app{ifup} script to
  start this interface automatically on bootup.
  Each interface needs a unique name which, depending on the method, represents
- either a physical interface or a logical interface name like "eth0.1" for a
+ either a physical interface or a logical interface name like \code{eth0.1} for a
- physical VLAN or "umts" as a logical name for a PPP interface.
+ physical VLAN or \code{umts} as a logical name for a PPP interface.
  Possible methods are:
  \begin{description}
- \item[static] use the given options to configure the interface statically
+         \item[static] use the given options to configure the interface statically
- \item[dhcp] just start a dhcp client using the interface \texttt{iface-name}
+         \item[dhcp] just start a dhcp client using the interface \code{iface-name}
- \item[manual] don't configure the interface but start pre-up.d hook scripts
+         \item[manual] don't configure the interface but start \code{pre-up.d} hook scripts
- \item[ppp] run \texttt{pon <provider>} where \texttt{<provider>} is given as an interface option
+         \item[ppp] run \code{pon <provider>} where \code{<provider>} is given as an interface option
  \end{description}
  \subsection{Switch/VLAN}
  The switch built-in into the most routers is capable of separating each port
  using VLAN tagging. You can configure the switch by simply adding the interface
  to the config file and giving the desired switch-ports:
- \begin{Verbatim}[label=/etc/network/interfaces]
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  auto eth0.0
  iface eth0.0 inet static
      switch-ports 1 2 5*
-Line 630 
 iface eth0.2 inet static
+Line 655 
 iface eth0.2 inet static
      gateway 172.16.1.1
  \end{Verbatim}
- This configures three VLAN interfaces \texttt{eth0.0} on ports 1 and 2,
+ This configures three VLAN interfaces \code{eth0.0} on ports 1 and 2,
- \texttt{eth0.1} on port 3 and 4 and \texttt{eth0.2} on port 0.
+ \code{eth0.1} on port 3 and 4 and \code{eth0.2} on port 0.
  If you need to do some advanced settings, because you have for example
  a powerful switch with a VLAN trunking port connected to one of your switch
  ports, the configuration would look like this:
- \begin{Verbatim}[label=/etc/network/interfaces]
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  auto eth0.1
  iface eth0.1 inet static
      switch-ports 2 3 4 5*
-Line 668 
 iface eth0.4 inet static
+Line 693 
 iface eth0.4 inet static
  \end{Verbatim}
- This configures four VLAN interfaces, \texttt{eth0.1} on physical ports 2, 3 and 4.
+ This configures four VLAN interfaces, \code{eth0.1} on physical ports 2, 3 and 4.
- The interfaces \texttt{eth0.2}, \texttt{eth0.3} and \texttt{eth0.4} are three
+ The interfaces \code{eth0.2}, \code{eth0.3} and \code{eth0.4} are three
- different networks with VLAN ID 2-4. The physical port 1 needs to be connected
+ different networks with VLAN ID 2--4. The physical port 1 needs to be connected
  to a VLAN trunking port on a switch with knows the same VLAN IDs.
  Explanation:
  \begin{description}
- \item[port 0] this is typically the port labeled as WAN
+         \item[port 0] this is typically the port labeled as WAN
- \item[port 1-4] these are typically the ports labeled as LAN
+         \item[port 1--4] these are typically the ports labeled as LAN
- \item[port 5] this special port represents the port where the router-board is
+         \item[port 5] this special port represents the port where the router--board is
-         connected to the switch
+                 connected to the switch
- \item[*] one interface always need an asterisk behind port 5 which means it is
+         \item[*] one interface always need an asterisk behind port 5 which means it is
-         the default interface and gets all the packages with unknown tags.
+                 the default interface and gets all the packages with unknown tags.
  \end{description}
  \subsection{Static IP configuration}
  As you can see in the VLAN example three interfaces were configured with static
  IP settings, so these are the commonly used options:
  \begin{description}
- \item[address] the IP address  - required
+         \item[address] the IP address  --- required
- \item[netmask] the netmask     - required
+         \item[netmask] the netmask     --- required
- \item[broadcast] broadcast address - only required for legacy applications (if using +, it will calculated automatically by the kernel)
+         \item[broadcast] broadcast address --- only required for legacy
- \item[gateway] an IP address added as default gateway if present
+         applications (if using \code{+}, it will be calculated automatically by the kernel)
- \item[mac-address] if you need to change your MAC address (required for some DSL providers)
+         \item[gateway] an IP address added as default gateway if present
+         \item[mac-address] if you need to change your MAC address (required for some DSL providers)
  \end{description}
  \subsection{DHCP}
  That's just as simple as:
- \begin{Verbatim}[label=/etc/network/interfaces]
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  auto eth0.1
  iface eth0.1 inet dhcp
      switch-ports  0 5
-Line 707 
 Typically this configures the WAN-Port t
+Line 733 
 Typically this configures the WAN-Port t
  \subsection{Bridging}
  This is mostly needed to combine LAN and WLAN to a homogeneous network.
- Be sure you have installed the package \texttt{bridge-utils}.
+ Be sure you have installed the package \app{bridge-utils}.
- \begin{Verbatim}[label=/etc/network/interfaces]
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  auto eth0.0
  iface eth0.0 inet manual
      switch-ports 1 2 3 4 5*
-Line 727 
 iface br0 inet static
+Line 753 
 iface br0 inet static
      broadcast +
  \end{Verbatim}
- This creates a new bridging interface \texttt{br0} which combines the VLAN
+ This creates a new bridging interface \code{br0} which combines the VLAN
- interface \texttt{eth0.0} (representing the LAN-ports 1-4) and the WLAN interface
+ interface \code{eth0.0} (representing the LAN-ports 1--4) and the WLAN interface
- \texttt{eth1} (on some devices like Asus WL500gP this might be \texttt{eth2}).
+ \code{eth1} (on some devices like \term{Asus WL500gP} this might be \code{eth2}).
  The bridge interface needs always be the last one, otherwise it can not find
- the interfaces in bridge-ifaces.
+ the interfaces in \code{bridge-ifaces}.
  \subsection{WLAN}
  A router containing a WLAN interface has an additional ethernet device
- representing it. On Broadcom-based hardware it is typically \texttt{eth1}
+ representing it. On Broad\-com-based hardware it is typically \code{eth1}
- (Linksys),\texttt{eth2} (Asus WL500gP) or on Netgear WGT634u which has a Madwifi
+ (\term{Linksys}),\code{eth2} (\term{Asus WL500gP}) or on \term{Netgear WGT634u} which has a Madwifi
- WLAN chip, it is \texttt{ath0}, \texttt{ath1}, etc. You can use these interfaces
+ WLAN chip, it is \code{ath0}, \code{ath1}, etc. You can use these interfaces
  standalone or bridged with other devices, e.g. the internal LAN.
  \subsubsection{Basic Settings}
  Mandatory options and default parameters are in bold font.
- \begin{tabular}{l|l|l}
+ \begin{tabular}{l|l|p{10cm}}
- \textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
+ \strong{Option} & \strong{Parameter} & \strong{Description} \\
+ \hline\hline
+ \code{\strong{type}} & \code{broadcom}                & Broadcom based card \\
+                      & \code{atheros}                 & Madwifi driver \\
+ \hline
+ \code{\strong{mode}} & \code{ap}                      & Access point mode \\
+                      & \code{sta}                     & Client mode \\
+                      & \code{adhoc}                   & Ad-Hoc mode \\
+                      & \code{wds}                     & WDS point-to-point link over wireless\\
+                      & \code{monitor}                 & The node acts as a passive monitor and only receives packets \\
+ \hline
+ \code{\strong{ssid}} & \code{<String>}                & Set the SSID (Network Name) \\
+ \hline
+ \code{country}       & \code{\{ALL|DE|JP|US|\ldots\}} & The country code used to determine the regulatory settings. \\
  \hline
- \textbf{type}& broadcom        & Broadcom based card \\
-              & atheros         & Madwifi driver \\
- \textbf{mode}& ap              & Access point mode \\
-              & sta             & Client mode \\
-              & adhoc           & Ad-Hoc mode \\
-              & wds             & WDS point-to-point link over wireless\\
-              & monitor         & The node acts as a passive monitor and only receives packets \\
- \textbf{ssid}& <String>        & Set the SSID (Network Name) \\
- country      & {ALL|DE|JP|US|...} & The country code used to determine the regulatory settings. \\
  \end{tabular}
  \subsubsection{Security Settings}
- \begin{tabular}{l|l|l}
+ \begin{longtable}{l|l|p{10cm}}
- \textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
+ \strong{Option} & \strong{Parameter} & \strong{Description} \\
+ \hline\hline
+ \code{\strong{security}} & \code{none}            & No authorization \\
+                          & \code{wep}             & WEP key \\
+                          & \code{wpa-psk}         & WPA with preshared key \\
+                          & \code{8021x}           & IEEE 802.1X authentication \\
  \hline
- \textbf{security}& none            & No authorization \\
+ \code{\strong{authorization}} &                 & \strong{wpa-psk} \\
-              & wep             & WEP key \\
+                               & \code{psk}             & WPA PSK \\
-              & wpa-psk         & WPA with preshared key \\
+                               & \code{psk2}            & WPA2 PSK \\
-              & 8021x           & IEEE 802.1X authentication \\
+                               & \code{psk psk2}        & WPA PSK and WPA2 PSK \\
- \textbf{authorization}&                 & \textbf{wpa-psk} \\
+                               &                        & \strong{8021x} \\
-              & psk             & WPA PSK \\
+                               & \code{wpa}             & WPA with RADIUS \\
-              & psk2            & WPA2 PSK \\
+                               & \code{wpa2}            & WPA2 with RADIUS \\
-              & psk psk2        & WPA PSK and WPA2 PSK \\
+                               & \code{wpa wpa2}        & WPA and WPA2 \\
-              &                 & \textbf{8021x} \\
+ \hline
-              & wpa             & WPA with RADIUS \\
+ \code{\strong{encryption}} &                        & \strong{wep} \\
-              & wpa2            & WPA2 with RADIUS \\
+                            & ---                    & not needed, automatically by key size \\
-              & wpa wpa2        & WPA and WPA2 \\
+                            &                        & \strong{wpa-psk} \\
- \textbf{encryption}&            & \textbf{wep} \\
+                            & \code{tkip}            & RC4 encryption \\
-              & -               & not needed, automatically by key size \\
+                            & \code{aes}             & AES encryption \\
-              &                 & \textbf{wpa-psk} \\
+                            & \code{aes+tkip}        & support both \\
-              & tkip            & RC4 encryption \\
+                            &                        & \strong{8021x} \\
-              & aes             & AES encryption \\
+                            & \code{wep}             & RC4 encryption (static) \\
-              & aes+tkip        & support both \\
+                            & \code{tkip}            & RC4 encryption \\
-              &                 & \textbf{8021x} \\
+                            & \code{aes}             & AES encryption \\
-              & wep             & RC4 encryption (static) \\
+                            & \code{aes+tkip}        & support both \\
-              & tkip            & RC4 encryption \\
+ \hline
-              & aes             & AES encryption \\
+ \code{eap-type} &                        & \strong{8021x} \\
-              & aes+tkip        & support both \\
+                 & \code{\strong{tls}}    & Transport Layer Security \\
- eap-type     &                 & \textbf{8021x} \\
+                 & \code{ttls}            & Tunnelled TLS \\
-              & \textbf{tls}    & Transport Layer Security \\
+                 & \code{peap}            & Protected EAP \\
-              & ttls            & Tunnelled TLS \\
+                 & \code{leap}            & Cisco Wireless \\
-              & peap            & Protected EAP \\
+ \hline
-              & leap            & Cisco Wireless \\
+ \code{key} &                            & \strong{wep} \\
- key          &                 & \textbf{wep} \\
+            &\code{\{\strong{1}|2|3|4\}} & Select WEP key to use. \\
-              &\{\textbf{1}|2|3|4\}& Select WEP key to use. \\
+ \hline
- key[1..4]    &                 & \textbf{wep} \\
+ \code{key[1..4]} &                 & \strong{wep} \\
-              & <String>        & WEP key.  The key must be 5, 13 or 16 bytes
+                  & \code{<String>} & WEP key.  The key must be 5, 13 or 16 bytes
-                                  long, or 10, 26, 32, or 64 hex digits long.  The encryption
+                                      long, or 10, 26, 32, or 64 hex digits long.  The encryption
-                                  algorithm is automatically selected based on the key size. key1 is
+                                      algorithm is automatically selected based on the key size. key1 is
-                                  the key for WEP client mode. \\
+                                      the key for WEP client mode. \\
- wpa-key      &                 & \textbf{wpa-psk} \\
+ \hline
-              & <String>        & Password to use with WPA/WPA2 PSK (at least 8,
+ \code{wpa-key} &                 & \strong{wpa-psk} \\
-                                  up to 63 chars) \\
+                & <String>        & Password to use with WPA/WPA2 PSK (at least 8, up to 63 chars) \\
- wpa-gtk-rekey &                & \textbf{wpa-psk}, \textbf{8021x} \\
+ \hline
-              & <Int> (\textbf{3600}) & Rekeying interval in seconds. \\
+ \code{wpa-gtk-rekey} &                              & \strong{wpa-psk}, \strong{8021x} \\
- \textbf{radius-ipaddr}&             & \textbf{8021x} \\
+                      & \code{<Int>} (\strong{3600}) & Rekeying interval in seconds. \\
-              & <a.b.c.d>       & IP to connect. \\
+ \hline
- radius-port  &                 & \textbf{8021x} \\
+ \code{\strong{radius-ipaddr}} &                  & \strong{8021x} \\
-              & <Int> (\textbf{1812}) & RADIUS-Port no. to connect \\
+                               & \code{<a.b.c.d>} & IP to connect. \\
- \textbf{radius-key}&                & \textbf{8021x} \\
+ \hline
-              & <String>        & Shared Secret for connection to the Radius server \\
+ \code{radius-port} &                              & \strong{8021x} \\
- \end{tabular}
+                    & \code{<Int>} (\strong{1812}) & RADIUS-Port no. to connect \\
+ \hline
+ \strong{radius-key} &                 & \strong{8021x} \\
+                     & \code{<String>} & Shared Secret for connection to the Radius server \\
+ \hline
+ \end{longtable}
  \subsubsection{MAC filter}
- \begin{tabular}{l|l|l}
+ \begin{tabular}{l|l|p{10cm}}
- \textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
+ \strong{Option} & \strong{Parameter} & \strong{Description} \\
- macmode      & {0|1|2}         & 0 - Disable MAC address matching. \\
+ \hline\hline
-              &                 & 1 - Deny association to stations on the MAC list. \\
+ \code{macmode} & \code{\{0|1|2\}} & 0: Disable MAC address matching. \\
-              &                 & 2 - Allow association to stations on the MAC list. \\
+                &                  & 1: Deny association to stations on the MAC list. \\
- maclist      & <MAC1> ... <MACn> & List of space separated mac addresses to
+                &                  & 2: Allow association to stations on the MAC list. \\
- allow/deny according to ''macmode''. Addresses should be entered with colons,
+ \hline
- e.g.: 00:02:2D:08:E2:1D 00:03:3E:05:E1:1B\\
+ \code{maclist} & \code{<MAC1> \ldots <MACn>} & List of space separated mac addresses to
+ allow/deny according to \code{macmode}. Addresses should be entered with colons,
+ e.g.: "\code{00:02:2D:08:E2:1D 00:03:3E:05:E1:1B}"\\
  \end{tabular}
  \subsubsection{Wireless Distribution System (WDS)}
- \begin{tabular}{l|l|l}
+ \begin{tabular}{l|l|p{10cm}}
- \texttt{Option} & \texttt{Parameter} & \texttt{Description} \\
+ \strong{Option}       & \strong{Parameter}          & \strong{Description} \\
- lazywds      & {0|1}           & Accept WDS connections from anyone \\
+ \hline\hline
- wds-bridge   & {brX}           & Add WDS peers to bridge brX \\
+ \code{lazywds}        & \code{\{0|1\}}              & Accept WDS connections from anyone \\
- wds-security & {wpa-psk}           & secure the wds bridge with WPA (optional)\\
+ \hline
- wds-encryption & {aes|tkip}           & Use AES or TKIP as cipher\\
+ \code{wds-bridge}     & \code{br\{X\}}              & Add WDS peers to bridge brX \\
- wds-wpa-key & <String>        & Password to use with WPA PSK (at least 8, up to 63 chars) \\
+ \hline
- wds          & <MAC1> ... <MACn> & List of WDS peer mac addresses (xx:xx:xx:xx:xx:xx, space separated) \\
+ \code{wds-security}   & \code{\{wpa-psk\}}          & secure the wds bridge with WPA (optional)\\
+ \hline
+ \code{wds-encryption} & \code{\{aes|tkip\}}         & Use AES or TKIP as cipher\\
+ \hline
+ \code{wds-wpa-key}    & \code{<String>}             & Password to use with WPA PSK (at least 8, up to 63 chars) \\
+ \hline
+ \code{wds}            & \code{<MAC1> \ldots <MACn>} & List of WDS peer mac addresses (\code{xx:xx:xx:xx:xx:xx}, space separated) \\
+ \hline
  \end{tabular}
  \subsubsection{Miscellaneous}
- \begin{tabular}{l|l|l}
+ \begin{longtable}{l|l|p{10cm}}
- \textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
+ \strong{Option} & \strong{Parameter} & \strong{Description} \\
- channel      & \{1-14\}          & The wifi channel \\
+ \hline\hline
- maxassoc     & \{1-255\}         & Maximum number of associated clients \\
+ \code{channel}      & \code{\{1--14\}}                & The wifi channel \\
- gmode        & \{LegacyB| \textbf{Auto}| GOnly| BDeferred| Performance| LRS\} & Set the 54g Mode \\
+ \hline
- frameburst   & \{\textbf{0}|1\}        & Disable/Enable frameburst mode. \\
+ \code{maxassoc}     & \code{\{1--255\}}               & Maximum number of associated clients \\
- txpower      & \{0-255|\textbf{-1}\}   & Set the transmit power in dBm \\
+ \hline
- rate         & <Int> (\textbf{-1})   & force a fixed rate \\
+ % TODO: add descriptions to the different gmode settings
-              &                 & valid values for 802.11a are (6, 9, 12, 18, 24, 36, 48, 54) \\
+ \code{gmode}        &                                 & Set the 54g Mode \\
-              &                 & valid values for 802.11b are (1, 2, 5.5, 11) \\
+                     & \code{\strong{Auto}}            & default \\
-              &                 & valid values for 802.11g are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54) \\
+                     & \code{LegacyB}                  & \\
-              &                 &-1 means automatically determine the best rate \\
+                     & \code{GOnly}                    & \\
- rts          & \{0-2347\}        & Set the RTS threshhold. \\
+                     & \code{BDeferred}                & \\
- frag         & \{256-2346\}      & Set the fragmentation threshhold. \\
+                     & \code{Performance}              & \\
- afterburner  & \{\textbf{0}|1\}        & Enable Afterburner capability \\
+                     & \code{LRS}                      & \\
- isolate      & \{\textbf{0}|1\}        & Hide Clients from each other \\
+ \hline
- bridge-if    & \{br0...brX\}   & The bridge interface (optional)
+ \code{frameburst}   & \code{\{\strong{0}|1\}}         & Disable/Enable frameburst mode. \\
- \end{tabular}
+ \hline
+ \code{txpower}      & \code{\{0--255|\strong{$-1$}\}} & Set the transmit power in dBm \\
+ \hline
+ \code{rate}         & \code{<Int> (\strong{$-1$})}    & force a fixed rate \\
+                     &                                 & valid values for 802.11a are (6, 9, 12, 18, 24, 36, 48, 54) \\
+                     &                                 & valid values for 802.11b are (1, 2, 5.5, 11) \\
+                     &                                 & valid values for 802.11g are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54) \\
+                     &                                 & $-1$ means automatically determine the best rate \\
+ \hline
+ \code{rts}          & \code{\{0-2347\}}               & Set the RTS threshhold. \\
+ \hline
+ \code{frag}         & \code{\{256-2346\}}             & Set the fragmentation threshhold. \\
+ \hline
+ \code{afterburner}  & \code{\{\strong{0}|1\}}         & Enable Afterburner capability \\
+ \hline
+ \code{isolate}      & \code{\{\strong{0}|1\}}         & Hide Clients from each other \\
+ \hline
+ \code{bridge-if}    & \code{\{br0..brX\}}             & The bridge interface (optional) \\
+ \hline
+ \end{longtable}
  \subsubsection{Examples}
- WLAN with WEP128
+ \paragraph{WLAN with WEP128}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface eth1 inet static
          address 192.168.10.1
          netmask 255.255.255.0
-Line 868 
 iface eth1 inet static
+Line 936 
 iface eth1 inet static
          wireless-channel 11
  \end{Verbatim}
- WLAN without encryption
+ \paragraph{WLAN without encryption}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface eth1 inet static
          address 192.168.10.1
          netmask 255.255.255.0
-Line 882 
 iface eth1 inet static
+Line 950 
 iface eth1 inet static
          wireless-channel 11
  \end{Verbatim}
- WLAN with WPA2 (AES)
+ \paragraph{WLAN with WPA2 (AES)}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface eth1 inet static
          address 192.168.10.1
          netmask 255.255.255.0
-Line 900 
 iface eth1 inet static
+Line 968 
 iface eth1 inet static
  \end{Verbatim}
  If you want to do MAC filtering, add the following to the sample above:
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
          wireless-macmode 2
          wireless-mac 00:01:02:03:04:05 06:07:08:09:0a:0b
  \end{Verbatim}
  this enables the filter and defines the list to contain addresses that should be allowed.
  To enhance wireless performance, you can enable some flags like Broadcom's SpeedBooster. Normally, these flags are not dangerous:
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
          wireless-gmode performance
          wireless-frameburst 1
          wireless-afterburner 1
  \end{Verbatim}
- WLAN client with WPA2 (AES) (''untested'')
+ \paragraph{WLAN client with WPA2 (AES) (\strong{untested})}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface eth1 inet static
          address 192.168.10.1
          netmask 255.255.255.0
-Line 929 
 iface eth1 inet static
+Line 997 
 iface eth1 inet static
          wireless-wpa-key 12345678
  \end{Verbatim}
- WLAN client with WEP128
+ \paragraph{WLAN client with WEP128}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface eth1 inet dhcp
          wireless-type broadcom
          wireless-country DE
-Line 943 
 iface eth1 inet dhcp
+Line 1011 
 iface eth1 inet dhcp
  WLAN with WDS nodes, the WDS nodes need to have the same
  SSID, channel and encryption parameters.
- WDS node 1 (MAC of Wireless 06:05:04:03:02:01)
+ WDS node 1 (MAC of Wireless \code{06:05:04:03:02:01})
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface br0 inet static
          bridge-ifaces eth1
          address 192.168.10.1
-Line 959 
 iface br0 inet static
+Line 1027 
 iface br0 inet static
          wireless-wds 01:02:03:04:05:06
          wireless-wds-bridge br0
  \end{Verbatim}
- WDS node 2 (MAC of Wireless 01:02:03:04:05:06)
+ WDS node 2 (MAC of Wireless \code{01:02:03:04:05:06})
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface br0 inet static
          bridge-ifaces eth1
          address 192.168.10.2
-Line 976 
 iface br0 inet static
+Line 1044 
 iface br0 inet static
          wireless-wds-bridge br0
  \end{Verbatim}
- Peer-to-Peer mode (no encryption, IP must be static)
+ \paragraph{Peer-to-Peer mode (no encryption, IP must be static)}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface eth1 inet static
          address 192.168.10.1
          netmask 255.255.255.0
-Line 993 
 iface eth1 inet static
+Line 1061 
 iface eth1 inet static
  \subsection{PPP}
  PPP comes in various flavours for different situations, the most commonly
- needed will likely be DSL and for WRT54G3G users UMTS. So there exists a
+ needed will likely be DSL and for \term{WRT54G3G} users UMTS. So there exists a
- hook-script that evaluates a "use-template" option and generates a ppp-peer.
+ hook-script that evaluates a \code{use-template} option and generates a ppp-peer.
  This way everything needed so far can be configured within the
- \texttt{interfaces} file. Be sure you have installed the packages
+ \code{interfaces} file. Be sure you have installed the packages
- \texttt{kmod-ppp}, \texttt{ppp} and \texttt{ppp-mod-pppoe}. For providers
+ \app{kmod-ppp}, \app{ppp} and \app{ppp-mod-pppoe}. For providers
- using PPTP for authentication, instead of PPPoE, you need to install \texttt{pptp}.
+ using PPTP for authentication, instead of PPPoE, you need to install \app{pptp}.
  \subsubsection{DSL with PPPoE}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  auto ppp0
  iface ppp0 inet ppp
          use-template dsl
-Line 1011 
 iface ppp0 inet ppp
+Line 1079 
 iface ppp0 inet ppp
          ppp-device eth0.1
  \end{Verbatim}
- Now your DSL connection will be started on boot (\texttt{auto ppp0})
+ Now your DSL connection will be started on boot (\code{auto ppp0})
- and you can manually shut it down with \texttt{ifdown ppp0} or start it up with
+ and you can manually shut it down with \command{ifdown ppp0} or start it up with
- \texttt{ifup ppp0}.
+ \command{ifup ppp0}.
- The template \texttt{dsl} will configure a typical PPPoE peer for you.
+ The template \code{dsl} will configure a typical PPPoE peer for you.
  \subsubsection{DSL with PPTP}
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  auto ppp0
  iface ppp0 inet ppp
          use-template pptp
          provider foobar
          ppp-username foo
          ppp-password bar
          ppp-modemip 10.0.0.1
          ppp-mtu 1480
          ppp-device eth0.1
  \end{Verbatim}
- Now your DSL connection will be started on boot (\texttt{auto ppp0})
+ Now your DSL connection will be started on boot (\code{auto ppp0})
- and you can manually shut it down with \texttt{ifdown ppp0} or start it up with
+ and you can manually shut it down with \command{ifdown ppp0} or start it up with
- \texttt{ifup ppp0}.
+ \command{ifup ppp0}.
- The template \texttt{pptp} will configure a typical PPTP peer for you.
+ The template \code{pptp} will configure a typical PPTP peer for you.
  \subsubsection{UMTS}
  Same footprint different template and some specific options. That is all that
  is needed for an UMTS connection to Vodafone as it can be seen in this example.
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface ppp0 inet ppp
          use-template    umts
          provider        umts
-Line 1048 
 iface ppp0 inet ppp
+Line 1116 
 iface ppp0 inet ppp
          umts-pincode    1234
          umts-mode       umts_first
  \end{Verbatim}
- As you can see: unneeded options like \texttt{ppp-username} or
+ As you can see: unneeded options like \code{ppp-username} or
- \texttt{ppp-password} can just be removed or commented out. Don't leave them
+ \code{ppp-password} can just be removed or commented out. Don't leave them
- without a value as that causes a failure in \texttt{ipup}. It does work if you
+ without a value as that causes a failure in \app{ipup}. It does work if you
- give empty double quotes as value like "".
+ give empty double quotes as value like \code{""}.
  Note that you have to set the correct APN, username and password for your provider!
  You may also remove the pin from your SIM-card and the configuration if you like.
- For Linksys WRT54G3G a package called \texttt{broadcom-watchbutton} will be
+ For \term{Linksys WRT54G3G} a package called \app{broadcom-watchbutton} will be
  installed, this is a small daemon that monitors the UMTS-button of the router
- and executes \texttt{ifup umts} or \texttt{ifdown umts} on a button press.
+ and executes \command{ifup umts} or \command{ifdown umts} on a button press.
- You have to set \texttt{watchbutton=YES} in /etc/rc.conf to have it start automatically.
+ You have to set \code{watchbutton=YES} in /etc/rc.conf to have it start automatically.
- This is totally independent from the \texttt{auto umts} setting. Even if you
+ This is totally independent from the \code{auto umts} setting. Even if you
  start the connection on bootup you can shut it down again with a button press.
  \subsection{custom interface hooks}
  \subsubsection{per interface}
  You can execute various commands on interface startup or shutdown with special option:
- \begin{Verbatim}
+ \begin{Verbatim}[label=\file{/etc/network/interfaces}]
  iface foobar inet static
      [...]
      pre-up <command>
-Line 1080 
 iface foobar inet static
+Line 1148 
 iface foobar inet static
  You can give each option multiple times and their commands will be executed in given order.
  \begin{description}
- \item[pre-up] before the interface will be started
+         \item[pre-up] before the interface will be started
- \item[up] after the interface was started successfully
+         \item[up] after the interface was started successfully
- \item[down] before the interface goes down
+         \item[down] before the interface goes down
- \item[post-down] after the interface shut down
+         \item[post-down] after the interface shut down
  \end{description}
  \subsubsection{general hooks}
  Additionally you can write scripts executed for each interface if you put them in
  \begin{itemize}
- \item \texttt{/etc/network/if-pre-up.d}
+         \item \texttt{/etc/network/if-pre-up.d}
- \item \texttt{/etc/network/if-up.d}
+         \item \texttt{/etc/network/if-up.d}
- \item \texttt{/etc/network/if-down.d}
+         \item \texttt{/etc/network/if-down.d}
- \item \texttt{/etc/network/if-post-down.d}
+         \item \texttt{/etc/network/if-post-down.d}
  \end{itemize}
  Same semantics as above.
  \section{FWCF - FreeWRT Configuration Filesystem}
- FWCF is a separate flash partition for all changes made to the /etc directory.
+ FWCF is a separate flash partition for all changes made to the \file{/etc/} directory.
- There is a small tool named \texttt{fwcf}, which is used to setup the system or
+ There is a small tool named \app{fwcf}, which is used to setup the system or
  to commit changes to the fwcf partition.
- On bootup the script \texttt{/sbin/mount\_root} is executed, which calls \dq{}fwcf
+ On bootup the script \file{/sbin/mount\_root} is executed, which calls
- setup\dq{} to setup /etc as memory filesystem and overlay the changes committed
+ \command{fwcf setup} to setup \file{/etc/} as memory filesystem and overlay the changes committed
  to the fwcf partition.
- If you change anything in /etc and like to keep the change, it is required to
+ If you change anything in \file{/etc/} and like to keep the change, it is required to
- execute \dq{}fwcf commit\dq{}. This will compress all changed or new files in /etc
+ execute \command{fwcf commit}. This will compress all changed or new files in
- and write the result into the fwcf partition.  The fwcf partition is 128 Kb in
+ \file{/etc/} and write the result into the fwcf partition.  The fwcf partition is 128 Kb in
  size. This size is not changeable at the moment.
  If you need more detailed information, please read the specification of FWCF,
  which can be found
- here \url{http://www.freewrt.org/trac/wiki/Documentation/Specs/FwCf}
+ at \url{http://www.freewrt.org/trac/wiki/Documentation/Specs/FwCf}
  If you want to remove all your changes and start your configuration from scratch,
- use \dq{}fwcf erase\dq{}. This is also required if you switch between compression
+ use \command{fwcf erase}. This is also required if you switch between compression
  plugins. Right now LZO plugin is default.
  \section{IPKG - Packagemanagement}
  All software for FreeWRT is available as a IPKG package. IPKG is a package manager
- very similar to Debian's dpkg/apt-get utilities. It is specially designed for
+ very similar to Debian's \app{dpkg/apt-get} utilities. It is specially designed for
  embedded systems and is widely used. The FreeWRT project use a special version,
  which is embedded to the busybox binary. Normally the command line tool
- \texttt{ipkg} is pre-installed.
+ \app{ipkg} is pre-installed.
- IPKG uses a configuration file similar to /etc/apt/sources.list, which
+ IPKG uses a configuration file similar to \file{/etc/apt/sources.list}, which
  contains a list of software repositories available via HTTP or FTP.
- The configuration file \texttt{/etc/ipkg.conf} contains the official
+ The configuration file \file{/etc/ipkg.conf} contains the official
  FreeWRT 1.0 repository for your board and kernel version.
  To update the list of available packages execute following command as root:
- \begin{verbatim}
+ \begin{Verbatim}[label=update list of available packages]
  # ipkg update
- \end{verbatim}
+ \end{Verbatim}
  This command requires a working internet connection, because it will fetch a
- package list from every repository declared in /etc/ipkg.conf.
+ package list from every repository declared in \file{/etc/ipkg.conf}.
  To install a new package use following command:
- \begin{verbatim}
+ \begin{Verbatim}[label=example installation of \app{tcpdump}]
  # ipkg install tcpdump
- \end{verbatim}
+ \end{Verbatim}
- This will install the package tcpdump and all dependencies onto the flash.
+ This will install the package \app{tcpdump} and all dependencies onto the flash.
  Where the data is saved depends on the root filesystem you decided to use while
  installing FreeWRT. If you use jffs2 as root filesystem, then the package is
  installed on the big linux partition. If you use squashfs-overlay, then the
-Line 1154 
 to the jffs2 data partition. If you use
+Line 1222 
 to the jffs2 data partition. If you use
  package data is directly install into the jffs2 data partition, containing
  symlinks to the read-only squashfs partition.
- You can also remove packages, but this is only useful if you are using JFFS2
+ You can also remove packages, but this is only useful if you are using jffs2
  as root filesystem:
- \begin{verbatim}
+ \begin{Verbatim}[label=example removal of \app{tcpdump}]
  # ipkg remove tcpdump
- \end{verbatim}
+ \end{Verbatim}
- This will not remove any dependencies, installed earlier. For example, libpcap
+ This will not remove any dependencies, installed earlier. For example,
- is still installed after executing this command.
+ \app{libpcap} is still installed after executing this command.
  On jffs2 root filesystem you should never remove any essential packages like
- busybox, fwcf or uclibc, otherwise you make the embedded system unusable.
+ \app{busybox}, \app{fwcf} or \app{uclibc}, otherwise you make the embedded system unusable.
- Nearly the same as for removing packages, counts for ipkg upgrade.  Please
+ Nearly the same as for removing packages, counts for \command{ipkg upgrade}.  Please
- \textbf{never ever} use ipkg upgrade to update your embedded system.  This command
+ \strong{never ever} use \command{ipkg upgrade} to update your embedded system.  This command
  is only useful to upgrade single packages on a jffs2 rootfilesystem or data
  partition.
-Line 1174 
 partition.
+Line 1242 
 partition.
  Some of the available packages containing software which start services at boot
  time. For that we provide simple startup scripts, which are installed into the
- directory \texttt{/etc/init.d}. See following example for
+ directory \file{/etc/init.d}. See following example for
- the package \texttt{dnsmasq}, a combined dns and dhcp
+ the package \app{dnsmasq}, a combined dns and dhcp
  server daemon:
- \begin{verbatim}
+ \begin{Verbatim}[label=\file{/etc/init.d/S50dnsmasq}]
  #!/bin/sh
  . /etc/rc.conf
-Line 1204 
 restart)
+Line 1272 
 restart)
          ;;
  esac
  exit 0
- \end{verbatim}
+ \end{Verbatim}
  After installation the package postinst script will add all needed changes to the
- /etc directory. For example packages can add new user and groups, add new
+ \file{/etc/} directory. For example packages can add new user and groups, add new
- variables to /etc/rc.conf or just add new values to existing files as
+ variables to \file{/etc/rc.conf} or just add new values to existing files as
- /etc/services. It is FreeWRT policy to do not start any services after
+ \file{/etc/services}. It is FreeWRT policy not to start any services after
  installation or in case of a new boot. To start services on bootup you need to set
- \$servicename=YES in /etc/rc.conf and commit your changes via \dq{}fwcf
+ \code{\$servicename=YES} in \file{/etc/rc.conf} and commit your changes via
- commit\dq{}. For every policy exist a exception, we start all essential services
+ \command{fwcf commit}. For every policy exists an exception, we start all essential services
  by default, like ssh daemon, syslog and network initialisation.
- For some services you can control the startup behavior by modifying
+ For some services you can control the startup behaviour by modifying
- the services\_flags variable in /etc/rc.conf.
+ the \code{\$servicename\_flags} variable in \file{/etc/rc.conf}.
- For example the variable \$ssh\_opts is provided as argument to the dropbear
+ For example the variable \code{\$ssh\_opts} is provided as an argument to the dropbear
- ssh daemon to control its behavior.
+ ssh daemon to control its behaviour.
  Having this policy helps you to configure your FreeWRT embedded system without
  shooting yourself in the foot. For example if you try to realize a firewall system
- and trying to set the rules in /etc/firewall.user, which is read by
+ and trying to set the rules in \file{/etc/firewall.user}, which is read by
- /etc/init.d/S45firewall, if the iptables package is installed. You can just
+ \file{/etc/init.d/S45firewall}, if the iptables package is installed. You can just
- reload the changed ruleset via /etc/init.d/S45firewall restart. If you managed
+ reload the changed ruleset via \code{/etc/init.d/S45firewall restart}. If you managed
  to kick you out of the system, you can just reboot the system and you gain access
  again. As soon as your are ready with the firewall configuration and you decide
- to activate the firewall rules on bootup, you set \$firewall=YES in /etc/rc.conf,
+ to activate the firewall rules on bootup, you set \code{firewall=YES} in
- commit your changes via \dq{}fwcf commit\dq{} and reboot. Now the firewall
+ \file{/etc/rc.conf},
+ commit your changes via \command{fwcf commit} and reboot. Now the firewall
  rules will be activated on bootup.
- \chapter{Troubleshooting}
+ \chapter{Troubleshooting}\label{ch:troubleshooting}
  \section{Failsafe Mode}
-Line 1245 
 more.
+Line 1314 
 more.
  When in failsafe mode, the device won't interpret any networking setup files.
  It stops even before the root filesystem gets mounted read--write, and fwcf is
  set up. It will just set the LAN interface up and give it the IP address
-.168.1.1 and netmask 255.255.255.0. Then it will start a telnet daemon, so
+ \file{192.168.1.1} and netmask \file{255.255.255.0}. Then it will start a
- you get straight access (without depending on the installed SSH--daemon).
+ \app{telnet} daemon, so you get straight access (without depending on the installed SSH daemon).
  \subsection{How It Works}
  To get FreeWRT into failsafe mode you need physical access to the device and
  the failsafe utility. The failsafe utility is built inside our ADK and
- is available in the directory bin/ after a successful build.
+ is available in the directory \file{bin/} after a successful build.
  If you just want to compile the tool and not a complete firmware image,
  use following command:
- \begin{Verbatim}
+ \begin{Verbatim}[label=building the failsafe utility for the host system]
  $ make subdir=tools/failsafe install
  \end{Verbatim}
  For some operating systems we provide ready to go binaries of failsafe.
- Take a look at http://www.freewrt.org/downloads/tools/failsafe
+ Take a look at \url{http://www.freewrt.org/downloads/tools/failsafe}
  The tool just opens a network socket and waits for a special UDP packet
  from the embedded device. FreeWRT sends the UDP packet via the first
-Line 1274 
 Connect your computer to the embedded sy
+Line 1343 
 Connect your computer to the embedded sy
  cable. Use the failsafe port (in most cases one of the LAN ports),
  see the device specific page for the exact network port.
- Configure your network interface to the IP address 192.168.1.2 with network
+ Configure your network interface to the IP address \file{192.168.1.2} with network
- mask 255.255.255.0. Now start the failsafe utility on your computer.
+ mask \file{255.255.255.0}. Now start the failsafe utility on your computer.
  \begin{Verbatim}
  $ ./failsafe
-Line 1318 
 After that you need to enable the FreeWR
+Line 1387 
 After that you need to enable the FreeWR
  # fwcf setup
  \end{Verbatim}
- Now you can change files in /etc and repair your broken configuration.
+ Now you can change files in \file{/etc/} and repair your broken configuration.
  Do not forget to commit your changes afterwards.
  \begin{Verbatim}
  # fwcf commit
  \end{Verbatim}
- If you want to start over with the default /etc directory, just remove the fwcf
+ If you want to start over with the default \file{/etc/} directory, just remove the fwcf
  partition content with following command:
  \begin{Verbatim}
  mtd erase fwcf
  \end{Verbatim}
- You can either use "reboot -f" or "-r" for mtd to reboot the system.
+ You can either use \command{reboot -f} or the option \command{-r} for \app{mtd} to reboot the system.
  %\section{Serial Console}

 Legend:



Removed from v.2535
 


changed lines


 
Added in v.2536
 Legend:



Removed from v.2535
 


changed lines


 
Added in v.2536
-Removed from v.2535
+Added in v.2536

root@freewrt.org:443	ViewVC Help
Powered by ViewVC 1.1.20

// Log In
// CVSweb
Project: FreeWRT
// Summary // Activity // Search // Tracker // Lists // News // SCM // Wiki