| 1 | .\" generated with Ronn/v0.5 |
| 2 | .\" http://github.com/rtomayko/ronn/ |
| 3 | . |
| 4 | .TH "USTTRACE" "1" "May 2010" "" "" |
| 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 |
| 57 | \fB\-l\fR |
| 58 | Runtime link with UST library. (Needed only if program was not linked at |
| 59 | compile time with libust.) |
| 60 | . |
| 61 | .TP |
| 62 | \fB\-L\fR |
| 63 | Add path to ust libraries to LD_LIBRARY_PATH. |
| 64 | . |
| 65 | .TP |
| 66 | \fB\-m\fR |
| 67 | Instrument malloc calls. |
| 68 | . |
| 69 | .TP |
| 70 | \fB\-f\fR |
| 71 | Also trace forked processes. |
| 72 | . |
| 73 | .TP |
| 74 | \fB\-s\fR |
| 75 | Use system\-wide daemon instead of creating one for this session. |
| 76 | . |
| 77 | .TP |
| 78 | \fB\-S\fR |
| 79 | Specify the subbuffer size. |
| 80 | . |
| 81 | .TP |
| 82 | \fB\-N\fR |
| 83 | Specify the number of subbuffers. |
| 84 | . |
| 85 | .TP |
| 86 | \fB\-W\fR |
| 87 | Print the location of the last trace saved in the usttrace output directory. |
| 88 | . |
| 89 | .SH "SEE ALSO" |
| 90 | ustctl(1), ustd(1) |
| 91 | . |
| 92 | .SH "AUTHOR" |
| 93 | \fBusttrace\fR was written by Pierre\-Marc Fournier. |
| 94 | . |
| 95 | .P |
| 96 | This manual page was written by Jon Bernard <jbernard@debian.org>, for |
| 97 | the Debian project (and may be used by others). |