detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-04-26 16:20:03 +02:00
Code Issues Actions Packages Releases Activity

command line docu. more coming up

Browse Source
This commit is contained in:
Dhanya Maliakal 2017-08-17 14:32:45 +02:00
parent 3da71c9274
commit de7bb0b979
7 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
RELEASE.txt
View File

@ -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. Manuals can be found under the 'manual' folder.
Command Line Documentation can be accessed from this location via browser: 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: User documentation and other help can be accessed directly at this location:
https://www.psi.ch/detectors/users-support https://www.psi.ch/detectors/users-support

8
manual/slsDetectorClientDocs/html/config.html
View File

@ -118,6 +118,9 @@ Data Size</a></h2>
<ul> <ul>
<li><b>flippeddatax [i]</b> 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.</li> <li><b>flippeddatax [i]</b> 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.</li>
</ul> </ul>
<ul>
<li><b>tengiga [i]</b> enables/disables 10GbE in system (detector &amp; receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.</li>
</ul>
<h2><a class="anchor" id="configflags"> <h2><a class="anchor" id="configflags">
Flags</a></h2> Flags</a></h2>
<p>commands to configure detector flags</p> <p>commands to configure detector flags</p>
@ -303,10 +306,7 @@ Detector Parameters</a></h2>
<li><b>parameters [fname]</b> sets/saves detector parameters contained in fname. Normally once per different measurement.</li> <li><b>parameters [fname]</b> sets/saves detector parameters contained in fname. Normally once per different measurement.</li>
</ul> </ul>
<ul> <ul>
<li><b>setup [fname]</b> sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc.</li> <li><b>setup [fname]</b> sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc. </li>
</ul>
<ul>
<li><b>tengiga [i]</b> enables/disables 10GbE in system (detector &amp; receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only. </li>
</ul> </ul>
</div> </div>
<!--- window showing the filter options --> <!--- window showing the filter options -->

2
manual/slsDetectorClientDocs/html/test.html
View File

@ -79,7 +79,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><b>getbit </b> ??? Only get!</li> <li><b>getbit </b> ??? Only get!</li>
</ul> </ul>
<ul> <ul>
<li><b>r_compression [i] sets/gets compression in receiver. 1 sets, 0 unsets. Not implemented.</b> </li> <li><b>r_compression [i] </b> sets/gets compression in receiver. 1 sets, 0 unsets. Not implemented. </li>
</ul> </ul>
</div> </div>
<!--- window showing the filter options --> <!--- window showing the filter options -->

12
manual/slsDetectorClientDocs/latex/config.tex
View File

@ -109,6 +109,11 @@ commands to configure detector data size
\begin{DoxyItemize} \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. \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} \end{DoxyItemize}\hypertarget{config_configflags}{}\subsection{Flags}\label{config_configflags}
commands to configure detector flags commands to configure detector flags
@ -387,10 +392,5 @@ commands to configure/retrieve configuration of detector
\begin{DoxyItemize} \begin{DoxyItemize}
\item {\bfseries setup \mbox{[}fname\mbox{]}} sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc. \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.
\end{DoxyItemize} \end{DoxyItemize}

4
manual/slsDetectorClientDocs/latex/doxygen.sty
View File

@ -24,9 +24,9 @@
\fancyplain{}{\bfseries\thepage}% \fancyplain{}{\bfseries\thepage}%
} }
\rfoot[\fancyplain{}{\bfseries\scriptsize% \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% \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{} \cfoot{}
%---------- Internal commands used in this style file ---------------- %---------- Internal commands used in this style file ----------------

2
manual/slsDetectorClientDocs/latex/refman.tex
View File

@ -40,7 +40,7 @@
\vspace*{1cm} \vspace*{1cm}
{\large Generated by Doxygen 1.6.1}\\ {\large Generated by Doxygen 1.6.1}\\
\vspace*{0.5cm} \vspace*{0.5cm}
{\small Thu Aug 17 14:16:02 2017}\\ {\small Thu Aug 17 14:31:37 2017}\\
\end{center} \end{center}
\end{titlepage} \end{titlepage}
\pagenumbering{roman} \pagenumbering{roman}

2
manual/slsDetectorClientDocs/latex/test.tex
View File

@ -65,5 +65,5 @@ Commands to be used only for software debugging. Avoid using them!
\begin{DoxyItemize} \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} \end{DoxyItemize}