cli: add short option `-l` for `--log-level`
[babeltrace.git] / doc / man / babeltrace.1.txt
CommitLineData
838dd456
PP
1babeltrace(1)
2=============
3:manpagetype: program
4:revdate: 5 October 2017
5
6
7NAME
8----
9babeltrace - Convert or process one or more traces, and more
10
11
12SYNOPSIS
13--------
14[verse]
15*babeltrace* [opt:--debug | opt:--verbose | opt:--log-level='LVL'] ['<<commands,CMD>>'] ['CMD ARGS']
16
17
18DESCRIPTION
19-----------
20`babeltrace` is an open-source trace converter and processor. The tool
21can convert from one trace format to another, possibly with one or more
22filters in the conversion path, and perform other operations depending
23on the command 'CMD'.
24
25See man:babeltrace-intro(7) to learn more about the Babeltrace
26project and its core concepts.
27
28Most of the `babeltrace` commands load Babeltrace plugins to perform
29their operation. The search path for Babeltrace plugins is, in this
30order:
31
32. The colon-separated list of directories in the
33 `BABELTRACE_PLUGIN_PATH` environment variable.
34
35. The colon-separated list of directories in the specific command's
36 nlopt:--plugin-path option.
37
38. `$HOME/.local/lib/babeltrace/plugins`
39
40. +{system_plugin_path}+
41
42You can use the man:babeltrace-list-plugins(1) command to dynamically
43list the available plugins and what they offer. See <<plugins,PLUGINS>>
44for a list of plugins shipped with Babeltrace.
45
46
47OPTIONS
48-------
49opt:-d, opt:--debug::
50 Turn the debugging mode on.
51+
52This is equivalent to opt:--log-level=`VERBOSE`.
53
21b5b16a 54opt:-l 'LVL', opt:--log-level='LVL'::
838dd456
PP
55 Set the log level of all known Babeltrace loggers to 'LVL'. You
56 can override the level of a specific logger with a dedicated
57 log level environment variable. If you don't specify this option,
58 it is equivalent to nlopt:--log-level=`WARNING`.
59+
60The available values for 'LVL' are:
61+
62--
63`NONE`::
64`N`::
65 Logging is disabled.
66
67`FATAL`::
68`F`::
69 Severe errors that lead the execution to abort immediately. This
70 level should be enabled in production.
71
72`ERROR`::
73`E`::
74 Errors that might still allow the execution to continue. Usually,
75 once one or more errors are reported at this level, the application,
76 plugin, or library won't perform any more useful task, but it should
77 still exit cleanly. This level should be enabled in production.
78
79`WARN`::
80`WARNING`::
81`W`::
82 Potentially harmful situations which still allow the execution
83 to continue. This level should be enabled in production.
84
85`INFO`::
86`I`::
87 Informational messages that highlight progress or important states
88 of the application, plugin, or library. This level can be enabled in
89 production.
90
91`DEBUG`::
92`D`::
93 Debugging information, with a higher level of details than the
94 `VERBOSE` level. This level should :not: be enabled in production.
95
96`VERBOSE`::
97`V`::
98 Low-level debugging context information. This level should :not: be
99 enabled in production.
100--
101
102opt:-v, opt:--verbose::
103 Turn the verbose mode on.
104+
105This is equivalent to opt:--log-level=`INFO`.
106
107opt:-h, opt:--help::
108 Show help and quit.
109
110opt:-V, opt:--version::
111 Show version and quit.
112
113
114[[commands]]
115COMMANDS
116--------
117The following commands also have their own nlopt:--help option.
118
119man:babeltrace-convert(1)::
120 Build a trace conversion graph and run it.
121+
122This is the default command: you don't need to explicitly
123specify this command name to use it.
124
125man:babeltrace-help(1)::
126 Get help for a specific plugin or plugin's component class.
127
128man:babeltrace-list-plugins(1)::
129 List the available Babeltrace plugins and their component classes.
130
131man:babeltrace-query(1)::
132 Query an object from a component class.
133
134man:babeltrace-run(1)::
135 Build a trace processing graph and run it.
136
137
138[[plugins]]
139PLUGINS
140-------
141The following plugins are provided by the Babeltrace project itself:
142
143man:babeltrace-plugin-ctf(7)::
144 CTF trace input (from the file system and from the LTTng-live
145 protocol) and output to the file system.
146+
147* man:babeltrace-sink.ctf.fs(7)
148* man:babeltrace-source.ctf.fs(7)
149* man:babeltrace-source.ctf.lttng-live(7)
150
151ifeval::[{enable_debug_info} == 1]
152man:babeltrace-plugin-lttng-utils(7)::
153 Processing graph utilities for LTTng traces.
154+
155* man:babeltrace-filter.lttng-utils.debug-info(7)
156endif::[]
157
158man:babeltrace-plugin-text(7)::
159 Text input and output.
160+
161* man:babeltrace-sink.text.pretty(7)
162* man:babeltrace-source.text.dmesg(7)
163
164man:babeltrace-plugin-utils(7)::
165 Processing graph utilities.
166+
167* man:babeltrace-filter.utils.muxer(7)
168* man:babeltrace-filter.utils.trimmer(7)
169* man:babeltrace-sink.utils.counter(7)
170* man:babeltrace-sink.utils.dummy(7)
171
172
173include::common-cli-env.txt[]
174
175include::common-cli-files.txt[]
176
177include::common-cmd-footer.txt[]
178
179
180SEE ALSO
181--------
182man:babeltrace-convert(1),
183man:babeltrace-help(1),
184man:babeltrace-list-plugins(1),
185man:babeltrace-query(1),
186man:babeltrace-run(1),
187man:babeltrace-intro(7)
This page took 0.029475 seconds and 4 git commands to generate.