jdk/src/solaris/doc/sun/man/man1/jmap.1
author bpatel
Wed, 11 May 2011 08:30:46 -0700
changeset 9573 c02ff5a7c67b
parent 5865 47da38a8c0f0
child 21743 3d979da7bdf0
permissions -rw-r--r--
7043684: Update man pages for JDK 7 tools Reviewed-by: skannan
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.
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    21
."
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    22
.TH jmap 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
jmap \- Memory Map
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\f3jmap\fP [ option ] pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
\f3jmap\fP [ option ] executable core
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
\f3jmap\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. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
pid 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    50
process id for which the memory map 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
    51
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
executable 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
Java executable from which the core dump was produced. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    55
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
core 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
core file for which the memory map is to be printed. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    59
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
remote\-hostname\-or\-IP 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    62
remote debug server's (see jsadebugd(1)) hostname or IP address. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    63
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
server\-id 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
optional unique id, if multiple debug servers are running on the same remote host.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    68
.RE
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. 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
    75
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
jmap \-J\-d64 \-heap pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
.LP
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    85
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    86
\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' needs 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
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    87
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    88
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    89
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    90
.LP
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    96
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
.TP 3
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    98
<no option> 
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    99
When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   100
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
\-dump:[live,]format=b,file=<filename> 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   103
Dumps the Java heap in hprof binary format to filename. The \f2live\fP suboption is optional. If specified, only the live objects in the heap are dumped. To browse the heap dump, you can use jhat(1) (Java Heap Analysis Tool) to read the generated file. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   104
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
\-finalizerinfo 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
Prints information on objects awaiting finalization. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   108
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
\-heap 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   112
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
\-histo[:live] 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
Prints a histogram of the heap. For each Java class, number of objects, memory size in bytes, and fully qualified class names are printed. VM internal class names are printed with '*' prefix. If the \f2live\fP suboption is specified, only live objects are counted. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   116
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
\-permstat 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
Prints class loader wise statistics of permanent generation of Java heap. For each class loader, its name, liveness, address, parent class loader, and the number and size of classes it has loaded are printed. In addition, the number and size of interned Strings are printed. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   120
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
\-F 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
Force. Use with jmap \-dump or jmap \-histo option if the pid does not respond. The \f2live\fP suboption is not supported in this mode. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   124
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
\-h 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
Prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   129
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
\-help 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
Prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   134
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
\-J<flag> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
Passes <flag> to the Java virtual machine on which jmap is run. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   138
.br
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   139
.RE
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   146
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   147
pmap(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   149
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   150
jhat(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   152
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   153
jps(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   155
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   156
jsadebugd(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160