< prev index next >

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

Print this page

        

@@ -1,6 +1,7 @@
-.\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
+'\" t
+.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 .\"
 .\" This code is free software; you can redistribute it and/or modify it
 .\" under the terms of the GNU General Public License version 2 only, as
 .\" published by the Free Software Foundation.

@@ -17,86 +18,95 @@
 .\"
 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 .\" or visit www.oracle.com if you need additional information or have any
 .\" questions.
 .\"
-.\" Automatically generated by Pandoc 2.3.1
-.\"
-.TH "JCONSOLE" "1" "2018" "JDK 13" "JDK Commands"
-.hy
-.SH NAME
-.PP
-jconsole \- start a graphical console to monitor and manage Java
-applications
-.SH SYNOPSIS
-.PP
-\f[CB]jconsole\f[R] [\f[CB]\-interval=\f[R]\f[I]n\f[R]] [\f[CB]\-notile\f[R]]
-[\f[CB]\-plugin\f[R] \f[I]path\f[R]] [\f[CB]\-version\f[R]]
-[\f[I]connection\f[R] ...
-] [\f[CB]\-J\f[R]\f[I]input_arguments\f[R]]
+.\"     Arch: generic
+.\"     Software: JDK 8
+.\"     Date: 21 November 2013
+.\"     SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools
+.\"     Title: jconsole.1
+.\"
+.if n .pl 99999
+.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+
+.SH NAME    
+jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&.
+.SH SYNOPSIS    
+.sp     
+.nf     
+
+\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ]
+.fi     
+.sp     
+.TP     
+\fIoptions\fR
+The command-line options\&. See Options\&.
+.TP     
+connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR
+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\&.
+
+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
+
+See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html
+.SH DESCRIPTION    
+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\&.
 .PP
-\f[CB]jconsole\f[R] \f[CB]\-help\f[R]
-.SH OPTIONS
-.TP
-.B \f[CB]\-interval\f[R]
-Sets the update interval to \f[CB]n\f[R] seconds (default is 4 seconds).
-.RS
-.RE
-.TP
-.B \f[CB]\-notile\f[R]
-Doesn\[aq]t tile the windows for two or more connections.
-.RS
-.RE
-.TP
-.B \f[CB]\-pluginpath\f[R] \f[I]path\f[R]
-Specifies the path that \f[CB]jconsole\f[R] uses to look up plug\-ins.
-The plug\-in \f[I]path\f[R] should contain a provider\-configuration file
-named \f[CB]META\-INF/services/com.sun.tools.jconsole.JConsolePlugin\f[R]
-that contains one line for each plug\-in.
-The line specifies the fully qualified class name of the class
-implementing the \f[CB]com.sun.tools.jconsole.JConsolePlugin\f[R] class.
-.RS
-.RE
+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\&.
+.SH OPTIONS    
 .TP
-.B \f[CB]\-version\f[R]
-Prints the program version.
-.RS
-.RE
-.TP
-.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]
-A connection is described by either \f[I]pid\f[R],
-\f[I]host\f[R]\f[CB]:\f[R]\f[I]port\f[R] or \f[I]jmxURL\f[R].
-.RS
-.IP \[bu] 2
-The \f[I]pid\f[R] value is the process ID of a target process.
-The JVM must be running with the same user ID as the user ID running the
-\f[CB]jconsole\f[R] command.
-.IP \[bu] 2
-The \f[I]host\f[R]\f[CB]:\f[R]\f[I]port\f[R] values are the name of the host
-system on which the JVM is running, and the port number specified by the
-system property \f[CB]com.sun.management.jmxremote.port\f[R] when the JVM
-was started.
-.IP \[bu] 2
-The \f[I]jmxUrl\f[R] value is the address of the JMX agent to be
-connected to as described in JMXServiceURL.
-.RE
-.TP
-.B \f[CB]\-J\f[R]\f[I]input_arguments\f[R]
-Passes \f[I]input_arguments\f[R] to the JVM on which the
-\f[CB]jconsole\f[R] command is run.
-.RS
-.RE
-.TP
-.B \f[CB]\-help\f[R] or \f[CB]\-\-help\f[R]
-Displays the help message for the command.
-.RS
-.RE
-.SH DESCRIPTION
-.PP
-The \f[CB]jconsole\f[R] command starts a graphical console tool that lets
-you monitor and manage Java applications and virtual machines on a local
-or remote machine.
-.PP
-On Windows, the \f[CB]jconsole\f[R] command doesn\[aq]t associate with a
-console window.
-It does, however, display a dialog box with error information when the
-\f[CB]jconsole\f[R] command fails.
+-interval\fI=n\fR
+.br
+Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&.
+.TP
+-notile
+.br
+Does not tile windows initially (for two or more connections)\&.
+.TP
+-pluginpath \fIplugins\fR
+.br
+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\&.
+.TP
+-version
+.br
+Displays release information and exits\&.
+.TP
+-help
+.br
+Displays a help message\&.
+.TP
+-J\fIflag\fR
+.br
+Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&.
+.SH SEE\ ALSO    
+.TP 0.2i    
+\(bu
+Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html
+.TP 0.2i    
+\(bu
+Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html
+.TP 0.2i    
+\(bu
+The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html
+.RE
+.br
+'pl 8.5i
+'bp
< prev index next >