1 ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. |
1 '\" t |
2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. |
3 ." |
3 .\" |
4 ." This code is free software; you can redistribute it and/or modify it |
4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
5 ." under the terms of the GNU General Public License version 2 only, as |
5 .\" |
6 ." published by the Free Software Foundation. |
6 .\" This code is free software; you can redistribute it and/or modify it |
7 ." |
7 .\" under the terms of the GNU General Public License version 2 only, as |
8 ." This code is distributed in the hope that it will be useful, but WITHOUT |
8 .\" published by the Free Software Foundation. |
9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
9 .\" |
10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
10 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
11 ." version 2 for more details (a copy is included in the LICENSE file that |
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 ." accompanied this code). |
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 ." |
13 .\" version 2 for more details (a copy is included in the LICENSE file that |
14 ." You should have received a copy of the GNU General Public License version |
14 .\" accompanied this code). |
15 ." 2 along with this work; if not, write to the Free Software Foundation, |
15 .\" |
16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
16 .\" You should have received a copy of the GNU General Public License version |
17 ." |
17 .\" 2 along with this work; if not, write to the Free Software Foundation, |
18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
19 ." or visit www.oracle.com if you need additional information or have any |
19 .\" |
20 ." questions. |
20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
21 ." |
21 .\" or visit www.oracle.com if you need additional information or have any |
22 .TH jconsole 1 "10 May 2011" |
22 .\" questions. |
|
23 .\" |
|
24 .\" Arch: generic |
|
25 .\" Software: JDK 8 |
|
26 .\" Date: 21 November 2013 |
|
27 .\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools |
|
28 .\" Title: jconsole.1 |
|
29 .\" |
|
30 .if n .pl 99999 |
|
31 .TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" |
|
32 .\" ----------------------------------------------------------------- |
|
33 .\" * Define some portability stuff |
|
34 .\" ----------------------------------------------------------------- |
|
35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
36 .\" http://bugs.debian.org/507673 |
|
37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
39 .ie \n(.g .ds Aq \(aq |
|
40 .el .ds Aq ' |
|
41 .\" ----------------------------------------------------------------- |
|
42 .\" * set default formatting |
|
43 .\" ----------------------------------------------------------------- |
|
44 .\" disable hyphenation |
|
45 .nh |
|
46 .\" disable justification (adjust text to left margin only) |
|
47 .ad l |
|
48 .\" ----------------------------------------------------------------- |
|
49 .\" * MAIN CONTENT STARTS HERE * |
|
50 .\" ----------------------------------------------------------------- |
23 |
51 |
24 .LP |
52 .SH NAME |
25 .SH "Name" |
53 jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. |
26 jconsole \- Java Monitoring and Management Console |
54 .SH SYNOPSIS |
27 .LP |
55 .sp |
28 .SH "SYNOPSIS" |
56 .nf |
29 .LP |
|
30 .nf |
|
31 \f3 |
|
32 .fl |
|
33 \fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] |
|
34 .fl |
|
35 |
57 |
36 .fl |
58 \fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] |
37 .fi |
59 .fi |
|
60 .sp |
|
61 .TP |
|
62 \fIoptions\fR |
|
63 The command-line options\&. See Options\&. |
|
64 .TP |
|
65 connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR |
|
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\&. |
38 |
67 |
39 .LP |
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 |
40 .SH "PARAMETERS" |
69 |
41 .LP |
70 See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html |
42 .RS 3 |
71 .SH DESCRIPTION |
43 .TP 3 |
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\&. |
44 options |
73 .PP |
45 Options, if used, should follow immediately after the command name. |
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\&. |
46 .TP 3 |
75 .SH OPTIONS |
47 connection = pid | host:port | jmxUrl |
76 .TP |
48 .RS 3 |
77 -interval\fI=n\fR |
49 .TP 2 |
78 .br |
50 o |
79 Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. |
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 |
80 .TP |
52 .na |
81 -notile |
53 \f2JMX Monitoring and Management\fP @ |
82 .br |
54 .fi |
83 Does not tile windows initially (for two or more connections)\&. |
55 http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. |
84 .TP |
56 .TP 2 |
85 -pluginpath \fIplugins\fR |
57 o |
86 .br |
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 |
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\&. |
59 .na |
88 .TP |
60 \f2JMX Monitoring and Management\fP @ |
89 -version |
61 .fi |
90 .br |
62 http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. |
91 Displays release information and exits\&. |
63 .TP 2 |
92 .TP |
64 o |
93 -help |
65 \f2jmxUrl\fP Address of the JMX agent to be connected to as described in |
94 .br |
66 .na |
95 Displays a help message\&. |
67 \f2JMXServiceURL\fP @ |
96 .TP |
68 .fi |
97 -J\fIflag\fR |
69 http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. |
98 .br |
|
99 Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. |
|
100 .SH SEE\ ALSO |
|
101 .TP 0.2i |
|
102 \(bu |
|
103 Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html |
|
104 .TP 0.2i |
|
105 \(bu |
|
106 Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html |
|
107 .TP 0.2i |
|
108 \(bu |
|
109 The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html |
70 .RE |
110 .RE |
71 .RE |
|
72 |
|
73 .LP |
|
74 .SH "DESCRIPTION" |
|
75 .LP |
|
76 .LP |
|
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. |
|
78 .LP |
|
79 .LP |
|
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. |
|
81 .LP |
|
82 .SH "OPTIONS" |
|
83 .LP |
|
84 .RS 3 |
|
85 .TP 3 |
|
86 \-interval=n |
|
87 Set the update interval to \f2n\fP seconds (default is 4 seconds). |
|
88 .TP 3 |
|
89 \-notile |
|
90 Do not tile windows initially (for two or more connections). |
|
91 .TP 3 |
|
92 \-pluginpath plugins |
|
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: |
|
94 .br |
111 .br |
95 .nf |
112 'pl 8.5i |
96 \f3 |
113 'bp |
97 .fl |
|
98 META\-INF/services/com.sun.tools.jconsole.JConsolePlugin |
|
99 .fl |
|
100 \fP |
|
101 .fi |
|
102 containing one line for each plugin specifying the fully qualified class name of the class implementing the |
|
103 .na |
|
104 \f2com.sun.tools.jconsole.JConsolePlugin\fP @ |
|
105 .fi |
|
106 http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. |
|
107 .TP 3 |
|
108 \-version |
|
109 Output version information and exit. |
|
110 .TP 3 |
|
111 \-help |
|
112 Output help message and exit. |
|
113 .TP 3 |
|
114 \-J<flag> |
|
115 Pass <flag> to the Java virtual machine on which jconsole is run. |
|
116 .RE |
|
117 |
|
118 .LP |
|
119 .SH "SEE ALSO" |
|
120 .LP |
|
121 .RS 3 |
|
122 .TP 2 |
|
123 o |
|
124 .na |
|
125 \f2Using JConsole\fP @ |
|
126 .fi |
|
127 http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html |
|
128 .TP 2 |
|
129 o |
|
130 .na |
|
131 \f2Monitoring and Management for Java Platform\fP @ |
|
132 .fi |
|
133 http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html |
|
134 .RE |
|
135 |
|
136 .LP |
|
137 |
|