< prev index next >

src/jdk.jconsole/share/man/jconsole.1

Print this page


   1 .\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.

   2 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 .\"
   4 .\" This code is free software; you can redistribute it and/or modify it
   5 .\" under the terms of the GNU General Public License version 2 only, as
   6 .\" published by the Free Software Foundation.
   7 .\"
   8 .\" This code is distributed in the hope that it will be useful, but WITHOUT
   9 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 .\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11 .\" version 2 for more details (a copy is included in the LICENSE file that
  12 .\" accompanied this code).
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License version
  15 .\" 2 along with this work; if not, write to the Free Software Foundation,
  16 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  17 .\"
  18 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  19 .\" or visit www.oracle.com if you need additional information or have any
  20 .\" questions.
  21 .\"
  22 .\" Automatically generated by Pandoc 2.3.1
  23 .\"
  24 .TH "JCONSOLE" "1" "2018" "JDK 13" "JDK Commands"
  25 .hy
  26 .SH NAME
  27 .PP
  28 jconsole \- start a graphical console to monitor and manage Java
  29 applications
  30 .SH SYNOPSIS
  31 .PP
  32 \f[CB]jconsole\f[R] [\f[CB]\-interval=\f[R]\f[I]n\f[R]] [\f[CB]\-notile\f[R]]
  33 [\f[CB]\-plugin\f[R] \f[I]path\f[R]] [\f[CB]\-version\f[R]]
  34 [\f[I]connection\f[R] ...
  35 ] [\f[CB]\-J\f[R]\f[I]input_arguments\f[R]]



































  36 .PP
  37 \f[CB]jconsole\f[R] \f[CB]\-help\f[R]
  38 .SH OPTIONS
  39 .TP
  40 .B \f[CB]\-interval\f[R]
  41 Sets the update interval to \f[CB]n\f[R] seconds (default is 4 seconds).
  42 .RS
  43 .RE
  44 .TP
  45 .B \f[CB]\-notile\f[R]
  46 Doesn\[aq]t tile the windows for two or more connections.
  47 .RS
  48 .RE
  49 .TP
  50 .B \f[CB]\-pluginpath\f[R] \f[I]path\f[R]
  51 Specifies the path that \f[CB]jconsole\f[R] uses to look up plug\-ins.
  52 The plug\-in \f[I]path\f[R] should contain a provider\-configuration file
  53 named \f[CB]META\-INF/services/com.sun.tools.jconsole.JConsolePlugin\f[R]
  54 that contains one line for each plug\-in.
  55 The line specifies the fully qualified class name of the class
  56 implementing the \f[CB]com.sun.tools.jconsole.JConsolePlugin\f[R] class.
  57 .RS
  58 .RE
  59 .TP
  60 .B \f[CB]\-version\f[R]
  61 Prints the program version.
  62 .RS
  63 .RE
  64 .TP
  65 .B \f[I]connection\f[R] = \f[I]pid\f[R] | \f[I]host\f[R]\f[CB]:\f[R]\f[I]port\f[R] | \f[I]jmxURL\f[R]
  66 A connection is described by either \f[I]pid\f[R],
  67 \f[I]host\f[R]\f[CB]:\f[R]\f[I]port\f[R] or \f[I]jmxURL\f[R].
  68 .RS
  69 .IP \[bu] 2
  70 The \f[I]pid\f[R] value is the process ID of a target process.
  71 The JVM must be running with the same user ID as the user ID running the
  72 \f[CB]jconsole\f[R] command.
  73 .IP \[bu] 2
  74 The \f[I]host\f[R]\f[CB]:\f[R]\f[I]port\f[R] values are the name of the host
  75 system on which the JVM is running, and the port number specified by the
  76 system property \f[CB]com.sun.management.jmxremote.port\f[R] when the JVM
  77 was started.
  78 .IP \[bu] 2
  79 The \f[I]jmxUrl\f[R] value is the address of the JMX agent to be
  80 connected to as described in JMXServiceURL.
  81 .RE
  82 .TP
  83 .B \f[CB]\-J\f[R]\f[I]input_arguments\f[R]
  84 Passes \f[I]input_arguments\f[R] to the JVM on which the
  85 \f[CB]jconsole\f[R] command is run.
  86 .RS
  87 .RE
  88 .TP
  89 .B \f[CB]\-help\f[R] or \f[CB]\-\-help\f[R]
  90 Displays the help message for the command.
  91 .RS
  92 .RE
  93 .SH DESCRIPTION
  94 .PP
  95 The \f[CB]jconsole\f[R] command starts a graphical console tool that lets
  96 you monitor and manage Java applications and virtual machines on a local
  97 or remote machine.
  98 .PP
  99 On Windows, the \f[CB]jconsole\f[R] command doesn\[aq]t associate with a
 100 console window.
 101 It does, however, display a dialog box with error information when the
 102 \f[CB]jconsole\f[R] command fails.
   1 '\" t
   2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
   3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 .\"
   5 .\" This code is free software; you can redistribute it and/or modify it
   6 .\" under the terms of the GNU General Public License version 2 only, as
   7 .\" published by the Free Software Foundation.
   8 .\"
   9 .\" This code is distributed in the hope that it will be useful, but WITHOUT
  10 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 .\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 .\" version 2 for more details (a copy is included in the LICENSE file that
  13 .\" accompanied this code).
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License version
  16 .\" 2 along with this work; if not, write to the Free Software Foundation,
  17 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18 .\"
  19 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20 .\" or visit www.oracle.com if you need additional information or have any
  21 .\" questions.
  22 .\"
  23 .\"     Arch: generic
  24 .\"     Software: JDK 8
  25 .\"     Date: 21 November 2013
  26 .\"     SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools
  27 .\"     Title: jconsole.1
  28 .\"
  29 .if n .pl 99999
  30 .TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools"
  31 .\" -----------------------------------------------------------------
  32 .\" * Define some portability stuff
  33 .\" -----------------------------------------------------------------
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .\" http://bugs.debian.org/507673
  36 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  37 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  38 .ie \n(.g .ds Aq \(aq
  39 .el       .ds Aq '
  40 .\" -----------------------------------------------------------------
  41 .\" * set default formatting
  42 .\" -----------------------------------------------------------------
  43 .\" disable hyphenation
  44 .nh
  45 .\" disable justification (adjust text to left margin only)
  46 .ad l
  47 .\" -----------------------------------------------------------------
  48 .\" * MAIN CONTENT STARTS HERE *
  49 .\" -----------------------------------------------------------------
  50 
  51 .SH NAME    
  52 jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&.
  53 .SH SYNOPSIS    
  54 .sp     
  55 .nf     
  56 
  57 \fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ]
  58 .fi     
  59 .sp     
  60 .TP     
  61 \fIoptions\fR
  62 The command-line options\&. See Options\&.
  63 .TP     
  64 connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR
  65 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\&.
  66 
  67 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
  68 
  69 See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html
  70 .SH DESCRIPTION    
  71 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\&.
  72 .PP
  73 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\&.
  74 .SH OPTIONS    




















  75 .TP
  76 -interval\fI=n\fR
  77 .br
  78 Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&.
  79 .TP
  80 -notile
  81 .br
  82 Does not tile windows initially (for two or more connections)\&.
  83 .TP
  84 -pluginpath \fIplugins\fR
  85 .br
  86 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\&.
  87 .TP
  88 -version
  89 .br
  90 Displays release information and exits\&.
  91 .TP
  92 -help
  93 .br
  94 Displays a help message\&.
  95 .TP
  96 -J\fIflag\fR
  97 .br
  98 Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&.
  99 .SH SEE\ ALSO    
 100 .TP 0.2i    
 101 \(bu
 102 Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html
 103 .TP 0.2i    
 104 \(bu
 105 Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html
 106 .TP 0.2i    
 107 \(bu
 108 The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html
 109 .RE
 110 .br
 111 'pl 8.5i
 112 'bp






< prev index next >