From a8be4294fc84cc1b81b1690412c22c9e06cdb8e3 Mon Sep 17 00:00:00 2001 From: Michael Jeanson Date: Tue, 4 Jun 2019 17:08:46 -0400 Subject: [PATCH] doc: Rename to babeltrace2 Adjust the documentation and manpages following the rename of the executables and library. Change-Id: I42cc662a94be6ece489af85d0415440bf1c1f36e Signed-off-by: Michael Jeanson Reviewed-on: https://review.lttng.org/c/babeltrace/+/1406 Tested-by: jenkins Reviewed-by: Philippe Proulx --- doc/api/Doxyfile.in | 14 +- doc/api/dox/includes-build.dox | 10 +- doc/man/Makefile.am | 44 +++--- doc/man/README.adoc | 16 +- doc/man/asciidoc-attrs.conf.in | 2 +- ...onvert.1.txt => babeltrace2-convert.1.txt} | 142 +++++++++--------- ...race2-filter.lttng-utils.debug-info.7.txt} | 14 +- ...t => babeltrace2-filter.utils.muxer.7.txt} | 14 +- ...=> babeltrace2-filter.utils.trimmer.7.txt} | 14 +- ...race-help.1.txt => babeltrace2-help.1.txt} | 20 +-- ...ce-intro.7.txt => babeltrace2-intro.7.txt} | 60 ++++---- ...s.1.txt => babeltrace2-list-plugins.1.txt} | 14 +- ...ltrace-log.1.txt => babeltrace2-log.1.txt} | 28 ++-- ...ctf.7.txt => babeltrace2-plugin-ctf.7.txt} | 20 +-- ...t => babeltrace2-plugin-lttng-utils.7.txt} | 14 +- ...xt.7.txt => babeltrace2-plugin-text.7.txt} | 16 +- ...s.7.txt => babeltrace2-plugin-utils.7.txt} | 26 ++-- ...ce-query.1.txt => babeltrace2-query.1.txt} | 22 +-- ...ltrace-run.1.txt => babeltrace2-run.1.txt} | 34 ++--- ...fs.7.txt => babeltrace2-sink.ctf.fs.7.txt} | 14 +- ...txt => babeltrace2-sink.text.pretty.7.txt} | 10 +- ...t => babeltrace2-sink.utils.counter.7.txt} | 10 +- ...txt => babeltrace2-sink.utils.dummy.7.txt} | 10 +- ....7.txt => babeltrace2-source.ctf.fs.7.txt} | 14 +- ...> babeltrace2-source.ctf.lttng-live.7.txt} | 14 +- ...xt => babeltrace2-source.text.dmesg.7.txt} | 10 +- .../{babeltrace.1.txt => babeltrace2.1.txt} | 66 ++++---- doc/man/common-cli-env.txt | 8 +- doc/man/common-cli-files.txt | 2 +- doc/man/common-cmd-params-format.txt | 2 +- doc/man/common-cmd-plugin-path.txt | 4 +- doc/man/common-common-compat-env.txt | 6 +- doc/man/common-ctf-plugin-env.txt | 12 +- doc/man/common-gen-options.txt | 2 +- doc/man/common-lib-env.txt | 4 +- doc/man/common-plugin-path-options.txt | 2 +- doc/man/common-ppp-env.txt | 4 +- 37 files changed, 359 insertions(+), 359 deletions(-) rename doc/man/{babeltrace-convert.1.txt => babeltrace2-convert.1.txt} (87%) rename doc/man/{babeltrace-filter.lttng-utils.debug-info.7.txt => babeltrace2-filter.lttng-utils.debug-info.7.txt} (96%) rename doc/man/{babeltrace-filter.utils.muxer.7.txt => babeltrace2-filter.utils.muxer.7.txt} (86%) rename doc/man/{babeltrace-filter.utils.trimmer.7.txt => babeltrace2-filter.utils.trimmer.7.txt} (89%) rename doc/man/{babeltrace-help.1.txt => babeltrace2-help.1.txt} (75%) rename doc/man/{babeltrace-intro.7.txt => babeltrace2-intro.7.txt} (90%) rename doc/man/{babeltrace-list-plugins.1.txt => babeltrace2-list-plugins.1.txt} (69%) rename doc/man/{babeltrace-log.1.txt => babeltrace2-log.1.txt} (62%) rename doc/man/{babeltrace-plugin-ctf.7.txt => babeltrace2-plugin-ctf.7.txt} (65%) rename doc/man/{babeltrace-plugin-lttng-utils.7.txt => babeltrace2-plugin-lttng-utils.7.txt} (64%) rename doc/man/{babeltrace-plugin-text.7.txt => babeltrace2-plugin-text.7.txt} (65%) rename doc/man/{babeltrace-plugin-utils.7.txt => babeltrace2-plugin-utils.7.txt} (66%) rename doc/man/{babeltrace-query.1.txt => babeltrace2-query.1.txt} (81%) rename doc/man/{babeltrace-run.1.txt => babeltrace2-run.1.txt} (92%) rename doc/man/{babeltrace-sink.ctf.fs.7.txt => babeltrace2-sink.ctf.fs.7.txt} (89%) rename doc/man/{babeltrace-sink.text.pretty.7.txt => babeltrace2-sink.text.pretty.7.txt} (94%) rename doc/man/{babeltrace-sink.utils.counter.7.txt => babeltrace2-sink.utils.counter.7.txt} (89%) rename doc/man/{babeltrace-sink.utils.dummy.7.txt => babeltrace2-sink.utils.dummy.7.txt} (83%) rename doc/man/{babeltrace-source.ctf.fs.7.txt => babeltrace2-source.ctf.fs.7.txt} (95%) rename doc/man/{babeltrace-source.ctf.lttng-live.7.txt => babeltrace2-source.ctf.lttng-live.7.txt} (93%) rename doc/man/{babeltrace-source.text.dmesg.7.txt => babeltrace2-source.text.dmesg.7.txt} (89%) rename doc/man/{babeltrace.1.txt => babeltrace2.1.txt} (72%) diff --git a/doc/api/Doxyfile.in b/doc/api/Doxyfile.in index 7a82c1cf..9715ca6b 100644 --- a/doc/api/Doxyfile.in +++ b/doc/api/Doxyfile.in @@ -141,13 +141,13 @@ WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = -INPUT = "@top_srcdir@/include/babeltrace/ctf-ir" \ - "@top_srcdir@/include/babeltrace/component" \ - "@top_srcdir@/include/babeltrace/plugin" \ - "@top_srcdir@/include/babeltrace/ref.h" \ - "@top_srcdir@/include/babeltrace/values.h" \ - "@top_srcdir@/include/babeltrace/logging.h" \ - "@top_srcdir@/include/babeltrace/types.h" \ +INPUT = "@top_srcdir@/include/babeltrace2/ctf-ir" \ + "@top_srcdir@/include/babeltrace2/component" \ + "@top_srcdir@/include/babeltrace2/plugin" \ + "@top_srcdir@/include/babeltrace2/ref.h" \ + "@top_srcdir@/include/babeltrace2/values.h" \ + "@top_srcdir@/include/babeltrace2/logging.h" \ + "@top_srcdir@/include/babeltrace2/types.h" \ "@srcdir@/dox/main-page.dox" \ "@srcdir@/dox/includes-build.dox" \ "@srcdir@/dox/write-plugin.dox" \ diff --git a/doc/api/dox/includes-build.dox b/doc/api/dox/includes-build.dox index 78c880fc..f7b42c1a 100644 --- a/doc/api/dox/includes-build.dox +++ b/doc/api/dox/includes-build.dox @@ -4,7 +4,7 @@ @section includefiles Include files You can find all the Babeltrace library include files (C headers) in the -\c babeltrace directory under the include files directory chosen when +\c babeltrace2 directory under the include files directory chosen when installing Babeltrace. By default, this is /usr/include. If you build Babeltrace from source without specifying an installation prefix, this is /usr/local/include. @@ -23,14 +23,14 @@ but which necessarily makes the compilation slower: Multiple types of applications can use the Babeltrace library: -- A user plugin (shared object) to be loaded by the \c babeltrace +- A user plugin (shared object) to be loaded by the \c babeltrace2 converter program or by another application. - A user application or library which loads plugins to manually connect existing components in a specific way. - A user application or library which creates its own component classes and manually connects them. -In any way, the only library to link to is `libbabeltrace`. +In any way, the only library to link to is `libbabeltrace2`. @subsection howtobuildplugin Build a plugin @@ -47,7 +47,7 @@ cc -c -fpic my-plugin.c
  • Create the plugin shared object: @verbatim -cc -shared my-plugin.o -lbabeltrace -o my-plugin.so +cc -shared my-plugin.o -lbabeltrace2 -o my-plugin.so @endverbatim
    • @@ -67,7 +67,7 @@ cc -c my-app.c
  • Create the executable application: @verbatim -cc my-app.o -lbabeltrace -o my-app +cc my-app.o -lbabeltrace2 -o my-app @endverbatim
    • diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 951705df..8cc9d4f3 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -7,33 +7,33 @@ manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2))) # List only the names without the .*.txt extension here: MAN1_NAMES = \ - babeltrace \ - babeltrace-convert \ - babeltrace-help \ - babeltrace-list-plugins \ - babeltrace-log \ - babeltrace-query \ - babeltrace-run -MAN7_NAMES = babeltrace-filter.utils.muxer \ - babeltrace-filter.utils.trimmer \ - babeltrace-intro \ - babeltrace-plugin-ctf \ - babeltrace-plugin-text \ - babeltrace-plugin-utils \ - babeltrace-sink.ctf.fs \ - babeltrace-sink.text.pretty \ - babeltrace-sink.utils.counter \ - babeltrace-sink.utils.dummy \ - babeltrace-source.ctf.fs \ - babeltrace-source.ctf.lttng-live \ - babeltrace-source.text.dmesg + babeltrace2 \ + babeltrace2-convert \ + babeltrace2-help \ + babeltrace2-list-plugins \ + babeltrace2-log \ + babeltrace2-query \ + babeltrace2-run +MAN7_NAMES = babeltrace2-filter.utils.muxer \ + babeltrace2-filter.utils.trimmer \ + babeltrace2-intro \ + babeltrace2-plugin-ctf \ + babeltrace2-plugin-text \ + babeltrace2-plugin-utils \ + babeltrace2-sink.ctf.fs \ + babeltrace2-sink.text.pretty \ + babeltrace2-sink.utils.counter \ + babeltrace2-sink.utils.dummy \ + babeltrace2-source.ctf.fs \ + babeltrace2-source.ctf.lttng-live \ + babeltrace2-source.text.dmesg MAN1_NO_ASCIIDOC_NAMES = MAN7_NO_ASCIIDOC_NAMES = if ENABLE_DEBUG_INFO MAN7_NAMES += \ - babeltrace-plugin-lttng-utils \ - babeltrace-filter.lttng-utils.debug-info + babeltrace2-plugin-lttng-utils \ + babeltrace2-filter.lttng-utils.debug-info endif # AsciiDoc sources and outputs diff --git a/doc/man/README.adoc b/doc/man/README.adoc index 1fc3bb07..1ebb48b0 100644 --- a/doc/man/README.adoc +++ b/doc/man/README.adoc @@ -15,17 +15,17 @@ the appropriate DocBook XSL stylesheet (using the `xmlto` command). Main program:: +__program__.1.txt+ -`babeltrace(1)` command:: - +babeltrace-__command__.1.txt+ +`babeltrace2(1)` command:: + +babeltrace2-__command__.1.txt+ Babeltrace introduction:: - `babeltrace-intro.7.txt` + `babeltrace2-intro.7.txt` Babeltrace plugin:: - +babeltrace-plugin-__plugin__.7.txt+ + +babeltrace2-plugin-__plugin__.7.txt+ Babeltrace plugin's component class:: - +babeltrace-__type__.__plugin__.__compcls__.7.txt+ + +babeltrace2-__type__.__plugin__.__compcls__.7.txt+ == Macros @@ -38,7 +38,7 @@ macro definitions used everywhere in the man page sources: +__page__+ in section +__section__+. In troff, the man page's name is rendered in bold. + -Example: `man:babeltrace-convert(1)` +Example: `man:babeltrace2-convert(1)` +opt:__name__+:: Use this macro to insert a link to the command-line option @@ -51,8 +51,8 @@ Example: `opt:--verbose`, `opt:--color='WHEN'` +__name__+ described in the _OPTIONS_ section of another Babeltrace or LTTng man page named +__page__+ in section +__section__+. + -Example: `manopt:babeltrace(1):--log-level`, -+manopt:babeltrace-convert(1):--component=\`source.ctf.fs`+ +Example: `manopt:babeltrace2(1):--log-level`, ++manopt:babeltrace2-convert(1):--component=\`source.ctf.fs`+ +nlopt:__name__+:: Use this macro to write a command-line option named +__name__+ diff --git a/doc/man/asciidoc-attrs.conf.in b/doc/man/asciidoc-attrs.conf.in index a5ece768..ae414315 100644 --- a/doc/man/asciidoc-attrs.conf.in +++ b/doc/man/asciidoc-attrs.conf.in @@ -1,5 +1,5 @@ [attributes] # default values -system_plugin_path="@LIBDIR@/babeltrace/plugins" +system_plugin_path="@LIBDIR@/babeltrace2/plugins" babeltrace_version="@PACKAGE_VERSION@" enable_debug_info="@ENABLE_DEBUG_INFO_VAL@" diff --git a/doc/man/babeltrace-convert.1.txt b/doc/man/babeltrace2-convert.1.txt similarity index 87% rename from doc/man/babeltrace-convert.1.txt rename to doc/man/babeltrace2-convert.1.txt index aefc4c17..1bf554f0 100644 --- a/doc/man/babeltrace-convert.1.txt +++ b/doc/man/babeltrace2-convert.1.txt @@ -1,4 +1,4 @@ -babeltrace-convert(1) +babeltrace2-convert(1) ===================== :manpagetype: command :revdate: 5 October 2017 @@ -6,7 +6,7 @@ babeltrace-convert(1) NAME ---- -babeltrace-convert - Convert one or more traces +babeltrace2-convert - Convert one or more traces SYNOPSIS @@ -14,7 +14,7 @@ SYNOPSIS Convert one or more traces: [verse] -*babeltrace convert* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 convert* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] [opt:--run-args | opt:--run-args-0] [opt:--retry-duration='DURUS'] @@ -23,7 +23,7 @@ Convert one or more traces: Print the metadata text of a CTF trace: [verse] -*babeltrace convert* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 convert* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] [opt:--output='OUTPATH'] @@ -33,7 +33,7 @@ Print the available http://lttng.org/docs/#doc-lttng-live[LTTng live] sessions: [verse] -*babeltrace convert* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 convert* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] [opt:--output='OUTPATH'] opt:--input-format=`lttng-live` 'URL' @@ -43,24 +43,24 @@ DESCRIPTION ----------- The `convert` command creates a trace conversion graph and runs it. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. [NOTE] ==== -`convert` is the default man:babeltrace(1) command: you usually don't +`convert` is the default man:babeltrace2(1) command: you usually don't need to specify its name. The following commands are equivalent -if the `...` part does not start with another man:babeltrace(1) +if the `...` part does not start with another man:babeltrace2(1) command's name, like `run` or `list-plugins`: [role="term"] ---- -$ babeltrace convert ... -$ babeltrace ... +$ babeltrace2 convert ... +$ babeltrace2 ... ---- If you need to make sure that you are executing the `convert` command, -use `babeltrace convert` explicitly. +use `babeltrace2 convert` explicitly. ==== A conversion graph is a specialized trace processing graph focused on @@ -89,9 +89,9 @@ optional. See <> to learn how to enable them. If you need another processing graph layout, use the more flexible -man:babeltrace-run(1) command. +man:babeltrace2-run(1) command. -Like with the man:babeltrace-run(1) command, you can create components +Like with the man:babeltrace2-run(1) command, you can create components explicitly with the opt:--component option (see <>). You can also use one of the many specific `convert` command options and arguments to create @@ -102,7 +102,7 @@ on the console: [role="term"] ---- -$ babeltrace /path/to/trace +$ babeltrace2 /path/to/trace ---- This is the equivalent of creating and connecting together: @@ -132,7 +132,7 @@ It is equivalent to the following command: [role="term"] ---- -$ babeltrace run --component=ctf-fs:src.ctf.fs \ +$ babeltrace2 run --component=ctf-fs:src.ctf.fs \ --params=path=/path/to/trace \ --component=pretty:sink.text.pretty \ --component=muxer:filter.utils.muxer \ @@ -140,14 +140,14 @@ $ babeltrace run --component=ctf-fs:src.ctf.fs \ ---- You can use the opt:--run-args option to make the `convert` command -print its equivalent man:babeltrace-run(1) arguments instead of +print its equivalent man:babeltrace2-run(1) arguments instead of creating and running the conversion graph. The printed arguments are escaped for shells, which means you can use them as is on the command line and possibly add more options to the `run` command: [role="term"] ---- -$ babeltrace run $(babeltrace --run-args /path/to/trace) ... +$ babeltrace2 run $(babeltrace2 --run-args /path/to/trace) ... ---- The opt:--run-args-0 option is like the opt:--run-args option, but the @@ -221,7 +221,7 @@ conversion graph without an explicit instantiation through the opt:--component option. An implicit component is easier to create than an explicit component: this is why the `convert` command exists, as you can also create and run a conversion graph with the generic -man:babeltrace-run(1) command. +man:babeltrace2-run(1) command. There are many ways to create implicit components with the `convert` command: @@ -235,7 +235,7 @@ Example: + [role="term"] ---- -$ babeltrace /path/to/trace /path/to/other/trace +$ babeltrace2 /path/to/trace /path/to/other/trace ---- + The opt:--clock-offset and opt:--clock-offset-ns options apply to _all_ @@ -243,7 +243,7 @@ the implicit compcls:src.ctf.fs components. For example: + [role="term"] ---- -$ babeltrace --clock-offset=3 trace1 trace2 +$ babeltrace2 --clock-offset=3 trace1 trace2 ---- + With the command line above, two implicit compcls:src.ctf.fs components @@ -263,7 +263,7 @@ Example: + [role="term"] ---- -$ babeltrace --input-format=lttng-live \ +$ babeltrace2 --input-format=lttng-live \ net://localhost/host/abeille/my-session ---- + @@ -278,17 +278,17 @@ Examples: + [role="term"] ---- -$ babeltrace /path/to/trace --begin=22:14:38 --end=22:15:07 +$ babeltrace2 /path/to/trace --begin=22:14:38 --end=22:15:07 ---- + [role="term"] ---- -$ babeltrace /path/to/trace --timerange=22:14:38,22:15:07 +$ babeltrace2 /path/to/trace --timerange=22:14:38,22:15:07 ---- + [role="term"] ---- -$ babeltrace /path/to/trace --end=12:31:04.882928015 +$ babeltrace2 /path/to/trace --end=12:31:04.882928015 ---- * To create an implicit compcls:filter.lttng-utils.debug-info (add @@ -300,18 +300,18 @@ Examples: + [role="term"] ---- -$ babeltrace --debug-info /path/to/trace +$ babeltrace2 --debug-info /path/to/trace ---- + [role="term"] ---- -$ babeltrace /path/to/trace \ +$ babeltrace2 /path/to/trace \ --debug-info-target-prefix=/tmp/tgt-root ---- + [role="term"] ---- -$ babeltrace /path/to/trace --debug-info-full-path +$ babeltrace2 /path/to/trace --debug-info-full-path ---- * To create an implicit compcls:sink.text.pretty component @@ -338,22 +338,22 @@ Examples: + [role="term"] ---- -$ babeltrace /path/to/trace +$ babeltrace2 /path/to/trace ---- + [role="term"] ---- -$ babeltrace /path/to/trace --no-delta +$ babeltrace2 /path/to/trace --no-delta ---- + [role="term"] ---- -$ babeltrace /path/to/trace --output-format=text +$ babeltrace2 /path/to/trace --output-format=text ---- + [role="term"] ---- -$ babeltrace /path/to/trace --output=/tmp/pretty-out +$ babeltrace2 /path/to/trace --output=/tmp/pretty-out ---- * To create an implicit compcls:sink.utils.dummy component (dummy @@ -364,7 +364,7 @@ Example: + [role="term"] ---- -$ babeltrace /path/to/trace --output-format=dummy +$ babeltrace2 /path/to/trace --output-format=dummy ---- * To create an implicit compcls:sink.ctf.fs component (CTF traces @@ -377,7 +377,7 @@ Example: + [role="term"] ---- -$ babeltrace /path/to/input/trace --output-format=ctf \ +$ babeltrace2 /path/to/input/trace --output-format=ctf \ --output=my-traces ---- @@ -387,16 +387,16 @@ it, and write it as another CTF trace: [role="term"] ---- -$ babeltrace /path/to/input/trace --timerange=22:14:38,22:15:07 \ +$ babeltrace2 /path/to/input/trace --timerange=22:14:38,22:15:07 \ --debug-info --output-format=ctf --output=out-dir ---- -The equivalent man:babeltrace-run(1) command of this `convert` command +The equivalent man:babeltrace2-run(1) command of this `convert` command is: [role="term"] ---- -$ babeltrace run --component=src-ctf-fs:src.ctf.fs \ +$ babeltrace2 run --component=src-ctf-fs:src.ctf.fs \ --params=path=/path/to/input/trace \ --component=sink-ctf-fs:sink.ctf.fs \ --params=path=out-dir \ @@ -514,7 +514,7 @@ opt:-i 'FORMAT', opt:--input-format='FORMAT':: individual component. See <>. + -See man:babeltrace-source.ctf.fs(7) to learn more about this +See man:babeltrace2-source.ctf.fs(7) to learn more about this component class. `lttng-live`:: @@ -532,7 +532,7 @@ component class. + Any other format for the positional argument is invalid. + -See man:babeltrace-source.ctf.lttng-live(7) to learn more about +See man:babeltrace2-source.ctf.lttng-live(7) to learn more about this component class. -- -- @@ -548,20 +548,20 @@ opt:-o 'FORMAT', opt:--output-format='FORMAT':: Create an implicit compcls:sink.text.pretty component. See <>. + -See man:babeltrace-sink.text.pretty(7) to learn more about +See man:babeltrace2-sink.text.pretty(7) to learn more about this component class. `ctf`:: Create an implicit compcls:sink.ctf.fs component. Specify the output path with the opt:--output option. + -See man:babeltrace-sink.ctf.fs(7) to learn more about +See man:babeltrace2-sink.ctf.fs(7) to learn more about this component class. `dummy`:: Create an implicit compcls:sink.utils.dummy component. + -See man:babeltrace-sink.utils.dummy(7) to learn more about +See man:babeltrace2-sink.utils.dummy(7) to learn more about this component class. `ctf-metadata`:: @@ -579,7 +579,7 @@ There is one implicit compcls:src.ctf.fs component per positional argument (which are trace paths), unless you specify opt:--input-format=`lttng-live`. -See man:babeltrace-source.ctf.fs(7) to learn more about this +See man:babeltrace2-source.ctf.fs(7) to learn more about this component class. opt:--clock-offset='SEC':: @@ -610,7 +610,7 @@ Implicit compcls:filter.utils.trimmer component If you specify at least one of the following options, you create an implicit compcls:filter.utils.trimmer component. -See man:babeltrace-filter.utils.trimmer(7) to learn more about +See man:babeltrace2-filter.utils.trimmer(7) to learn more about this component class. See <> for the format of 'BEGIN' and 'END'. @@ -637,7 +637,7 @@ If you specify at least one of the following options, you create an implicit compcls:filter.lttng-utils.debug-info component. This component only alters compatible LTTng events. -See man:babeltrace-filter.lttng-utils.debug-info(7) to learn more +See man:babeltrace2-filter.lttng-utils.debug-info(7) to learn more about this component class. opt:--debug-info:: @@ -681,7 +681,7 @@ implicit compcls:sink.text.pretty component. The `convert` command also creates a default implicit compcls:sink.text.pretty component if no other sink component exists. -See man:babeltrace-sink.text.pretty(7) to learn more about this +See man:babeltrace2-sink.text.pretty(7) to learn more about this component class. opt:--clock-cycles:: @@ -791,15 +791,15 @@ compcls:sink.ctf.fs component to 'PATH'. Otherwise, create an implicit compcls:sink.text.pretty component and set its manparam:sink.text.pretty:path initialization parameter to 'PATH'. + -See man:babeltrace-sink.ctf.fs(7) and -man:babeltrace-sink.text.pretty(7) to learn more about those +See man:babeltrace2-sink.ctf.fs(7) and +man:babeltrace2-sink.text.pretty(7) to learn more about those component classes. -Equivalent `babeltrace run` arguments +Equivalent `babeltrace2 run` arguments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ opt:--run-args:: - Print the equivalent man:babeltrace-run(1) arguments instead of + Print the equivalent man:babeltrace2-run(1) arguments instead of creating and running the conversion graph. The printed arguments are space-separated and individually escaped for safe shell input. + @@ -807,7 +807,7 @@ You cannot use this option with the opt:--run-args-0 or opt:--stream-intersection option. opt:--run-args-0:: - Print the equivalent man:babeltrace-run(1) arguments instead of + Print the equivalent man:babeltrace2-run(1) arguments instead of creating and running the conversion graph. The printed arguments are separated with a null character and :not: escaped for safe shell input. @@ -838,7 +838,7 @@ project's component class which supports this query object is compcls:source.ctf.fs. + Because it is not possible to replicate with a single -man:babeltrace-run(1) command line what the `convert` method does with +man:babeltrace2-run(1) command line what the `convert` method does with the opt:--stream-intersection option, you cannot use this option with the opt:--run-args or opt:--run-args-0 option. @@ -846,7 +846,7 @@ the opt:--run-args or opt:--run-args-0 option. Plugin path ~~~~~~~~~~~ opt:--omit-home-plugin-path:: - Do not search for plugins in `$HOME/.local/lib/babeltrace/plugins`. + Do not search for plugins in `$HOME/.local/lib/babeltrace2/plugins`. opt:--omit-system-plugin-path:: Do not search for plugins in +{system_plugin_path}+. @@ -869,17 +869,17 @@ EXAMPLES ==== [role="term"] ---- -$ babeltrace my-trace +$ babeltrace2 my-trace ---- [role="term"] ---- -$ babeltrace my-traces +$ babeltrace2 my-traces ---- [role="term"] ---- -$ babeltrace my-trace-1 my-trace-2 my-trace-3 +$ babeltrace2 my-trace-1 my-trace-2 my-trace-3 ---- ==== @@ -887,23 +887,23 @@ $ babeltrace my-trace-1 my-trace-2 my-trace-3 ==== [role="term"] ---- -$ babeltrace my-trace --begin=22:55:43.658582931 \ +$ babeltrace2 my-trace --begin=22:55:43.658582931 \ --end=22:55:46.967687564 ---- [role="term"] ---- -$ babeltrace my-trace --begin=22:55:43.658582931 +$ babeltrace2 my-trace --begin=22:55:43.658582931 ---- [role="term"] ---- -$ babeltrace my-trace --end=22:55:46.967687564 +$ babeltrace2 my-trace --end=22:55:46.967687564 ---- [role="term"] ---- -$ babeltrace my-trace --timerange=22:55:43,22:55:46.967687564 +$ babeltrace2 my-trace --timerange=22:55:43,22:55:46.967687564 ---- ==== @@ -911,7 +911,7 @@ $ babeltrace my-trace --timerange=22:55:43,22:55:46.967687564 ==== [role="term"] ---- -$ babeltrace my-trace --stream-intersection \ +$ babeltrace2 my-trace --stream-intersection \ --timerange=22:55:43,22:55:46.967687564 \ --output-format=ctf --output=out-trace ---- @@ -921,7 +921,7 @@ $ babeltrace my-trace --stream-intersection \ ==== [role="term"] ---- -$ babeltrace --input-format=lttng-live \ +$ babeltrace2 --input-format=lttng-live \ net://localhost/host/myhostname/auto-20170411-134512 \ --output-format=ctf --output=/path/to/generated/traces ---- @@ -931,7 +931,7 @@ $ babeltrace --input-format=lttng-live \ ==== [role="term"] ---- -$ babeltrace my-trace --output-format=dummy +$ babeltrace2 my-trace --output-format=dummy ---- ==== @@ -939,7 +939,7 @@ $ babeltrace my-trace --output-format=dummy ==== [role="term"] ---- -$ babeltrace trace1 trace2 trace3 --stream-intersection \ +$ babeltrace2 trace1 trace2 trace3 --stream-intersection \ --debug-info --output=pretty-out ---- ==== @@ -948,7 +948,7 @@ $ babeltrace trace1 trace2 trace3 --stream-intersection \ ==== [role="term"] ---- -$ babeltrace ctf-trace --component=src.my-plugin.my-src \ +$ babeltrace2 ctf-trace --component=src.my-plugin.my-src \ --params=output-some-event-type=yes --clock-seconds ---- ==== @@ -957,7 +957,7 @@ $ babeltrace ctf-trace --component=src.my-plugin.my-src \ ==== [role="term"] ---- -$ babeltrace --input-format=lttng-live \ +$ babeltrace2 --input-format=lttng-live \ net://localhost/host/myhostname/mysession \ --component=sink.my-plugin.my-sink ---- @@ -967,7 +967,7 @@ $ babeltrace --input-format=lttng-live \ ==== [role="term"] ---- -$ babeltrace /path/to/trace --timerange=22:14:38,22:15:07 \ +$ babeltrace2 /path/to/trace --timerange=22:14:38,22:15:07 \ --debug-info --component=filter.my-plugin.my-filter \ --params=criteria=xyz,ignore-abc=yes \ --output-format=ctf --output=out-trace @@ -978,7 +978,7 @@ $ babeltrace /path/to/trace --timerange=22:14:38,22:15:07 \ ==== [role="term"] ---- -$ babeltrace /path/to/trace --output-format=ctf-metadata +$ babeltrace2 /path/to/trace --output-format=ctf-metadata ---- ==== @@ -986,7 +986,7 @@ $ babeltrace /path/to/trace --output-format=ctf-metadata ==== [role="term"] ---- -$ babeltrace --input-format=lttng-live net://localhost +$ babeltrace2 --input-format=lttng-live net://localhost ---- ==== @@ -1000,6 +1000,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace(1), -man:babeltrace-run(1), -man:babeltrace-intro(7) +man:babeltrace2(1), +man:babeltrace2-run(1), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-filter.lttng-utils.debug-info.7.txt b/doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt similarity index 96% rename from doc/man/babeltrace-filter.lttng-utils.debug-info.7.txt rename to doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt index e640cdef..ca05d708 100644 --- a/doc/man/babeltrace-filter.lttng-utils.debug-info.7.txt +++ b/doc/man/babeltrace2-filter.lttng-utils.debug-info.7.txt @@ -1,4 +1,4 @@ -babeltrace-filter.lttng-utils.debug-info(7) +babeltrace2-filter.lttng-utils.debug-info(7) =========================================== :manpagetype: component class :revdate: 5 October 2017 @@ -8,14 +8,14 @@ babeltrace-filter.lttng-utils.debug-info(7) NAME ---- -babeltrace-filter.lttng-utils.debug-info - Babeltrace's debugging +babeltrace2-filter.lttng-utils.debug-info - Babeltrace's debugging information filter component class for LTTng traces DESCRIPTION ----------- The Babeltrace {comp} component class, provided by the the -man:babeltrace-plugin-lttng-utils(7) plugin, once instantiated, receives +man:babeltrace2-plugin-lttng-utils(7) plugin, once instantiated, receives events from http://lttng.org/[LTTng] traces and creates new ones which are copies of the original ones with extra debugging information when it's available and possible. @@ -252,8 +252,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_FLT_LTTNG_UTILS_DEBUG_INFO_LOG_LEVEL`:: Component class's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). include::common-footer.txt[] @@ -261,7 +261,7 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-lttng-utils(7), +man:babeltrace2-plugin-lttng-utils(7), man:lttng(1), man:lttng-add-context(1), -man:babeltrace-intro(7) +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-filter.utils.muxer.7.txt b/doc/man/babeltrace2-filter.utils.muxer.7.txt similarity index 86% rename from doc/man/babeltrace-filter.utils.muxer.7.txt rename to doc/man/babeltrace2-filter.utils.muxer.7.txt index b35731fc..dde289a1 100644 --- a/doc/man/babeltrace-filter.utils.muxer.7.txt +++ b/doc/man/babeltrace2-filter.utils.muxer.7.txt @@ -1,4 +1,4 @@ -babeltrace-filter.utils.muxer(7) +babeltrace2-filter.utils.muxer(7) ================================ :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-filter.utils.muxer(7) NAME ---- -babeltrace-filter.utils.muxer - Babeltrace's notification multiplexer +babeltrace2-filter.utils.muxer - Babeltrace's notification multiplexer filter component class DESCRIPTION ----------- The Babeltrace compcls:filter.utils.muxer component class, provided by -the man:babeltrace-plugin-utils(7) plugin, once instantiated, +the man:babeltrace2-plugin-utils(7) plugin, once instantiated, multiplexes the notifications that it receives from one or more input ports into a linear sequence of events ordered by time on its output port. @@ -73,8 +73,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_FLT_UTILS_MUXER_LOG_LEVEL`:: Component class's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). include::common-footer.txt[] @@ -82,5 +82,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-utils(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-utils(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-filter.utils.trimmer.7.txt b/doc/man/babeltrace2-filter.utils.trimmer.7.txt similarity index 89% rename from doc/man/babeltrace-filter.utils.trimmer.7.txt rename to doc/man/babeltrace2-filter.utils.trimmer.7.txt index 97f627d8..cf49d9c5 100644 --- a/doc/man/babeltrace-filter.utils.trimmer.7.txt +++ b/doc/man/babeltrace2-filter.utils.trimmer.7.txt @@ -1,4 +1,4 @@ -babeltrace-filter.utils.trimmer(7) +babeltrace2-filter.utils.trimmer(7) ================================== :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-filter.utils.trimmer(7) NAME ---- -babeltrace-filter.utils.trimmer - Babeltrace's trimmer filter +babeltrace2-filter.utils.trimmer - Babeltrace's trimmer filter component class DESCRIPTION ----------- The Babeltrace compcls:filter.utils.trimmer component class, provided by -the man:babeltrace-plugin-utils(7) plugin, once instantiated, discards +the man:babeltrace2-plugin-utils(7) plugin, once instantiated, discards all the received events with a time less than a given beginning time and greater than a given end time. It effectively ``cuts'', or trims traces. @@ -112,8 +112,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_FLT_UTILS_TRIMMER_LOG_LEVEL`:: Component class's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). include::common-footer.txt[] @@ -121,5 +121,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-utils(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-utils(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-help.1.txt b/doc/man/babeltrace2-help.1.txt similarity index 75% rename from doc/man/babeltrace-help.1.txt rename to doc/man/babeltrace2-help.1.txt index 13b06b3e..e1b7d7c5 100644 --- a/doc/man/babeltrace-help.1.txt +++ b/doc/man/babeltrace2-help.1.txt @@ -1,4 +1,4 @@ -babeltrace-help(1) +babeltrace2-help(1) ================== :manpagetype: command :revdate: 5 October 2017 @@ -6,13 +6,13 @@ babeltrace-help(1) NAME ---- -babeltrace-help - Get help for a Babeltrace plugin or component class +babeltrace2-help - Get help for a Babeltrace plugin or component class SYNOPSIS -------- [verse] -*babeltrace help* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 help* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] ('PLUGIN' | 'TYPE.PLUGIN.COMPCLS') @@ -23,7 +23,7 @@ DESCRIPTION The `help` command prints the details and help text of either the plugin 'PLUGIN' or the specific component class 'TYPE.PLUGIN.COMPCLS'. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. The available values for 'TYPE' are: @@ -59,7 +59,7 @@ EXAMPLES ==== [role="term"] ---- -$ babeltrace help my-plugin +$ babeltrace2 help my-plugin ---- ==== @@ -67,7 +67,7 @@ $ babeltrace help my-plugin ==== [role="term"] ---- -$ babeltrace help src.my-plugin.my-source +$ babeltrace2 help src.my-plugin.my-source ---- ==== @@ -75,7 +75,7 @@ $ babeltrace help src.my-plugin.my-source ==== [role="term"] ---- -$ babeltrace help sink.my-plugin.my-sink +$ babeltrace2 help sink.my-plugin.my-sink ---- ==== @@ -89,6 +89,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace(1), -man:babeltrace-list-plugins(1) -man:babeltrace-intro(7) +man:babeltrace2(1), +man:babeltrace2-list-plugins(1) +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-intro.7.txt b/doc/man/babeltrace2-intro.7.txt similarity index 90% rename from doc/man/babeltrace-intro.7.txt rename to doc/man/babeltrace2-intro.7.txt index 101fe7a4..62cea708 100644 --- a/doc/man/babeltrace-intro.7.txt +++ b/doc/man/babeltrace2-intro.7.txt @@ -1,4 +1,4 @@ -babeltrace-intro(7) +babeltrace2-intro(7) =================== :manpagetype: man page :revdate: 5 October 2017 @@ -6,7 +6,7 @@ babeltrace-intro(7) NAME ---- -babeltrace-intro - Introduction to Babeltrace +babeltrace2-intro - Introduction to Babeltrace DESCRIPTION @@ -32,37 +32,37 @@ https://en.wikipedia.org/wiki/Tracing_(software)[traces]. The Babeltrace project includes the following parts: -[[libbabeltrace]]Babeltrace library (libbabeltrace):: +[[libbabeltrace2]]Babeltrace library (libbabeltrace2):: A shared library with a C API. + -With libbabeltrace, you can programmatically create <> +With libbabeltrace2, you can programmatically create <> and <>, build and run <>, and more (see the <> section for more details about those concepts). All the other Babeltrace parts rely on this library. -[[babeltrace-1]]`babeltrace` command:: - A command-line interface which uses libbabeltrace to load plugins, +[[babeltrace2-1]]`babeltrace2` command:: + A command-line interface which uses libbabeltrace2 to load plugins, create a trace processing graph, create components, and run the graph. + -You can also use `babeltrace` to list the available plugins or to query +You can also use `babeltrace2` to list the available plugins or to query an object from a component class. + -See man:babeltrace(1). +See man:babeltrace2(1). [[python-bindings]]Babeltrace Python bindings:: A Python{nbsp}3 package which offers a Pythonic interface of - libbabeltrace. + libbabeltrace2. + -You can perform the same operations which are available in libbabeltrace +You can perform the same operations which are available in libbabeltrace2 with the Python bindings, but in a really easier way and with less code. Babeltrace project's plugins:: The Babeltrace <> shipped with the project. + -Those plugins are not special, in that they only rely on libbabeltrace -and you don't need them to use libbabeltrace, man:babeltrace(1), or the +Those plugins are not special, in that they only rely on libbabeltrace2 +and you don't need them to use libbabeltrace2, man:babeltrace2(1), or the Python bindings. + The Babeltrace project's plugins are: @@ -71,26 +71,26 @@ The Babeltrace project's plugins are: `ctf`:: Common Trace Format input/output, including the LTTng live source. + -See man:babeltrace-plugin-ctf(7). +See man:babeltrace2-plugin-ctf(7). `lttng-utils`:: Graph utilities specific to http://lttng.org/[LTTng] traces. + -See man:babeltrace-plugin-lttng-utils(7). +See man:babeltrace2-plugin-lttng-utils(7). `text`:: Text input/output. + -See man:babeltrace-plugin-text(7). +See man:babeltrace2-plugin-text(7). `utils`:: Graph utilities (muxer, trimmer, counter, dummy sink). + -See man:babeltrace-plugin-utils(7). +See man:babeltrace2-plugin-utils(7). -- Python plugin provider:: - A shared library which libbabeltrace tries to load to add support + A shared library which libbabeltrace2 tries to load to add support for Babeltrace plugins written in Python. + The package you use to write a Python Babeltrace plugin is the one @@ -106,15 +106,15 @@ Babeltrace{nbsp}1 exists since 2010. The major improvements brought by Babeltrace{nbsp}2 are: * Full plugin support: any user can distribute a Babeltrace plugin and, - as long as <> finds it, any application - linked to libbabeltrace can load it and use it. + as long as <> finds it, any application + linked to libbabeltrace2 can load it and use it. + Plugins are not just input and output formats: they provide source, filter, and sink <> so that you can connect specialized, reusable components together in a graph to create a customized trace conversion or analysis device. -* In order to support user components, all the objects of libbabeltrace +* In order to support user components, all the objects of libbabeltrace2 have a reference count. The possible reference cycles are handled internally so that the library's API is clean and predictable. The two reference counting functions, `bt_get()` and `bt_put()`, are all you @@ -129,9 +129,9 @@ BABELTRACE CONCEPTS ------------------- This section defines the main concepts of the Babeltrace project. These concepts translate into types and functions in -<> and its <> and its <>, but also as command-line actions and options in the -<>. The other Babeltrace man pages +<>. The other Babeltrace man pages assume that you are familiar with the following definitions. Some Babeltrace concepts are interdependent: it is normal to jump from @@ -269,9 +269,9 @@ Discarded packets:: output <> to input ports. + You can build a trace processing graph with -<>, with the <>, or with the man:babeltrace-run(1) and -man:babeltrace-convert(1) commands. +<>, with the <>, or with the man:babeltrace2-run(1) and +man:babeltrace2-convert(1) commands. + When you _run_ a trace processing graph, the sink components consume notifications from their input ports, making all the graph's components @@ -285,18 +285,18 @@ Each component class within a plugin has a type (source, filter, or sink) and a name. The type and name pair is unique within a given plugin. + -<> can load a plugin (`.so` or `.dll` file) +<> can load a plugin (`.so` or `.dll` file) at run time: the result is a plugin object in which you can find a specific component class and instantiate it within a <> as a <>. + -The <> uses the +The <> uses the 'TYPE.PLUGIN.COMPCLS' format to identify a specific component class within a specific plugin. 'TYPE' is either `source`, `filter`, or `sink`. + You can list the available Babeltrace plugins with the -man:babeltrace-list-plugins(1) command. +man:babeltrace2-list-plugins(1) command. [[query]]Query:: An operation with which you can get a named object from a @@ -306,7 +306,7 @@ man:babeltrace-list-plugins(1) command. The plain text metadata stream of a CTF trace and the available LTTng live sessions of a given LTTng relay daemon are examples of queries. + -You can use the man:babeltrace-query(1) command to query a component +You can use the man:babeltrace2-query(1) command to query a component class's object. @@ -412,4 +412,4 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace(1) +man:babeltrace2(1) diff --git a/doc/man/babeltrace-list-plugins.1.txt b/doc/man/babeltrace2-list-plugins.1.txt similarity index 69% rename from doc/man/babeltrace-list-plugins.1.txt rename to doc/man/babeltrace2-list-plugins.1.txt index f15e9760..6c15e079 100644 --- a/doc/man/babeltrace-list-plugins.1.txt +++ b/doc/man/babeltrace2-list-plugins.1.txt @@ -1,4 +1,4 @@ -babeltrace-list-plugins(1) +babeltrace2-list-plugins(1) ========================== :manpagetype: command :revdate: 5 October 2017 @@ -6,13 +6,13 @@ babeltrace-list-plugins(1) NAME ---- -babeltrace-list-plugins - List Babeltrace plugins and their properties +babeltrace2-list-plugins - List Babeltrace plugins and their properties SYNOPSIS -------- [verse] -*babeltrace list-plugins* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 list-plugins* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] @@ -22,7 +22,7 @@ DESCRIPTION The `list-plugins` command prints a list of available Babeltrace plugins along with their component classes and their properties. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. @@ -46,6 +46,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace(1), -man:babeltrace-help(1), -man:babeltrace-intro(7) +man:babeltrace2(1), +man:babeltrace2-help(1), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-log.1.txt b/doc/man/babeltrace2-log.1.txt similarity index 62% rename from doc/man/babeltrace-log.1.txt rename to doc/man/babeltrace2-log.1.txt index 2f87ac54..c88056c9 100644 --- a/doc/man/babeltrace-log.1.txt +++ b/doc/man/babeltrace2-log.1.txt @@ -1,4 +1,4 @@ -babeltrace-log(1) +babeltrace2-log(1) ================= :manpagetype: program :revdate: 5 October 2017 @@ -6,18 +6,18 @@ babeltrace-log(1) NAME ---- -babeltrace-log - Convert a Linux kernel ring buffer to a CTF trace +babeltrace2-log - Convert a Linux kernel ring buffer to a CTF trace SYNOPSIS -------- [verse] -*babeltrace-log* [opt:--with-timestamps] 'OUTPUT-PATH' +*babeltrace2-log* [opt:--with-timestamps] 'OUTPUT-PATH' DESCRIPTION ----------- -The `babeltrace-log` tool reads the lines of a Linux kernel ring buffer, +The `babeltrace2-log` tool reads the lines of a Linux kernel ring buffer, as printed by the man:dmesg(1) tool, from the standard input stream and converts them to a http://diamon.org/ctf/[CTF] trace written to the 'OUTPUT-PATH' directory. @@ -26,14 +26,14 @@ Usage example: [role="term"] ---- -$ dmesg | babeltrace-log --with-timestamps my-trace +$ dmesg | babeltrace2-log --with-timestamps my-trace ---- The events of the generated CTF trace are named `string` and contain a single payload string field named `str` which contains the corresponding ring buffer line. -By default, `babeltrace-log` does not try to extract the timestamps of +By default, `babeltrace2-log` does not try to extract the timestamps of the kernel ring buffer lines to use them as the created events's timestamps. A typical man:dmesg(1) line looks like this: @@ -42,7 +42,7 @@ timestamps. A typical man:dmesg(1) line looks like this: ---- In the last example, the `[87166.510937]` part is a timestamp which -could be extracted. You can make `babeltrace-log` extract timestamps +could be extracted. You can make `babeltrace2-log` extract timestamps from lines with the opt:--with-timestamps option. @@ -56,9 +56,9 @@ opt:-t, opt:--with-timestamps:: ENVIRONMENT VARIABLES --------------------- -See the environment variables of man:babeltrace-source.text.dmesg(7), -man:babeltrace-filter.utils.muxer(7), and -man:babeltrace-sink.ctf.fs(7). +See the environment variables of man:babeltrace2-source.text.dmesg(7), +man:babeltrace2-filter.utils.muxer(7), and +man:babeltrace2-sink.ctf.fs(7). include::common-lib-env.txt[] @@ -69,7 +69,7 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace-intro(7), -man:babeltrace-source.text.dmesg(7), -man:babeltrace-filter.utils.muxer(7), -man:babeltrace-sink.ctf.fs(7) +man:babeltrace2-intro(7), +man:babeltrace2-source.text.dmesg(7), +man:babeltrace2-filter.utils.muxer(7), +man:babeltrace2-sink.ctf.fs(7) diff --git a/doc/man/babeltrace-plugin-ctf.7.txt b/doc/man/babeltrace2-plugin-ctf.7.txt similarity index 65% rename from doc/man/babeltrace-plugin-ctf.7.txt rename to doc/man/babeltrace2-plugin-ctf.7.txt index 4749104d..9cc93ed9 100644 --- a/doc/man/babeltrace-plugin-ctf.7.txt +++ b/doc/man/babeltrace2-plugin-ctf.7.txt @@ -1,4 +1,4 @@ -babeltrace-plugin-ctf(7) +babeltrace2-plugin-ctf(7) ======================== :manpagetype: plugin :revdate: 5 October 2017 @@ -6,7 +6,7 @@ babeltrace-plugin-ctf(7) NAME ---- -babeltrace-plugin-ctf - Babeltrace's CTF plugin +babeltrace2-plugin-ctf - Babeltrace's CTF plugin DESCRIPTION @@ -14,7 +14,7 @@ DESCRIPTION The Babeltrace `ctf` plugin contains component classes which can read and write the http://diamon.org/ctf/[Common Trace Format]. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. @@ -23,19 +23,19 @@ COMPONENT CLASSES compcls:sink.ctf.fs:: Writes the received notifications as a CTF trace on the file system. + -See man:babeltrace-sink.ctf.fs(7). +See man:babeltrace2-sink.ctf.fs(7). compcls:source.ctf.fs:: Opens one or more CTF traces on the file system and emits the notifications of their data stream files. + -See man:babeltrace-source.ctf.fs(7). +See man:babeltrace2-source.ctf.fs(7). compcls:source.ctf.lttng-live:: Connects to an http://lttng.org/[LTTng] relay daemon and emits the notifications of the received CTF data streams. + -See man:babeltrace-source.ctf.lttng-live(7). +See man:babeltrace2-source.ctf.lttng-live(7). include::common-footer.txt[] @@ -43,7 +43,7 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-sink.ctf.fs(7), -man:babeltrace-source.ctf.fs(7), -man:babeltrace-source.ctf.lttng-live(7), -man:babeltrace-intro(7) +man:babeltrace2-sink.ctf.fs(7), +man:babeltrace2-source.ctf.fs(7), +man:babeltrace2-source.ctf.lttng-live(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-plugin-lttng-utils.7.txt b/doc/man/babeltrace2-plugin-lttng-utils.7.txt similarity index 64% rename from doc/man/babeltrace-plugin-lttng-utils.7.txt rename to doc/man/babeltrace2-plugin-lttng-utils.7.txt index fd946f8a..c80b1040 100644 --- a/doc/man/babeltrace-plugin-lttng-utils.7.txt +++ b/doc/man/babeltrace2-plugin-lttng-utils.7.txt @@ -1,4 +1,4 @@ -babeltrace-plugin-lttng-utils(7) +babeltrace2-plugin-lttng-utils(7) ================================ :manpagetype: plugin :revdate: 5 October 2017 @@ -6,7 +6,7 @@ babeltrace-plugin-lttng-utils(7) NAME ---- -babeltrace-plugin-lttng-utils - Babeltrace's LTTng utilities plugin +babeltrace2-plugin-lttng-utils - Babeltrace's LTTng utilities plugin DESCRIPTION @@ -14,9 +14,9 @@ DESCRIPTION The Babeltrace `lttng-utils` plugin contains utilities that apply to LTTng traces. You can use the compcls:source.ctf.fs and compcls:source.ctf.lttng-live components to read LTTng traces (see -man:babeltrace-plugin-ctf(7)). +man:babeltrace2-plugin-ctf(7)). -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. @@ -26,7 +26,7 @@ compcls:filter.lttng-utils.debug-info:: Receives notifications from its input port and creates new, equivalent notifications with additionnal debugging information. + -See man:babeltrace-filter.lttng-utils.debug-info(7). +See man:babeltrace2-filter.lttng-utils.debug-info(7). include::common-footer.txt[] @@ -34,5 +34,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-filter.lttng-utils.debug-info(7), -man:babeltrace-intro(7) +man:babeltrace2-filter.lttng-utils.debug-info(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-plugin-text.7.txt b/doc/man/babeltrace2-plugin-text.7.txt similarity index 65% rename from doc/man/babeltrace-plugin-text.7.txt rename to doc/man/babeltrace2-plugin-text.7.txt index 36eee2c5..f88db0b4 100644 --- a/doc/man/babeltrace-plugin-text.7.txt +++ b/doc/man/babeltrace2-plugin-text.7.txt @@ -1,4 +1,4 @@ -babeltrace-plugin-text(7) +babeltrace2-plugin-text(7) ========================= :manpagetype: plugin :revdate: 5 October 2017 @@ -6,7 +6,7 @@ babeltrace-plugin-text(7) NAME ---- -babeltrace-plugin-text - Babeltrace's plain text plugin +babeltrace2-plugin-text - Babeltrace's plain text plugin DESCRIPTION @@ -14,7 +14,7 @@ DESCRIPTION The Babeltrace `text` plugin contains component classes which read or write plain text data. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. @@ -24,14 +24,14 @@ compcls:sink.text.pretty:: Pretty-prints the notifications it receives to the console or to a file. + -See man:babeltrace-sink.text.pretty(7). +See man:babeltrace2-sink.text.pretty(7). compcls:source.text.dmesg:: Reads the lines of a Linux kernel ring buffer, that is, the output of the man:dmesg(1) tool, and emits each line as an event notification. + -See man:babeltrace-source.text.dmesg(7). +See man:babeltrace2-source.text.dmesg(7). include::common-footer.txt[] @@ -39,6 +39,6 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-sink-text.text(7), -man:babeltrace-source-text.dmesg(7), -man:babeltrace-intro(7), +man:babeltrace2-sink-text.text(7), +man:babeltrace2-source-text.dmesg(7), +man:babeltrace2-intro(7), diff --git a/doc/man/babeltrace-plugin-utils.7.txt b/doc/man/babeltrace2-plugin-utils.7.txt similarity index 66% rename from doc/man/babeltrace-plugin-utils.7.txt rename to doc/man/babeltrace2-plugin-utils.7.txt index e1a0a6be..49efecbf 100644 --- a/doc/man/babeltrace-plugin-utils.7.txt +++ b/doc/man/babeltrace2-plugin-utils.7.txt @@ -1,4 +1,4 @@ -babeltrace-plugin-utils(7) +babeltrace2-plugin-utils(7) ========================== :manpagetype: plugin :revdate: 5 October 2017 @@ -6,7 +6,7 @@ babeltrace-plugin-utils(7) NAME ---- -babeltrace-plugin-utils - Babeltrace's utilities plugin +babeltrace2-plugin-utils - Babeltrace's utilities plugin DESCRIPTION @@ -14,7 +14,7 @@ DESCRIPTION The Babeltrace `utils` plugin contains common, generic utility component classes which you can use in any processing graph. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. @@ -24,28 +24,28 @@ compcls:filter.utils.muxer:: Multiplexes the notifications received on its multiple input ports by time to its single output port. + -See man:babeltrace-filter.utils.muxer(7). +See man:babeltrace2-filter.utils.muxer(7). compcls:filter.utils.trimmer:: Discards all the received events with a timestamp less than a given beginning timestamp and greater than a given end timestamp, effectively ``cutting'' the traces. + -See man:babeltrace-filter.utils.trimmer(7). +See man:babeltrace2-filter.utils.trimmer(7). compcls:sink.utils.dummy:: Receives the notifications from its single input port and discards them (does absolutely nothing with them). This is useful for testing and benchmarking a trace processing graph application, - for example man:babeltrace(1). + for example man:babeltrace2(1). + -See man:babeltrace-sink.utils.dummy(7). +See man:babeltrace2-sink.utils.dummy(7). compcls:sink.utils.counter:: Prints the number of notifications received from its single input port, either once at the end or periodically. + -See man:babeltrace-sink.utils.counter(7). +See man:babeltrace2-sink.utils.counter(7). include::common-footer.txt[] @@ -53,8 +53,8 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-intro(7), -man:babeltrace-filter.utils.muxer(7), -man:babeltrace-filter.utils.trimmer(7), -man:babeltrace-sink.utils.counter(7), -man:babeltrace-sink.utils.dummy(7) +man:babeltrace2-intro(7), +man:babeltrace2-filter.utils.muxer(7), +man:babeltrace2-filter.utils.trimmer(7), +man:babeltrace2-sink.utils.counter(7), +man:babeltrace2-sink.utils.dummy(7) diff --git a/doc/man/babeltrace-query.1.txt b/doc/man/babeltrace2-query.1.txt similarity index 81% rename from doc/man/babeltrace-query.1.txt rename to doc/man/babeltrace2-query.1.txt index f15e69bf..d5483b97 100644 --- a/doc/man/babeltrace-query.1.txt +++ b/doc/man/babeltrace2-query.1.txt @@ -1,4 +1,4 @@ -babeltrace-query(1) +babeltrace2-query(1) =================== :manpagetype: command :revdate: 5 October 2017 @@ -6,13 +6,13 @@ babeltrace-query(1) NAME ---- -babeltrace-query - Query object from a component class +babeltrace2-query - Query object from a component class SYNOPSIS -------- [verse] -*babeltrace query* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 query* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] [opt:--params='PARAMS'] 'TYPE.PLUGIN.COMPCLS' 'OBJECT' @@ -24,7 +24,7 @@ The `query` command queries the object named 'OBJECT' from the component class 'COMPCLS' of the type 'TYPE' found in the Babeltrace plugin 'PLUGIN' and prints the results. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. The available values for 'TYPE' are: @@ -41,7 +41,7 @@ The available values for 'TYPE' are: Sink component class. The exact object names and the parameters that a given component class -expects are described in its documentation. man:babeltrace-help(1) can +expects are described in its documentation. man:babeltrace2-help(1) can generally provide this information. You can use the opt:--params='PARAMS' option to pass parameters to the @@ -83,7 +83,7 @@ EXAMPLES ==== [role="term"] ---- -$ babeltrace query src.ctf.lttng-live sessions \ +$ babeltrace2 query src.ctf.lttng-live sessions \ --params='url="net://RHOST/host/TGTHOST"' ---- ==== @@ -92,7 +92,7 @@ $ babeltrace query src.ctf.lttng-live sessions \ ==== [role="term"] ---- -$ babeltrace query src.ctf.fs metadata-info \ +$ babeltrace2 query src.ctf.fs metadata-info \ --params='path="/path/to/trace"' ---- ==== @@ -101,7 +101,7 @@ $ babeltrace query src.ctf.fs metadata-info \ ==== [role="term"] ---- -$ babeltrace query src.ctf.fs trace-info \ +$ babeltrace2 query src.ctf.fs trace-info \ --params='path="/path/to/trace"' ---- ==== @@ -110,7 +110,7 @@ $ babeltrace query src.ctf.fs trace-info \ ==== [role="term"] ---- -$ babeltrace query sink.my-plugin.my-sink some-object +$ babeltrace2 query sink.my-plugin.my-sink some-object ---- ==== @@ -124,5 +124,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace(1), -man:babeltrace-intro(7) +man:babeltrace2(1), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-run.1.txt b/doc/man/babeltrace2-run.1.txt similarity index 92% rename from doc/man/babeltrace-run.1.txt rename to doc/man/babeltrace2-run.1.txt index 686bd818..dcdd26b8 100644 --- a/doc/man/babeltrace-run.1.txt +++ b/doc/man/babeltrace2-run.1.txt @@ -1,4 +1,4 @@ -babeltrace-run(1) +babeltrace2-run(1) ================= :manpagetype: command :revdate: 5 October 2017 @@ -6,13 +6,13 @@ babeltrace-run(1) NAME ---- -babeltrace-run - Create a trace processing graph and run it +babeltrace2-run - Create a trace processing graph and run it SYNOPSIS -------- [verse] -*babeltrace run* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] +*babeltrace2 run* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] [opt:--plugin-path='PATH'[:__PATH__]...] [opt:--retry-duration='DURUS'] @@ -23,15 +23,15 @@ DESCRIPTION ----------- The `run` command creates a trace processing graph and runs it. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. -The `run` command uses libbabeltrace to dynamically load plugins which +The `run` command uses libbabeltrace2 to dynamically load plugins which supply component classes. With the `run` command, you specify which component classes to instantiate as components and how they must be connected. -The steps to write a `babeltrace run` command line are: +The steps to write a `babeltrace2 run` command line are: . Specify which component classes to instantiate as components and how. This is the 'COMPONENTS' part of the synopsis. See @@ -41,11 +41,11 @@ The steps to write a `babeltrace run` command line are: opt:--connect options. See <> to learn more. -NOTE: The man:babeltrace-convert(1) command is a specialization of the +NOTE: The man:babeltrace2-convert(1) command is a specialization of the `run` command for the very common case of converting one or more traces: it generates a `run` command line and executes it. You can use its -manopt:babeltrace-convert(1):--run-args or -manopt:babeltrace-convert(1):--run-args-0 option to make it print the +manopt:babeltrace2-convert(1):--run-args or +manopt:babeltrace2-convert(1):--run-args-0 option to make it print the equivalent `run` command line instead. @@ -261,7 +261,7 @@ EXAMPLES ==== [role="term"] ---- -$ babeltrace run --component=A:src.plug.my-src \ +$ babeltrace2 run --component=A:src.plug.my-src \ --component=B:sink.plug.my-sink \ --connect=A:B ---- @@ -282,7 +282,7 @@ Possible resulting graph: ==== [role="term"] ---- -$ babeltrace run --component=src.plug.my-src --name=the-source \ +$ babeltrace2 run --component=src.plug.my-src --name=the-source \ --component=the-sink:sink.plug.my-sink \ --connect=the-source:the-sink ---- @@ -295,7 +295,7 @@ In this example, the opt:--params option only applies to component [role="term"] ---- -$ babeltrace run --component=the-source:src.my-plugin.my-src \ +$ babeltrace2 run --component=the-source:src.my-plugin.my-src \ --params='offset=123, flag=true' \ --component=the-sink:sink.my-plugin.my-sink \ --connect=the-source:the-sink @@ -313,7 +313,7 @@ created components are: [role="term"] ---- -$ babeltrace run --base-params='offset=1203, flag=false' \ +$ babeltrace2 run --base-params='offset=1203, flag=false' \ --component=A:src.plugin.compcls \ --component=B:flt.plugin.compcls \ --params='flag=true, type=event' \ @@ -338,7 +338,7 @@ and _any_ `A` output port, whatever its name, would be connected to a [role="term"] ---- -$ babeltrace run --component=A:src.plug.my-src \ +$ babeltrace2 run --component=A:src.plug.my-src \ --component=B:sink.plug.my-sink \ --connect='A.foo*:B:nin*' --connect='A:B.oth*' ---- @@ -368,6 +368,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace(1), -man:babeltrace-convert(1), -man:babeltrace-intro(7) +man:babeltrace2(1), +man:babeltrace2-convert(1), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-sink.ctf.fs.7.txt b/doc/man/babeltrace2-sink.ctf.fs.7.txt similarity index 89% rename from doc/man/babeltrace-sink.ctf.fs.7.txt rename to doc/man/babeltrace2-sink.ctf.fs.7.txt index bd04246e..aab42675 100644 --- a/doc/man/babeltrace-sink.ctf.fs.7.txt +++ b/doc/man/babeltrace2-sink.ctf.fs.7.txt @@ -1,4 +1,4 @@ -babeltrace-sink.ctf.fs(7) +babeltrace2-sink.ctf.fs(7) ========================= :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-sink.ctf.fs(7) NAME ---- -babeltrace-sink.ctf.fs - Babeltrace's file system CTF sink component +babeltrace2-sink.ctf.fs - Babeltrace's file system CTF sink component class DESCRIPTION ----------- The Babeltrace compcls:sink.ctf.fs component class, provided by the -man:babeltrace-plugin-ctf(7) plugin, once instantiated, writes the +man:babeltrace2-plugin-ctf(7) plugin, once instantiated, writes the events it receives to one or more http://diamon.org/ctf/[CTF] traces on the file system. @@ -102,8 +102,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_SINK_CTF_FS_LOG_LEVEL`:: Component class's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). include::common-footer.txt[] @@ -111,5 +111,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-ctf(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-ctf(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-sink.text.pretty.7.txt b/doc/man/babeltrace2-sink.text.pretty.7.txt similarity index 94% rename from doc/man/babeltrace-sink.text.pretty.7.txt rename to doc/man/babeltrace2-sink.text.pretty.7.txt index 8a3629d7..3fd4ae1d 100644 --- a/doc/man/babeltrace-sink.text.pretty.7.txt +++ b/doc/man/babeltrace2-sink.text.pretty.7.txt @@ -1,4 +1,4 @@ -babeltrace-sink.text.pretty(7) +babeltrace2-sink.text.pretty(7) ============================== :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-sink.text.pretty(7) NAME ---- -babeltrace-sink.text.pretty - Babeltrace's pretty-printing sink +babeltrace2-sink.text.pretty - Babeltrace's pretty-printing sink component class DESCRIPTION ----------- The Babeltrace compcls:sink.text.pretty component class, provided by the -man:babeltrace-plugin-text(7) plugin, once instantiated, pretty-prints +man:babeltrace2-plugin-text(7) plugin, once instantiated, pretty-prints the events it receives from its input port to the console or to a file. By default, a compcls:sink.text.pretty component pretty-prints to @@ -143,5 +143,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-text(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-text(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-sink.utils.counter.7.txt b/doc/man/babeltrace2-sink.utils.counter.7.txt similarity index 89% rename from doc/man/babeltrace-sink.utils.counter.7.txt rename to doc/man/babeltrace2-sink.utils.counter.7.txt index 008c9277..708cfa6f 100644 --- a/doc/man/babeltrace-sink.utils.counter.7.txt +++ b/doc/man/babeltrace2-sink.utils.counter.7.txt @@ -1,4 +1,4 @@ -babeltrace-sink.utils.counter(7) +babeltrace2-sink.utils.counter(7) ================================ :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-sink.utils.counter(7) NAME ---- -babeltrace-sink.utils.counter - Babeltrace's notification counter sink +babeltrace2-sink.utils.counter - Babeltrace's notification counter sink component class DESCRIPTION ----------- The Babeltrace compcls:sink.utils.counter component class, provided by -the man:babeltrace-plugin-utils(7) plugin, once instantiated, prints to +the man:babeltrace2-plugin-utils(7) plugin, once instantiated, prints to the standard output the number of notifications it receives on its input port, with a count for each type. @@ -83,5 +83,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-utils(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-utils(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-sink.utils.dummy.7.txt b/doc/man/babeltrace2-sink.utils.dummy.7.txt similarity index 83% rename from doc/man/babeltrace-sink.utils.dummy.7.txt rename to doc/man/babeltrace2-sink.utils.dummy.7.txt index 9173cd34..cb4b52db 100644 --- a/doc/man/babeltrace-sink.utils.dummy.7.txt +++ b/doc/man/babeltrace2-sink.utils.dummy.7.txt @@ -1,4 +1,4 @@ -babeltrace-sink.utils.dummy(7) +babeltrace2-sink.utils.dummy(7) ============================== :manpagetype: component class :revdate: 5 October 2017 @@ -6,13 +6,13 @@ babeltrace-sink.utils.dummy(7) NAME ---- -babeltrace-sink.utils.dummy - Babeltrace's dummy sink component class +babeltrace2-sink.utils.dummy - Babeltrace's dummy sink component class DESCRIPTION ----------- The Babeltrace compcls:sink.utils.dummy component class, provided by the -man:babeltrace-plugin-utils(7) plugin, once instantiated, receives +man:babeltrace2-plugin-utils(7) plugin, once instantiated, receives notifications from its input port and discards them (does absolutely nothing with them). @@ -53,5 +53,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-utils(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-utils(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-source.ctf.fs.7.txt b/doc/man/babeltrace2-source.ctf.fs.7.txt similarity index 95% rename from doc/man/babeltrace-source.ctf.fs.7.txt rename to doc/man/babeltrace2-source.ctf.fs.7.txt index 74b08b67..8fafb076 100644 --- a/doc/man/babeltrace-source.ctf.fs.7.txt +++ b/doc/man/babeltrace2-source.ctf.fs.7.txt @@ -1,4 +1,4 @@ -babeltrace-source.ctf.fs(7) +babeltrace2-source.ctf.fs(7) =========================== :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-source.ctf.fs(7) NAME ---- -babeltrace-source.ctf.fs - Babeltrace's file system CTF source +babeltrace2-source.ctf.fs - Babeltrace's file system CTF source component class DESCRIPTION ----------- The Babeltrace compcls:source.ctf.fs component class, provided by the -man:babeltrace-plugin-ctf(7) plugin, once instantiated, opens one or +man:babeltrace2-plugin-ctf(7) plugin, once instantiated, opens one or more http://diamon.org/ctf/[CTF] traces on the file system and emits the notifications of their data streams on its output ports. @@ -245,8 +245,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_SRC_CTF_FS_LOG_LEVEL`:: Component class's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). include::common-footer.txt[] @@ -254,5 +254,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-ctf(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-ctf(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace-source.ctf.lttng-live.7.txt b/doc/man/babeltrace2-source.ctf.lttng-live.7.txt similarity index 93% rename from doc/man/babeltrace-source.ctf.lttng-live.7.txt rename to doc/man/babeltrace2-source.ctf.lttng-live.7.txt index fc2803d3..d3b4f47e 100644 --- a/doc/man/babeltrace-source.ctf.lttng-live.7.txt +++ b/doc/man/babeltrace2-source.ctf.lttng-live.7.txt @@ -1,4 +1,4 @@ -babeltrace-source.ctf.lttng-live(7) +babeltrace2-source.ctf.lttng-live(7) =================================== :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-source.ctf.lttng-live(7) NAME ---- -babeltrace-source.ctf.lttng-live - Babeltrace's LTTng live source +babeltrace2-source.ctf.lttng-live - Babeltrace's LTTng live source component class DESCRIPTION ----------- The Babeltrace compcls:source.ctf.lttng-live source component class, -provided by the man:babeltrace-plugin-ctf(7) plugin, once instantiated, +provided by the man:babeltrace2-plugin-ctf(7) plugin, once instantiated, connects to a local or remote http://lttng.org/[LTTng] relay daemon and emits the received notifications on its output ports. More information about LTTng live is available in the @@ -172,8 +172,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_SRC_CTF_LTTNG_LIVE_LOG_LEVEL`:: Component class's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). include::common-footer.txt[] @@ -181,7 +181,7 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-ctf(7), -man:babeltrace-intro(7), +man:babeltrace2-plugin-ctf(7), +man:babeltrace2-intro(7), man:lttng-relayd(8), man:lttng-create(1) diff --git a/doc/man/babeltrace-source.text.dmesg.7.txt b/doc/man/babeltrace2-source.text.dmesg.7.txt similarity index 89% rename from doc/man/babeltrace-source.text.dmesg.7.txt rename to doc/man/babeltrace2-source.text.dmesg.7.txt index a3183388..f24d4eec 100644 --- a/doc/man/babeltrace-source.text.dmesg.7.txt +++ b/doc/man/babeltrace2-source.text.dmesg.7.txt @@ -1,4 +1,4 @@ -babeltrace-source.text.dmesg(7) +babeltrace2-source.text.dmesg(7) =============================== :manpagetype: component class :revdate: 5 October 2017 @@ -6,14 +6,14 @@ babeltrace-source.text.dmesg(7) NAME ---- -babeltrace-source.text.dmesg - Babeltrace's Linux kernel ring buffer +babeltrace2-source.text.dmesg - Babeltrace's Linux kernel ring buffer source component class DESCRIPTION ----------- The Babeltrace compcls:source.text.dmesg component class, provided by -the man:babeltrace-plugin-text(7) plugin, once instantiated, reads the +the man:babeltrace2-plugin-text(7) plugin, once instantiated, reads the lines of a Linux kernel ring buffer, as printed by the man:dmesg(1) tool, and emits corresponding event notifications on its output port. @@ -76,5 +76,5 @@ include::common-footer.txt[] SEE ALSO -------- -man:babeltrace-plugin-text(7), -man:babeltrace-intro(7) +man:babeltrace2-plugin-text(7), +man:babeltrace2-intro(7) diff --git a/doc/man/babeltrace.1.txt b/doc/man/babeltrace2.1.txt similarity index 72% rename from doc/man/babeltrace.1.txt rename to doc/man/babeltrace2.1.txt index a9cfdc89..413930c9 100644 --- a/doc/man/babeltrace.1.txt +++ b/doc/man/babeltrace2.1.txt @@ -1,4 +1,4 @@ -babeltrace(1) +babeltrace2(1) ============= :manpagetype: program :revdate: 5 October 2017 @@ -6,26 +6,26 @@ babeltrace(1) NAME ---- -babeltrace - Convert or process one or more traces, and more +babeltrace2 - Convert or process one or more traces, and more SYNOPSIS -------- [verse] -*babeltrace* [opt:--debug | opt:--verbose | opt:--log-level='LVL'] ['<>'] ['CMD ARGS'] +*babeltrace2* [opt:--debug | opt:--verbose | opt:--log-level='LVL'] ['<>'] ['CMD ARGS'] DESCRIPTION ----------- -`babeltrace` is an open-source trace converter and processor. The tool +`babeltrace2` is an open-source trace converter and processor. The tool can convert from one trace format to another, possibly with one or more filters in the conversion path, and perform other operations depending on the command 'CMD'. -See man:babeltrace-intro(7) to learn more about the Babeltrace +See man:babeltrace2-intro(7) to learn more about the Babeltrace project and its core concepts. -Most of the `babeltrace` commands load Babeltrace plugins to perform +Most of the `babeltrace2` commands load Babeltrace plugins to perform their operation. The search path for Babeltrace plugins is, in this order: @@ -35,11 +35,11 @@ order: . The colon-separated list of directories in the specific command's nlopt:--plugin-path option. -. `$HOME/.local/lib/babeltrace/plugins` +. `$HOME/.local/lib/babeltrace2/plugins` . +{system_plugin_path}+ -You can use the man:babeltrace-list-plugins(1) command to dynamically +You can use the man:babeltrace2-list-plugins(1) command to dynamically list the available plugins and what they offer. See <> for a list of plugins shipped with Babeltrace. @@ -116,22 +116,22 @@ COMMANDS -------- The following commands also have their own nlopt:--help option. -man:babeltrace-convert(1):: +man:babeltrace2-convert(1):: Build a trace conversion graph and run it. + This is the default command: you don't need to explicitly specify this command name to use it. -man:babeltrace-help(1):: +man:babeltrace2-help(1):: Get help for a specific plugin or plugin's component class. -man:babeltrace-list-plugins(1):: +man:babeltrace2-list-plugins(1):: List the available Babeltrace plugins and their component classes. -man:babeltrace-query(1):: +man:babeltrace2-query(1):: Query an object from a component class. -man:babeltrace-run(1):: +man:babeltrace2-run(1):: Build a trace processing graph and run it. @@ -140,34 +140,34 @@ PLUGINS ------- The following plugins are provided by the Babeltrace project itself: -man:babeltrace-plugin-ctf(7):: +man:babeltrace2-plugin-ctf(7):: CTF trace input (from the file system and from the LTTng-live protocol) and output to the file system. + -* man:babeltrace-sink.ctf.fs(7) -* man:babeltrace-source.ctf.fs(7) -* man:babeltrace-source.ctf.lttng-live(7) +* man:babeltrace2-sink.ctf.fs(7) +* man:babeltrace2-source.ctf.fs(7) +* man:babeltrace2-source.ctf.lttng-live(7) ifeval::[{enable_debug_info} == 1] -man:babeltrace-plugin-lttng-utils(7):: +man:babeltrace2-plugin-lttng-utils(7):: Processing graph utilities for LTTng traces. + -* man:babeltrace-filter.lttng-utils.debug-info(7) +* man:babeltrace2-filter.lttng-utils.debug-info(7) endif::[] -man:babeltrace-plugin-text(7):: +man:babeltrace2-plugin-text(7):: Text input and output. + -* man:babeltrace-sink.text.pretty(7) -* man:babeltrace-source.text.dmesg(7) +* man:babeltrace2-sink.text.pretty(7) +* man:babeltrace2-source.text.dmesg(7) -man:babeltrace-plugin-utils(7):: +man:babeltrace2-plugin-utils(7):: Processing graph utilities. + -* man:babeltrace-filter.utils.muxer(7) -* man:babeltrace-filter.utils.trimmer(7) -* man:babeltrace-sink.utils.counter(7) -* man:babeltrace-sink.utils.dummy(7) +* man:babeltrace2-filter.utils.muxer(7) +* man:babeltrace2-filter.utils.trimmer(7) +* man:babeltrace2-sink.utils.counter(7) +* man:babeltrace2-sink.utils.dummy(7) include::common-cli-env.txt[] @@ -179,9 +179,9 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace-convert(1), -man:babeltrace-help(1), -man:babeltrace-list-plugins(1), -man:babeltrace-query(1), -man:babeltrace-run(1), -man:babeltrace-intro(7) +man:babeltrace2-convert(1), +man:babeltrace2-help(1), +man:babeltrace2-list-plugins(1), +man:babeltrace2-query(1), +man:babeltrace2-run(1), +man:babeltrace2-intro(7) diff --git a/doc/man/common-cli-env.txt b/doc/man/common-cli-env.txt index 85140e8e..82e1b740 100644 --- a/doc/man/common-cli-env.txt +++ b/doc/man/common-cli-env.txt @@ -7,10 +7,10 @@ include::common-ppp-env.txt[] CLI ~~~ `BABELTRACE_CLI_LOG_LEVEL`:: - `babeltrace` CLI's log level. The available values are the same as - for the manopt:babeltrace(1):--log-level option. + `babeltrace2` CLI's log level. The available values are the same as + for the manopt:babeltrace2(1):--log-level option. `BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH`:: - Set to `0` to disable the warning message which `babeltrace` prints + Set to `0` to disable the warning message which `babeltrace2` prints when you convert a trace with a relative path that's also the name - of a `babeltrace` command. + of a `babeltrace2` command. diff --git a/doc/man/common-cli-files.txt b/doc/man/common-cli-files.txt index c2451a16..c9659cea 100644 --- a/doc/man/common-cli-files.txt +++ b/doc/man/common-cli-files.txt @@ -1,6 +1,6 @@ FILES ----- -`$HOME/.local/lib/babeltrace/plugins`:: +`$HOME/.local/lib/babeltrace2/plugins`:: User plugin directory. +{system_plugin_path}+:: diff --git a/doc/man/common-cmd-params-format.txt b/doc/man/common-cmd-params-format.txt index 4acce3d7..c8cefc0e 100644 --- a/doc/man/common-cmd-params-format.txt +++ b/doc/man/common-cmd-params-format.txt @@ -41,7 +41,7 @@ You may put whitespaces around the individual `=` (assignment) and `,` Example: ---- -babeltrace ... --params='many=null, fresh=yes, condition=false, +babeltrace2 ... --params='many=null, fresh=yes, condition=false, squirrel=-782329, play=+23, observe=3.14, simple=beef, needs-quotes="some string", escape.chars-are:allowed="a \" quote", diff --git a/doc/man/common-cmd-plugin-path.txt b/doc/man/common-cmd-plugin-path.txt index ae8afc3d..8527de9f 100644 --- a/doc/man/common-cmd-plugin-path.txt +++ b/doc/man/common-cmd-plugin-path.txt @@ -10,10 +10,10 @@ search path for Babeltrace plugins is, in this order: option. . *If the opt:--omit-home-plugin-path option is absent*: - `$HOME/.local/lib/babeltrace/plugins` + `$HOME/.local/lib/babeltrace2/plugins` . *If the opt:--omit-system-plugin-path option is absent*: +{system_plugin_path}+ -You can use the man:babeltrace-list-plugins(1) command to dynamically +You can use the man:babeltrace2-list-plugins(1) command to dynamically list the available plugins. diff --git a/doc/man/common-common-compat-env.txt b/doc/man/common-common-compat-env.txt index ee17f8f2..3c2f3ed9 100644 --- a/doc/man/common-common-compat-env.txt +++ b/doc/man/common-common-compat-env.txt @@ -1,11 +1,11 @@ `BABELTRACE_COMMON_LOG_LEVEL`:: Common functions's log level. The available values are the same as - for the manopt:babeltrace(1):--log-level option of man:babeltrace(1). + for the manopt:babeltrace2(1):--log-level option of man:babeltrace2(1). `BABELTRACE_COMPAT_LOG_LEVEL`:: Compatibility functions's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). `BABELTRACE_TERM_COLOR`:: Force the terminal color support. The available values are: diff --git a/doc/man/common-ctf-plugin-env.txt b/doc/man/common-ctf-plugin-env.txt index a4ecb483..4b8affd5 100644 --- a/doc/man/common-ctf-plugin-env.txt +++ b/doc/man/common-ctf-plugin-env.txt @@ -2,15 +2,15 @@ ~~~~~~~~~~~~ `BABELTRACE_PLUGIN_CTF_BTR_LOG_LEVEL`:: Binary type reader's log level. The available values are the same as - for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). `BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL`:: Metadata decoder's log level. The available values are the same as - for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). `BABELTRACE_PLUGIN_CTF_NOTIF_ITER_LOG_LEVEL`:: Notification iterator's log level. The available values are the same - as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). diff --git a/doc/man/common-gen-options.txt b/doc/man/common-gen-options.txt index 58b3b09b..413f3050 100644 --- a/doc/man/common-gen-options.txt +++ b/doc/man/common-gen-options.txt @@ -1,6 +1,6 @@ General options ~~~~~~~~~~~~~~~ -See man:babeltrace(1) for more details. +See man:babeltrace2(1) for more details. nlopt:-d, nlopt:--debug:: Turn the debugging mode on. diff --git a/doc/man/common-lib-env.txt b/doc/man/common-lib-env.txt index 179c98d3..dc7c9779 100644 --- a/doc/man/common-lib-env.txt +++ b/doc/man/common-lib-env.txt @@ -7,8 +7,8 @@ include::common-common-compat-env.txt[] `BABELTRACE_LOGGING_GLOBAL_LEVEL`:: Babeltrace library's global log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1) + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1) `BABELTRACE_NO_DLCLOSE`:: Set to `1` to make the Babeltrace library leave any dynamically diff --git a/doc/man/common-plugin-path-options.txt b/doc/man/common-plugin-path-options.txt index 446ab003..7e114fa3 100644 --- a/doc/man/common-plugin-path-options.txt +++ b/doc/man/common-plugin-path-options.txt @@ -1,7 +1,7 @@ Plugin path ~~~~~~~~~~~ opt:--omit-home-plugin-path:: - Do not search for plugins in `$HOME/.local/lib/babeltrace/plugins`. + Do not search for plugins in `$HOME/.local/lib/babeltrace2/plugins`. opt:--omit-system-plugin-path:: Do not search for plugins in +{system_plugin_path}+. diff --git a/doc/man/common-ppp-env.txt b/doc/man/common-ppp-env.txt index f2fa3539..49cc7720 100644 --- a/doc/man/common-ppp-env.txt +++ b/doc/man/common-ppp-env.txt @@ -2,5 +2,5 @@ Python plugin provider ~~~~~~~~~~~~~~~~~~~~~~ `BABELTRACE_PYTHON_PLUGIN_PROVIDER_LOG_LEVEL`:: Python plugin provider's log level. The available values are the - same as for the manopt:babeltrace(1):--log-level option of - man:babeltrace(1). + same as for the manopt:babeltrace2(1):--log-level option of + man:babeltrace2(1). -- 2.34.1