update ustctl man page

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

diff --git a/doc/man/ustctl.1 b/doc/man/ustctl.1
index e77251d4faad33b57782765c9e7e7ef3bb42131c..4f171c61ecd247c192852265ac275334d9c6f8ee 100644 (file)
--- a/doc/man/ustctl.1
+++ b/doc/man/ustctl.1
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.5
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "USTCTL" "1" "May 2010" "" ""
+.TH "USTCTL" "1" "August 2010" "" ""
 .
 .SH "NAME"
 \fBustctl\fR \-\- a program to control the tracing of userspace applications
@@ -50,6 +50,10 @@ Set the size of subbuffers in CHANNEL.
 Set the number of subbuffers per buffer for CHANNEL. Must be a power of 2.
 .
 .TP
+\fB\-\-set\-sock\-path\fR
+Set the path of the daemon socket.
+.
+.TP
 \fB\-\-get\-subbuf\-size\fR \fICHANNEL\fR
 Print the size of subbuffers per buffer for CHANNEL.
 .
@@ -58,6 +62,10 @@ Print the size of subbuffers per buffer for CHANNEL.
 Print the number of subbuffers per buffer for CHANNEL.
 .
 .TP
+\fB\-\-get\-sock\-path\fR
+Get the path of the daemon socket.
+.
+.TP
 \fB\-\-enable\-marker\fR \fICHANNEL\fR/\fIMARKER\fR
 Enable a marker.
 .
@@ -69,6 +77,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
@@ -95,12 +107,15 @@ being recorded in the buffer. The daemon automatically collects these events.
 .P
 The trace may be stopped with \fB\-\-stop\-trace\fR, either definitely after all the
 wanted information is collected, or temporarily, before being started again
-with \fB\-\-start\-trace\fR. This results in effectively "pausing" the recording.
+with \fB\-\-start\-trace\fR. This results in effectively 'pausing' the recording.
+After using \fB\-\-stop\-trace\fR, if a daemon is collecting the trace, it may not
+have flushed to the disk the full contents of the buffer yet.
 .
 .P
 Finally, when \fB\-\-destroy\-trace\fR 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 \fBustd\fR, this command
+guarantees its full contents is flushed to the disk.
 .
 .SH "STRUCTURE OF A TRACE"
 Each instrumentation point that is added in a program is associated to a