dyld-832.7.1.tar.gz
[apple/dyld.git] / doc / man / man1 / dyld_usage.1
1 .\" Man page generated from reStructuredText.
2 .
3 .TH "DYLD_USAGE" "1" "2020-04-13" "" "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] [\-j] [\-h] [\-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 .INDENT 7.0
60 .TP
61 .B \-j
62 .UNINDENT
63 .sp
64 Display output in JSON format.
65 .UNINDENT
66 .INDENT 0.0
67 .TP
68 .B \-h
69 Display usage information and exit.
70 .UNINDENT
71 .INDENT 0.0
72 .TP
73 .B \-R
74 Specify a raw trace file to process.
75 .UNINDENT
76 .INDENT 0.0
77 .TP
78 .B \-t
79 Specify timeout in seconds (for use in automated tools).
80 .UNINDENT
81 .SH DISPLAY
82 .sp
83 The data columns displayed are as follows:
84 .INDENT 0.0
85 .INDENT 3.5
86 .INDENT 0.0
87 .TP
88 .B TIMESTAMP
89 Time of day when call occurred.
90 .TP
91 .B OPERATION
92 The \fIdyld\fP operation triggered by the process. Typically these operations
93 are triggered by process launch or via a \fBdlopen\fP or \fBdlsym\fP system
94 call. System call entries include both the parameters to the system call and
95 the system call\(aqs return code (e.g., 0 on success).
96 .TP
97 .B TIME INTERVAL
98 The elapsed time spent in the dynamic linker operation or system call.
99 .TP
100 .B PROCESS NAME
101 The process that generated the dynamic linker activity. If space allows, the
102 thread id will be appended to the process name (i.e., Mail.nnn).
103 .UNINDENT
104 .UNINDENT
105 .UNINDENT
106 .SH SAMPLE USAGE
107 .INDENT 0.0
108 .INDENT 3.5
109 \fBsudo dyld_usage Mail\fP
110 .sp
111 \fBdyld_usage\fP will display dynamic link operations for all instances of
112 processes named Mail.
113 .UNINDENT
114 .UNINDENT
115 .SH SEE ALSO
116 .sp
117 \fBdyld(1)\fP, \fBfs_usage(1)\fP
118 .SH AUTHOR
119 Apple, Inc.
120 .SH COPYRIGHT
121 2000-2020, Apple, Inc.
122 .\" Generated by docutils manpage writer.
123 .