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 d0ecb983d5380831ccefb5f176c4998ca9f9f68c..208e1dd88c05b6fb01ff3f0e2de65a3919570852 100644 (file)
--- a/doc/man/ustctl.1.md
+++ b/doc/man/ustctl.1.md
@@ -39,12 +39,18 @@ starting with two dashes(`-'). A summary of options is included below.
   * `--set-subbuf-num` <CHANNEL>:
     Set the number of subbuffers per buffer for CHANNEL. Must be a power of 2.
 
+  * `--set-sock-path`:
+    Set the path of the daemon socket.
+
   * `--get-subbuf-size` <CHANNEL>:
     Print the size of subbuffers per buffer for CHANNEL.
 
   * `--get-subbuf-num` <CHANNEL>:
     Print the number of subbuffers per buffer for CHANNEL.
 
+  * `--get-sock-path`:
+    Get the path of the daemon socket.
+
   * `--enable-marker` <CHANNEL>/<MARKER>:
     Enable a marker.
 
@@ -54,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
@@ -77,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