blob: ea072ffce646fa05067a58d01819cf31f4fb48c6 [file] [log] [blame]
bpatel4bf512b2011-05-11 08:30:46 -07001." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
duke6e45e102007-12-01 00:00:00 +00002." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3."
4." This code is free software; you can redistribute it and/or modify it
5." under the terms of the GNU General Public License version 2 only, as
6." published by the Free Software Foundation.
7."
8." This code is distributed in the hope that it will be useful, but WITHOUT
9." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11." version 2 for more details (a copy is included in the LICENSE file that
12." accompanied this code).
13."
14." You should have received a copy of the GNU General Public License version
15." 2 along with this work; if not, write to the Free Software Foundation,
16." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17."
ohair2283b9d2010-05-25 15:58:33 -070018." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
19." or visit www.oracle.com if you need additional information or have any
20." questions.
duke6e45e102007-12-01 00:00:00 +000021."
bpatel4bf512b2011-05-11 08:30:46 -070022.TH jinfo 1 "10 May 2011"
duke6e45e102007-12-01 00:00:00 +000023
24.LP
tbell16c34dd2009-05-04 18:28:26 -070025.SH "Name"
duke6e45e102007-12-01 00:00:00 +000026jinfo \- Configuration Info
27.LP
28.SH "SYNOPSIS"
29.LP
duke6e45e102007-12-01 00:00:00 +000030.nf
31\f3
32.fl
33\fP\f3jinfo\fP [ option ] pid
34.fl
35\f3jinfo\fP [ option ] executable core
36.fl
37\f3jinfo\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
38.fl
39.fi
40
41.LP
42.SH "PARAMETERS"
43.LP
tbell16c34dd2009-05-04 18:28:26 -070044.RS 3
duke6e45e102007-12-01 00:00:00 +000045.TP 3
46option
47Options are mutually exclusive. Option, if used, should follow immediately after the command name.
bpatel4bf512b2011-05-11 08:30:46 -070048.RE
49
50.LP
tbell16c34dd2009-05-04 18:28:26 -070051.RS 3
duke6e45e102007-12-01 00:00:00 +000052.TP 3
53pid
tbell16c34dd2009-05-04 18:28:26 -070054process id for which the configuration info 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.
55.RE
bpatel4bf512b2011-05-11 08:30:46 -070056
57.LP
tbell16c34dd2009-05-04 18:28:26 -070058.RS 3
duke6e45e102007-12-01 00:00:00 +000059.TP 3
60executable
tbell16c34dd2009-05-04 18:28:26 -070061Java executable from which the core dump was produced.
62.RE
bpatel4bf512b2011-05-11 08:30:46 -070063
64.LP
tbell16c34dd2009-05-04 18:28:26 -070065.RS 3
duke6e45e102007-12-01 00:00:00 +000066.TP 3
67core
tbell16c34dd2009-05-04 18:28:26 -070068core file for which the configuration info is to be printed.
69.RE
bpatel4bf512b2011-05-11 08:30:46 -070070
71.LP
tbell16c34dd2009-05-04 18:28:26 -070072.RS 3
duke6e45e102007-12-01 00:00:00 +000073.TP 3
74remote\-hostname\-or\-IP
tbell16c34dd2009-05-04 18:28:26 -070075remote debug server's (see jsadebugd(1)) hostname or IP address.
76.RE
bpatel4bf512b2011-05-11 08:30:46 -070077
78.LP
tbell16c34dd2009-05-04 18:28:26 -070079.RS 3
duke6e45e102007-12-01 00:00:00 +000080.TP 3
81server\-id
tbell16c34dd2009-05-04 18:28:26 -070082optional unique id, if multiple debug servers are running on the same remote host.
83.RE
tbell16c34dd2009-05-04 18:28:26 -070084
duke6e45e102007-12-01 00:00:00 +000085.LP
86.SH "DESCRIPTION"
87.LP
duke6e45e102007-12-01 00:00:00 +000088.LP
89\f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
90.br
duke6e45e102007-12-01 00:00:00 +000091jinfo \-J\-d64 \-sysprops pid
bpatel4bf512b2011-05-11 08:30:46 -070092.LP
duke6e45e102007-12-01 00:00:00 +000093.LP
tbell16c34dd2009-05-04 18:28:26 -070094\f3NOTE \- 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' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
95.LP
96.LP
97\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
duke6e45e102007-12-01 00:00:00 +000098.LP
99.SH "OPTIONS"
100.LP
tbell16c34dd2009-05-04 18:28:26 -0700101.RS 3
duke6e45e102007-12-01 00:00:00 +0000102.TP 3
103<no option>
104prints both command line flags as well as System properties name, value pairs.
105.br
106.TP 3
107\-flag name
108prints the name and value of the given command line flag.
109.br
110.TP 3
111\-flag [+|\-]name
112enables or disables the given boolean command line flag.
113.br
114.TP 3
115\-flag name=value
116sets the given command line flag to the specified value.
117.br
118.TP 3
119\-flags
120prints command line flags passed to the JVM. pairs.
121.br
122.TP 3
123\-sysprops
124prints Java System properties as name, value pairs.
125.br
126.TP 3
127\-h
128prints a help message
129.TP 3
130\-help
131prints a help message
tbell16c34dd2009-05-04 18:28:26 -0700132.RE
133
duke6e45e102007-12-01 00:00:00 +0000134.LP
135.SH "SEE ALSO"
136.LP
137.RS 3
138.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700139o
140jps(1)
duke6e45e102007-12-01 00:00:00 +0000141.TP 2
tbell16c34dd2009-05-04 18:28:26 -0700142o
143jsadebugd(1)
duke6e45e102007-12-01 00:00:00 +0000144.RE
145
146.LP
duke6e45e102007-12-01 00:00:00 +0000147