Dev/doc c standard (#1268)

* 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

docs/src/dataformat.rst

@@ -1,3 +1,5 @@
+.. _data format:
+
 Data Format
 ================================
 

docs/src/dependencies.rst

@@ -14,7 +14,12 @@ the shared libraries these are needed:
 
  * Linux, preferably recent kernel (currently no cross platform support)
  * CMake >= 3.14 
- * C++11 compatible compiler. (We test with gcc and clang)
+ * C++17 compatible compiler. (We test with gcc and clang)
+
+.. note ::  
+    
+    For v9.x.x of slsDetectorPackage and older, C++11 compatible compiler.
+
 
 -----------------------
 Python bindings

docs/src/fileformat.rst

@@ -1,3 +1,5 @@
+.. _file format:
+
 File format
 ================================
 

docs/src/index.rst

@@ -33,7 +33,8 @@ Welcome to slsDetectorPackage's documentation!
     :maxdepth: 2
 
     multidet
-
+    quick_start_guide
+    
 .. toctree::
     :caption: Python API
     :maxdepth: 2
@@ -50,7 +51,7 @@ Welcome to slsDetectorPackage's documentation!
     :maxdepth: 1
 
     commandline  
-    quick_start_guide
+
 
 .. toctree::
     :caption: Developer

docs/src/installation.rst

@@ -220,7 +220,7 @@ Example cmake options               Comment
 3.3. Build on old distributions using conda
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If your linux distribution doesn't come with a C++11 compiler (gcc>4.8) then 
+If your linux distribution doesn't come with a C++17 compiler (gcc>8) then 
 it's possible to install a newer gcc using conda and build the slsDetectorPackage
 using this compiler
 

docs/src/quick_start_guide.rst

@@ -19,14 +19,14 @@ For a Single Module
         slsReceiver
 
         # custom port 2012
-        slsReceiver -t2012
+        slsReceiver -p 2012
 
 
 For Multiple Modules
     .. code-block:: bash  
 
-        # slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]
-        slsMultiReceiver 2012 2 0 
+        # slsMultiReceiver [-p: starting port, -n: number of receivers]
+        slsMultiReceiver -p 2012 -n 2 
 
 
 Client
@@ -131,6 +131,27 @@ For Multiple Modules
 .. note ::   
     The **hostname** and **detsize** command in a multi module system can affect the row and column values in the udp/zmq header. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on. 
 
+
+
+
+
+Data
+-----
+
+Check out the :ref:`UDP header section<detector udp header>` for details on output UDP header data format.`
+
+Check out the :ref:`Data format section<data format>`  for details on output data format.
+
+
+Receiver
+---------
+
+When using `slsReceiver`, `slsMultiReceiver` or `slsFrameSynchronizer`, check out the following sections:
+
+ - :ref:`File format<file format>`
+ - :ref:`slsReceiver header format<sls receiver header format>`
+ - :ref:`Master file attributes<master file attributes>`
+
     
 Gui
 ----

docs/src/slsreceiver.rst

@@ -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