jdk/src/solaris/doc/sun/man/man1/jhat.1
changeset 2692 345bc8d65b19
parent 2 90ce3da70b43
child 5506 202f599c92aa
equal deleted inserted replaced
2691:bad7bbf42755 2692:345bc8d65b19
     1 .'" t
       
     2 ." Copyright 2006 Sun Microsystems, Inc.  All Rights Reserved.
     1 ." Copyright 2006 Sun Microsystems, Inc.  All Rights Reserved.
     3 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4 ."
     3 ."
     5 ." This code is free software; you can redistribute it and/or modify it
     4 ." This code is free software; you can redistribute it and/or modify it
     6 ." under the terms of the GNU General Public License version 2 only, as
     5 ." under the terms of the GNU General Public License version 2 only, as
    17 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    18 ."
    17 ."
    19 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    20 ." CA 95054 USA or visit www.sun.com if you need additional information or
    19 ." CA 95054 USA or visit www.sun.com if you need additional information or
    21 ." have any questions.
    20 ." have any questions.
    22 ." ` 
    21 ."
    23 .TH jhat 1 "05 Aug 2006"
    22 .TH jhat 1 "04 May 2009"
    24 ." Generated by html2roff
    23 ." Generated from HTML by html2man (author: Eric Armstrong)
    25 
    24 
    26 .LP
    25 .LP
    27 .SH NAME
    26 .SH "Name"
    28 jhat \- Java Heap Analysis Tool
    27 jhat \- Java Heap Analysis Tool
    29 .LP
    28 .LP
    30 .SH "SYNOPSIS"
    29 .SH "SYNOPSIS"
    31 .LP
    30 .LP
    32 
    31 
    43 .LP
    42 .LP
    44 .SH "PARAMETERS"
    43 .SH "PARAMETERS"
    45 .LP
    44 .LP
    46 
    45 
    47 .LP
    46 .LP
       
    47 .RS 3
    48 .TP 3
    48 .TP 3
    49 options 
    49 options 
    50 Options, if used, should follow immediately after the command name. 
    50 Options, if used, should follow immediately after the command name. 
       
    51 .br
    51 .TP 3
    52 .TP 3
    52 heap\-dump\-file 
    53 heap\-dump\-file 
    53 Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3". 
    54 Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3". 
    54 .LP
    55 .SH "DESCRIPTION" 
    55 .SH "DESCRIPTION"
       
    56 .LP
       
    57 
       
    58 .LP
    56 .LP
    59 .LP
    57 .LP
    60 The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/
    58 The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/
    61 .LP
    59 .LP
    62 .LP
    60 .LP
    63 There are several ways to generate a java heap dump:
    61 There are several ways to generate a java heap dump:
    64 .LP
    62 .LP
    65 .RS 3
    63 .RS 3
    66 .TP 2
    64 .TP 2
    67 *
    65 o
    68 Use jmap \-dump option to obtain a heap dump at runtime; 
    66 Use jmap(1) \-dump option to obtain a heap dump at runtime; 
    69 .TP 2
    67 .TP 2
    70 *
    68 o
    71 Use jconsole option to obtain a heap dump via 
    69 Use jconsole(1) option to obtain a heap dump via 
    72 .na
    70 .na
    73 \f2HotSpotDiagnosticMXBean\fP @
    71 \f2HotSpotDiagnosticMXBean\fP @
    74 .fi
    72 .fi
    75 http://java.sun.com/javase/6/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticsMXBean.html at runtime; 
    73 http://java.sun.com/javase/6/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime; 
    76 .TP 2
    74 .TP 2
    77 *
    75 o
    78 Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option; 
    76 Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option; 
    79 .TP 2
    77 .TP 2
    80 *
    78 o
    81 Use 
    79 Use 
    82 .na
    80 .na
    83 \f2hprof\fP @
    81 \f2hprof\fP @
    84 .fi
    82 .fi
    85 http://java.sun.com/developer/technicalArticles/Programming/HPROF.html. 
    83 http://java.sun.com/developer/technicalArticles/Programming/HPROF.html. 
    87 
    85 
    88 .LP
    86 .LP
    89 .LP
    87 .LP
    90 \f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK.
    88 \f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK.
    91 .LP
    89 .LP
    92 .SH "OPTIONS"
    90 .SH "OPTIONS"  
    93 .LP
    91 .RS 3
    94 
       
    95 .LP
       
    96 .TP 3
    92 .TP 3
    97 \-stack false/true 
    93 \-stack false/true 
    98 Turn off tracking object allocation call stack. Note that if allocation site information is not available in the heap dump, you have to set this flag to false. Default is true. 
    94 Turn off tracking object allocation call stack. Note that if allocation site information is not available in the heap dump, you have to set this flag to false. Default is true. 
    99 .TP 3
    95 .TP 3
   100 \-refs false/true 
    96 \-refs false/true 
   121 \-help\  
   117 \-help\  
   122 Output help message and exit. 
   118 Output help message and exit. 
   123 .TP 3
   119 .TP 3
   124 \-J<flag>\  
   120 \-J<flag>\  
   125 Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB. 
   121 Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB. 
       
   122 .RE
       
   123 
   126 .LP
   124 .LP
   127 .SH "SEE ALSO"
   125 .SH "SEE ALSO" 
   128 .LP
       
   129 .RS 3
   126 .RS 3
   130 .TP 2
   127 .TP 2
   131 *
   128 o
   132 jmap \- Java Memory Map 
   129 jmap(1) 
   133 .TP 2
   130 .TP 2
   134 *
   131 o
   135 jconsole \- Java Monitoring and Management Console 
   132 jconsole(1) 
   136 .TP 2
   133 .TP 2
   137 *
   134 o
   138 .na
   135 .na
   139 \f2hprof \- Heap and CPU profiling tool\fP @
   136 \f2hprof \- Heap and CPU profiling tool\fP @
   140 .fi
   137 .fi
   141 http://java.sun.com/developer/technicalArticles/Programming/HPROF.html 
   138 http://java.sun.com/developer/technicalArticles/Programming/HPROF.html 
   142 .RE
   139 .RE
   143 
   140 .RE
   144 .LP
       
   145 
       
   146 .LP
       
   147  
   141