.\" 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
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.
.
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.
.
\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
.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