jdk/src/linux/doc/man/jconsole.1
author fparain
Wed, 28 Mar 2012 02:20:09 -0700
changeset 12299 ea3d337ed663
parent 9573 c02ff5a7c67b
child 21743 3d979da7bdf0
permissions -rw-r--r--
7156831: The jcmd man page is not included in generated bundles Reviewed-by: dholmes, sla, dsamersoff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
     1
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
." This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
." under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
." published by the Free Software Foundation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
." This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
." version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
." accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
." You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
." 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
."
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    18
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    19
." or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    20
." questions.
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    21
."
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    22
.TH jconsole 1 "10 May 2011"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    25
.SH "Name"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
jconsole \- Java Monitoring and Management Console
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
.SH "SYNOPSIS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
\fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ]
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
.SH "PARAMETERS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
options 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
Options, if used, should follow immediately after the command name. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
connection = pid | host:port | jmxUrl 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
.RS 3
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    49
.TP 2
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    50
o
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    51
\f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    52
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    53
\f2JMX Monitoring and Management\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    54
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    55
http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. 
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    56
.TP 2
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    57
o
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    58
\f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    59
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    60
\f2JMX Monitoring and Management\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    61
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    62
http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. 
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    63
.TP 2
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    64
o
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    65
\f2jmxUrl\fP Address of the JMX agent to be connected to as described in 
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    66
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    67
\f2JMXServiceURL\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    68
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    69
http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
\-interval=n 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
Set the update interval to \f2n\fP seconds (default is 4 seconds). 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
.TP 3
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    89
\-notile 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
Do not tile windows initially (for two or more connections). 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
.TP 3
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    92
\-pluginpath plugins 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
   META\-INF/services/com.sun.tools.jconsole.JConsolePlugin
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
.fi
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   102
containing one line for each plugin specifying the fully qualified class name of the class implementing the 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   103
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   104
\f2com.sun.tools.jconsole.JConsolePlugin\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   105
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   106
http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
.TP 3
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   108
\-version 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
Output version information and exit. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.TP 3
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   111
\-help 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
Output help message and exit. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
.TP 3
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   114
\-J<flag> 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
Pass <flag> to the Java virtual machine on which jconsole is run. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
o
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   124
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   125
\f2Using JConsole\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   126
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   127
http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
o
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   130
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   131
\f2Monitoring and Management for Java Platform\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   132
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   133
http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137