jdk/src/linux/doc/man/jconsole.1
author ctornqvi
Wed, 18 Feb 2015 19:28:08 -0800
changeset 29105 3927f8f0bf4b
parent 21743 3d979da7bdf0
child 31876 91b22707521a
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     1
'\" t
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     2
.\"  Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     3
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     4
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     5
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     6
.\" This code is free software; you can redistribute it and/or modify it
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     7
.\" under the terms of the GNU General Public License version 2 only, as
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     8
.\" published by the Free Software Foundation.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
     9
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    10
.\" This code is distributed in the hope that it will be useful, but WITHOUT
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    11
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    12
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    13
.\" version 2 for more details (a copy is included in the LICENSE file that
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    14
.\" accompanied this code).
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    15
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    16
.\" You should have received a copy of the GNU General Public License version
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    17
.\" 2 along with this work; if not, write to the Free Software Foundation,
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    18
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    19
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    20
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    21
.\" or visit www.oracle.com if you need additional information or have any
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    22
.\" questions.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    23
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    24
.\"     Arch: generic
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    25
.\"     Software: JDK 8
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    26
.\"     Date: 21 November 2013
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    27
.\"     SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    28
.\"     Title: jconsole.1
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    29
.\"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    30
.if n .pl 99999
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    31
.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools"
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    32
.\" -----------------------------------------------------------------
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    33
.\" * Define some portability stuff
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    34
.\" -----------------------------------------------------------------
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    35
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    36
.\" http://bugs.debian.org/507673
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    37
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    38
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    39
.ie \n(.g .ds Aq \(aq
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    40
.el       .ds Aq '
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    41
.\" -----------------------------------------------------------------
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    42
.\" * set default formatting
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    43
.\" -----------------------------------------------------------------
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    44
.\" disable hyphenation
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    45
.nh
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    46
.\" disable justification (adjust text to left margin only)
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    47
.ad l
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    48
.\" -----------------------------------------------------------------
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    49
.\" * MAIN CONTENT STARTS HERE *
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    50
.\" -----------------------------------------------------------------
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    52
.SH NAME    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    53
jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    54
.SH SYNOPSIS    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    55
.sp     
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    56
.nf     
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    58
\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ]
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    59
.fi     
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    60
.sp     
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    61
.TP     
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    62
\fIoptions\fR
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    63
The command-line options\&. See Options\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    64
.TP     
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    65
connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    66
The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    67
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    68
For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    70
See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    71
.SH DESCRIPTION    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    72
The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    73
.PP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    74
On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    75
.SH OPTIONS    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    76
.TP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    77
-interval\fI=n\fR
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    78
.br
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    79
Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    80
.TP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    81
-notile
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    82
.br
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    83
Does not tile windows initially (for two or more connections)\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    84
.TP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    85
-pluginpath \fIplugins\fR
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    86
.br
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    87
Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    88
.TP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    89
-version
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
.br
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    91
Displays release information and exits\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    92
.TP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    93
-help
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    94
.br
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    95
Displays a help message\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    96
.TP
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    97
-J\fIflag\fR
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    98
.br
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
    99
Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&.
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   100
.SH SEE\ ALSO    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   101
.TP 0.2i    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   102
\(bu
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   103
Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   104
.TP 0.2i    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   105
\(bu
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   106
Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   107
.TP 0.2i    
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   108
\(bu
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   109
The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   110
.RE
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   111
.br
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   112
'pl 8.5i
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 9573
diff changeset
   113
'bp