Changeset 29f2fbe2 in freewrt for docs

Timestamp:

Dec 26, 2006, 1:14:42 PM (19 years ago)

Author:

Waldemar Brodkorb <wbx@…>

Branches:

freewrt_1_0, freewrt_2_0

Children:

e80a2f9

Parents:

1e897878

Message:

add html output, remove $, because it breaks html output, need to find a better fix soon

git-svn-id: ​svn://www.freewrt.org/branches/freewrt_1_0@1384 afb5a338-a214-0410-bd46-81f09a774fd1

Location:

docs/handbook/user

Files:

• 00-allinone.tex (modified) (9 diffs)
• Makefile (modified) (1 diff)
• handbook.tex (modified) (1 diff)

docs/handbook/user/00-allinone.tex

@@ -312 +312 @@
 \begin{itemize} % TODO: insert \ref's to jump to the appropriate section?
 \item via the original firmware's web interface
-\item via \texttt{mtd} when reflashing or migrating from another $\star$WRT
+\item via \texttt{mtd} when reflashing or migrating from another third party distribution
 \item via network using a TFTP client
 \end{itemize}
@@ -341 +341 @@
 the flash has been written.
 
-\begin{center}\fbox{\parbox{30em}{
-\textbf{No \texttt{mtd} utility available?} \\
-There is one built statically for those situations, so you can just
-\texttt{scp} it to the device and use it standalone. 
-% TODO: describe where to find it/how to build it
-}}\end{center}
-
-Mostly, the sample usage shown in the help output should be all that has to be
+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}
-# mtd -r write linux.trx linux
+# mtd -e linux -r write freewrt.bin linux
 \end{Verbatim}
 The parameters explained in detail: \\
 \begin{tabular}{l|l}
-$-r$ & trigger rebooting right after finishing work \\
+-e linux & erase existing data in flash\\
+-r & trigger rebooting right after finishing work\\
 write & write the firmware image contained in the file given as next parameter
-                        to flash \\
+                        to flash\\
 linux.trx & the actual image to write - ignore the suffix, it is detected at
-                                runtime \\
+                                runtime\\
 linux & this is an abstract identifier for a certain partition in flash, so
-don't change this \\
+don't change this\\
 \end{tabular}
 
@@ -538 +532 @@
 
 \subsubsection{Basic Settings}
-$\star$ with Option means mandatory, $\star$ with Parameter means default.
 
 \begin{tabular}{l|l|l}
 \textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
 \hline
-type$\star$  & broadcom        & Broadcom based card \\
+type  & broadcom        & Broadcom based card \\
              & atheros         & Madwifi driver \\
-mode$\star$  & ap              & Access point mode \\
+mode  & ap              & Access point mode \\
              & sta             & Client mode \\
              & adhoc           & Ad-Hoc mode \\
              & wds             & WDS point-to-point link \\
              & monitor         & The node acts as a passive monitor and only receives packets \\
-ssid$\star$  & <String>        & Set the SSID (Network Name) \\
+ssid  & <String>        & Set the SSID (Network Name) \\
 country      & {ALL|DE|JP|US|...} & The country code used to determine the regulatory settings. \\
 \end{tabular}
@@ -558 +551 @@
 \textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
 \hline 
-security$\star$ & none            & No authorization \\
+security & none            & No authorization \\
              & wep             & WEP key \\
              & wpa-psk         & WPA with preshared key \\
              & 8021x           & IEEE 802.1X authentication \\
-authorization$\star$ &            & \textbf{wep} \\
+authorization &            & \textbf{wep} \\
              & open            & Only Open System Authentication \\
              & shared          & Only Shared Key Authentication \\
-             & open+shared$\star$ & Both Open System and Shared Key Authentication
+             & open+shared & Both Open System and Shared Key Authentication
                                  \\
              &                 & \textbf{wpa-psk} \\
@@ -577 +570 @@
              & wpa2            & WPA2 with RADIUS \\
              & wpa wpa2        & WPA and WPA2 \\
-encryption$\star$ &            & \textbf{wep} \\
+encryption &            & \textbf{wep} \\
              & -               & not needed, automatically by key size \\
              &                 & \textbf{wpa-psk} \\
@@ -589 +582 @@
              & aes+tkip        & support both \\
 eap-type     &                 & \textbf{8021x} \\
-             & tls$\star$      & Transport Layer Security \\
+             & tls      & Transport Layer Security \\
              & ttls            & Tunnelled TLS \\
              & peap            & Protected EAP \\
              & leap            & Cisco Wireless \\
 key          &                 & \textbf{wep} \\
-             & \{1$\star$|2|3|4\}    & Select WEP key to use. \\
+             & \{1|2|3|4\}    & Select WEP key to use. \\
 key[1..4]    &                 & \textbf{wep} \\
              & <String>        & WEP key.  The key must be 5, 13 or 16 bytes
@@ -604 +597 @@
                                  up to 63 chars) \\
 wpa-gtk-rekey &                & \textbf{wpa-psk}, \textbf{8021x} \\
-             & <Int> (3600$\star$) & Rekeying interval in seconds. \\
-radius-ipaddr$\star$ &             & \textbf{8021x} \\
+             & <Int> (3600) & Rekeying interval in seconds. \\
+radius-ipaddr &             & \textbf{8021x} \\
              & <a.b.c.d>       & IP to connect. \\
 radius-port  &                 & \textbf{8021x} \\
-             & <Int> (1812$\star$) & RADIUS-Port no. to connect \\
-radius-key$\star$ &                & \textbf{8021x} \\
+             & <Int> (1812) & RADIUS-Port no. to connect \\
+radius-key &                & \textbf{8021x} \\
              & <String>        & Shared Secret for connection to the Radius server \\
 \end{tabular}
@@ -636 +629 @@
 channel      & {1-14}          & The wifi channel \\
 maxassoc     & {1-255}         & Maximum number of associated clients \\
-gmode        & {LegacyB| Auto$\star$| GOnly| BDeferred| Performance| LRS} & Set the 54g Mode \\
-frameburst   & {0$\star$|1}        & Disable/Enable frameburst mode. \\
-txpower      & {0-255|-1$\star$}   & Set the transmit power in dBm \\
-rate         & <Int> (-1$\star$)   & force a fixed rate \\
+gmode        & {LegacyB| Auto| GOnly| BDeferred| Performance| LRS} & Set the 54g Mode \\
+frameburst   & {0|1}        & Disable/Enable frameburst mode. \\
+txpower      & {0-255|-1}   & Set the transmit power in dBm \\
+rate         & <Int> (-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) \\
@@ -646 +639 @@
 rts          & {0-2347}        & Set the RTS threshhold. \\
 frag         & {256-2346}      & Set the fragmentation threshhold. \\
-afterburner  & {0$\star$|1}        & Enable Afterburner capability \\
-isolate      & {0$\star$|1}        & Hide Clients from each other \\
+afterburner  & {0|1}        & Enable Afterburner capability \\
+isolate      & {0|1}        & Hide Clients from each other \\
 \end{tabular}
 

docs/handbook/user/Makefile

@@ -16 +16 @@
         pdflatex $(BASEOBJ)
         pdflatex $(BASEOBJ)
+        latex2html -no_navigation -split 0 -noinfo -noaddress -local_icons $(BASEOBJ)
         echo $(OBJECTS)
 

docs/handbook/user/handbook.tex

@@ -43 +43 @@
 %\usepackage{thumbpdf}
 \usepackage{cancel}
-\usepackage[final, activate, verbose=true]{microtype}
+%\usepackage[final, activate, verbose=true]{microtype}
 \usepackage{ngerman}
 %\usepackage{bookman}