doc/man: create lttng-status(1) and update/fix content
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Sat, 14 Nov 2015 05:16:43 +0000 (00:16 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 17 Mar 2016 22:12:24 +0000 (18:12 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/Makefile.am
doc/man/lttng-status.1.txt [new file with mode: 0644]

index 0a10e86532fc91eaa4cacd6caaef28d012b9f1f2..d856276f449b8b372fe5d051a900d764ca887b25 100644 (file)
@@ -24,7 +24,8 @@ MAN1_NAMES = \
        lttng-list \
        lttng-calibrate \
        lttng-track \
        lttng-list \
        lttng-calibrate \
        lttng-track \
-       lttng-untrack
+       lttng-untrack \
+       lttng-status
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt
new file mode 100644 (file)
index 0000000..89bfca8
--- /dev/null
@@ -0,0 +1,43 @@
+lttng-status(1)
+===============
+
+
+NAME
+----
+lttng-status - Get the current LTTng tracing session's status
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['GENERAL OPTIONS'] *status*
+
+
+DESCRIPTION
+-----------
+The `lttng status` command shows the status of the current
+tracing session.
+
+This command is the exact equivalent of:
+
+---------------------
+lttng list CURSESSION
+---------------------
+
+where `CURSESSION` is the name of the current tracing session.
+Use linklttng:lttng-set-session(1) to set the current tracing session.
+
+
+include::common-cmd-options-head.txt[]
+
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng-set-session(1),
+linklttng:lttng(1)
This page took 0.037864 seconds and 4 git commands to generate.