jdk/src/linux/doc/man/jconsole.1
author jjg
Tue, 11 Mar 2008 13:14:55 -0700
changeset 168 25697c18650b
parent 2 90ce3da70b43
child 2692 345bc8d65b19
permissions -rw-r--r--
6307187: clean up code for -Xlint:options Summary: introduce common code for handling one-of and any-of options Reviewed-by: mcimadamore
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
.'" t
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
." Copyright 2004-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
." This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
." under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
." published by the Free Software Foundation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
." This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
." version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
." accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
." You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
." 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
." CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
." have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
." 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
." `
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
.TH jconsole 1 "07 Aug 2006"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
." Generated by html2man
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
.SH NAME
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
jconsole \- Java Monitoring and Management Console
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
.SH "SYNOPSIS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
\fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ]
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
.SH "PARAMETERS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
options 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
Options, if used, should follow immediately after the command name. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
connection = pid | host:port | jmxUrl 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
\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 JMX Monitoring and Management for details. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
\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 JMX Monitoring and Management for details. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
\f2jmxUrl\fP\ \  Address of the JMX agent to be connected to as described in JMXServiceURL. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
.SH "DESCRIPTION"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
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
    73
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
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
    76
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
.SH "OPTIONS"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
\-interval=n 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
Set the update interval to \f2n\fP seconds (default is 4 seconds). 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
\-notile\  
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
Do not tile windows initially (for two or more connections). 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
\-pluginpath\  plugins 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
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
    91
.br
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
   META\-INF/services/com.sun.tools.jconsole.JConsolePlugin
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
containing one line for each plugin specifying the fully qualified class name of the class implementing the  com.sun.tools.jconsole.JConsolePlugin class.  
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
\-version\  
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
Output version information and exit. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
\-help\  
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
Output help message and exit. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
.TP 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
\-J<flag>\  
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
Pass <flag> to the Java virtual machine on which jconsole is run. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
.SH "SEE ALSO"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
o
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
Using JConsole 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
o
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
Monitoring and Management for Java Platform 
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127