detectors/slsDetectorPackage
24
1
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-02-08 06:28:41 +01:00
Code Issues Actions Packages Releases Activity

Dev/doc c standard (#1268)
Some checks failed
Build on RHEL9 / build (push) Failing after 4m21s
Details
Build on RHEL8 / build (push) Failing after 4m56s
Details

Browse Source 
* updated c++11 to c++17

* more about c++11 and updating readme

* updated documentation for receiver arguments and also making receiver constructor explicit

* minor fix for rxr err message

* fixed doc about gcc version
This commit is contained in:
maliakal_d
2025-08-13 15:53:07 +02:00
committed by GitHub
parent 89fe2a6329
commit 776338a3d4
10 changed files with 110 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/src/slsreceiver.rst
View File

@@ -38,18 +38,41 @@ There are three main receiver types. How to start them is described :ref:`below<
+----------------------+--------------------+-----------------------------------------+--------------------------------+
.. _Starting up the Receiver:
Starting up the Receiver
-------------------------
.. code-block:: bash
Usage: slsReceiver Options:
-v, --version : Version.
-p, --port : TCP port to communicate with client for configuration. Non-zero and 16 bit.
-u, --uid : Set effective user id if receiver started with privileges.
Usage: slsMultiReceiver Options:
-v, --version : Version.
-n, --num-receivers : Number of receivers.
-p, --port : TCP port to communicate with client for configuration. Non-zero and 16 bit.
-c, --callback : Enable dummy callbacks for debugging. Disabled by default.
-u, --uid : Set effective user id if receiver started with privileges.
Usage: slsFrameSynchronizer Options:
-v, --version : Version.
-n, --num-receivers : Number of receivers.
-p, --port : TCP port to communicate with client for configuration. Non-zero and 16 bit.
-c, --print-headers : Print callback headers for debugging. Disabled by default.
-u, --uid : Set effective user id if receiver started with privileges.
For a Single Module
.. code-block:: bash
slsReceiver # default port 1954
slsReceiver -t2012 # custom port 2012
slsReceiver -p 2012 # custom port 2012
For Multiple Modules
@@ -59,13 +82,13 @@ For Multiple Modules
# option 1 (one for each module)
slsReceiver
slsReceiver -t1955
slsReceiver -p 1955
# option 2
slsMultiReceiver 2012 2
slsMultiReceiver -p 2012 -n 2
# option 3
slsFrameSynchronizer 2012 2
slsFrameSynchronizer -p 2012 -n 2