Changeset e91877d in freewrt for docs


Ignore:
Timestamp:
Jan 2, 2007, 3:58:57 PM (19 years ago)
Author:
Phil Sutter <n0-1@…>
Branches:
freewrt_1_0, freewrt_2_0
Children:
3e916e1
Parents:
a5dfd27
Message:
  • fixed the $\star$ issue, replaced it with \textbf
  • improved Makefile a bit, now html docs are created as single file as well as splitted

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

Location:
docs/handbook/user
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • docs/handbook/user/00-allinone.tex

    ra5dfd27 re91877d  
    533533\subsubsection{Basic Settings}
    534534
     535Mandatory options and default parameters are in bold font.
     536
    535537\begin{tabular}{l|l|l}
    536538\textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
    537539\hline
    538 type  & broadcom        & Broadcom based card \\
     540\textbf{type}& broadcom        & Broadcom based card \\
    539541             & atheros         & Madwifi driver \\
    540 mode  & ap              & Access point mode \\
     542\textbf{mode}& ap              & Access point mode \\
    541543             & sta             & Client mode \\
    542544             & adhoc           & Ad-Hoc mode \\
    543545             & wds             & WDS point-to-point link \\
    544546             & monitor         & The node acts as a passive monitor and only receives packets \\
    545 ssid  & <String>        & Set the SSID (Network Name) \\
     547\textbf{ssid}& <String>        & Set the SSID (Network Name) \\
    546548country      & {ALL|DE|JP|US|...} & The country code used to determine the regulatory settings. \\
    547549\end{tabular}
     
    551553\textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
    552554\hline
    553 security & none            & No authorization \\
     555\textbf{security}& none            & No authorization \\
    554556             & wep             & WEP key \\
    555557             & wpa-psk         & WPA with preshared key \\
    556558             & 8021x           & IEEE 802.1X authentication \\
    557 authorization &            & \textbf{wep} \\
     559\textbf{authorization}&            & \textbf{wep} \\
    558560             & open            & Only Open System Authentication \\
    559561             & shared          & Only Shared Key Authentication \\
    560              & open+shared & Both Open System and Shared Key Authentication
     562             & \textbf{open+shared}& Both Open System and Shared Key Authentication
    561563                                 \\
    562564             &                 & \textbf{wpa-psk} \\
     
    570572             & wpa2            & WPA2 with RADIUS \\
    571573             & wpa wpa2        & WPA and WPA2 \\
    572 encryption &            & \textbf{wep} \\
     574\textbf{encryption}&            & \textbf{wep} \\
    573575             & -               & not needed, automatically by key size \\
    574576             &                 & \textbf{wpa-psk} \\
     
    582584             & aes+tkip        & support both \\
    583585eap-type     &                 & \textbf{8021x} \\
    584              & tls      & Transport Layer Security \\
     586             & \textbf{tls}    & Transport Layer Security \\
    585587             & ttls            & Tunnelled TLS \\
    586588             & peap            & Protected EAP \\
    587589             & leap            & Cisco Wireless \\
    588590key          &                 & \textbf{wep} \\
    589              & \{1|2|3|4\}    & Select WEP key to use. \\
     591             &\{\textbf{1}|2|3|4\}& Select WEP key to use. \\
    590592key[1..4]    &                 & \textbf{wep} \\
    591593             & <String>        & WEP key.  The key must be 5, 13 or 16 bytes
     
    597599                                 up to 63 chars) \\
    598600wpa-gtk-rekey &                & \textbf{wpa-psk}, \textbf{8021x} \\
    599              & <Int> (3600) & Rekeying interval in seconds. \\
    600 radius-ipaddr &             & \textbf{8021x} \\
     601             & <Int> (\textbf{3600}) & Rekeying interval in seconds. \\
     602\textbf{radius-ipaddr}&             & \textbf{8021x} \\
    601603             & <a.b.c.d>       & IP to connect. \\
    602604radius-port  &                 & \textbf{8021x} \\
    603              & <Int> (1812) & RADIUS-Port no. to connect \\
    604 radius-key &                & \textbf{8021x} \\
     605             & <Int> (\textbf{1812}) & RADIUS-Port no. to connect \\
     606\textbf{radius-key}&                & \textbf{8021x} \\
    605607             & <String>        & Shared Secret for connection to the Radius server \\
    606608\end{tabular}
     
    627629\begin{tabular}{l|l|l}
    628630\textbf{Option} & \textbf{Parameter} & \textbf{Description} \\
    629 channel      & {1-14}          & The wifi channel \\
    630 maxassoc     & {1-255}         & Maximum number of associated clients \\
    631 gmode        & {LegacyB| Auto| GOnly| BDeferred| Performance| LRS} & Set the 54g Mode \\
    632 frameburst   & {0|1}        & Disable/Enable frameburst mode. \\
    633 txpower      & {0-255|-1}   & Set the transmit power in dBm \\
    634 rate         & <Int> (-1)   & force a fixed rate \\
     631channel      & \{1-14\}          & The wifi channel \\
     632maxassoc     & \{1-255\}         & Maximum number of associated clients \\
     633gmode        & \{LegacyB| \textbf{Auto}| GOnly| BDeferred| Performance| LRS\} & Set the 54g Mode \\
     634frameburst   & \{\textbf{0}|1\}        & Disable/Enable frameburst mode. \\
     635txpower      & \{0-255|\textbf{-1}\}   & Set the transmit power in dBm \\
     636rate         & <Int> (\textbf{-1})   & force a fixed rate \\
    635637             &                 & valid values for 802.11a are (6, 9, 12, 18, 24, 36, 48, 54) \\
    636638             &                 & valid values for 802.11b are (1, 2, 5.5, 11) \\
    637639             &                 & valid values for 802.11g are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54) \\
    638640             &                 &-1 means automatically determine the best rate \\
    639 rts          & {0-2347}        & Set the RTS threshhold. \\
    640 frag         & {256-2346}      & Set the fragmentation threshhold. \\
    641 afterburner  & {0|1}        & Enable Afterburner capability \\
    642 isolate      & {0|1}        & Hide Clients from each other \\
     641rts          & \{0-2347\}        & Set the RTS threshhold. \\
     642frag         & \{256-2346\}      & Set the fragmentation threshhold. \\
     643afterburner  & \{\textbf{0}|1\}        & Enable Afterburner capability \\
     644isolate      & \{\textbf{0}|1\}        & Hide Clients from each other \\
    643645\end{tabular}
    644646
  • docs/handbook/user/Makefile

    ra5dfd27 re91877d  
    55OBJECTS = *.tex
    66BULLSHIT = *.aux *.log *.idx *.toc *.out
    7 TARGET = $(NAME).pdf
     7TARGETS = $(NAME).pdf allinone splitup
     8
    89PAGE =
     10HTMLOPTS = -no_navigation -noinfo -noaddress -local_icons
    911
    10 .PHONY: all clean distclean help
     12.PHONY: all clean distclean help allinone splitup
    1113
    12 all: $(TARGET)
     14all: $(TARGETS)
    1315
    14 $(TARGET): $(OBJECTS)
     16allinone: $(OBJECTS)
     17        mkdir -p $@
     18        latex2html $(HTMLOPTS) -split 0 -dir $@ $(BASEOBJ)
     19
     20splitup: $(OBJECTS)
     21        mkdir -p $@
     22        latex2html $(HTMLOPTS) -split +3 -dir $@ $(BASEOBJ)
     23
     24$(NAME).pdf: $(OBJECTS)
    1525        # run twice to generate tableofcontents
    1626        pdflatex $(BASEOBJ)
    1727        pdflatex $(BASEOBJ)
    18         latex2html -no_navigation -split 0 -noinfo -noaddress -local_icons $(BASEOBJ)
    19         echo $(OBJECTS)
    2028
    2129clean:
    22         -rm $(BULLSHIT)
     30        rm -rf $(BULLSHIT)
    2331
    2432tclean:
    25         -rm $(TARGET)
     33        rm -rf $(TARGETS)
    2634
    2735distclean: clean tclean
Note: See TracChangeset for help on using the changeset viewer.