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