Updated configuration docs.
authorFlorian Pose <fp@igh-essen.com>
Fri, 04 Nov 2011 13:19:03 +0100
changeset 2153 5bb7df22ced2
parent 2152 cc8fcd840e30
child 2154 6a0296e7d1cd
Updated configuration docs.
documentation/ethercat_doc.tex
--- a/documentation/ethercat_doc.tex	Fri Nov 04 12:21:36 2011 +0100
+++ b/documentation/ethercat_doc.tex	Fri Nov 04 13:19:03 2011 +0100
@@ -2,7 +2,7 @@
 %
 %  IgH EtherCAT Master Documentation
 %
-%  $Id$
+%  $Id: ethercat_doc.tex,v 1baafcd263cc 2011/07/06 14:37:40 fp $
 %
 %  vi: spell spelllang=en tw=78
 % 
@@ -19,6 +19,7 @@
 \usepackage[nofancy]{rcsinfo}
 \usepackage{SIunits}
 \usepackage{amsmath} % for \text{}
+\usepackage{longtable}
 \usepackage{hyperref}
 
 \hypersetup{pdfpagelabels,plainpages=false}
@@ -62,7 +63,7 @@
 \newcommand{\IgH}{\raisebox{-0.7667ex}
   {\includegraphics[height=2.2ex]{images/ighsign}}}
 
-\rcsInfo $RCSId$
+\rcsInfo $RCSId: ethercat_doc.tex,v 1baafcd263cc 2011/07/06 14:37:40 fp exp $
 
 \newcommand{\masterversion}{1.5.0}
 \newcommand{\linenum}[1]{\normalfont\textcircled{\tiny #1}}
@@ -2987,63 +2988,79 @@
 
 Table~\ref{tab:config} lists important configuration switches and options.
 
-\begin{table}
-  \caption{Configuration options}
-  \label{tab:config}
-  \vspace{2mm}
-  \begin{tabular}{l|p{.3\textwidth}|l}
-
-\bf Option/Switch & \bf Description & \bf Default\\\hline
+\begin{longtable}{l|p{.4\textwidth}|l}
+  \caption{Configuration options}\rule[-5ex]{0mm}{0mm}
+  \label{tab:config}\\
+
+\textbf{Option/Switch} & \textbf{Description} & \textbf{Default}\\\hline
+\endfirsthead
+
+\textbf{Option/Switch} & \textbf{Description} & \textbf{Default}\\\hline
+\endhead
 
 \lstinline+--prefix+ & Installation prefix & \textit{/opt/etherlab}\\
 
 \lstinline+--with-linux-dir+ & Linux kernel sources & Use running kernel\\
 
+\lstinline+--with-module-dir+ & Subdirectory in the kernel module tree, where
+the EtherCAT kernel modules shall be installed. & \textit{ethercat}\\
+
+\hline
+
+\lstinline+--enable-generic+ & Build the generic Ethernet driver (see
+sec.~\ref{sec:generic-driver}). & no\\
+
+\lstinline+--enable-8139too+ & Build the 8139too driver & yes\\
+
+\lstinline+--with-8139too-kernel+ & 8139too kernel & $\dagger$\\
+
+\lstinline+--enable-e100+ & Build the e100 driver & no\\
+
+\lstinline+--with-e100-kernel+ & e100 kernel & $\dagger$\\
+
+\lstinline+--enable-e1000+ & Enable e1000 driver & no\\
+
+\lstinline+--with-e1000-kernel+ & e1000 kernel & $\dagger$\\
+
+\lstinline+--enable-e1000e+ & Enable e1000e driver & no\\
+
+\lstinline+--with-e1000e-kernel+ & e1000e kernel & $\dagger$\\
+
+\lstinline+--enable-r8169+ & Enable r8169 driver & no\\
+
+\lstinline+--with-r8169-kernel+ & r8169 kernel & $\dagger$\\
+
+\hline
+
 \lstinline+--with-rtai-dir+ & RTAI path (only for RTAI example) & \\
 
-\hline
+\lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\
+
+\lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\
+
+\lstinline+--enable-eoe+ & Enable EoE support & yes\\
+
+\lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel
+architecture to get finer timing calculation. & no\\
+
+\lstinline+--enable-hrtimer+ & Use high-resolution timer to let the master
+state machine sleep between sending frames. & no\\
+
+\lstinline+--enable-regalias+ & Read alias address from register. & no\\
 
 \lstinline+--enable-tool+ & Build the command-line tool ``ethercat'' (see
 sec.~\ref{sec:tool}). & yes\\
 
 \lstinline+--enable-userlib+ & Build the userspace library. & yes\\
 
-\lstinline+--enable-eoe+ & Enable EoE support & yes\\
-
-\lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel
-architecture to get finer timing calculation. & no\\
-
-\lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\
-
-\lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\
+\lstinline+--enable-tty+ & Build the TTY driver. & no\\
+
+\lstinline+--enable-wildcards+ & Enable \textit{0xffffffff} to be wildcards
+for vendor ID and product code. & no\\
 
 \hline
 
-\lstinline+--enable-8139too+ & Build the 8139too driver & yes\\
-
-\lstinline+--with-8139too-kernel+ & 8139too kernel & $\dagger$\\
-
-\lstinline+--enable-e100+ & Build the e100 driver & no\\
-
-\lstinline+--with-e100-kernel+ & e100 kernel & $\dagger$\\
-
-\lstinline+--enable-e1000+ & Enable e1000 driver & no\\
-
-\lstinline+--with-e1000-kernel+ & e1000 kernel & $\dagger$\\
-
-\lstinline+--enable-e1000e+ & Enable e1000e driver & no\\
-
-\lstinline+--with-e1000e-kernel+ & e1000e kernel & $\dagger$\\
-
-\lstinline+--enable-r8169+ & Enable r8169 driver & no\\
-
-\lstinline+--with-r8169-kernel+ & r8169 kernel & $\dagger$\\
-
-\lstinline+--enable-generic+ & Build the generic Ethernet driver (see
-sec.~\ref{sec:generic-driver}). & no\\
-
-  \end{tabular}
-  \vspace{2mm}
+\end{longtable}
 
 \begin{description}
 
@@ -3052,8 +3069,6 @@
 
 \end{description}
 
-\end{table}
-
 \section{Building the Interface Documentation}
 \label{sec:gendoc}