jdk/src/linux/doc/man/jmap.1
author mikejwre
Wed, 09 Jun 2010 18:56:41 -0700
changeset 5634 895b66935810
parent 5506 202f599c92aa
child 5865 47da38a8c0f0
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
     1
." Copyright 2006 Sun Microsystems, Inc.  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
."
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    22
.TH jmap 1 "04 May 2009"
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    23
." Generated from HTML by html2man (author: Eric Armstrong)
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    26
.SH "Name"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
jmap \- Memory Map
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
.SH "SYNOPSIS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
\fP\f3jmap\fP [ option ] pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
\f3jmap\fP [ option ] executable core
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
.SH "PARAMETERS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    49
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
option 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
Options are mutually exclusive. Option, if used, should follow immediately after the command name. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
pid 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    55
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
    56
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
executable 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
Java executable from which the core dump was produced. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    60
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
core 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
core file for which the memory map is to be printed. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    64
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
remote\-hostname\-or\-IP 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    67
remote debug server's (see jsadebugd(1)) hostname or IP address. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    68
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
server\-id 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
optional unique id, if multiple debug servers are running on the same remote host.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    73
.RE
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
\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
    82
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
jmap \-J\-d64 \-heap pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    96
\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 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    97
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    98
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    99
.LP
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   107
.RS 3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
.TP 3
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   109
<no option> 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   110
When no option is used \f3jmap\fP 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. 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   111
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
\-dump:[live,]format=b,file=<filename> 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   114
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
   115
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
\-finalizerinfo 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
Prints information on objects awaiting finalization. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   119
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
\-heap 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
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
   123
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
\-histo[:live] 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
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
   127
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
\-permstat 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
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
   131
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
\-F 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
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
   135
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
\-h 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
Prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   140
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
\-help 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
Prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   145
.br
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
\-J<flag> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
Passes <flag> to the Java virtual machine on which jmap is run. 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   149
.br
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   150
.RE
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   157
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   158
pmap(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   160
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   161
jhat(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   163
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   164
jps(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
.TP 2
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   166
o
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   167
jsadebugd(1) 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173