doc/man/lttng-view.1.txt

   1 lttng-view(1)
   2 =============
   3 :revdate: 14 June 2021
   4
   5
   6 NAME
   7 ----
   8 lttng-view - Launch an LTTng trace reader
   9
  10
  11 SYNOPSIS
  12 --------
  13 [verse]
  14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *view* [option:--viewer='READER']
  15       ['SESSION' | option:--trace-path='DIR']
  16
  17
  18 DESCRIPTION
  19 -----------
  20 The `lttng view` command launches an external trace reader to read the
  21 current traces of:
  22
  23 With the option:--session='SESSION' option::
  24     The recording session named 'SESSION'.
  25
  26 With the option:--trace-path='DIR' option::
  27     The local file system directory 'DIR'.
  28
  29 Otherwise::
  30     The current recording session (see man:concepts(1) to learn more
  31     about the current recording session).
  32
  33 With the option:--session option or without the option:--trace-path
  34 option, the mode of the selected recording session may :not: be network
  35 streaming or live.
  36
  37 By default, the `view` command attempts to launch man:babeltrace2(1) or,
  38 if it's not available, man:babeltrace(1). Override which trace reader to
  39 launch with the option:--viewer option.
  40
  41 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
  42
  43
  44 include::common-lttng-cmd-options-head.txt[]
  45
  46
  47 option:-t 'DIR', option:--trace-path='DIR'::
  48     Pass 'DIR' as the last argument of the trace reader command instead
  49     of the output directory of the selected recording session.
  50
  51 option:-e 'READER', option:--viewer='READER'::
  52     Use the trace reader 'READER' to read the traces.
  53 +
  54 'READER' is the absolute path to the reader command to use, and it can
  55 contain command arguments as well. The `view` command passes the trace
  56 directory path to read to the 'READER' command as its last argument.
  57 +
  58 Without this option, the `view` command uses man:babeltrace2(1) if it's
  59 available. Otherwise, it tries to use man:babeltrace(1).
  60
  61
  62 include::common-lttng-cmd-help-options.txt[]
  63
  64
  65 include::common-lttng-cmd-after-options.txt[]
  66
  67
  68 [[examples]]
  69 EXAMPLES
  70 --------
  71 .Read the traces of the current recording session with Babeltrace.
  72 ====
  73 [role="term"]
  74 ----
  75 $ lttng view
  76 ----
  77 ====
  78
  79 .Read the traces of a specific recording session with a custom trace reader.
  80 ====
  81 See the option:--viewer option.
  82
  83 [role="term"]
  84 ----
  85 $ lttng view --viewer='/usr/bin/my-reader -zK --details=3' \
  86              my-session
  87 ----
  88 ====
  89
  90
  91 include::common-footer.txt[]
  92
  93
  94 SEE ALSO
  95 --------
  96 man:babeltrace2(1),
  97 man:lttng(1)