8240777: Update all nroff manpages for JDK 15 release

Reviewed-by: dholmes
This commit is contained in:
Pavel Rappo 2020-07-24 17:06:35 +01:00
parent 8a9d2b08a0
commit 922ba8da30
29 changed files with 486 additions and 436 deletions

View file

@ -22,7 +22,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVA" "1" "2020" "JDK 14" "JDK Commands"
.TH "JAVA" "1" "2020" "JDK 15" "JDK Commands"
.hy
.SH NAME
.PP
@ -180,9 +180,10 @@ API that was defined in JDK \f[I]N\f[R].
with new values added and old values removed.
You\[aq]ll get an error message if you use a value of \f[I]N\f[R] that is
no longer supported.
Supported values of \f[I]N\f[R] for this release are \f[CB]7\f[R],
\f[CB]8\f[R], \f[CB]9\f[R], \f[CB]10\f[R], \f[CB]11\f[R], \f[CB]12\f[R],
\f[CB]13\f[R], and \f[CB]14\f[R].
The supported values of \f[I]N\f[R] are the current Java SE release
(\f[CB]15\f[R]) and a limited number of previous releases, detailed in the
command\-line help for \f[CB]javac\f[R], under the \f[CB]\-\-source\f[R] and
\f[CB]\-\-release\f[R] options.
.RE
.PP
If the file does not have the \f[CB]\&.java\f[R] extension, the
@ -437,9 +438,9 @@ After the library name, a comma\-separated list of options specific to
the library can be used.
.RS
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] If the option
\f[CB]\-agentlib:foo\f[R] is specified, then the JVM attempts to load the
library named \f[CB]libfoo.so\f[R] in the location specified by the
\f[B]Linux and macOS:\f[R] If the option \f[CB]\-agentlib:foo\f[R] is
specified, then the JVM attempts to load the library named
\f[CB]libfoo.so\f[R] in the location specified by the
\f[CB]LD_LIBRARY_PATH\f[R] system variable (on macOS this variable is
\f[CB]DYLD_LIBRARY_PATH\f[R]).
.IP \[bu] 2
@ -784,8 +785,8 @@ Specifies a list of directories, JAR files, and ZIP archives to append
to the end of the default bootstrap class path.
.RS
.PP
\f[B]Oracle Solaris, Linux, and macOS:\f[R] Colons (\f[CB]:\f[R]) separate
entities in this list.
\f[B]Linux and macOS:\f[R] Colons (\f[CB]:\f[R]) separate entities in this
list.
.PP
\f[B]Windows:\f[R] Semicolons (\f[CB];\f[R]) separate entities in this
list.
@ -948,7 +949,7 @@ running user cleanup code (such as closing database connections) at
shutdown, even if the JVM terminates abruptly.
.RS
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R]
\f[B]Linux and macOS:\f[R]
.RS 2
.IP \[bu] 2
The JVM catches signals to implement shutdown hooks for unexpected
@ -994,8 +995,8 @@ process \f[CB]CTRL_C_EVENT\f[R], \f[CB]CTRL_CLOSE_EVENT\f[R],
.PP
There are two consequences of specifying \f[CB]\-Xrs\f[R]:
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] \f[CB]SIGQUIT\f[R] thread dumps
aren\[aq]t available.
\f[B]Linux and macOS:\f[R] \f[CB]SIGQUIT\f[R] thread dumps aren\[aq]t
available.
.IP \[bu] 2
\f[B]Windows:\f[R] Ctrl + Break thread dumps aren\[aq]t available.
.PP
@ -1082,8 +1083,6 @@ Linux/x64 (64\-bit): 1024 KB
.IP \[bu] 2
macOS (64\-bit): 1024 KB
.IP \[bu] 2
Oracle Solaris (64\-bit): 1024 KB
.IP \[bu] 2
Windows: The default value depends on virtual memory
.PP
The following examples set the thread stack size to 1024 KB in different
@ -1334,8 +1333,8 @@ the identifier of the process is specified as \f[CB]%p\f[R]):
\f[CB]\-XX:ErrorFile=./hs_err_pid%p.log\f[R]
.RE
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] The following example shows
how to set the error log to \f[CB]/var/log/java/java_error.log\f[R]:
\f[B]Linux and macOS:\f[R] The following example shows how to set the
error log to \f[CB]/var/log/java/java_error.log\f[R]:
.RS 2
.RS
.PP
@ -1357,8 +1356,7 @@ Otherwise, if the file can\[aq]t be created in the specified directory
(due to insufficient space, permission problem, or another issue), then
the file is created in the temporary directory for the operating system:
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] The temporary directory is
\f[CB]/tmp\f[R].
\f[B]Linux and macOS:\f[R] The temporary directory is \f[CB]/tmp\f[R].
.IP \[bu] 2
\f[B]Windows:\f[R] The temporary directory is specified by the value of
the \f[CB]TMP\f[R] environment variable; if that environment variable
@ -1579,12 +1577,11 @@ If the string contains spaces, then it must be enclosed in quotation
marks.
.RS
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] The following example shows
how the \f[CB]\-XX:OnError\f[R] option can be used to run the
\f[CB]gcore\f[R] command to create a core image, and start the
\f[CB]gdb\f[R] debugger to attach to the process in case of an
irrecoverable error (the \f[CB]%p\f[R] designates the current process
identifier):
\f[B]Linux and macOS:\f[R] The following example shows how the
\f[CB]\-XX:OnError\f[R] option can be used to run the \f[CB]gcore\f[R]
command to create a core image, and start the \f[CB]gdb\f[R] debugger to
attach to the process in case of an irrecoverable error (the \f[CB]%p\f[R]
designates the current process identifier):
.RS 2
.RS
.PP
@ -1691,7 +1688,7 @@ source with a null\-detail message.
The null\-detail message is calculated and returned by
\f[CB]NullPointerException.getMessage()\f[R], and will be printed as the
exception message along with the method, filename, and line number.
By default, this option is disabled.
By default, this option is enabled.
.RS
.RE
.TP
@ -1839,8 +1836,6 @@ Linux/x64 (64\-bit): 1024 KB
.IP \[bu] 2
macOS (64\-bit): 1024 KB
.IP \[bu] 2
Oracle Solaris (64\-bit): 1024 KB
.IP \[bu] 2
Windows: The default value depends on virtual memory
.PP
The following examples show how to set the thread stack size to 1
@ -1856,17 +1851,6 @@ megabyte in different units:
This option is similar to \f[CB]\-Xss\f[R].
.RE
.TP
.B \f[CB]\-XX:\-UseBiasedLocking\f[R]
Disables the use of biased locking.
Some applications with significant amounts of uncontended
synchronization may attain significant speedups with this flag enabled,
but applications with certain patterns of locking may see slowdowns.
\&.
.RS
.PP
By default, this option is enabled.
.RE
.TP
.B \f[CB]\-XX:\-UseCompressedOops\f[R]
Disables the use of compressed pointers.
By default, this option is enabled, and compressed pointers are used.
@ -2362,6 +2346,7 @@ To disable method inlining, specify \f[CB]\-XX:\-Inline\f[R].
.B \f[CB]\-XX:InlineSmallCode=\f[R]\f[I]size\f[R]
Sets the maximum code size (in bytes) for already compiled methods that
may be inlined.
This flag only applies to the C2 compiler.
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
\f[CB]G\f[R] to indicate gigabytes.
@ -2395,6 +2380,7 @@ console every time a method is compiled by using the
.TP
.B \f[CB]\-XX:FreqInlineSize=\f[R]\f[I]size\f[R]
Sets the maximum bytecode size (in bytes) of a hot method to be inlined.
This flag only applies to the C2 compiler.
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
\f[CB]G\f[R] to indicate gigabytes.
@ -2410,6 +2396,22 @@ In the following example it is set to 325 bytes:
.B \f[CB]\-XX:MaxInlineSize=\f[R]\f[I]size\f[R]
Sets the maximum bytecode size (in bytes) of a cold method to be
inlined.
This flag only applies to the C2 compiler.
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
\f[CB]G\f[R] to indicate gigabytes.
By default, the maximum bytecode size is set to 35 bytes:
.RS
.RS
.PP
\f[CB]\-XX:MaxInlineSize=35\f[R]
.RE
.RE
.TP
.B \f[CB]\-XX:C1MaxInlineSize=\f[R]\f[I]size\f[R]
Sets the maximum bytecode size (in bytes) of a cold method to be
inlined.
This flag only applies to the C1 compiler.
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
\f[CB]G\f[R] to indicate gigabytes.
@ -2424,6 +2426,23 @@ By default, the maximum bytecode size is set to 35 bytes:
.B \f[CB]\-XX:MaxTrivialSize=\f[R]\f[I]size\f[R]
Sets the maximum bytecode size (in bytes) of a trivial method to be
inlined.
This flag only applies to the C2 compiler.
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
\f[CB]G\f[R] to indicate gigabytes.
By default, the maximum bytecode size of a trivial method is set to 6
bytes:
.RS
.RS
.PP
\f[CB]\-XX:MaxTrivialSize=6\f[R]
.RE
.RE
.TP
.B \f[CB]\-XX:C1MaxTrivialSize=\f[R]\f[I]size\f[R]
Sets the maximum bytecode size (in bytes) of a trivial method to be
inlined.
This flag only applies to the C1 compiler.
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
\f[CB]G\f[R] to indicate gigabytes.
@ -2675,7 +2694,7 @@ Flags that control intrinsics now require the option
.TP
.B \f[CB]\-XX:+UseSHA\f[R]
Enables hardware\-based intrinsics for SHA crypto hash functions for
SPARC hardware.
some hardware.
The \f[CB]UseSHA\f[R] option is used in conjunction with the
\f[CB]UseSHA1Intrinsics\f[R], \f[CB]UseSHA256Intrinsics\f[R], and
\f[CB]UseSHA512Intrinsics\f[R] options.
@ -2817,7 +2836,7 @@ Default value is 1/10th of \f[CB]\-XX:LoopStripMiningIter\f[R].
.TP
.B \f[CB]\-XX:+UseFMA\f[R]
Enables hardware\-based FMA intrinsics for hardware where FMA
instructions are available (such as, Intel, SPARC, and ARM64).
instructions are available (such as, Intel and ARM64).
FMA intrinsics are generated for the
\f[CB]java.lang.Math.fma(\f[R]\f[I]a\f[R]\f[CB],\f[R] \f[I]b\f[R]\f[CB],\f[R]
\f[I]c\f[R]\f[CB])\f[R] methods that calculate the value of \f[CB](\f[R]
@ -2916,8 +2935,8 @@ different JDK version.
.RE
.TP
.B \f[CB]\-XX:+ExtendedDTraceProbes\f[R]
\f[B]Oracle Solaris, Linux, and macOS:\f[R] Enables additional
\f[CB]dtrace\f[R] tool probes that affect the performance.
\f[B]Linux and macOS:\f[R] Enables additional \f[CB]dtrace\f[R] tool probes
that affect the performance.
By default, this option is disabled and \f[CB]dtrace\f[R] performs only
standard probes.
.RS
@ -2949,9 +2968,8 @@ The following example shows how to set the default file explicitly
\f[CB]\-XX:HeapDumpPath=./java_pid%p.hprof\f[R]
.RE
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] The following example shows
how to set the heap dump file to
\f[CB]/var/log/java/java_heapdump.hprof\f[R]:
\f[B]Linux and macOS:\f[R] The following example shows how to set the
heap dump file to \f[CB]/var/log/java/java_heapdump.hprof\f[R]:
.RS 2
.RS
.PP
@ -2975,8 +2993,8 @@ By default, the file is created in the current working directory, and
it\[aq]s named \f[CB]hotspot.log\f[R].
.RS
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] The following example shows
how to set the log file to \f[CB]/var/log/java/hotspot.log\f[R]:
\f[B]Linux and macOS:\f[R] The following example shows how to set the log
file to \f[CB]/var/log/java/hotspot.log\f[R]:
.RS 2
.RS
.PP
@ -2999,7 +3017,7 @@ Enables printing of a class instance histogram after one of the
following events:
.RS
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] \f[CB]Control+Break\f[R]
\f[B]Linux and macOS:\f[R] \f[CB]Control+Break\f[R]
.IP \[bu] 2
\f[B]Windows:\f[R] \f[CB]Control+C\f[R] (\f[CB]SIGTERM\f[R])
.PP
@ -3015,7 +3033,7 @@ Enables printing of \f[CB]java.util.concurrent\f[R] locks after one of the
following events:
.RS
.IP \[bu] 2
\f[B]Oracle Solaris, Linux, and macOS:\f[R] \f[CB]Control+Break\f[R]
\f[B]Linux and macOS:\f[R] \f[CB]Control+Break\f[R]
.IP \[bu] 2
\f[B]Windows:\f[R] \f[CB]Control+C\f[R] (\f[CB]SIGTERM\f[R])
.PP
@ -3278,13 +3296,11 @@ amount of memory used for the Java heap:
.TP
.B \f[CB]\-XX:InitialSurvivorRatio=\f[R]\f[I]ratio\f[R]
Sets the initial survivor space ratio used by the throughput garbage
collector (which is enabled by the \f[CB]\-XX:+UseParallelGC\f[R] and/or
\f[CB]\-XX:+UseParallelOldGC\f[R] options).
collector (which is enabled by the \f[CB]\-XX:+UseParallelGC\f[R] option).
Adaptive sizing is enabled by default with the throughput garbage
collector by using the \f[CB]\-XX:+UseParallelGC\f[R] and
\f[CB]\-XX:+UseParallelOldGC\f[R] options, and the survivor space is
resized according to the application behavior, starting with the initial
value.
collector by using the \f[CB]\-XX:+UseParallelGC\f[R] option, and the
survivor space is resized according to the application behavior,
starting with the initial value.
If adaptive sizing is disabled (using the
\f[CB]\-XX:\-UseAdaptiveSizePolicy\f[R] option), then the
\f[CB]\-XX:SurvivorRatio\f[R] option should be used to set the size of the
@ -3811,8 +3827,6 @@ application by leveraging multiple processors.
.RS
.PP
By default, this option is disabled and the default collector is used.
If it\[aq]s enabled, then the \f[CB]\-XX:+UseParallelOldGC\f[R] option is
automatically enabled, unless you explicitly disable it.
.RE
.TP
.B \f[CB]\-XX:+UseSerialGC\f[R]
@ -3855,19 +3869,66 @@ To disable the use of TLABs, specify the option \f[CB]\-XX:\-UseTLAB\f[R].
.RE
.TP
.B \f[CB]\-XX:+UseZGC\f[R]
Enables the use of the Z garbage collector.
This garbage collector is best for providing lowest latency with large
Java heaps at some throughput cost.
This is an experimental garbage collector, you need to specify
\f[CB]\-XX:+UnlockExperimentalVMOptions\f[R] before \f[CB]\-XX:+UseZGC\f[R]
on the command line.
Enables the use of the Z garbage collector (ZGC).
This is a low latency garbage collector, providing max pause times of a
few milliseconds, at some throughput cost.
Pause times are independent of what heap size is used.
Supports heap sizes from 8MB to 16TB.
.RS
.PP
Example:
.RS
.PP
\f[CB]\-XX:+UnlockExperimentalVMOptions\ \-XX:+UseZGC\f[R]
.RE
.TP
.B \f[CB]\-XX:ZAllocationSpikeTolerance\f[R]=\f[I]factor\f[R]
Sets the allocation spike tolerance for ZGC.
By default, this option is set to 2.0.
This factor describes the level of allocation spikes to expect.
For example, using a factor of 3.0 means the current allocation rate can
be expected to triple at any time.
.RS
.RE
.TP
.B \f[CB]\-XX:ZCollectionInterval\f[R]=\f[I]seconds\f[R]
Sets the maximum interval (in seconds) between two GC cycles when using
ZGC.
By default, this option is set to 0 (disabled).
.RS
.RE
.TP
.B \f[CB]\-XX:ZFragmentationLimit\f[R]=\f[I]percent\f[R]
Sets the maximum acceptable heap fragmentation (in percent) for ZGC.
By default, this option is set to 25.
Using a lower value will cause the heap to be compacted more
aggressively, to reclaim more memory at the cost of using more CPU time.
.RS
.RE
.TP
.B \f[CB]\-XX:+ZProactive\f[R]
Enables proactive GC cycles when using ZGC.
By default, this option is enabled.
ZGC will start a proactive GC cycle if doing so is expected to have
minimal impact on the running application.
This is useful if the application is mostly idle or allocates very few
objects, but you still want to keep the heap size down and allow
reference processing to happen even when there are a lot of free space
on the heap.
.RS
.RE
.TP
.B \f[CB]\-XX:+ZUncommit\f[R]
Enables uncommitting of unused heap memory when using ZGC.
By default, this option is enabled.
Uncommitting unused heap memory will lower the memory footprint of the
JVM, and make that memory available for other processes to use.
.RS
.RE
.TP
.B \f[CB]\-XX:ZUncommitDelay\f[R]=\f[I]seconds\f[R]
Sets the amount of time (in seconds) that heap memory must have been
unused before being uncommitted.
By default, this option is set to 300 (5 minutes).
Committing and uncommitting memory are relatively expensive operations.
Using a lower value will cause heap memory to be uncommitted earlier, at
the risk of soon having to commit it again.
.RS
.RE
.SH DEPRECATED JAVA OPTIONS
.PP
@ -3993,27 +4054,20 @@ The replacement Unified Logging syntax is
See \f[B]Enable Logging with the JVM Unified Logging Framework\f[R].
.RE
.TP
.B \f[CB]\-XX:+UseParallelOldGC\f[R]
Enables the use of the parallel garbage collector for full GCs.
By default, this option is disabled.
Enabling it automatically enables the \f[CB]\-XX:+UseParallelGC\f[R]
option.
.B \f[CB]\-XX:+UseBiasedLocking\f[R]
Enables the use of biased locking.
Some applications with significant amounts of uncontended
synchronization may attain significant speedups with this flag enabled,
but applications with certain patterns of locking may see slowdowns.
.RS
.PP
By default, this option is disabled.
.RE
.SH OBSOLETE JAVA OPTIONS
.PP
These \f[CB]java\f[R] options are still accepted but ignored, and a
warning is issued when they\[aq]re used.
.TP
.B \f[CB]\-XX:+FailOverToOldVerifier\f[R]
Enables automatic failover to the old verifier when the new type checker
fails.
By default, this option is disabled and it\[aq]s ignored (that is,
treated as disabled) for classes with a recent bytecode version.
You can enable it only for classes with older versions of the bytecode.
.RS
.RE
.TP
.B \f[CB]\-XX:+UseMembar\f[R]
Enabled issuing membars on thread\-state transitions.
This option was disabled by default on all platforms except ARM servers,
@ -4035,13 +4089,48 @@ This option was deprecated in JDK 8 and superseded by the
\f[CB]\-XX:MetaspaceSize\f[R] option.
.RS
.RE
.TP
.B \f[CB]\-XX:+UseParallelOldGC\f[R]
Enables the use of the parallel garbage collector for full GCs.
By default, this option is disabled.
Enabling it automatically enables the \f[CB]\-XX:+UseParallelGC\f[R]
option.
.RS
.RE
.SH REMOVED JAVA OPTIONS
.PP
No documented \f[CB]java\f[R] options have been removed in JDK 14.
These \f[CB]java\f[R] options have been removed in JDK 15 and using them
results in an error of:
.RS
.PP
\f[CB]Unrecognized\ VM\ option\f[R] \f[I]option\-name\f[R]
.RE
.TP
.B \f[CB]\-XX:+FailOverToOldVerifier\f[R]
Enables automatic failover to the old verifier when the new type checker
fails.
By default, this option is disabled and it\[aq]s ignored (that is,
treated as disabled) for classes with a recent bytecode version.
You can enable it only for classes with older versions of the bytecode.
.RS
.RE
.TP
.B \f[CB]\-XX:+UseConcMarkSweepGC\f[R]
Enables the use of the CMS garbage collector for the old generation.
CMS is an alternative to the default garbage collector (G1), which also
focuses on meeting application latency requirements.
By default, this option is disabled and the collector is selected
automatically based on the configuration of the machine and type of the
JVM.
.RS
.RE
.PP
For the lists and descriptions of options removed in previous releases
see the \f[I]Removed Java Options\f[R] section in:
.IP \[bu] 2
\f[B]Java Platform, Standard Edition Tools Reference, Release 14\f[R]
[https://docs.oracle.com/en/java/javase/14/docs/specs/man/java.html]
.IP \[bu] 2
\f[B]Java Platform, Standard Edition Tools Reference, Release 13\f[R]
[https://docs.oracle.com/en/java/javase/13/docs/specs/man/java.html]
.IP \[bu] 2
@ -5060,11 +5149,7 @@ fragmentation, which could make it impossible to reserve enough large
page memory.
When this happens, either the OS or JVM reverts to using regular pages.
.PP
Oracle Solaris, Linux, and Windows support large pages.
.SS Large Pages Support for Oracle Solaris
.PP
Oracle Solaris includes Multiple Page Size Support (MPSS).
No additional configuration is necessary.
Linux and Windows support large pages.
.SS Large Pages Support for Linux
.PP
The 2.6 kernel supports large pages.
@ -5623,9 +5708,9 @@ Create a single list of classes used by all the applications that will
share the shared archive file.
.RS 4
.PP
\f[B]Oracle Solaris, Linux, and macOS\f[R] The following commands combine
the files \f[CB]hello.classlist\f[R] and \f[CB]hi.classlist\f[R] into one
file, \f[CB]common.classlist\f[R]:
\f[B]Linux and macOS\f[R] The following commands combine the files
\f[CB]hello.classlist\f[R] and \f[CB]hi.classlist\f[R] into one file,
\f[CB]common.classlist\f[R]:
.RS
.PP
\f[CB]cat\ hello.classlist\ hi.classlist\ >\ common.classlist\f[R]