lttng: Add remove-trigger command

[lttng-tools.git] / doc / man / lttng-metadata.1.txt

diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt
index a146c93243d6c32b51b3472f222ea6ac8ba66e46..5d9864be7c9842a98e47c01279c5021eaddb0fc0 100644 (file)
--- a/doc/man/lttng-metadata.1.txt
+++ b/doc/man/lttng-metadata.1.txt
@@ -1,5 +1,6 @@
 lttng-metadata(1)
 =================
 lttng-metadata(1)
 =================

+:revdate: 28 November 2016

 
 
 NAME
 
 
 NAME


@@ -10,32 +11,19 @@ lttng-metadata - Manage an LTTng tracing session's metadata generation
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-*lttng* ['GENERAL OPTIONS'] *metadata regenerate* [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *metadata regenerate* [option:--session='SESSION']

 
 
 DESCRIPTION
 -----------
 
 
 DESCRIPTION
 -----------

-The `lttng metadata` command manages a tracing session's metadata
-generation options.
-
-As of this version, only the `regenerate` command's action is available.
-Regenerating a tracing session's metadata can be used to
-resample the offset between the system's monotonic clock and
-the wall-clock time.
-
-This command is meant to be used to resample the wall-clock time
-following a major
-link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP]
-correction. As such, a system booting with an incorrect wall time can be
-traced before its wall time is NTP-corrected. Regenerating the tracing
-session's metadata ensures that trace viewers can accurately determine
-the events time relative to Unix Epoch.
+WARNING: This command is **deprecated**; it has been replaced by
+`lttng regenerate metadata` (see man:lttng-regenerate(1)).

 
 
 include::common-cmd-options-head.txt[]
 
 
 
 
 include::common-cmd-options-head.txt[]
 
 

-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::

     Manage the metadata generation of the tracing session named 'SESSION'
     instead of the current tracing session.
 
     Manage the metadata generation of the tracing session named 'SESSION'
     instead of the current tracing session.
 


@@ -49,8 +37,8 @@ The `lttng metadata regenerate` command can only be used on kernel and
 user space tracing sessions (using per-user buffering), in non-live
 mode.
 
 user space tracing sessions (using per-user buffering), in non-live
 mode.
 

-See linklttng:lttng-enable-channel(1) for more information about
-buffering schemes and linklttng:lttng-create(1) for more information
+See man:lttng-enable-channel(1) for more information about
+buffering schemes and man:lttng-create(1) for more information

 about the different tracing session modes.
 
 
 about the different tracing session modes.
 
 


@@ -59,4 +47,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------

-linklttng:lttng(1)
+man:lttng(1)