common: move copy_filter_bytecode to bytecode.c and rename it
[lttng-tools.git] / doc / man / lttng.1.txt
index 5b30b123b574ce26bcf989057ae058281f91205b..8465ceeb4a2c477c52a952507f61aedd5d764ecb 100644 (file)
@@ -1,5 +1,6 @@
 lttng(1)
 ========
+:revdate: 16 October 2019
 
 
 NAME
@@ -16,7 +17,7 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
+The https://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
 source software package used for correlated tracing of the Linux kernel,
 user applications, and user libraries.
 
@@ -55,7 +56,7 @@ interact with multiple tracers (kernel and user space) within the same
 container, a _tracing session_. Traces can be gathered from the Linux
 kernel and/or from instrumented applications (see
 man:lttng-ust(3)). You can aggregate and read the events of LTTng
-traces using man:babeltrace(1).
+traces using man:babeltrace2(1).
 
 To trace the Linux kernel, the session daemon needs to be running as
 `root`. LTTng uses a _tracing group_ to allow specific users to interact
@@ -82,10 +83,10 @@ option:--no-sessiond general option can be set to avoid this.
 
 OPTIONS
 -------
-option:-g, option:--group='GROUP'::
+option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
-option:-m, option:--mi='TYPE'::
+option:-m 'TYPE', option:--mi='TYPE'::
     Print the command's result using the machine interface type 'TYPE'
     instead of a human-readable output.
 +
@@ -148,88 +149,98 @@ The following commands also have their own nloption:--help option.
 Tracing sessions
 ~~~~~~~~~~~~~~~~
 man:lttng-create(1)::
-    Create a tracing session.
+    {cmd_descr_create}.
 
 man:lttng-destroy(1)::
-    Tear down tracing sessions.
+    {cmd_descr_destroy}.
 
 man:lttng-load(1)::
-    Load tracing session configurations.
+    {cmd_descr_load}.
 
-man:lttng-metadata(1)::
-    Manage an LTTng tracing session's metadata generation.
+man:lttng-regenerate(1)::
+    {cmd_descr_regenerate}.
 
 man:lttng-save(1)::
-    Save tracing session configurations.
+    {cmd_descr_save}.
 
 man:lttng-set-session(1)::
-    Set current tracing session.
+    {cmd_descr_set_session}.
 
 
 Channels
 ~~~~~~~~
 man:lttng-add-context(1)::
-    Add context fields to a channel.
+    {cmd_descr_add_context}.
 
 man:lttng-disable-channel(1)::
-    Disable tracing channels.
+    {cmd_descr_disable_channel}.
 
 man:lttng-enable-channel(1)::
-    Create or enable tracing channels.
+    {cmd_descr_enable_channel}.
 
 
 Event rules
 ~~~~~~~~~~~
 man:lttng-disable-event(1)::
-    Disable event rules.
+    {cmd_descr_disable_event}.
 
 man:lttng-enable-event(1)::
-    Create or enable event rules.
+    {cmd_descr_enable_event}.
 
 
 Status
 ~~~~~~
 man:lttng-list(1)::
-    List tracing sessions, domains, channels, and events.
+    {cmd_descr_list}.
 
 man:lttng-status(1)::
-    Get the status of the current tracing session.
+    {cmd_descr_status}.
 
 
 Control
 ~~~~~~~
 man:lttng-snapshot(1)::
-    Snapshot buffers of current tracing session.
+    {cmd_descr_snapshot}.
 
 man:lttng-start(1)::
-    Start tracing.
+    {cmd_descr_start}.
 
 man:lttng-stop(1)::
-    Stop tracing.
+    {cmd_descr_stop}.
+
+
+Tracing session rotation
+~~~~~~~~~~~~~~~~~~~~~~~~
+man:lttng-disable-rotation(1)::
+    {cmd_descr_disable_rotation}.
+
+man:lttng-enable-rotation(1)::
+    {cmd_descr_enable_rotation}.
+
+man:lttng-rotate(1)::
+    {cmd_descr_rotate}.
+
 
 
 Resource tracking
 ~~~~~~~~~~~~~~~~~
 man:lttng-track(1)::
-    Track specific system resources.
+    {cmd_descr_track}.
 
 man:lttng-untrack(1)::
-    Untrack specific system resources.
+    {cmd_descr_untrack}.
 
 
 Miscellaneous
 ~~~~~~~~~~~~~
-man:lttng-calibrate(1)::
-    Quantify LTTng overhead.
-
 man:lttng-help(1)::
-    Display help information about a command.
+    {cmd_descr_help}.
 
 man:lttng-version(1)::
-    Show version information.
+    {cmd_descr_version}.
 
 man:lttng-view(1)::
-    Start trace viewer.
+    {cmd_descr_view}.
 
 
 include::common-cmd-footer.txt[]
@@ -241,4 +252,4 @@ man:lttng-sessiond(8),
 man:lttng-relayd(8),
 man:lttng-crash(1),
 man:lttng-ust(3),
-man:babeltrace(1)
+man:babeltrace2(1)
This page took 0.026265 seconds and 4 git commands to generate.