| rgallard | b643545 | 2013-11-25 20:19:02 -0800 | [diff] [blame] | 1 | '\" t |
| 2 | .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. |
| 3 | .\"
|
| 4 | .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
| 5 | .\"
|
| 6 | .\" This code is free software; you can redistribute it and/or modify it
|
| 7 | .\" under the terms of the GNU General Public License version 2 only, as
|
| 8 | .\" published by the Free Software Foundation.
|
| 9 | .\"
|
| 10 | .\" This code is distributed in the hope that it will be useful, but WITHOUT
|
| 11 | .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
| 12 | .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
| 13 | .\" version 2 for more details (a copy is included in the LICENSE file that
|
| 14 | .\" accompanied this code).
|
| 15 | .\"
|
| 16 | .\" You should have received a copy of the GNU General Public License version
|
| 17 | .\" 2 along with this work; if not, write to the Free Software Foundation,
|
| 18 | .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
| 19 | .\"
|
| 20 | .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
| 21 | .\" or visit www.oracle.com if you need additional information or have any
|
| 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 | .\" -----------------------------------------------------------------
|
| duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 51 | |
| rgallard | b643545 | 2013-11-25 20:19:02 -0800 | [diff] [blame] | 52 | .SH NAME |
| 53 | jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. |
| 54 | .SH SYNOPSIS |
| 55 | .sp |
| 56 | .nf |
| duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 57 | |
| rgallard | b643545 | 2013-11-25 20:19:02 -0800 | [diff] [blame] | 58 | \fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] |
| 59 | .fi |
| 60 | .nf |
| tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 61 | |
| rgallard | b643545 | 2013-11-25 20:19:02 -0800 | [diff] [blame] | 62 | \fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] |
| 63 | .fi |
| 64 | .sp |
| 65 | .TP |
| 66 | \fIpid\fR |
| 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\&. |
| 68 | .TP |
| 69 | \fIexecutable\fR |
| 70 | The Java executable from which the core dump was produced\&. |
| 71 | .TP |
| 72 | \fIcore\fR |
| 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) |
| 106 | .RE
|
| 107 | .br
|
| 108 | 'pl 8.5i
|
| 109 | 'bp
|