dyld-732.8.tar.gz
[apple/dyld.git] / doc / man / man1 / dyld_usage.1
1 .\" Man page generated from reStructuredText.
2 .
3 .TH "DYLD_USAGE" "1" "2018-07-28" "" "dyld"
4 .SH NAME
5 dyld_usage \- report dynamic linker activity in real-time
6 .
7 .nr rst2man-indent-level 0
8 .
9 .de1 rstReportMargin
10 \\$1 \\n[an-margin]
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13 -
14 \\n[rst2man-indent0]
15 \\n[rst2man-indent1]
16 \\n[rst2man-indent2]
17 ..
18 .de1 INDENT
19 .\" .rstReportMargin pre:
20 . RS \\$1
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
24 ..
25 .de UNINDENT
26 . RE
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32 ..
33 .SH SYNOPSIS
34 .sp
35 \fBdyld_usage\fP \fB[\-e] [\-f mode] [\-t seconds] [\-R rawfile [\-S start_time]
36 [\-E end_time]] [pid | cmd [pid | cmd] ...]\fP
37 .SH DESCRIPTION
38 .sp
39 The \fBdyld_usage\fP utility presents an ongoing display of information
40 pertaining to dynamic linker activity within one or more processes. It requires
41 root privileges due to the kernel tracing facility it uses to operate. By
42 default \fBdyld_usage\fP monitors \fIdyld\fP activity in all processes except
43 the running \fIdyld_usage\fP process, \fITerminal\fP, \fItelnetd\fP, \fIsshd\fP, \fIrlogind\fP,
44 \fItcsh\fP, \fIcsh\fP, and \fIsh\fP\&. These defaults can be overridden such that output is
45 limited to include or exclude a list of processes specified on the command line.
46 Processes may be specified either by file name or by process id.
47 .sp
48 The output of \fBdyld_usage\fP is formatted according to the size of your
49 window. A narrow window will display fewer columns of data. Use a wide window
50 for maximum data display.
51 .SH OPTIONS
52 .sp
53 \fBdyld_usage\fP supports the following options:
54 .INDENT 0.0
55 .TP
56 .B \-e
57 Exclude the specified list of pids and commands from the sample, and exclude
58 \fBdyld_usage\fP by default.
59 .UNINDENT
60 .INDENT 0.0
61 .TP
62 .B \-R
63 specifies a raw trace file to process.
64 .UNINDENT
65 .INDENT 0.0
66 .TP
67 .B \-t
68 specifies timeout in seconds (for use in automated tools).
69 .UNINDENT
70 .SH DISPLAY
71 .sp
72 The data columns displayed are as follows:
73 .INDENT 0.0
74 .INDENT 3.5
75 .INDENT 0.0
76 .TP
77 .B TIMESTAMP
78 Time of day when call occurred.
79 .TP
80 .B OPERATION
81 The \fIdyld\fP operation triggered by the process. Typically these operations
82 are triggered by process launch or via a \fBdlopen\fP or \fBdlsym\fP system
83 call. System call entries include both the parameters to the system call and
84 the system call\(aqs return code (e.g., 0 on success).
85 .TP
86 .B TIME INTERVAL
87 The elapsed time spent in the dynamic linker operation or system call.
88 .TP
89 .B PROCESS NAME
90 The process that generated the dynamic linker activity. If space allows, the
91 thread id will be appended to the process name (i.e., Mail.nnn).
92 .UNINDENT
93 .UNINDENT
94 .UNINDENT
95 .SH SAMPLE USAGE
96 .INDENT 0.0
97 .INDENT 3.5
98 \fBsudo dyld_usage Mail\fP
99 .sp
100 \fBdyld_usage\fP will display dynamic link operations for all instances of
101 processes named Mail.
102 .UNINDENT
103 .UNINDENT
104 .SH SEE ALSO
105 .sp
106 \fBdyld(1)\fP, \fBfs_usage(1)\fP
107 .SH AUTHOR
108 Apple, Inc.
109 .SH COPYRIGHT
110 2000-2018, Apple, Inc.
111 .\" Generated by docutils manpage writer.
112 .