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

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

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
+++ 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)