4632N/A." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
4632N/A." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4632N/A."
4632N/A." This code is free software; you can redistribute it and/or modify it
4632N/A." under the terms of the GNU General Public License version 2 only, as
4632N/A." published by the Free Software Foundation.
4632N/A."
4632N/A." This code is distributed in the hope that it will be useful, but WITHOUT
4632N/A." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4632N/A." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4632N/A." version 2 for more details (a copy is included in the LICENSE file that
4632N/A." accompanied this code).
4632N/A."
4632N/A." You should have received a copy of the GNU General Public License version
4632N/A." 2 along with this work; if not, write to the Free Software Foundation,
4632N/A." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
4632N/A."
4632N/A." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
4632N/A." or visit www.oracle.com if you need additional information or have any
4632N/A." questions.
4632N/A."
4632N/A.TH jps 1 "10 May 2011"
4632N/A
4632N/A.LP
4632N/A.SH "Name"
4632N/Ajps \- Java Virtual Machine Process Status Tool
4632N/A.LP
4632N/A.SH "SYNOPSIS"
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/A\fP\f3jps\fP [ \f2options\fP ] [ \f2hostid\fP ]
4632N/A.br
4632N/A
4632N/A.fl
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.SH "PARAMETERS"
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/Aoptions
4632N/ACommand\-line options.
4632N/A.TP 3
4632N/Ahostid
4632N/AThe host identifier of the host for which the process report should be generated. The \f2hostid\fP may include optional components that indicate the communications protocol, port number, and other implementation specific data.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SH "DESCRIPTION"
4632N/A.LP
4632N/A.LP
4632N/AThe \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions.
4632N/A.LP
4632N/A.LP
4632N/AIf \f3jps\fP is run without specifying a \f2hostid\fP, it will look for instrumented JVMs on the local host. If started with a \f2hostid\fP, it will look for JVMs on the indicated host, using the specified protocol and port. A \f3jstatd\fP process is assumed to be running on the target host.
4632N/A.LP
4632N/A.LP
4632N/AThe \f3jps\fP command will report the local VM identifier, or \f2lvmid\fP, for each instrumented JVM found on the target system. The \f3lvmid\fP is typically, but not necessarily, the operating system's process identifier for the JVM process. With no options, \f3jps\fP will list each Java application's \f2lvmid\fP followed by the short form of the application's class name or jar file name. The short form of the class name or JAR file name omits the class's package information or the JAR files path information.
4632N/A.LP
4632N/A.LP
4632N/AThe \f3jps\fP command uses the \f3java\fP launcher to find the class name and arguments passed to the \f2main\fP method. If the target JVM is started with a custom launcher, the class name (or JAR file name) and the arguments to the \f2main\fP method will not be available. In this case, the \f3jps\fP command will output the string \f2Unknown\fP for the class name or JAR file name and for the arguments to the main method.
4632N/A.LP
4632N/A.LP
4632N/AThe list of JVMs produced by the \f3jps\fP command may be limited by the permissions granted to the principal running the command. The command will only list the JVMs for which the principle has access rights as determined by operating system specific access control mechanisms.
4632N/A.LP
4632N/A.LP
4632N/A\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms.
4632N/A.LP
4632N/A.SH "OPTIONS"
4632N/A.LP
4632N/A.LP
4632N/AThe \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future.
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-q
4632N/ASuppress the output of the class name, JAR file name, and arguments passed to the \f2main\fP method, producing only a list of local VM identifiers.
4632N/A.TP 3
4632N/A\-m
4632N/AOutput the arguments passed to the main method. The output may be null for embedded JVMs.
4632N/A.TP 3
4632N/A\-l
4632N/AOutput the full package name for the application's main class or the full path name to the application's JAR file.
4632N/A.TP 3
4632N/A\-v
4632N/AOutput the arguments passed to the JVM.
4632N/A.TP 3
4632N/A\-V
4632N/AOutput the arguments passed to the JVM through the flags file (the .hotspotrc file or the file specified by the \-XX:Flags=<\f2filename\fP> argument).
4632N/A.TP 3
4632N/A\-Joption
4632N/APass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SS
4632N/AHOST IDENTIFIER
4632N/A.LP
4632N/A.LP
4632N/AThe host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI:
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/A[\fP\f4protocol\fP\f3:][[//]\fP\f4hostname\fP\f3][:\fP\f4port\fP\f3][/\fP\f4servername\fP\f3]\fP
4632N/A.br
4632N/A\f3
4632N/A.fl
4632N/A\fP
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/Aprotocol
4632N/AThe communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific, optimized, local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP.
4632N/A.TP 3
4632N/Ahostname
4632N/AA hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host.
4632N/A.TP 3
4632N/Aport
4632N/AThe default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used.
4632N/A.TP 3
4632N/Aservername
4632N/AThe treatment of this parameter depends on the implementation. For the optimized, local protocol, this field is ignored. For the \f3rmi\fP protocol, this parameter is a string representing the name of the RMI remote object on the remote host. See the \f3\-n\fP option for the jstatd(1) command.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SH "OUTPUT FORMAT"
4632N/A.LP
4632N/A.LP
4632N/AThe output of the \f3jps\fP command follows the following pattern:
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/A\fP\f4lvmid\fP\f3 [ [ \fP\f4classname\fP\f3 | \fP\f4JARfilename\fP\f3 | "Unknown"] [ \fP\f4arg\fP\f3* ] [ \fP\f4jvmarg\fP\f3* ] ]\fP
4632N/A.br
4632N/A\f3
4632N/A.fl
4632N/A\fP
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.LP
4632N/AWhere all output tokens are separated by white space. An \f2arg\fP that includes embedded white space will introduce ambiguity when attempting to map arguments to their actual positional parameters.
4632N/A.br
4632N/A.br
4632N/A\f3NOTE\fP: You are advised not to write scripts to parse \f3jps\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jps\fP output, expect to modify them for future releases of this tool.
4632N/A.br
4632N/A
4632N/A.LP
4632N/A.SH "EXAMPLES"
4632N/A.LP
4632N/A.LP
4632N/AThis section provides examples of the \f3jps\fP command.
4632N/A.LP
4632N/A.LP
4632N/AListing the instrumented JVMs on the local host:
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/A\fP\f3jps\fP
4632N/A.br
4632N/A
4632N/A.fl
4632N/A18027 Java2Demo.JAR
4632N/A.br
4632N/A
4632N/A.fl
4632N/A18032 jps
4632N/A.br
4632N/A
4632N/A.fl
4632N/A18005 jstat
4632N/A.br
4632N/A
4632N/A.fl
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.LP
4632N/AListing the instrumented JVMs on a remote host:
4632N/A.LP
4632N/A.LP
4632N/AThis example assumes that the \f3jstat\fP server and either the its internal RMI registry or a separate external \f3rmiregistry\fP process are running on the remote host on the default port (port 1099). It also assumes that the local host has appropriate permissions to access the remote host. This example also includes the \f2\-l\fP option to output the long form of the class names or JAR file names.
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/A\fP\f3jps \-l remote.domain\fP
4632N/A.br
4632N/A
4632N/A.fl
4632N/A3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR
4632N/A.br
4632N/A
4632N/A.fl
4632N/A2857 sun.tools.jstatd.jstatd
4632N/A.br
4632N/A
4632N/A.fl
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.LP
4632N/AListing the instrumented JVMs on a remote host with a non\-default port for the RMI registry
4632N/A.LP
4632N/A.LP
4632N/AThis example assumes that the \f3jstatd\fP server, with an internal RMI registry bound to port 2002, is running on the remote host. This example also uses the \f2\-m\fP option to include the arguments passed to the \f2main\fP method of each of the listed Java applications.
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/A\fP\f3jps \-m remote.domain:2002\fP
4632N/A.br
4632N/A
4632N/A.fl
4632N/A3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR
4632N/A.br
4632N/A
4632N/A.fl
4632N/A3102 sun.tools.jstatd.jstatd \-p 2002
4632N/A.fl
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.SH "SEE ALSO"
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 2
4632N/Ao
4632N/Ajava(1) \- the Java Application Launcher
4632N/A.TP 2
4632N/Ao
4632N/Ajstat(1) \- the Java virtual machine Statistics Monitoring Tool
4632N/A.TP 2
4632N/Ao
4632N/Ajstatd(1) \- the jstat daemon
4632N/A.TP 2
4632N/Ao
4632N/Armiregistry(1) \- the Java Remote Object Registry
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A