annotate src/jdk.jcmd/share/man/jstack.1 @ 53682:2e52aa822c57

8178317: Create man pages using pandoc from markdown sources Reviewed-by: erikj
author ihse
date Wed, 28 Nov 2018 10:00:41 +0100
parents src/bsd/doc/man/jstack.1@71c04702a3d5
children d4890c3721be
rev   line source
rgallard@21743 1 '\" t
mfang@31876 2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
mfang@31876 3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mfang@31876 4 .\"
mfang@31876 5 .\" This code is free software; you can redistribute it and/or modify it
mfang@31876 6 .\" under the terms of the GNU General Public License version 2 only, as
mfang@31876 7 .\" published by the Free Software Foundation.
mfang@31876 8 .\"
mfang@31876 9 .\" This code is distributed in the hope that it will be useful, but WITHOUT
mfang@31876 10 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mfang@31876 11 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
mfang@31876 12 .\" version 2 for more details (a copy is included in the LICENSE file that
mfang@31876 13 .\" accompanied this code).
mfang@31876 14 .\"
mfang@31876 15 .\" You should have received a copy of the GNU General Public License version
mfang@31876 16 .\" 2 along with this work; if not, write to the Free Software Foundation,
mfang@31876 17 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mfang@31876 18 .\"
mfang@31876 19 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
mfang@31876 20 .\" or visit www.oracle.com if you need additional information or have any
mfang@31876 21 .\" questions.
mfang@31876 22 .\"
rgallard@21743 23 .\" Arch: generic
rgallard@21743 24 .\" Software: JDK 8
rgallard@21743 25 .\" Date: 21 November 2013
rgallard@21743 26 .\" SectDesc: Troubleshooting Tools
rgallard@21743 27 .\" Title: jstack.1
rgallard@21743 28 .\"
rgallard@21743 29 .if n .pl 99999
rgallard@21743 30 .TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools"
mfang@31876 31 .\" -----------------------------------------------------------------
mfang@31876 32 .\" * Define some portability stuff
mfang@31876 33 .\" -----------------------------------------------------------------
mfang@31876 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
mfang@31876 35 .\" http://bugs.debian.org/507673
mfang@31876 36 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
mfang@31876 37 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
mfang@31876 38 .ie \n(.g .ds Aq \(aq
mfang@31876 39 .el .ds Aq '
mfang@31876 40 .\" -----------------------------------------------------------------
mfang@31876 41 .\" * set default formatting
mfang@31876 42 .\" -----------------------------------------------------------------
mfang@31876 43 .\" disable hyphenation
mfang@31876 44 .nh
mfang@31876 45 .\" disable justification (adjust text to left margin only)
mfang@31876 46 .ad l
mfang@31876 47 .\" -----------------------------------------------------------------
mfang@31876 48 .\" * MAIN CONTENT STARTS HERE *
mfang@31876 49 .\" -----------------------------------------------------------------
michaelm@12047 50
rgallard@21743 51 .SH NAME
rgallard@21743 52 jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&.
rgallard@21743 53 .SH SYNOPSIS
rgallard@21743 54 .sp
rgallard@21743 55 .nf
rgallard@21743 56
rgallard@21743 57 \fBjstack\fR [ \fIoptions\fR ] \fIpid\fR
rgallard@21743 58 .fi
rgallard@21743 59 .nf
rgallard@21743 60
rgallard@21743 61 \fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR
rgallard@21743 62 .fi
rgallard@21743 63 .nf
rgallard@21743 64
rgallard@21743 65 \fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR
rgallard@21743 66 .fi
rgallard@21743 67 .sp
rgallard@21743 68 .TP
rgallard@21743 69 \fIoptions\fR
rgallard@21743 70 The command-line options\&. See Options\&.
rgallard@21743 71 .TP
rgallard@21743 72 \fIpid\fR
rgallard@21743 73 The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&.
rgallard@21743 74 .TP
rgallard@21743 75 \fIexecutable\fR
rgallard@21743 76 The Java executable from which the core dump was produced\&.
rgallard@21743 77 .TP
rgallard@21743 78 \fIcore\fR
rgallard@21743 79 The core file for which the stack trace is to be printed\&.
rgallard@21743 80 .TP
rgallard@21743 81 \fIremote-hostname-or-IP\fR
rgallard@21743 82 The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&.
rgallard@21743 83 .TP
rgallard@21743 84 \fIserver-id\fR
rgallard@21743 85 An optional unique ID to use when multiple debug servers are running on the same remote host\&.
rgallard@21743 86 .SH DESCRIPTION
rgallard@21743 87 The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&.
rgallard@21743 88 .PP
rgallard@21743 89 \fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example:
rgallard@21743 90 .sp
rgallard@21743 91 .nf
rgallard@21743 92 \f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP
rgallard@21743 93 .fi
rgallard@21743 94 .nf
rgallard@21743 95 \f3\fP
rgallard@21743 96 .fi
rgallard@21743 97 .sp
rgallard@21743 98 .SH OPTIONS
rgallard@21743 99 .TP
rgallard@21743 100 -F
michaelm@12047 101 .br
rgallard@21743 102 Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&.
rgallard@21743 103 .TP
rgallard@21743 104 -l
michaelm@12047 105 .br
rgallard@21743 106 Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html
rgallard@21743 107 .TP
rgallard@21743 108 -m
michaelm@12047 109 .br
rgallard@21743 110 Prints a mixed mode stack trace that has both Java and native C/C++ frames\&.
rgallard@21743 111 .TP
rgallard@21743 112 -h
michaelm@12047 113 .br
rgallard@21743 114 Prints a help message\&.
rgallard@21743 115 .TP
rgallard@21743 116 -help
michaelm@12047 117 .br
rgallard@21743 118 Prints a help message\&.
rgallard@21743 119 .SH KNOWN\ BUGS
rgallard@21743 120 In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&.
rgallard@21743 121 .SH SEE\ ALSO
rgallard@21743 122 .TP 0.2i
rgallard@21743 123 \(bu
michaelm@12047 124 pstack(1)
rgallard@21743 125 .TP 0.2i
rgallard@21743 126 \(bu
rgallard@21743 127 C++filt(1)
rgallard@21743 128 .TP 0.2i
rgallard@21743 129 \(bu
michaelm@12047 130 jps(1)
rgallard@21743 131 .TP 0.2i
rgallard@21743 132 \(bu
michaelm@12047 133 jsadebugd(1)
mfang@31876 134 .RE
mfang@31876 135 .br
mfang@31876 136 'pl 8.5i
mfang@31876 137 'bp