From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 14 Nov 2015 05:16:43 +0000 (-0500)
Subject: doc/man: create lttng-status(1) and update/fix content
X-Git-Tag: v2.8.0-rc1~38
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=18d6fa61d34ddc3ce8326e84390cf028f1984fd3;p=lttng-tools.git

doc/man: create lttng-status(1) and update/fix content

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 0a10e8653..d856276f4 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -24,7 +24,8 @@ MAN1_NAMES = \
 	lttng-list \
 	lttng-calibrate \
 	lttng-track \
-	lttng-untrack
+	lttng-untrack \
+	lttng-status
 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
index 000000000..89bfca851
--- /dev/null
+++ b/doc/man/lttng-status.1.txt
@@ -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)