1 ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. |
1 '\" t |
2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. |
3 ." |
3 .\" |
4 ." This code is free software; you can redistribute it and/or modify it |
4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
5 ." under the terms of the GNU General Public License version 2 only, as |
5 .\" |
6 ." published by the Free Software Foundation. |
6 .\" This code is free software; you can redistribute it and/or modify it |
7 ." |
7 .\" under the terms of the GNU General Public License version 2 only, as |
8 ." This code is distributed in the hope that it will be useful, but WITHOUT |
8 .\" published by the Free Software Foundation. |
9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
9 .\" |
10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
10 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
11 ." version 2 for more details (a copy is included in the LICENSE file that |
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 ." accompanied this code). |
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 ." |
13 .\" version 2 for more details (a copy is included in the LICENSE file that |
14 ." You should have received a copy of the GNU General Public License version |
14 .\" accompanied this code). |
15 ." 2 along with this work; if not, write to the Free Software Foundation, |
15 .\" |
16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
16 .\" You should have received a copy of the GNU General Public License version |
17 ." |
17 .\" 2 along with this work; if not, write to the Free Software Foundation, |
18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
19 ." or visit www.oracle.com if you need additional information or have any |
19 .\" |
20 ." questions. |
20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
21 ." |
21 .\" or visit www.oracle.com if you need additional information or have any |
22 .TH jsadebugd 1 "10 May 2011" |
22 .\" questions. |
|
23 .\" |
|
24 .\" Arch: generic |
|
25 .\" Software: JDK 8 |
|
26 .\" Date: 21 November 2013 |
|
27 .\" SectDesc: Troubleshooting Tools |
|
28 .\" Title: jsadebugd.1 |
|
29 .\" |
|
30 .if n .pl 99999 |
|
31 .TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" |
|
32 .\" ----------------------------------------------------------------- |
|
33 .\" * Define some portability stuff |
|
34 .\" ----------------------------------------------------------------- |
|
35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
36 .\" http://bugs.debian.org/507673 |
|
37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
39 .ie \n(.g .ds Aq \(aq |
|
40 .el .ds Aq ' |
|
41 .\" ----------------------------------------------------------------- |
|
42 .\" * set default formatting |
|
43 .\" ----------------------------------------------------------------- |
|
44 .\" disable hyphenation |
|
45 .nh |
|
46 .\" disable justification (adjust text to left margin only) |
|
47 .ad l |
|
48 .\" ----------------------------------------------------------------- |
|
49 .\" * MAIN CONTENT STARTS HERE * |
|
50 .\" ----------------------------------------------------------------- |
23 |
51 |
24 .LP |
52 .SH NAME |
25 .SH "Name" |
53 jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. |
26 jsadebugd \- Serviceability Agent Debug Daemon |
54 .SH SYNOPSIS |
27 .LP |
55 .sp |
28 .SH "SYNOPSIS" |
56 .nf |
29 .LP |
|
30 .nf |
|
31 \f3 |
|
32 .fl |
|
33 \fP\f3jsadebugd\fP pid [ server\-id ] |
|
34 .fl |
|
35 \f3jsadebugd\fP executable core [ server\-id ] |
|
36 .fl |
|
37 .fi |
|
38 |
57 |
39 .LP |
58 \fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] |
40 .SH "PARAMETERS" |
59 .fi |
41 .LP |
60 .nf |
42 .RS 3 |
61 |
43 .TP 3 |
62 \fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] |
44 pid |
63 .fi |
45 process 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. |
64 .sp |
46 .TP 3 |
65 .TP |
47 executable |
66 \fIpid\fR |
48 Java executable from which the core dump was produced |
67 The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. |
49 .TP 3 |
68 .TP |
50 core |
69 \fIexecutable\fR |
51 Core file to which the debug server should attach. |
70 The Java executable from which the core dump was produced\&. |
52 .TP 3 |
71 .TP |
53 server\-id |
72 \fIcore\fR |
54 Optional 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. |
73 The core file to which the debug server should attach\&. |
|
74 .TP |
|
75 \fIserver-id\fR |
|
76 An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. |
|
77 .SH DESCRIPTION |
|
78 The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: |
|
79 .sp |
|
80 .nf |
|
81 \f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP |
|
82 .fi |
|
83 .nf |
|
84 \f3\fP |
|
85 .fi |
|
86 .sp |
|
87 If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. |
|
88 .PP |
|
89 \fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. |
|
90 .SH SEE\ ALSO |
|
91 .TP 0.2i |
|
92 \(bu |
|
93 jinfo(1) |
|
94 .TP 0.2i |
|
95 \(bu |
|
96 jmap(1) |
|
97 .TP 0.2i |
|
98 \(bu |
|
99 jps(1) |
|
100 .TP 0.2i |
|
101 \(bu |
|
102 jstack(1) |
|
103 .TP 0.2i |
|
104 \(bu |
|
105 rmiregistry(1) |
55 .RE |
106 .RE |
56 |
107 .br |
57 .LP |
108 'pl 8.5i |
58 .SH "DESCRIPTION" |
109 'bp |
59 .LP |
|
60 .LP |
|
61 \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, |
|
62 .na |
|
63 \f2rmiregistry\fP @ |
|
64 .fi |
|
65 http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi must be started with: |
|
66 .LP |
|
67 .nf |
|
68 \f3 |
|
69 .fl |
|
70 \fP\f4rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi.jar\fP\f3 |
|
71 .fl |
|
72 \fP |
|
73 .fi |
|
74 |
|
75 .LP |
|
76 .LP |
|
77 where \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. |
|
78 .LP |
|
79 .LP |
|
80 \f3NOTE\fP \- 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, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. |
|
81 .LP |
|
82 .LP |
|
83 For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP |
|
84 .LP |
|
85 .SH "SEE ALSO" |
|
86 .LP |
|
87 .RS 3 |
|
88 .TP 2 |
|
89 o |
|
90 jinfo(1) |
|
91 .TP 2 |
|
92 o |
|
93 jmap(1) |
|
94 .TP 2 |
|
95 o |
|
96 jps(1) |
|
97 .TP 2 |
|
98 o |
|
99 jstack(1) |
|
100 .TP 2 |
|
101 o |
|
102 .na |
|
103 \f2rmiregistry\fP @ |
|
104 .fi |
|
105 http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi |
|
106 .RE |
|
107 |
|
108 .LP |
|
109 |
|