blob: 6f99725ca20577627241cac562509616b588fe92 [file] [log] [blame]
tbell16c34dd2009-05-04 18:28:26 -07001." Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
duke6e45e102007-12-01 00:00:00 +00002." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3."
4." This code is free software; you can redistribute it and/or modify it
5." under the terms of the GNU General Public License version 2 only, as
6." published by the Free Software Foundation.
7."
8." This code is distributed in the hope that it will be useful, but WITHOUT
9." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11." version 2 for more details (a copy is included in the LICENSE file that
12." accompanied this code).
13."
14." You should have received a copy of the GNU General Public License version
15." 2 along with this work; if not, write to the Free Software Foundation,
16." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17."
18." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
19." CA 95054 USA or visit www.sun.com if you need additional information or
20." have any questions.
21."
tbell16c34dd2009-05-04 18:28:26 -070022.TH jsadebugd 1 "04 May 2009"
23." Generated from HTML by html2man (author: Eric Armstrong)
duke6e45e102007-12-01 00:00:00 +000024
25.LP
tbell16c34dd2009-05-04 18:28:26 -070026.SH "Name"
duke6e45e102007-12-01 00:00:00 +000027jsadebugd \- Serviceability Agent Debug Daemon
28.LP
29.SH "SYNOPSIS"
30.LP
31
32.LP
33.nf
34\f3
35.fl
36\fP\f3jsadebugd\fP pid [ server\-id ]
37.fl
38\f3jsadebugd\fP executable core [ server\-id ]
39.fl
40.fi
41
42.LP
43.SH "PARAMETERS"
44.LP
45
46.LP
tbell16c34dd2009-05-04 18:28:26 -070047.RS 3
duke6e45e102007-12-01 00:00:00 +000048.TP 3
49pid
tbell16c34dd2009-05-04 18:28:26 -070050process id of the process to which the debug server should attach. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. At most one instance of the debug server may be attached to a single process.
51.RE
52
duke6e45e102007-12-01 00:00:00 +000053.LP
tbell16c34dd2009-05-04 18:28:26 -070054.RS 3
duke6e45e102007-12-01 00:00:00 +000055.TP 3
56executable
tbell16c34dd2009-05-04 18:28:26 -070057.RE
58
duke6e45e102007-12-01 00:00:00 +000059.LP
tbell16c34dd2009-05-04 18:28:26 -070060.RS 3
duke6e45e102007-12-01 00:00:00 +000061.TP 3
62Java executable from which the core dump was produced
tbell16c34dd2009-05-04 18:28:26 -070063.RE
64
duke6e45e102007-12-01 00:00:00 +000065.LP
tbell16c34dd2009-05-04 18:28:26 -070066.RS 3
duke6e45e102007-12-01 00:00:00 +000067.TP 3
68core
69Core file to which the debug server should attach.
tbell16c34dd2009-05-04 18:28:26 -070070.RE
71
duke6e45e102007-12-01 00:00:00 +000072.LP
tbell16c34dd2009-05-04 18:28:26 -070073.RS 3
duke6e45e102007-12-01 00:00:00 +000074.TP 3
75server\-id
76Optional unique id, needed if multiple debug servers are started on the same machine. This ID must be used by remote clients to identify the particular debug server to attach. Within a single machine, this ID must be unique.
tbell16c34dd2009-05-04 18:28:26 -070077.RE
78
duke6e45e102007-12-01 00:00:00 +000079.LP
80.SH "DESCRIPTION"
81.LP
82
83.LP
84.LP
tbell16c34dd2009-05-04 18:28:26 -070085\f3jsadebugd\fP attaches to a Java process or core file and acts as a debug server. Remote clients such as jstack(1), jmap(1), and jinfo(1) can attach to the server using Java Remote Method Invocation (RMI). Before starting \f2jsadebugd\fP,
86.na
87\f2rmiregistry\fP @
88.fi
89http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi must be started with:
duke6e45e102007-12-01 00:00:00 +000090.LP
91.RS 3
92
93.LP
94.nf
95\f3
96.fl
97\fP\f4rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi.jar\fP\f3
98.fl
99\fP
100.fi
101.RE
102
103.LP
104.LP
105where \f2$JAVA_HOME\fP is the JDK installation directory. If rmiregistry was not started, jsadebugd will start an rmiregistry in a standard (1099) port internally. Debug server may be stopped by sending SIGINT (pressing Ctrl\-C) to it.
106.LP
107.LP
tbell16c34dd2009-05-04 18:28:26 -0700108\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
109.LP
110.LP
111\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
duke6e45e102007-12-01 00:00:00 +0000112.LP
113.SH "SEE ALSO"
114.LP
115.RS 3
116.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700117o
118jinfo(1)
duke6e45e102007-12-01 00:00:00 +0000119.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700120o
121jmap(1)
duke6e45e102007-12-01 00:00:00 +0000122.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700123o
124jps(1)
duke6e45e102007-12-01 00:00:00 +0000125.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700126o
127jstack(1)
duke6e45e102007-12-01 00:00:00 +0000128.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700129o
130.na
131\f2rmiregistry\fP @
132.fi
133http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi
duke6e45e102007-12-01 00:00:00 +0000134.RE
135
136.LP
137
138.LP
139