[installation] Change to nightly

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

@@ -6,7 +6,7 @@
 invextr
 #######
 
-**Extract channels from inventory.**
+**Extract and clean or remove streams from inventory.**
 
 
 Description
@@ -14,31 +14,37 @@ Description
 
 invextr reads and modifies inventory XML provided as file or on stdin:
 
-* Extract or remove networks, stations and channels based on
+* Extract or remove networks, stations, sensor locations and channels based on
 
-  * channel IDs
-  * geographic region
-  * time
+  * stream IDs,
+  * geographic region,
+  * time.
 
-* Clean inventories from unused objects such as data loggers, sensors or
-  instrument responses.
+* Clean inventories from unreferenced objects such as data loggers, sensors or
+  instrument responses when extracting.
+
+  .. note::
+
+     Cleaning inventory may also be achieved by merging inventories with
+     :ref:`scinv`.
 
 The important parameters are:
 
-* Channel ID list (required)
+* Stream ID list (:option:`--chans`, :option:`--nslc`). Without a stream ID,
+  only unreferenced objects are removed when extracting.
 * Input file or stdin
-* Output file or stdout
-* Region bounding box (optional)
+* Output file (:option:`--output`) or stdout
+* Region bounding box (:option:`--region`, optional)
 
-whereas the output file defaults to stdout and the input file to
+where the output XML defaults to stdout and the input file to
 stdin if not given.
 
 The optional region box will be used to filter the read inventory based on the
 coordinates of sensor locations. Only stations with sensor locations within the
 region will be considered. All others will be ignored.
 
-A channel ID is a simple string that is matched against the final channel ID
-in the inventory. This final channel ID is constructed by joining the codes of
+A stream ID is a simple string that is matched against the final stream ID
+in the inventory. This final stream ID is constructed by joining the codes of
 all stages with a dot where the stages are network, station, location and
 channel.
 
@@ -48,7 +54,8 @@ The content of the resulting inventory may be listed using :ref:`scinv`.
 Examples
 --------
 
-Suppose an inventory with network GE, a station MORC and several channels:
+Suppose an inventory with network GE, a station MORC with one sensor locations
+and several channels:
 
 .. code-block:: sh
 
@@ -62,11 +69,18 @@ Suppose an inventory with network GE, a station MORC and several channels:
          channel LHN    ID: GE.MORC..LHN
          channel LHE    ID: GE.MORC..LHE
 
-* The IDs are matched against streams passed with --chans.
+* Just clean inventory from unreferenced objects such as data loggers, sensors
+  or instrument responses.
 
   .. code-block:: sh
 
-     invextr --chans "GE*" inv.xml
+     invextr inventory.xml -o inventory-cleaned.xml
+
+* The IDs are matched against streams passed with :option:`--chans`:
+
+  .. code-block:: sh
+
+     invextr --chans "GE*" inventory.xml
 
   All streams are passed and nothing is filtered because GE* matches all
   available IDs and region filter is not used. Since :file:`inv.xml` only
@@ -75,7 +89,7 @@ Suppose an inventory with network GE, a station MORC and several channels:
 
   .. code-block:: sh
 
-     invextr -r 0,-180,90,180 inv.xml
+     invextr -r 0,-180,90,180 inventory.xml
 
    All streams located in the northern hemisphere are passed as commanded by the
    region bounding box.
@@ -84,33 +98,33 @@ Suppose an inventory with network GE, a station MORC and several channels:
 
   .. code-block:: sh
 
-     invextr --chans "*MORC*" inv.xml
+     invextr --chans "*MORC*" inventory.xml
 
 * Everything is filtered because GE.MORC does not match with any ID. To make it
   work, an asterisk needs to be appended: GE.MORC* or GE.MORC.*.
 
   .. code-block:: sh
 
-     invextr --chans "GE.MORC" inv.xml
+     invextr --chans "GE.MORC" inventory.xml
 
 
 * To extract all vertical components, use:
 
   .. code-block:: sh
 
-     invextr --chans "*Z" inv.xml
+     invextr --chans "*Z" inventory.xml
 
 * To extract BHN and LHZ, use:
 
-.. code-block:: sh
+  .. code-block:: sh
 
-   invextr --chans "*BHN,*LHZ" inv.xml
+     invextr --chans "*BHN,*LHZ" inventory.xml
 
 * To remove all HH and SH channels, use:
 
   .. code-block:: sh
 
-     invextr --rm --chans "*HH?,*SH?" inv.xml
+     invextr --rm --chans "*HH?,*SH?" inventory.xml
 
 
 .. _invextr_configuration:
@@ -239,11 +253,15 @@ Extract
 
 .. option:: --chans arg
 
-   A comma separated list of channel IDs to extract
-   which can contain wildcards. Default: \*.\*.\*.\* meaning
-   all streams.
+   A comma separated list of streams to extract or remove \(\-\-rm\)
+   which can contain wildcards. Avoiding confusion with files
+   names due to SHELL extension requires to enclose stream codes
+   by quotes. Default: \*.\*.\*.\* meaning all streams. Unreferenced
+   sensors, data loggers and resonses are removed when extracting.
+   A comma separated list of channel IDs to extract which may
+   contain wildcards. Default: \*.\*.\*.\* meaning all streams.
    
-   Example: invextr \-\-chans \"GE.\*.\*.BHZ,GE.MORC.\*.\*\" inv.xml
+   Example: invextr \-\-chans \"GE.\*.\*.BHZ,GE.MORC.\*.\*\" inventory.xml
 
 .. option:: --nslc arg
 
@@ -253,7 +271,7 @@ Extract
 .. option:: -r, --region arg
 
    Filter streams by geographic region given as
-   \"South, East, North, West\". Region is unused by default.
+   \"South,West,North,East\". Region is unused by default.
 
 .. option:: --rm arg
 
@@ -262,7 +280,16 @@ Extract
    
    Example: invextr \-\-rm \-\-chans \"GE.\*\" inv.xml
 
+
+Output
+------
+
 .. option:: -f, --formatted
 
-   Enables formatted XML output.
+   Enable formatted XML output.
+
+.. option:: -o, --output
+
+   Name of output file. If not given or '\-', output is sent to
+   stdout.