Add `babeltrace.` prefix to `trace-info` and `support-info` query objects
[babeltrace.git] / doc / man / babeltrace2-query.1.txt
CommitLineData
c1f82f3b 1babeltrace2-query(1)
838dd456
PP
2===================
3:manpagetype: command
4:revdate: 5 October 2017
5
6
7NAME
8----
c1f82f3b 9babeltrace2-query - Query object from a component class
838dd456
PP
10
11
12SYNOPSIS
13--------
14[verse]
c1f82f3b 15*babeltrace2 query* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path]
838dd456
PP
16 [opt:--omit-system-plugin-path]
17 [opt:--plugin-path='PATH'[:__PATH__]...]
18 [opt:--params='PARAMS'] 'TYPE.PLUGIN.COMPCLS' 'OBJECT'
19
20
21DESCRIPTION
22-----------
23The `query` command queries the object named 'OBJECT' from the component
24class 'COMPCLS' of the type 'TYPE' found in the Babeltrace plugin
25'PLUGIN' and prints the results.
26
c1f82f3b 27See man:babeltrace2-intro(7) to learn more about the Babeltrace
838dd456
PP
28project and its core concepts.
29
30The available values for 'TYPE' are:
31
32`source`::
33`src`::
34 Source component class.
35
36`filter`::
37`flt`::
38 Filter component class.
39
40`sink`::
41 Sink component class.
42
43The exact object names and the parameters that a given component class
c1f82f3b 44expects are described in its documentation. man:babeltrace2-help(1) can
838dd456
PP
45generally provide this information.
46
47You can use the opt:--params='PARAMS' option to pass parameters to the
48component class's query function. See <<params-fmt,Parameters format>>
49for the exact format of 'PARAMS'.
50
51The output of the `query` command looks like YAML, although it is not
52guaranteed that it is YAML-compliant.
53
54See <<examples,EXAMPLES>> for usage examples.
55
56
57include::common-cmd-params-format.txt[]
58
59include::common-cmd-plugin-path.txt[]
60
61
62OPTIONS
63-------
64include::common-gen-options.txt[]
65
66
67Query parameters
68~~~~~~~~~~~~~~~~
69opt:-p 'PARAMS', opt:--params='PARAMS'::
70 Set the query parameters to 'PARAMS'. See <<params-fmt,Parameters
71 format>> for the exact format of 'PARAMS'.
72
73
74include::common-plugin-path-options.txt[]
75
76include::common-cmd-info-options.txt[]
77
78
79[[examples]]
80EXAMPLES
81--------
82.Query the available sessions of the LTTng live source component class.
83====
84[role="term"]
85----
c1f82f3b 86$ babeltrace2 query src.ctf.lttng-live sessions \
838dd456
PP
87 --params='url="net://RHOST/host/TGTHOST"'
88----
89====
90
91.Query the metadata info (includes the decoded text) of a CTF trace located on the local file system.
92====
93[role="term"]
94----
c1f82f3b 95$ babeltrace2 query src.ctf.fs metadata-info \
838dd456
PP
96 --params='path="/path/to/trace"'
97----
98====
99
100.Query the trace info of CTF traces located on the local file system.
101====
102[role="term"]
103----
9e534aae
PP
104$ babeltrace2 query src.ctf.fs babeltrace.trace-info \
105 --params='path="/path/to/trace"'
838dd456
PP
106----
107====
108
109.Query some object from a sink component class without parameters.
110====
111[role="term"]
112----
c1f82f3b 113$ babeltrace2 query sink.my-plugin.my-sink some-object
838dd456
PP
114----
115====
116
117
118include::common-cli-env.txt[]
119
120include::common-cli-files.txt[]
121
122include::common-cmd-footer.txt[]
123
124
125SEE ALSO
126--------
c1f82f3b
MJ
127man:babeltrace2(1),
128man:babeltrace2-intro(7)
This page took 0.036575 seconds and 4 git commands to generate.