jdk/src/linux/doc/man/jinfo.1
author fparain
Wed, 28 Mar 2012 02:20:09 -0700
changeset 12299 ea3d337ed663
parent 9573 c02ff5a7c67b
child 21743 3d979da7bdf0
permissions -rw-r--r--
7156831: The jcmd man page is not included in generated bundles Reviewed-by: dholmes, sla, dsamersoff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
     1
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
." This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
." under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
." published by the Free Software Foundation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
." This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
." version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
." accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
." You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
." 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
."
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    18
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    19
." or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    20
." questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
."
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    22
.TH jinfo 1 "10 May 2011"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    25
.SH "Name"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
jinfo \- Configuration Info
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
.SH "SYNOPSIS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
\fP\f3jinfo\fP [ option ] pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
\f3jinfo\fP [ option ] executable core
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
\f3jinfo\fP [ option ] [server\-id@]remote\-hostname\-or\-IP 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.SH "PARAMETERS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    44
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
option 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
Options are mutually exclusive. Option, if used, should follow immediately after the command name. 
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    48
.RE
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    49
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    50
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    51
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
pid 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    54
process 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. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    55
.RE
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    56
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    57
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    58
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
executable 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    61
Java executable from which the core dump was produced. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    62
.RE
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    63
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    64
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    65
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
core 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    68
core file for which the configuration info is to be printed. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    69
.RE
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    70
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    71
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    72
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
remote\-hostname\-or\-IP 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    75
remote debug server's (see jsadebugd(1)) hostname or IP address. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    76
.RE
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    77
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    78
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    79
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
server\-id 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    82
optional unique id, if multiple debug servers are running on the same remote host. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    83
.RE
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    84
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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.:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
.br
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    91
jinfo \-J\-d64 \-sysprops pid
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    94
\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
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    95
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    96
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    97
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   101
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
<no option> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
prints both command line flags as well as System properties name, value pairs.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
\-flag name 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
prints the name and value of the given command line flag.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
\-flag [+|\-]name 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
enables or disables the given boolean command line flag.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
\-flag name=value 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
sets the given command line flag to the specified value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
\-flags 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
prints command line flags passed to the JVM. pairs.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
\-sysprops 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
prints Java System properties as name, value pairs.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
\-h 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
prints a help message 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
\-help 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
prints a help message 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   132
.RE
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   133
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   139
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   140
jps(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   142
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   143
jsadebugd(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147