From de7bb0b9794289b197525b2434e952ec6634d1b7 Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Thu, 17 Aug 2017 14:32:45 +0200 Subject: [PATCH] command line docu. more coming up --- RELEASE.txt | 3 ++- manual/slsDetectorClientDocs/html/config.html | 8 ++++---- manual/slsDetectorClientDocs/html/test.html | 2 +- manual/slsDetectorClientDocs/latex/config.tex | 12 ++++++------ manual/slsDetectorClientDocs/latex/doxygen.sty | 4 ++-- manual/slsDetectorClientDocs/latex/refman.tex | 2 +- manual/slsDetectorClientDocs/latex/test.tex | 2 +- 7 files changed, 17 insertions(+), 16 deletions(-) diff --git a/RELEASE.txt b/RELEASE.txt index 805f42288..32ce5b1f6 100644 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -10,8 +10,9 @@ This document describes the differences between previous versions and 3.0.0 rele Manuals can be found under the 'manual' folder. Command Line Documentation can be accessed from this location via browser: - slsDetectorSoftware/slsDetectorClientDocs/html/index.html + manual/slsDetectorClientDocs/html/index.html + User documentation and other help can be accessed directly at this location: https://www.psi.ch/detectors/users-support diff --git a/manual/slsDetectorClientDocs/html/config.html b/manual/slsDetectorClientDocs/html/config.html index fddf6e406..82b2dfe64 100644 --- a/manual/slsDetectorClientDocs/html/config.html +++ b/manual/slsDetectorClientDocs/html/config.html @@ -118,6 +118,9 @@ Data Size +

Flags

commands to configure detector flags

@@ -303,10 +306,7 @@ Detector Parameters
  • parameters [fname] sets/saves detector parameters contained in fname. Normally once per different measurement.
    • - diff --git a/manual/slsDetectorClientDocs/html/test.html b/manual/slsDetectorClientDocs/html/test.html index eb2f82193..c1446703f 100644 --- a/manual/slsDetectorClientDocs/html/test.html +++ b/manual/slsDetectorClientDocs/html/test.html @@ -79,7 +79,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • getbit ??? Only get!
    • diff --git a/manual/slsDetectorClientDocs/latex/config.tex b/manual/slsDetectorClientDocs/latex/config.tex index 208e398cf..ac130ad48 100644 --- a/manual/slsDetectorClientDocs/latex/config.tex +++ b/manual/slsDetectorClientDocs/latex/config.tex @@ -109,6 +109,11 @@ commands to configure detector data size \begin{DoxyItemize} \item {\bfseries flippeddatax \mbox{[}i\mbox{]}} enables/disables data being flipped across x axis. 1 enables, 0 disables. Used for EIGER only. 1 for bottom half-\/module, 0 for top-\/half module. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries tengiga \mbox{[}i\mbox{]}} enables/disables 10GbE in system (detector \& receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only. \end{DoxyItemize}\hypertarget{config_configflags}{}\subsection{Flags}\label{config_configflags} commands to configure detector flags @@ -387,10 +392,5 @@ commands to configure/retrieve configuration of detector \begin{DoxyItemize} -\item {\bfseries setup \mbox{[}fname\mbox{]}} sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc. -\end{DoxyItemize} - - -\begin{DoxyItemize} -\item {\bfseries tengiga \mbox{[}i\mbox{]}} enables/disables 10GbE in system (detector \& receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only. +\item {\bfseries setup \mbox{[}fname\mbox{]}} sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc. \end{DoxyItemize} \ No newline at end of file diff --git a/manual/slsDetectorClientDocs/latex/doxygen.sty b/manual/slsDetectorClientDocs/latex/doxygen.sty index b138dbe41..2ba1c1b0f 100644 --- a/manual/slsDetectorClientDocs/latex/doxygen.sty +++ b/manual/slsDetectorClientDocs/latex/doxygen.sty @@ -24,9 +24,9 @@ \fancyplain{}{\bfseries\thepage}% } \rfoot[\fancyplain{}{\bfseries\scriptsize% - Generated on Thu Aug 17 14:16:02 2017 by Doxygen }]{} + Generated on Thu Aug 17 14:31:37 2017 by Doxygen }]{} \lfoot[]{\fancyplain{}{\bfseries\scriptsize% - Generated on Thu Aug 17 14:16:02 2017 by Doxygen }} + Generated on Thu Aug 17 14:31:37 2017 by Doxygen }} \cfoot{} %---------- Internal commands used in this style file ---------------- diff --git a/manual/slsDetectorClientDocs/latex/refman.tex b/manual/slsDetectorClientDocs/latex/refman.tex index 9c75cbda8..ada982757 100644 --- a/manual/slsDetectorClientDocs/latex/refman.tex +++ b/manual/slsDetectorClientDocs/latex/refman.tex @@ -40,7 +40,7 @@ \vspace*{1cm} {\large Generated by Doxygen 1.6.1}\\ \vspace*{0.5cm} -{\small Thu Aug 17 14:16:02 2017}\\ +{\small Thu Aug 17 14:31:37 2017}\\ \end{center} \end{titlepage} \pagenumbering{roman} diff --git a/manual/slsDetectorClientDocs/latex/test.tex b/manual/slsDetectorClientDocs/latex/test.tex index ad49ae565..b175f8d54 100644 --- a/manual/slsDetectorClientDocs/latex/test.tex +++ b/manual/slsDetectorClientDocs/latex/test.tex @@ -65,5 +65,5 @@ Commands to be used only for software debugging. Avoid using them! \begin{DoxyItemize} -\item {\bfseries r\_\-compression \mbox{[}i\mbox{]} sets/gets compression in receiver. 1 sets, 0 unsets. Not implemented.} +\item {\bfseries r\_\-compression \mbox{[}i\mbox{]} } sets/gets compression in receiver. 1 sets, 0 unsets. Not implemented. \end{DoxyItemize} \ No newline at end of file