annotate src/linux/doc/man/jstack.1 @ 4176:42c22d5a2cd0

7043684: Update man pages for JDK 7 tools Reviewed-by: skannan
author bpatel
date Wed, 11 May 2011 08:30:46 -0700
parents d58354a69011
children 8ce5bf8bfc5b
rev   line source
bpatel@4176 1 ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. 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 ."
ohair@2362 18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@2362 19 ." or visit www.oracle.com if you need additional information or have any
ohair@2362 20 ." questions.
duke@0 21 ."
bpatel@4176 22 .TH jstack 1 "10 May 2011"
duke@0 23
duke@0 24 .LP
tbell@1178 25 .SH "Name"
duke@0 26 jstack \- Stack Trace
duke@0 27 .br
duke@0 28
duke@0 29 .LP
duke@0 30 .SH "SYNOPSIS"
duke@0 31 .LP
duke@0 32 .nf
duke@0 33 \f3
duke@0 34 .fl
duke@0 35 \fP\f3jstack\fP [ option ] pid
duke@0 36 .fl
duke@0 37 \f3jstack\fP [ option ] executable core
duke@0 38 .fl
duke@0 39 \f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
duke@0 40 .fl
duke@0 41 .fi
duke@0 42
duke@0 43 .LP
duke@0 44 .SH "PARAMETERS"
duke@0 45 .LP
duke@0 46 .LP
duke@0 47 Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS.
duke@0 48 .LP
duke@0 49 .RS 3
duke@0 50 .TP 3
duke@0 51 pid
tbell@1178 52 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 53 .RE
duke@0 54
duke@0 55 .LP
duke@0 56 .RS 3
duke@0 57 .TP 3
duke@0 58 executable
duke@0 59 Java executable from which the core dump was produced.
duke@0 60 .br
duke@0 61 .TP 3
duke@0 62 core
duke@0 63 core file for which the stack trace is to be printed.
duke@0 64 .br
duke@0 65 .TP 3
duke@0 66 remote\-hostname\-or\-IP
tbell@1178 67 remote debug server's (see jsadebugd(1)) hostname or IP address.
duke@0 68 .br
duke@0 69 .TP 3
duke@0 70 server\-id
duke@0 71 optional unique id, if multiple debug servers are running on the same remote host.
duke@0 72 .RE
duke@0 73
duke@0 74 .LP
duke@0 75 .SH "DESCRIPTION"
duke@0 76 .LP
duke@0 77 .LP
duke@0 78 \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 79 .br
duke@0 80
duke@0 81 .LP
duke@0 82 .nf
duke@0 83 \f3
duke@0 84 .fl
duke@0 85 jstack \-J\-d64 \-m pid
duke@0 86 .fl
duke@0 87 \fP
duke@0 88 .fi
duke@0 89
duke@0 90 .LP
duke@0 91 .LP
tbell@1178 92 \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 93 .LP
tbell@1178 94 .LP
tbell@1178 95 For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
duke@0 96 .LP
duke@0 97 .SH "OPTIONS"
duke@0 98 .LP
duke@0 99 .RS 3
duke@0 100 .TP 3
duke@0 101 \-F
tbell@1178 102 Force a stack dump when 'jstack [\-l] pid' does not respond.
tbell@1178 103 .TP 3
tbell@1178 104 \-l
tbell@1178 105 Long listing. Prints additional information about locks such as list of owned java.util.concurrent
tbell@1178 106 .na
tbell@1178 107 \f2ownable synchronizers\fP @
tbell@1178 108 .fi
bpatel@4176 109 http://download.oracle.com/javase/7/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html.
duke@0 110 .TP 3
duke@0 111 \-m
duke@0 112 prints mixed mode (both Java and native C/C++ frames) stack trace.
duke@0 113 .TP 3
duke@0 114 \-h
duke@0 115 prints a help message.
duke@0 116 .br
duke@0 117 .br
duke@0 118 .TP 3
duke@0 119 \-help
duke@0 120 prints a help message
duke@0 121 .br
duke@0 122 .RE
duke@0 123
duke@0 124 .LP
duke@0 125 .SH "SEE ALSO"
duke@0 126 .LP
duke@0 127 .RS 3
duke@0 128 .TP 2
duke@0 129 o
duke@0 130 pstack(1)
duke@0 131 .TP 2
duke@0 132 o
duke@0 133 c++filt(1)
duke@0 134 .TP 2
duke@0 135 o
tbell@1178 136 jps(1)
duke@0 137 .TP 2
duke@0 138 o
tbell@1178 139 jsadebugd(1)
duke@0 140 .RE
duke@0 141
duke@0 142 .LP
duke@0 143 .SH "KNOWN BUGS"
duke@0 144 .LP
duke@0 145 .LP
duke@0 146 Mixed mode stack trace, the \-m option, does not work with the remote debug server.
duke@0 147 .LP
duke@0 148