[seiscomp, scanloc] Install, add .gitignore

share/doc/seiscomp/html/_sources/apps/scchkcfg.rst.txt

@@ -0,0 +1,75 @@
+.. highlight:: rst
+
+.. _scchkcfg:
+
+########
+scchkcfg
+########
+
+**Checks a module configuration.**
+
+
+Description
+===========
+
+scchkcfg checks for case-sensitivity issues of parameter names of the module
+configuration file for a module. It reads all defined configuration stages
+(see :ref:`global_modules`) and checks for each parameter read if it exists
+again with a different spelling.
+
+If *standalone* is not given, it checks all 6 configurations
+files (including :file:`global.cfg`), 3 otherwise.
+
+
+Examples
+========
+
+.. code-block:: sh
+
+   $ scchkcfg scautopick
+   Read configuration files OK
+   No possible conflict detected
+
+scchkcfg checks only for possible conflicts since it does not know what parameters
+a module will read eventually.
+
+.. code-block:: sh
+
+   $ scchkcfg scautopick
+   Read configuration files OK
+   Conflict #1
+    connection.server    /home/sysop/seiscomp/etc/global.cfg:8
+    connection.Server    /home/sysop/.seiscomp/scautopick.cfg:1
+   1 conflict detected
+
+In this case everything is ok and the conflict needs to be fixed.
+:confval:`connection.Server` is not a valid parameter name
+(but :confval:`connection.server` is) in
+:file:`/home/sysop/.seiscomp/scautopick.cfg` and thus will not be used.
+
+
+.. code-block:: sh
+
+   $ scchkcfg scautopick
+   Read configuration files OK
+   Conflict #1
+    module.trunk.global.amplitudes.mb.signalEnd    \
+         /home/sysop/.seiscomp/scautopick.cfg:1
+    module.trunk.global.amplitudes.mB.signalEnd    \
+         /home/sysop/.seiscomp/scautopick.cfg:2
+   1 conflict detected
+
+In this case the configuration is OK and this is an example why the case-sensitivity
+has changed from previous versions: mb != mB. scchkcfg detects a possible
+conflicts but does not know that this case is well defined. But it helps the user to
+decide whether it needs a fix or not.
+
+
+
+Command-Line Options
+====================
+
+.. program:: scchkcfg
+
+:program:`scchkcfg {mod-name} [standalone]`
+