From: Alexis Hallé <alexis.halle@polymtl.ca>
Date: Wed, 14 Jul 2010 18:52:01 +0000 (-0400)
Subject: ustctl manpage: document force-switch
X-Git-Tag: v0.6~4
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=6b42a59a97281f18247d985d2ef8e2114ccdffbb;p=ust.git

ustctl manpage: document force-switch
---

diff --git a/doc/man/ustctl.1 b/doc/man/ustctl.1
index 8b4d32c..5dfccba 100644
--- a/doc/man/ustctl.1
+++ b/doc/man/ustctl.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.6.6
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "USTCTL" "1" "June 2010" "" ""
+.TH "USTCTL" "1" "July 2010" "" ""
 .
 .SH "NAME"
 \fBustctl\fR \- a program to control the tracing of userspace applications
@@ -75,6 +75,10 @@ Disable a marker\.
 \fB\-\-list\-markers\fR
 List the markers of the process, their state and format string\.
 .
+.TP
+\fB\-\-force\-switch\fR
+Force a subbuffer switch\. This will flush all the data currently held\.
+.
 .SH "LIFE CYCLE OF A TRACE"
 Typically, the first step is to enable markers with \fB\-\-enable\-marker\fR\. An enabled marker generates an event when the control flow passes over it (assuming the trace is recording)\. A disabled marker produces nothing\. Enabling and disabling markers may however be done at any point, including while the trace is being recorded\.
 .
diff --git a/doc/man/ustctl.1.md b/doc/man/ustctl.1.md
index eefd89f..f215b7d 100644
--- a/doc/man/ustctl.1.md
+++ b/doc/man/ustctl.1.md
@@ -60,6 +60,9 @@ starting with two dashes(`-'). A summary of options is included below.
   * `--list-markers`:
     List the markers of the process, their state and format string.
 
+  * `--force-switch`:
+    Force a subbuffer switch. This will flush all the data currently held.
+
 ## LIFE CYCLE OF A TRACE
 
 Typically, the first step is to enable markers with `--enable-marker`. An