projects / ust.git / blame
| Commit | Line | Data |
|---|---|---|
| 235ae2d7 | 1 | .\" generated with Ronn/v0.5 |
| 43550d37 JB |
2 | .\" http://github.com/rtomayko/ronn/ |
| 3 | . | |
| 235ae2d7 | 4 | .TH "USTTRACE" "1" "May 2010" "" "" |
| 43550d37 JB |
5 | . |
| 6 | .SH "NAME" | |
| 7 | \fBusttrace\fR \-\- the simplest way to record a trace | |
| 8 | . | |
| 9 | .SH "SYNOPSIS" | |
| 10 | \fBusttrace\fR [\fIoptions\fR] [\fIcommand\fR] | |
| 11 | . | |
| 12 | .SH "DESCRIPTION" | |
| 13 | The \fBusttrace\fR script automatically: | |
| 14 | . | |
| 15 | .IP "\(bu" 4 | |
| 16 | creates a daemon | |
| 17 | . | |
| 18 | .IP "\(bu" 4 | |
| 19 | enables all markers | |
| 20 | . | |
| 21 | .IP "\(bu" 4 | |
| 22 | runs the command specified on the command line | |
| 23 | . | |
| 24 | .IP "\(bu" 4 | |
| 25 | after the command ends, prints the location where the trace was saved | |
| 26 | . | |
| 27 | .IP "" 0 | |
| 28 | . | |
| 29 | .P | |
| 30 | Each subdirectory of the save location contains the trace of one process that | |
| 31 | was generated by the command. The name of a subdirectory consists in the PID of | |
| 32 | the process, followed by the timestamp of its creation. | |
| 33 | . | |
| 34 | .P | |
| 35 | The save location also contains logs of the tracing. | |
| 36 | . | |
| 37 | .P | |
| 38 | When using usttrace, the early tracing is always active, which means that the | |
| 39 | tracing is guaranteed to be started by the time the process enters its main() | |
| 40 | function. | |
| 41 | . | |
| 42 | .P | |
| 43 | Several usttrace's may be run simultaneously without risk of conflict. This | |
| 44 | facilitates the use of the tracer by independent users on a system. Each | |
| 45 | instance of usttrace starts its own daemon which collects the events of the | |
| 46 | processes it creates. | |
| 47 | . | |
| 48 | .SH "OPTIONS" | |
| 49 | These programs follow the usual GNU command line syntax, with long options | |
| 50 | starting with two dashes(`\-'). A summary of options is included below. | |
| 51 | . | |
| 52 | .TP | |
| 53 | \fB\-h\fR | |
| 54 | Show summary of options. | |
| 55 | . | |
| 56 | .TP | |
| a5502d1c DG |
57 | \fB\-o\fR |
| 58 | Set the trace output directory | |
| 59 | . | |
| 60 | .TP | |
| 43550d37 JB |
61 | \fB\-l\fR |
| 62 | Runtime link with UST library. (Needed only if program was not linked at | |
| 63 | compile time with libust.) | |
| 64 | . | |
| 65 | .TP | |
| 66 | \fB\-L\fR | |
| 67 | Add path to ust libraries to LD_LIBRARY_PATH. | |
| 68 | . | |
| 69 | .TP | |
| 70 | \fB\-m\fR | |
| 71 | Instrument malloc calls. | |
| 72 | . | |
| 73 | .TP | |
| 74 | \fB\-f\fR | |
| 75 | Also trace forked processes. | |
| 76 | . | |
| 77 | .TP | |
| 78 | \fB\-s\fR | |
| 79 | Use system\-wide daemon instead of creating one for this session. | |
| 80 | . | |
| 81 | .TP | |
| 235ae2d7 AH |
82 | \fB\-S\fR |
| 83 | Specify the subbuffer size. | |
| 84 | . | |
| 85 | .TP | |
| 86 | \fB\-N\fR | |
| 87 | Specify the number of subbuffers. | |
| 88 | . | |
| 89 | .TP | |
| 43550d37 | 90 | \fB\-W\fR |
| 21859693 | 91 | Print the location of the last trace saved in the usttrace output directory. |
| 43550d37 | 92 | . |
| c3947c25 | 93 | .SH "SEE ALSO" |
| 9dc7b7ff | 94 | ustctl(1), ust-consumerd(1) |
| c3947c25 | 95 | . |
| 43550d37 JB |
96 | .SH "AUTHOR" |
| 97 | \fBusttrace\fR was written by Pierre\-Marc Fournier. | |
| 98 | . | |
| 99 | .P | |
| 100 | This manual page was written by Jon Bernard <jbernard@debian.org>, for | |
| 101 | the Debian project (and may be used by others). |