jdk/src/linux/doc/man/jmap.1
author jjg
Tue, 11 Mar 2008 13:14:55 -0700
changeset 168 25697c18650b
parent 2 90ce3da70b43
child 2692 345bc8d65b19
permissions -rw-r--r--
6307187: clean up code for -Xlint:options Summary: introduce common code for handling one-of and any-of options Reviewed-by: mcimadamore
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
.'" t
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
." Copyright 2004-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
." This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
." under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
." published by the Free Software Foundation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
." This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
." version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
." accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
." You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
." 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
." CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
." have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
." `
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
.TH jmap 1 "05 Aug 2006"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
." Generated by html2roff
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
.SH NAME
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
jmap \- Memory Map
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
.SH "SYNOPSIS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
\fP\f3jmap\fP [ option ] pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
\f3jmap\fP [ option ] executable core
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
.SH "PARAMETERS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
option 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
Options are mutually exclusive. Option, if used, should follow immediately after the command name. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
pid 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
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 may be used. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
executable 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
Java executable from which the core dump was produced. 
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. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
remote\-hostname\-or\-IP 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
remote debug server's (see jsadebugd) hostname or IP address. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
server\-id 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
optional unique id, if multiple debug servers are running on the same remote host.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
\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
    79
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
jmap \-J\-d64 \-heap pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK.\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
The only forms of jmap available on the Windows platform are 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
jmap \-dump:<\f2dump\-options\fP> pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
and 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
jmap \-histo[:live] pid
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
<no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
option> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
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. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
\-dump:[live,]format=b,file=<filename> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
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 (Java Heap Analysis Tool) to read the generated file. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
\-finalizerinfo 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
Prints information on objects awaiting finalization. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
\-heap 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
\-histo[:live] 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
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. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
\-permstat 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
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. 
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. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
\-h 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
Prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
\-help 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
Prints a help message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
\-J<flag> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
Passes <flag> to the Java virtual machine on which jmap is run. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
*
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
pmap (1) 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
*
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
jhat 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
*
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
jps 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
*
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
jsadebugd 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168