jdk/src/linux/doc/man/jvisualvm.1
author alanb
Wed, 05 Jun 2013 13:57:16 +0100
changeset 17950 b2d5b298ec6e
parent 9573 c02ff5a7c67b
permissions -rw-r--r--
8015880: GenerateBreakIteratorData build warning Reviewed-by: peytoia
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     1
." Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     2
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     3
."
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     4
." This code is free software; you can redistribute it and/or modify it
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     5
." under the terms of the GNU General Public License version 2 only, as
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     6
." published by the Free Software Foundation.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     7
."
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     8
." This code is distributed in the hope that it will be useful, but WITHOUT
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
     9
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    10
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    11
." version 2 for more details (a copy is included in the LICENSE file that
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    12
." accompanied this code).
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    13
."
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    14
." You should have received a copy of the GNU General Public License version
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    15
." 2 along with this work; if not, write to the Free Software Foundation,
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    16
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    17
."
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    18
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    19
." or visit www.oracle.com if you need additional information or have any
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    20
." questions.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    21
."
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    22
.TH jvisualvm 1 "10 May 2011"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    23
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    24
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    25
.SH "Name"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    26
\f2jvisualvm\fP \- Java Virtual Machine Monitoring, Troubleshooting, and Profiling Tool
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    27
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    28
.SH "SYNOPSIS"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    29
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    30
.nf
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    31
\f3
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    32
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    33
        \fP\f3jvisualvm\fP [ \f2options\fP ]
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    34
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    35
.fi
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    36
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    37
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    38
.SH "PARAMETERS"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    39
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    40
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    41
Options, if used, should follow immediately after the command name. Options may be in any order. For a discussion of parameters that apply to a specific option, see OPTIONS below.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    42
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    43
.SH "DESCRIPTION"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    44
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    45
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    46
Java VisualVM is an intuitive graphical user interface that provides detailed information about Java technology\-based applications (Java applications) while they are running on a given Java Virtual Machine (JVM(*)). The name Java VisualVM comes from the fact that Java VisualVM provides information about the JVM software \f2visually\fP.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    47
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    48
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    49
Java VisualVM combines several monitoring, troubleshooting, and profiling utilities into a single tool. For example, most of the functionality offered by the standalone tools \f2jmap\fP, \f2jinfo\fP, \f2jstat\fP and \f2jstack\fP have been integrated into Java VisualVM. Other functionalities, such as some of those offered by the JConsole tool, can be added as optional plug\-ins.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    50
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    51
.SH "OPTIONS"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    52
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    53
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    54
The following option is possible when you launch Java VisualVM.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    55
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    56
.RS 3
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    57
.TP 3
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    58
\-J<jvm_option>\  
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    59
Pass this \f2<jvm_option>\fP to the JVM software. 
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    60
.RE
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    61
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    62
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    63
.SH "USAGE"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    64
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    65
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    66
Java VisualVM is useful to Java application developers to troubleshoot applications and to monitor and improve the applications' performance. Java VisualVM can allow developers to generate and analyse heap dumps, track down memory leaks, perform and monitor garbage collection, and perform lightweight memory and CPU profiling. Plug\-ins also exist that expand the functionality of Java VisualVM. For example, most of the functionality of the JConsole tool is available via the MBeans Tab and JConsole Plug\-in Wrapper plug\-ins. You can choose from a catalog of standard Java VisualVM plug\-ins by selecting 'Tools' | 'Plugins' in the Java VisualVM menus.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    67
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    68
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    69
Start Java VisualVM with the following command:
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    70
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    71
.nf
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    72
\f3
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    73
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    74
%  jvisualvm \fP\f4<options>\fP\f3
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    75
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    76
\fP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    77
.fi
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    78
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    79
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    80
.SH "SEE ALSO"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    81
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    82
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    83
For more details about Java VisualVM see the following pages.
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    84
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    85
.RS 3
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    86
.TP 2
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    87
o
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    88
.na
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    89
\f2Java VisualVM developers' site\fP @
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    90
.fi
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    91
http://visualvm.java.net 
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    92
.TP 2
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    93
o
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    94
.na
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    95
\f2Java VisualVM in Java SE platform documentation\fP @
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    96
.fi
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    97
http://download.oracle.com/javase/7/docs/technotes/guides/visualvm/index.html 
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    98
.RE
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
    99
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
   100
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
   101
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
   102
\f2(* The terms "Java Virtual Machine" and "JVM" mean a Virtual Machine for the Java platform.)\fP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
   103
.LP
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents:
diff changeset
   104