aboutsummaryrefslogtreecommitdiff
path: root/Documentation/trace-cmd/trace-cmd-list.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/trace-cmd/trace-cmd-list.1.txt')
-rw-r--r--Documentation/trace-cmd/trace-cmd-list.1.txt95
1 files changed, 95 insertions, 0 deletions
diff --git a/Documentation/trace-cmd/trace-cmd-list.1.txt b/Documentation/trace-cmd/trace-cmd-list.1.txt
new file mode 100644
index 00000000..b77e3460
--- /dev/null
+++ b/Documentation/trace-cmd/trace-cmd-list.1.txt
@@ -0,0 +1,95 @@
+TRACE-CMD-LIST(1)
+=================
+
+NAME
+----
+trace-cmd-list - list available plugins, events or options for Ftrace.
+
+SYNOPSIS
+--------
+*trace-cmd list* ['OPTIONS']
+
+DESCRIPTION
+-----------
+The trace-cmd(1) list displays the available plugins, events or Ftrace options
+that are configured on the current machine. If no option is given, then it
+lists all plugins, event systems, events and Ftrace options to standard output.
+
+OPTIONS
+-------
+*-e* ['regex']::
+ This option will list the available events that are enabled on the
+ local system.
+
+ It takes an optional argument that uses 'regcomp(3)' expressions to seach.
+
+ trace-cmd list -e '^sys.*'
+
+*-F*::
+ Used with *-e* 'regex' to show the fields of the event.
+
+*--full*::
+ Used with *-F* which will show the "print fmt" of the event along with the fields.
+
+*-l*::
+ Used with *-e* 'regex' to show those events filters.
+
+*-R*::
+ Used with *-e* 'regex' to show those events triggers.
+
+*-s*::
+ This option will list the available event systems.
+
+*-t*::
+ This option will list the available tracers that are enabled on the
+ local system.
+
+*-p*::
+ Same as *-t* and only for legacy purposes.
+
+*-o*::
+ This option will list the available Ftrace options that are configured on
+ the local system.
+
+*-f* ['regex']::
+ This option will list the available filter functions. These are the list of
+ functions on the system that you can trace, or filter on.
+ It takes an optional argument that uses 'regcomp(3)' expressions to seach.
+
+ trace-cmd list -f '^sched.*'
+
+*-P*::
+ List the plugin files that get loaded on trace-cmd report.
+
+*-O*::
+ List plugin options that can be used by trace-cmd report *-O* option.
+
+*-B*::
+ List defined buffer instances (sub buffers).
+
+*-C*::
+ List defined clocks that can be used with trace-cmd record -C.
+ The one in brackets ([]) is the active clock.
+
+*-c*::
+ List the available trace file compression algorithms.
+
+SEE ALSO
+--------
+trace-cmd(1), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1),
+trace-cmd-stop(1), trace-cmd-extract(1), trace-cmd-reset(1),
+trace-cmd-split(1), trace-cmd-listen(1)
+
+AUTHOR
+------
+Written by Steven Rostedt, <rostedt@goodmis.org>
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
+
+COPYING
+-------
+Copyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).
+