annotate src/bsd/doc/man/jinfo.1 @ 2640:9282f04c3555

. Make changes to the BSD man pages identical to those made to the Linux man pages.
author Greg Lewis <glewis@eyesbeyond.com>
date Sat, 17 Jul 2010 18:02:36 -0700
parents 8356c7fa1a33
children 2d3bbea20640
rev   line source
glewis@2640 1 ." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
mr@489 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mr@489 3 ."
mr@489 4 ." This code is free software; you can redistribute it and/or modify it
mr@489 5 ." under the terms of the GNU General Public License version 2 only, as
mr@489 6 ." published by the Free Software Foundation.
mr@489 7 ."
mr@489 8 ." This code is distributed in the hope that it will be useful, but WITHOUT
mr@489 9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mr@489 10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
mr@489 11 ." version 2 for more details (a copy is included in the LICENSE file that
mr@489 12 ." accompanied this code).
mr@489 13 ."
mr@489 14 ." You should have received a copy of the GNU General Public License version
mr@489 15 ." 2 along with this work; if not, write to the Free Software Foundation,
mr@489 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mr@489 17 ."
glewis@2552 18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
glewis@2552 19 ." or visit www.oracle.com if you need additional information or have any
glewis@2552 20 ." questions.
mr@489 21 ."
glewis@2640 22 .TH jinfo 1 "02 Jun 2010"
mr@489 23
mr@489 24 .LP
kurt@1245 25 .SH "Name"
mr@489 26 jinfo \- Configuration Info
mr@489 27 .LP
mr@489 28 .SH "SYNOPSIS"
mr@489 29 .LP
mr@489 30
mr@489 31 .LP
mr@489 32 .nf
mr@489 33 \f3
mr@489 34 .fl
mr@489 35 \fP\f3jinfo\fP [ option ] pid
mr@489 36 .fl
mr@489 37 \f3jinfo\fP [ option ] executable core
mr@489 38 .fl
mr@489 39 \f3jinfo\fP [ option ] [server\-id@]remote\-hostname\-or\-IP
mr@489 40 .fl
mr@489 41 .fi
mr@489 42
mr@489 43 .LP
mr@489 44 .SH "PARAMETERS"
mr@489 45 .LP
mr@489 46
mr@489 47 .LP
kurt@1245 48 .RS 3
mr@489 49 .TP 3
mr@489 50 option
mr@489 51 Options are mutually exclusive. Option, if used, should follow immediately after the command name.
kurt@1245 52 .RS 3
mr@489 53 .TP 3
mr@489 54 pid
kurt@1245 55 process id for which the configuration info is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used.
kurt@1245 56 .RE
kurt@1245 57 .RS 3
mr@489 58 .TP 3
mr@489 59 executable
kurt@1245 60 Java executable from which the core dump was produced.
kurt@1245 61 .RE
kurt@1245 62 .RS 3
mr@489 63 .TP 3
mr@489 64 core
kurt@1245 65 core file for which the configuration info is to be printed.
kurt@1245 66 .RE
kurt@1245 67 .RS 3
mr@489 68 .TP 3
mr@489 69 remote\-hostname\-or\-IP
kurt@1245 70 remote debug server's (see jsadebugd(1)) hostname or IP address.
kurt@1245 71 .RE
kurt@1245 72 .RS 3
mr@489 73 .TP 3
mr@489 74 server\-id
kurt@1245 75 optional unique id, if multiple debug servers are running on the same remote host.
kurt@1245 76 .RE
kurt@1245 77 .RE
kurt@1245 78
mr@489 79 .LP
mr@489 80 .SH "DESCRIPTION"
mr@489 81 .LP
mr@489 82
mr@489 83 .LP
mr@489 84 .LP
mr@489 85 \f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
mr@489 86 .br
mr@489 87
mr@489 88 .LP
mr@489 89 .RS 3
mr@489 90
mr@489 91 .LP
mr@489 92 jinfo \-J\-d64 \-sysprops pid
mr@489 93 .RE
mr@489 94 .LP
kurt@1245 95 \f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
kurt@1245 96 .LP
kurt@1245 97 .LP
kurt@1245 98 \f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
mr@489 99 .LP
mr@489 100 .SH "OPTIONS"
mr@489 101 .LP
mr@489 102
mr@489 103 .LP
kurt@1245 104 .RS 3
mr@489 105 .TP 3
mr@489 106 <no option>
mr@489 107 prints both command line flags as well as System properties name, value pairs.
mr@489 108 .br
mr@489 109 .TP 3
mr@489 110 \-flag name
mr@489 111 prints the name and value of the given command line flag.
mr@489 112 .br
mr@489 113 .TP 3
mr@489 114 \-flag [+|\-]name
mr@489 115 enables or disables the given boolean command line flag.
mr@489 116 .br
mr@489 117 .TP 3
mr@489 118 \-flag name=value
mr@489 119 sets the given command line flag to the specified value.
mr@489 120 .br
mr@489 121 .TP 3
mr@489 122 \-flags
mr@489 123 prints command line flags passed to the JVM. pairs.
mr@489 124 .br
mr@489 125 .TP 3
mr@489 126 \-sysprops
mr@489 127 prints Java System properties as name, value pairs.
mr@489 128 .br
mr@489 129 .TP 3
mr@489 130 \-h
mr@489 131 prints a help message
mr@489 132 .TP 3
mr@489 133 \-help
mr@489 134 prints a help message
kurt@1245 135 .RE
kurt@1245 136
mr@489 137 .LP
mr@489 138 .SH "SEE ALSO"
mr@489 139 .LP
mr@489 140 .RS 3
mr@489 141 .TP 2
kurt@1245 142 o
kurt@1245 143 jps(1)
mr@489 144 .TP 2
kurt@1245 145 o
kurt@1245 146 jsadebugd(1)
mr@489 147 .RE
mr@489 148
mr@489 149 .LP
mr@489 150