Add manpages for ustd, ustctl, and usttrace
[ust.git] / doc / man / ustctl.1
CommitLineData
43550d37
JB
1.\" generated with Ronn/v0.4.1
2.\" http://github.com/rtomayko/ronn/
3.
4.TH "USTCTL" "1" "March 2010" "" ""
5.
6.SH "NAME"
7\fBustctl\fR \-\- a program to control the tracing of userspace applications
8.
9.SH "SYNOPSIS"
10\fBustctl\fR [\fIcommand\fR] [\fIPIDs\fR]...
11.
12.SH "DESCRIPTION"
13\fBustclt\fR is a program to control the tracing of userspace applications. It can
14list markers, start the tracing, stop the tracing, enable/disable markers, etc.
15.
16.SH "OPTIONS"
17These programs follow the usual GNU command line syntax, with long options
18starting with two dashes(`\-'). A summary of options is included below.
19.
20.TP
21\fB\-h\fR, \fB\-\-help\fR
22Show summary of options.
23.
24.TP
25\fB\-\-create\-trace\fR
26Create trace.
27.
28.TP
29\fB\-\-alloc\-trace\fR
30Alloc trace.
31.
32.TP
33\fB\-\-start\-trace\fR
34Start tracing.
35.
36.TP
37\fB\-\-stop\-trace\fR
38Stop tracing.
39.
40.TP
41\fB\-\-destroy\-trace\fR
42Destroy the trace.
43.
44.TP
45\fB\-\-set\-subbuf\-size\fR \fICHANNEL\fR/\fIbytes\fR
46Set the size of subbuffers per channel.
47.
48.TP
49\fB\-\-set\-subbuf\-num\fR \fICHANNEL\fR
50Set the number of subbuffers per channel.
51.
52.TP
53\fB\-\-get\-subbuf\-size\fR \fICHANNEL\fR
54Get the size of subbuffers per channel.
55.
56.TP
57\fB\-\-get\-subbuf\-num\fR \fICHANNEL\fR
58Get the number of subbuffers per channel.
59.
60.TP
61\fB\-\-enable\-marker\fR \fICHANNEL\fR/\fIMARKER\fR
62Enable a marker.
63.
64.TP
65\fB\-\-disable\-marker\fR \fICHANNEL\fR/\fIMARKER\fR
66Disable a marker.
67.
68.TP
69\fB\-\-list\-markers\fR
70List the markers of the process, their state and format string.
71.
72.SH "AUTHOR"
73\fBustctl\fR was written by Pierre\-Marc Fournier.
74.
75.P
76This manual page was written by Jon Bernard <jbernard@debian.org>, for
77the Debian project (and may be used by others).
This page took 0.024818 seconds and 4 git commands to generate.