Skip to content
This repository has been archived by the owner. It is now read-only.

JDK-8273179: Update nroff pages in JDK 18 before RC #5

Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVA" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JAVA" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -935,11 +935,11 @@ size of the heap for the young generation, you can use
.RE
.TP
.B \f[CB]\-Xms\f[R] \f[I]size\f[R]
Sets the minimum and initial size (in bytes) of the heap.
Sets the minimum and the initial size (in bytes) of the heap.
This value must be a multiple of 1024 and greater than 1 MB.
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, \f[CB]g\f[R] or \f[CB]G\f[R]
to indicate gigabytes.
\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.
The following examples show how to set the size of allocated memory to 6
MB using various units:
.RS
@@ -952,14 +952,17 @@ MB using various units:
\f[R]
.fi
.PP
Instead of the \f[CB]\-Xms\f[R] option to set both the minimum and initial
size of the heap, you can use \f[CB]\-XX:MinHeapSize\f[R] to set the
minimum size and \f[CB]\-XX:InitialHeapSize\f[R] to set the initial size.
.PP
If you don\[aq]t set this option, the initial size is set as the sum of
the sizes allocated for the old generation and the young generation.
If you do not set this option, then the initial size will be set as the
sum of the sizes allocated for the old generation and the young
generation.
The initial size of the heap for the young generation can be set using
the \f[CB]\-Xmn\f[R] option or the \f[CB]\-XX:NewSize\f[R] option.
.PP
Note that the \f[CB]\-XX:InitialHeapSize\f[R] option can also be used to
set the initial heap size.
If it appears after \f[CB]\-Xms\f[R] on the command line, then the initial
heap size gets set to the value specified with
\f[CB]\-XX:InitialHeapSize\f[R].
.RE
.TP
.B \f[CB]\-Xmx\f[R] \f[I]size\f[R]
@@ -1366,7 +1369,7 @@ By default this option is disabled.
.RS
.RE
.TP
.B \f[CB]\-XX:FlightRecorderOptions=\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R] (or)\f[CB]\-XX:FlightRecorderOptions:\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R]
.B \f[CB]\-XX:FlightRecorderOptions=\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R] (or) \f[CB]\-XX:FlightRecorderOptions:\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R]
Sets the parameters that control the behavior of JFR.
.RS
.PP
@@ -1640,7 +1643,7 @@ Specifies the path and name of the class data sharing (CDS) archive file
See \f[B]Application Class Data Sharing\f[R].
.RE
.TP
.B \f[CB]\-XX:SharedArchiveConfigFile\f[R]=\f[I]shared_config_file\f[R]
.B \f[CB]\-XX:SharedArchiveConfigFile=\f[R]\f[I]shared_config_file\f[R]
Specifies additional shared data added to the archive file.
.RS
.RE
@@ -1747,9 +1750,6 @@ written when the recording is stopped, for example:
\f[CB]/home/user/recordings/recording.jfr\f[R]
.IP \[bu] 2
\f[CB]c:\\recordings\\recording.jfr\f[R]
.PP
If \f[CB]%p\f[R] and/or \f[CB]%t\f[R] is specified in the filename, it expands to the JVM\[aq]s
PID and the current timestamp, respectively.
.RE
.TP
.B \f[CB]name=\f[R]\f[I]identifier\f[R]
@@ -1825,10 +1825,10 @@ To list available options, use the \f[CB]JAVA_HOME\f[R]/bin/jfr tool.
.RS
.RE
.TP
.B \f[CB]event\-setting\f[R]=\f[I]value\f[R]
.B \f[CB]event\-setting=\f[R]\f[I]value\f[R]
Specifies the event setting value to modify.
Use the form: #= To add a new event setting, prefix the event name with
\[aq]+\[aq].
Use the form: \f[CB]<event\-name>#<setting\-name>=<value>\f[R].
To add a new event setting, prefix the event name with \[aq]+\[aq].
.RS
.RE
.PP
@@ -2591,23 +2591,19 @@ The \f[CB]\-XX:UseRTMLocking\f[R] option must be enabled.
.RE
.TP
.B \f[CB]\-XX:+SegmentedCodeCache\f[R]
Enables segmentation of the code cache.
Without the \f[CB]\-XX:+SegmentedCodeCache\f[R], the code cache consists
of one large segment.
With \f[CB]\-XX:+SegmentedCodeCache\f[R], we have separate segments for
nonmethod, profiled method, and nonprofiled method code.
These segments aren\[aq]t resized at runtime.
The feature is enabled by default if tiered compilation is enabled
(\f[CB]\-XX:+TieredCompilation\f[R] ) and
\f[CB]\-XX:ReservedCodeCacheSize\f[R] >= 240 MB.
Enables segmentation of the code cache, without which the code cache
consists of one large segment.
With \f[CB]\-XX:+SegmentedCodeCache\f[R], separate segments will be used
for non\-method, profiled method, and non\-profiled method code.
The segments are not resized at runtime.
The advantages are better control of the memory footprint, reduced code
fragmentation, and better iTLB/iCache behavior due to improved locality.
iTLB/iCache is a CPU\-specific term meaning Instruction Translation
Lookaside Buffer (ITLB).
ICache is an instruction cache in theCPU.
The implementation of the code cache can be found in the file:
\f[CB]/share/vm/code/codeCache.cpp\f[R].
fragmentation, and better CPU iTLB (instruction translation lookaside
buffer) and instruction cache behavior due to improved locality.
.RS
.PP
The feature is enabled by default if tiered compilation is enabled
(\f[CB]\-XX:+TieredCompilation\f[R] ) and the reserved code cache size
(\f[CB]\-XX:ReservedCodeCacheSize\f[R]) is at least 240 MB.
.RE
.TP
.B \f[CB]\-XX:StartAggressiveSweepingAt=\f[R]\f[I]percent\f[R]
@@ -2639,16 +2635,17 @@ Is set by default to the highest supported version available (x86 only).
Enables hardware\-based AES intrinsics for hardware that supports it.
This option is on by default on hardware that has the necessary
instructions.
The \f[CB]\-XX:+UseAES\f[R] is used in conjunction with UseAESIntrinsics.
The \f[CB]\-XX:+UseAES\f[R] is used in conjunction with
\f[CB]UseAESIntrinsics\f[R].
Flags that control intrinsics now require the option
\f[CB]\-XX:+UnlockDiagnosticVMOptions\f[R].
.RS
.RE
.TP
.B \f[CB]\-XX:+UseAESIntrinsics\f[R]
Enables AES intrinsics.
Specifying\f[CB]\-XX:+UseAESIntrinsics\f[R] is equivalent to also enabling
\f[CB]\-XX:+UseAES\f[R].
Specifying \f[CB]\-XX:+UseAESIntrinsics\f[R] is equivalent to also
enabling \f[CB]\-XX:+UseAES\f[R].
To disable hardware\-based AES intrinsics, specify
\f[CB]\-XX:\-UseAES\ \-XX:\-UseAESIntrinsics\f[R].
For example, to enable hardware AES, use the following flags:
@@ -2844,7 +2841,7 @@ The default value is 1,000.
.RS
.RE
.TP
.B \f[CB]\-XX:LoopStripMiningIterShortLoop\f[R]=\f[I]number_of_iterations\f[R]
.B \f[CB]\-XX:LoopStripMiningIterShortLoop=\f[R]\f[I]number_of_iterations\f[R]
Controls loop strip mining optimization.
Loops with the number of iterations less than specified will not have
safepoints in them.
@@ -2971,7 +2968,7 @@ an \f[CB]OutOfMemoryError\f[R] exception is thrown.
.RS
.RE
.TP
.B \f[CB]\-XX:HeapDumpPath=path\f[R]
.B \f[CB]\-XX:HeapDumpPath=\f[R]\f[I]path\f[R]
Sets the path and file name for writing the heap dump provided by the
heap profiler (HPROF) when the \f[CB]\-XX:+HeapDumpOnOutOfMemoryError\f[R]
option is set.
@@ -3165,7 +3162,7 @@ The default value is 3.
.RS
.RE
.TP
.B \f[CB]\-XX:G1HeapRegionSize=size\f[R]
.B \f[CB]\-XX:G1HeapRegionSize=\f[R]\f[I]size\f[R]
Sets the size of the regions into which the Java heap is subdivided when
using the garbage\-first (G1) collector.
The value is a power of 2 and can range from 1 MB to 32 MB.
@@ -3294,6 +3291,11 @@ If you set this option to 0, then the initial size is set as the sum of
the sizes allocated for the old generation and the young generation.
The size of the heap for the young generation can be set using the
\f[CB]\-XX:NewSize\f[R] option.
Note that the \f[CB]\-Xms\f[R] option sets both the minimum and the
initial heap size of the heap.
If \f[CB]\-Xms\f[R] appears after \f[CB]\-XX:InitialHeapSize\f[R] on the
command line, then the initial heap size gets set to the value specified
with \f[CB]\-Xms\f[R].
.RE
.TP
.B \f[CB]\-XX:InitialRAMPercentage=\f[R]\f[I]percent\f[R]
@@ -3895,7 +3897,7 @@ Supports heap sizes from 8MB to 16TB.
.RS
.RE
.TP
.B \f[CB]\-XX:ZAllocationSpikeTolerance\f[R]=\f[I]factor\f[R]
.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.
@@ -3904,14 +3906,14 @@ be expected to triple at any time.
.RS
.RE
.TP
.B \f[CB]\-XX:ZCollectionInterval\f[R]=\f[I]seconds\f[R]
.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]
.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
@@ -3939,7 +3941,7 @@ 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]
.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).
@@ -4231,7 +4233,7 @@ In the argument file,
.nf
\f[CB]
\-cp\ "/lib/cool\\
\\app/jars???
\\app/jars"
\f[R]
.fi
.PP
@@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "KEYTOOL" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "KEYTOOL" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "RMIREGISTRY" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "RMIREGISTRY" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JRUNSCRIPT" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JRUNSCRIPT" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVAC" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JAVAC" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -681,43 +681,28 @@ Selects a diagnostic mode.
.RE
.TP
.B \f[CB]\-Xdoclint\f[R]
Enables recommended checks for problems in \f[CB]javadoc\f[R] comments
Enables recommended checks for problems in documentation comments.
.RS
.RE
.TP
.B \f[CB]\-Xdoclint:\f[R](\f[CB]all\f[R]|\f[CB]none\f[R]|[\f[CB]\-\f[R]]\f[I]group\f[R])[\f[CB]/\f[R]\f[I]access\f[R]]
Enables or disables specific groups of checks,
Enables or disables specific groups of checks in documentation comments.
.RS
.PP
\f[I]group\f[R] can have one of the following values:
.IP \[bu] 2
\f[CB]accessibility\f[R]
.IP \[bu] 2
\f[CB]html\f[R]
.IP \[bu] 2
\f[CB]missing\f[R]
.IP \[bu] 2
\f[CB]reference\f[R]
.IP \[bu] 2
\f[CB]syntax\f[R]
\f[CB]accessibility\f[R], \f[CB]html\f[R], \f[CB]missing\f[R],
\f[CB]reference\f[R], \f[CB]syntax\f[R]
.PP
The variable \f[I]access\f[R] specifies the minimum visibility level of
classes and members that the \f[CB]\-Xdoclint\f[R] option checks.
It can have one of the following values (in order of most to least
visible):
.IP \[bu] 2
\f[CB]public\f[R]
.IP \[bu] 2
\f[CB]protected\f[R]
.IP \[bu] 2
\f[CB]package\f[R]
.IP \[bu] 2
\f[CB]private\f[R]
visible): \f[CB]public\f[R], \f[CB]protected\f[R], \f[CB]package\f[R],
\f[CB]private\f[R].
.PP
The default \f[I]access\f[R] level is \f[CB]private\f[R].
.PP
For more information about these groups of checks, see the
\f[CB]\-Xdoclint\f[R] option of the \f[CB]javadoc\f[R] command.
\f[B]DocLint\f[R] section of the \f[CB]javadoc\f[R] command documentation.
The \f[CB]\-Xdoclint\f[R] option is disabled by default in the
\f[CB]javac\f[R] command.
.PP
@@ -747,6 +732,9 @@ sub\-packages of the given package.
Each \f[I]package\f[R] can be prefixed with a hyphen (\f[CB]\-\f[R]) to
disable checks for a specified package or packages.
.RS
.PP
For more information, see the \f[B]DocLint\f[R] section of the
\f[CB]javadoc\f[R] command documentation.
.RE
.TP
.B \f[CB]\-Xlint\f[R]
@@ -1047,7 +1035,7 @@ Create a file named \f[CB]options\f[R] that contains the following:
\f[R]
.fi
.PP
Create a file named \f[CB]classes\f[R] that contains the following:
Create a file named \f[CB]sources\f[R] that contains the following:
.IP
.nf
\f[CB]
@@ -1060,7 +1048,7 @@ MyClass3.java
Then, run the \f[CB]javac\f[R] command as follows:
.RS
.PP
\f[CB]javac\ \@options\ \@classes\f[R]
\f[CB]javac\ \@options\ \@sources\f[R]
.RE
.RE
.TP
@@ -1071,7 +1059,7 @@ are relative to the current working directory (not \f[CB]path1\f[R] or
.RS
.RS
.PP
\f[CB]javac\ \@path1/options\ \@path2/classes\f[R]
\f[CB]javac\ \@path1/options\ \@path2/sources\f[R]
.RE
.RE
.SH ARRANGEMENT OF SOURCE CODE
@@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "SERIALVER" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "SERIALVER" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JHSDB" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JHSDB" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@@ -1,6 +1,27 @@
.\" Copyright (c) 2021, 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.
.\"
.\" This code is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
.\" version 2 for more details (a copy is included in the LICENSE file that
.\" accompanied this code).
.\"
.\" You should have received a copy of the GNU General Public License version
.\" 2 along with this work; if not, write to the Free Software Foundation,
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
.\"
.\" 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 "JWEBSERVER" "1" "2021" "JDK 18\-internal" "JDK Commands"
.TH "JWEBSERVER" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP