# HG changeset patch # User Florian Pose # Date 1320409143 -3600 # Node ID 0566476835d74b7bbe5ec0774c8e1e0a29007797 # Parent c3f2fab463a090e82395ddf0262a4209eed5e005 Updated configuration docs. diff -r c3f2fab463a0 -r 0566476835d7 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 @@ -19,6 +19,7 @@ \usepackage[nofancy]{rcsinfo} \usepackage{SIunits} \usepackage{amsmath} % for \text{} +\usepackage{longtable} \usepackage{hyperref} \hypersetup{pdfpagelabels,plainpages=false} @@ -2987,11 +2988,15 @@ 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} +\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 \bf Option/Switch & \bf Description & \bf Default\\\hline @@ -2999,51 +3004,61 @@ \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-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 +3067,6 @@ \end{description} -\end{table} - \section{Building the Interface Documentation} \label{sec:gendoc}