jdk/src/solaris/doc/sun/man/man1/jmap.1
changeset 2692 345bc8d65b19
parent 2 90ce3da70b43
child 5506 202f599c92aa
--- a/jdk/src/solaris/doc/sun/man/man1/jmap.1	Thu Apr 30 15:04:39 2009 -0700
+++ b/jdk/src/solaris/doc/sun/man/man1/jmap.1	Mon May 04 18:28:26 2009 -0700
@@ -1,4 +1,3 @@
-.'" t
 ." Copyright 2006 Sun Microsystems, Inc.  All Rights Reserved.
 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 ."
@@ -19,12 +18,12 @@
 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 ." CA 95054 USA or visit www.sun.com if you need additional information or
 ." have any questions.
-." ` 
-.TH jmap 1 "05 Aug 2006"
-." Generated by html2roff
+."
+.TH jmap 1 "04 May 2009"
+." Generated from HTML by html2man (author: Eric Armstrong)
 
 .LP
-.SH NAME
+.SH "Name"
 jmap \- Memory Map
 .LP
 .SH "SYNOPSIS"
@@ -47,25 +46,31 @@
 .LP
 
 .LP
+.RS 3
 .TP 3
 option 
 Options are mutually exclusive. Option, if used, should follow immediately after the command name. 
 .TP 3
 pid 
-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. 
+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. 
+.br
 .TP 3
 executable 
 Java executable from which the core dump was produced. 
+.br
 .TP 3
 core 
 core file for which the memory map is to be printed. 
+.br
 .TP 3
 remote\-hostname\-or\-IP 
-remote debug server's (see jsadebugd) hostname or IP address. 
+remote debug server's (see jsadebugd(1)) hostname or IP address. 
+.br
 .TP 3
 server\-id 
 optional unique id, if multiple debug servers are running on the same remote host.
 .br
+.RE
 
 .LP
 .SH "DESCRIPTION"
@@ -88,76 +93,78 @@
 .RE
 
 .LP
-\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK.\fP
+\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 
+.LP
+\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
+.LP
 .br
 
 .LP
-The only forms of jmap available on the Windows platform are 
-.RS 3
-
-.LP
-jmap \-dump:<\f2dump\-options\fP> pid
-.RE
-and 
-.RS 3
-
-.LP
-jmap \-histo[:live] pid
-.RE
 .SH "OPTIONS"
 .LP
 
 .LP
+.RS 3
 .TP 3
-<no
-option> 
-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. 
+<no option> 
+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. 
+.br
 .TP 3
 \-dump:[live,]format=b,file=<filename> 
-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. 
+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. 
+.br
 .TP 3
 \-finalizerinfo 
 Prints information on objects awaiting finalization. 
+.br
 .TP 3
 \-heap 
 Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed. 
+.br
 .TP 3
 \-histo[:live] 
 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. 
+.br
 .TP 3
 \-permstat 
 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. 
+.br
 .TP 3
 \-F 
 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. 
+.br
 .TP 3
 \-h 
 Prints a help message.
 .br
+.br
 .TP 3
 \-help 
 Prints a help message.
 .br
+.br
 .TP 3
 \-J<flag> 
 Passes <flag> to the Java virtual machine on which jmap is run. 
+.br
+.RE
 
 .LP
 .SH "SEE ALSO"
 .LP
 .RS 3
 .TP 2
-*
-pmap (1) 
+o
+pmap(1) 
 .TP 2
-*
-jhat 
+o
+jhat(1) 
 .TP 2
-*
-jps 
+o
+jps(1) 
 .TP 2
-*
-jsadebugd 
+o
+jsadebugd(1) 
 .RE
 
 .LP