.. _common-options: ============================ Common Commandline Options ============================ .. seealso:: :ref:`Common RSB commandline options ` Additional, more generic commandline options accepted by all :ref:`RSB `-related programs. .. _replay-related-options: Replay-related Options ====================== .. option:: --channel REGEX, -c REGEX Select the :term:`channels ` matching the regular expression :samp:`{REGEXP}` for replay. This option can be specified multiple times. By default, :samp:`{REGEXP}` can match any substring of the :term:`channel` name. to match the whole name instead, :samp:`^{REGEXP}$` can used. Again by default, channel names are of the form :samp:`{SCOPE}:{TYPE-NAME}`. To only match the :term:`scope` or type, the regular expressions :samp:`^{SCOPE-REGEXP}:` or :samp:`:{TYPE-REGEXP}$` can be used respectively. .. option:: --start-time TIMESTAMP-OR-SECONDS, -s TIMESTAMP-OR-SECONDS Start replaying events at the point in time indicated by :samp:`{TIMESTAMP-OR-SECONDS}`. * When the value should be parsed as a timestamp, the syntax :samp:`@[{YYYY}-{MM}-{DD}T]{HH}:{MM}:{SS}` has to be used. * A single *non-negative* real number is interpreted as time in seconds relative to the *beginning* of the recording. * A single *negative* real number is interpreted as time in seconds relative to the *end* of the recording. Mutually exclusive with :option:`--start-index`. .. option:: --start-index INDEX, -S INDEX Index of the :term:`event` at which the replay should start. A negative value is interpreted as an offset from the end of the recording. Mutually exclusive with :option:`--start-time`. .. option:: --end-time TIMESTAMP-OR-SECONDS, -e TIMESTAMP-OR-SECONDS Stop replaying :term:`events ` at the point in time indicated by :samp:`{TIMESTAMP-OR-SECONDS}`. * When the value should be parsed as a timestamp, the syntax :samp:`@[{YYYY}-{MM}-{DD}T]{HH}:{MM}:{SS}` has to be used. * A single *non-negative* real number is interpreted as time in seconds relative to the *beginning* of the recording. * A single *negative* real number is interpreted as time in seconds relative to the *end* of the recording. Mutually exclusive with :option:`--end-index`. .. option:: --end-index INDEX, -E INDEX Index of the :term:`event` at which the replay should end. A negative value is interpreted as an offset from the end of the recording. Mutually exclusive with :option:`--end-time`. .. option:: --loop NUMBER-OF-TIMES-OR-T, -n NUMBER-OF-TIMES-OR-T Repeat the whole replay :samp:`{NUMBER-OF-TIMES-OR-T}` times if :samp:`{NUMBER-OF-TIMES-OR-T}` is a positive integer or indefinitely if :samp:`{NUMBER-OF-TIMES-OR-T}` is ``t``. .. option:: --filter SPEC, -f SPEC Specify a :term:`filter` that :term:`events ` have to match in order to be processed rather than discarded. This option can be supplied multiple times in which case :term:`events ` have to match all specified :term:`filters `. Each :samp:`{SPEC}` has to be of one of the forms:: KIND KIND SINGLE-VALUE KIND KEY1 VALUE1 KEY2 VALUE2 ... where keys and values depend on :samp:`{KIND}` and may be mandatory in some cases. Examples (note that the single quotes have to be included only when used within a shell) .. code-block:: sh --filter 'origin "EAEE2B00-AF4B-11E0-8930-001AA0342D7D"' --filter 'regex ".*foo[0-9]+"' --filter 'regex :regex ".*foo[0-9]+"' (equivalent) -f 'xpath :xpath "node()/@foo" :fallback-policy :do-not-match' .. tip:: Use the :option:`common --help-for` ``filter`` or :option:`common --help-for` ``all`` options to display the full help text for this item. .. option:: --replay-strategy SPEC, -r SPEC Replay :term:`events ` from the :term:`log file` according to :samp:`SPEC` which has to be of the form:: KIND KEY1 VALUE1 KEY2 VALUE2 ... where keys and values depend on :samp:`KIND` and are optional in most cases. Examples: .. code-block:: sh --replay-strategy recorded-timing -r as-fast-as-possible --replay-strategy 'fixed-rate :rate 10' -r 'remote-controlled :uri "spread://localhost:4803/myplayback/control"' .. note:: The single quotes have to be included only when used within a shell) .. seealso:: :ref:`interactive-playback` For a detailed explanation of the interactive replay strategy :ref:`remote-controlled-playback` For a detailed explanation of the remote-controlled replay strategy. .. option:: --style SPEC This option works as in the :ref:`logger ` program. See :option:`logger --style`.