annotate src/linux/doc/man/jstack.1 @ 1178:b056c42ea5b4

6837214: Update JDK7 man pages Reviewed-by: darcy, bpatel, tbell Contributed-by: jacob.royal@sun.com
author tbell
date Mon, 04 May 2009 18:28:26 -0700
parents 37a05a11f281
children 00cd9dc3c2b5
rev   line source
tbell@1178 1 ." Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
duke@0 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@0 3 ."
duke@0 4 ." This code is free software; you can redistribute it and/or modify it
duke@0 5 ." under the terms of the GNU General Public License version 2 only, as
duke@0 6 ." published by the Free Software Foundation.
duke@0 7 ."
duke@0 8 ." This code is distributed in the hope that it will be useful, but WITHOUT
duke@0 9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@0 10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@0 11 ." version 2 for more details (a copy is included in the LICENSE file that
duke@0 12 ." accompanied this code).
duke@0 13 ."
duke@0 14 ." You should have received a copy of the GNU General Public License version
duke@0 15 ." 2 along with this work; if not, write to the Free Software Foundation,
duke@0 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@0 17 ."
duke@0 18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@0 19 ." CA 95054 USA or visit www.sun.com if you need additional information or
duke@0 20 ." have any questions.
duke@0 21 ."
tbell@1178 22 .TH jstack 1 "04 May 2009"
tbell@1178 23 ." Generated from HTML by html2man (author: Eric Armstrong)
duke@0 24
duke@0 25 .LP
tbell@1178 26 .SH "Name"
duke@0 27 jstack \- Stack Trace
duke@0 28 .br
duke@0 29
duke@0 30 .LP
duke@0 31 .SH "SYNOPSIS"
duke@0 32 .LP
duke@0 33
duke@0 34 .LP
duke@0 35 .nf
duke@0 36 \f3
duke@0 37 .fl
duke@0 38 \fP\f3jstack\fP [ option ] pid
duke@0 39 .fl
duke@0 40 \f3jstack\fP [ option ] executable core
duke@0 41 .fl
duke@0 42 \f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
duke@0 43 .fl
duke@0 44 .fi
duke@0 45
duke@0 46 .LP
duke@0 47 .SH "PARAMETERS"
duke@0 48 .LP
duke@0 49
duke@0 50 .LP
duke@0 51 .LP
duke@0 52 Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS.
duke@0 53 .LP
duke@0 54 .RS 3
duke@0 55 .TP 3
duke@0 56 pid
tbell@1178 57 process id for which the stack trace is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used.
duke@0 58 .RE
duke@0 59
duke@0 60 .LP
duke@0 61 .RS 3
duke@0 62 .TP 3
duke@0 63 executable
duke@0 64 Java executable from which the core dump was produced.
duke@0 65 .br
duke@0 66 .TP 3
duke@0 67 core
duke@0 68 core file for which the stack trace is to be printed.
duke@0 69 .br
duke@0 70 .TP 3
duke@0 71 remote\-hostname\-or\-IP
tbell@1178 72 remote debug server's (see jsadebugd(1)) hostname or IP address.
duke@0 73 .br
duke@0 74 .TP 3
duke@0 75 server\-id
duke@0 76 optional unique id, if multiple debug servers are running on the same remote host.
duke@0 77 .RE
duke@0 78
duke@0 79 .LP
duke@0 80 .SH "DESCRIPTION"
duke@0 81 .LP
duke@0 82
duke@0 83 .LP
duke@0 84 .LP
duke@0 85 \f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
duke@0 86 .br
duke@0 87
duke@0 88 .LP
duke@0 89 .RS 3
duke@0 90
duke@0 91 .LP
duke@0 92 .nf
duke@0 93 \f3
duke@0 94 .fl
duke@0 95 jstack \-J\-d64 \-m pid
duke@0 96 .fl
duke@0 97 \fP
duke@0 98 .fi
duke@0 99 .RE
duke@0 100
duke@0 101 .LP
duke@0 102 .LP
tbell@1178 103 \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.
duke@0 104 .LP
tbell@1178 105 .LP
tbell@1178 106 For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
duke@0 107 .LP
duke@0 108 .SH "OPTIONS"
duke@0 109 .LP
duke@0 110
duke@0 111 .LP
duke@0 112 .RS 3
duke@0 113 .TP 3
duke@0 114 \-F
tbell@1178 115 Force a stack dump when 'jstack [\-l] pid' does not respond.
tbell@1178 116 .TP 3
tbell@1178 117 \-l
tbell@1178 118 Long listing. Prints additional information about locks such as list of owned java.util.concurrent
tbell@1178 119 .na
tbell@1178 120 \f2ownable synchronizers\fP @
tbell@1178 121 .fi
tbell@1178 122 http://java.sun.com/javase/6/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html.
duke@0 123 .TP 3
duke@0 124 \-m
duke@0 125 prints mixed mode (both Java and native C/C++ frames) stack trace.
duke@0 126 .TP 3
duke@0 127 \-h
duke@0 128 prints a help message.
duke@0 129 .br
duke@0 130 .br
duke@0 131 .TP 3
duke@0 132 \-help
duke@0 133 prints a help message
duke@0 134 .br
duke@0 135 .RE
duke@0 136
duke@0 137 .LP
duke@0 138 .SH "SEE ALSO"
duke@0 139 .LP
duke@0 140 .RS 3
duke@0 141 .TP 2
duke@0 142 o
duke@0 143 pstack(1)
duke@0 144 .TP 2
duke@0 145 o
duke@0 146 c++filt(1)
duke@0 147 .TP 2
duke@0 148 o
tbell@1178 149 jps(1)
duke@0 150 .TP 2
duke@0 151 o
tbell@1178 152 jsadebugd(1)
duke@0 153 .RE
duke@0 154
duke@0 155 .LP
duke@0 156 .SH "KNOWN BUGS"
duke@0 157 .LP
duke@0 158
duke@0 159 .LP
duke@0 160 .LP
duke@0 161 Mixed mode stack trace, the \-m option, does not work with the remote debug server.
duke@0 162 .LP
duke@0 163
duke@0 164 .LP
duke@0 165