update ustctl man page

[ust.git] / doc / man / ustctl.1.md

diff --git a/doc/man/ustctl.1.md b/doc/man/ustctl.1.md
index eefd89f114873a5c99d6e03ad341490948c2ca0b..208e1dd88c05b6fb01ff3f0e2de65a3919570852 100644 (file)
--- 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
@@ -83,11 +86,14 @@ being recorded in the buffer. The daemon automatically collects these events.
 
 The trace may be stopped with `--stop-trace`, either definitely after all the
 wanted information is collected, or temporarily, before being started again
-with `--start-trace`. This results in effectively "pausing" the recording.
+with `--start-trace`. This results in effectively 'pausing' the recording.
+After using `--stop-trace`, if a daemon is collecting the trace, it may not
+have flushed to the disk the full contents of the buffer yet.
 
 Finally, when `--destroy-trace` is used, the trace buffers are unallocated.
 However, the memory may not be effectively freed until the daemon finishes to
-collect them.
+collect them. When the trace is being collected by `ustd`, this command
+guarantees its full contents is flushed to the disk.
 
 ## STRUCTURE OF A TRACE