jdk/src/linux/doc/man/jstack.1
changeset 2 90ce3da70b43
child 2692 345bc8d65b19
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/linux/doc/man/jstack.1	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,166 @@
+.'" t
+."
+." Copyright 2004-2006 Sun Microsystems, Inc.  All Rights Reserved.
+." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+."
+." This code is free software; you can redistribute it and/or modify it
+." under the terms of the GNU General Public License version 2 only, as
+." published by the Free Software Foundation.
+."
+." This code is distributed in the hope that it will be useful, but WITHOUT
+." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+." version 2 for more details (a copy is included in the LICENSE file that
+." accompanied this code).
+."
+." You should have received a copy of the GNU General Public License version
+." 2 along with this work; if not, write to the Free Software Foundation,
+." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+."
+." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+." CA 95054 USA or visit www.sun.com if you need additional information or
+." have any questions.
+."
+." `
+.TH jstack 1 "07 Aug 2006"
+." Generated by html2man
+
+.LP
+.SH NAME
+jstack \- Stack Trace
+.br
+
+.LP
+.SH "SYNOPSIS"
+.LP
+
+.LP
+.nf
+\f3
+.fl
+\fP\f3jstack\fP [ option ] pid
+.fl
+\f3jstack\fP [ option ] executable core
+.fl
+\f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
+.fl
+.fi
+
+.LP
+.SH "PARAMETERS"
+.LP
+
+.LP
+.LP
+Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS.
+.LP
+.RS 3
+.TP 3
+pid 
+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 may be used. 
+.RE
+
+.LP
+.RS 3
+.TP 3
+executable 
+Java executable from which the core dump was produced. 
+.br
+.TP 3
+core 
+core file for which the stack trace is to be printed. 
+.br
+.TP 3
+remote\-hostname\-or\-IP 
+remote debug server's (see jsadebugd) hostname or IP address. 
+.br
+.TP 3
+server\-id 
+optional unique id, if multiple debug servers are running on the same remote host. 
+.RE
+
+.LP
+.SH "DESCRIPTION"
+.LP
+
+.LP
+.LP
+\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.:
+.br
+
+.LP
+.RS 3
+
+.LP
+.nf
+\f3
+.fl
+jstack \-J\-d64 \-m pid
+.fl
+\fP
+.fi
+.RE
+
+.LP
+.LP
+\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. The only form of jstack that is available on Windows platforms is\fP
+.LP
+.nf
+\f3
+.fl
+\fP\f3    jstack pid \fP
+.fl
+.fi
+
+.LP
+.SH "OPTIONS"
+.LP
+
+.LP
+.RS 3
+.TP 3
+\-F 
+Forces a stack dump when 'jstack pid' does not respond. 
+.TP 3
+\-m 
+prints mixed mode (both Java and native C/C++ frames) stack trace. 
+.TP 3
+\-h 
+prints a help message.
+.br
+.br
+.TP 3
+\-help 
+prints a help message
+.br
+.RE
+
+.LP
+.SH "SEE ALSO"
+.LP
+.RS 3
+.TP 2
+o
+pstack(1) 
+.TP 2
+o
+c++filt(1) 
+.TP 2
+o
+jps 
+.TP 2
+o
+jsadebugd 
+.RE
+
+.LP
+.SH "KNOWN BUGS"
+.LP
+
+.LP
+.LP
+Mixed mode stack trace, the \-m option, does not work with the remote debug server.
+.LP
+
+.LP
+