8273179: Update nroff pages in JDK 18 before RC

Reviewed-by: dholmes
This commit is contained in:
Jonathan Gibbons 2021-12-10 02:50:37 +00:00
parent d40e90b4a1
commit ed5d53ae0e
28 changed files with 715 additions and 413 deletions

View File

@ -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,7 +2635,8 @@ 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
@ -2647,8 +2644,8 @@ Flags that control intrinsics now require the option
.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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAR" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JAR" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JARSIGNER" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JARSIGNER" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

File diff suppressed because it is too large Load Diff

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JCMD" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JCMD" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@ -596,8 +596,8 @@ To list available options, use the \f[CB]JAVA_HOME\f[R]/bin/jfr tool.
.IP \[bu] 2
\f[CB]event\-setting\f[R]: (Optional) 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].
.PP
You can specify values for multiple event settings and .jfc options by
separating them with a whitespace.
@ -1077,10 +1077,6 @@ detail comparison against previous baseline, which shows the memory
allocation activities at different callsites.
(BOOLEAN, false)
.IP \[bu] 2
\f[CB]shutdown\f[R]: (Optional) Requests runtime to shutdown itself and
free the memory used by runtime.
(BOOLEAN, false)
.IP \[bu] 2
\f[CB]statistics\f[R]: (Optional) Prints tracker statistics for tuning
purpose.
(BOOLEAN, false)

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JINFO" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JINFO" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JMAP" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JMAP" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JPS" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JPS" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JSTACK" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JSTACK" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JSTAT" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JSTAT" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JCONSOLE" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JCONSOLE" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVAP" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JAVAP" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JDEPRSCAN" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JDEPRSCAN" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JDEPS" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JDEPS" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JDB" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JDB" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JFR" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JFR" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JLINK" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JLINK" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@ -294,6 +294,17 @@ Example:
Strips debug information from the output image.
.RS
.RE
.SS Plugin \f[CB]generate\-cds\-archive\f[R]
.TP
.B Options
\f[CB]\-\-generate\-cds\-archive\f[R]
.RS
.RE
.TP
.B Description
Generate CDS archive if the runtime image supports the CDS feature.
.RS
.RE
.SH JLINK EXAMPLES
.PP
The following command creates a runtime image in the directory

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JMOD" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JMOD" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JPACKAGE" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JPACKAGE" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP
@ -56,7 +56,7 @@ Read options from a file.
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-type\f[R] or \f[CB]\-t\f[R] <type string>
.B \f[CB]\-\-type\f[R] or \f[CB]\-t\f[R] \f[I]type\f[R]
The type of package to create
.RS
.PP
@ -67,17 +67,17 @@ If this option is not specified a platform dependent default type will
be created.
.RE
.TP
.B \f[CB]\-\-app\-version\f[R] <version>
.B \f[CB]\-\-app\-version\f[R] \f[I]version\f[R]
Version of the application and/or package
.RS
.RE
.TP
.B \f[CB]\-\-copyright\f[R] <copyright string>
.B \f[CB]\-\-copyright\f[R] \f[I]copyright\f[R]
Copyright for the application
.RS
.RE
.TP
.B \f[CB]\-\-description\f[R] <description string>
.B \f[CB]\-\-description\f[R] \f[I]description\f[R]
Description of the application
.RS
.RE
@ -88,30 +88,33 @@ for the current platform to the output stream, and exit.
.RS
.RE
.TP
.B \f[CB]\-\-icon\f[R] <icon file path>
Path of the icon of the application package (absolute path or relative
to the current directory)
.B \f[CB]\-\-icon\f[R] \f[I]path\f[R]
Path of the icon of the application package
.RS
.PP
(absolute path or relative to the current directory)
.RE
.TP
.B \f[CB]\-\-name\f[R] or \f[CB]\-n\f[R] <name>
.B \f[CB]\-\-name\f[R] or \f[CB]\-n\f[R] \f[I]name\f[R]
Name of the application and/or package
.RS
.RE
.TP
.B \f[CB]\-\-dest\f[R] or \f[CB]\-d\f[R] <output path>
.B \f[CB]\-\-dest\f[R] or \f[CB]\-d\f[R] \f[I]destination\f[R]
Path where generated output file is placed
.RS
.PP
Defaults to the current working directory.
(absolute path or relative to the current directory).
.PP
Defaults to the current working directory.
.RE
.TP
.B \f[CB]\-\-temp\f[R] <directory path>
.B \f[CB]\-\-temp\f[R] \f[I]directory\f[R]
Path of a new or empty directory used to create temporary files
(absolute path or relative to the current directory)
.RS
.PP
(absolute path or relative to the current directory)
.PP
If specified, the temp dir will not be removed upon the task completion
and must be removed manually.
.PP
@ -119,7 +122,7 @@ If not specified, a temporary directory will be created and removed upon
the task completion.
.RE
.TP
.B \f[CB]\-\-vendor\f[R] <vendor string>
.B \f[CB]\-\-vendor\f[R] \f[I]vendor\f[R]
Vendor of the application
.RS
.RE
@ -135,7 +138,7 @@ Print the product version to the output stream and exit.
.RE
.SS Options for creating the runtime image:
.TP
.B \f[CB]\-\-add\-modules\f[R] <module name> [\f[CB],\f[R]<module name>...]
.B \f[CB]\-\-add\-modules\f[R] \f[I]module\-name\f[R] [\f[CB],\f[R]\f[I]module\-name\f[R]...]
A comma (",") separated list of modules to add
.RS
.PP
@ -148,7 +151,7 @@ specified) are used.
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-module\-path\f[R] or \f[CB]\-p\f[R] <module path>...
.B \f[CB]\-\-module\-path\f[R] or \f[CB]\-p\f[R] \f[I]module\-path\f[R] [\f[CB],\f[R]\f[I]module\-path\f[R]...]
A File.pathSeparator separated list of paths
.RS
.PP
@ -158,7 +161,7 @@ and is absolute or relative to the current directory.
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-jlink\-options\f[R] <jlink options>
.B \f[CB]\-\-jlink\-options\f[R] \f[I]options\f[R]
A space separated list of options to pass to jlink
.RS
.PP
@ -168,34 +171,48 @@ If not specified, defaults to "\-\-strip\-native\-commands
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-runtime\-image\f[R] <directory path>
.B \f[CB]\-\-runtime\-image\f[R] \f[I]directory\f[R]
Path of the predefined runtime image that will be copied into the
application image (absolute path or relative to the current directory)
application image
.RS
.PP
(absolute path or relative to the current directory)
.PP
If \-\-runtime\-image is not specified, jpackage will run jlink to
create the runtime image using options specified by \-\-jlink\-options.
.RE
.SS Options for creating the application image:
.TP
.B \f[CB]\-\-input\f[R] or \f[CB]\-i\f[R] <input path>
.B \f[CB]\-\-input\f[R] or \f[CB]\-i\f[R] \f[I]directory\f[R]
Path of the input directory that contains the files to be packaged
(absolute path or relative to the current directory)
.RS
.PP
(absolute path or relative to the current directory)
.PP
All files in the input directory will be packaged into the application
image.
.RE
.SS Options for creating the application launcher(s):
.TP
.B \f[CB]\-\-add\-launcher\f[R] <launcher name>=<file path>
Name of launcher, and a path to a Properties file that contains a list
of key, value pairs (absolute path or relative to the current directory)
.B `\-\-app\-content \f[I]additional\-content\f[R][,\f[I]additional\-content\f[R]...]
A comma separated list of paths to files and/or directories to add to
the application payload.
.RS
.PP
This option can be used more than once.
.RE
.SS Options for creating the application launcher(s):
.TP
.B \f[CB]\-\-add\-launcher\f[R] \f[I]name\f[R]=\f[I]path\f[R]
Name of launcher, and a path to a Properties file that contains a list
of key, value pairs
.RS
.PP
(absolute path or relative to the current directory)
.PP
The keys "module", "main\-jar", "main\-class", "arguments",
"java\-options", "app\-version", "icon", "linux\-app\-category",
"linux\-app\-release", and "win\-console" can be used.
"java\-options", "app\-version", "icon", "win\-console",
"win\-shortcut", "win\-menu", "linux\-app\-category", and
"linux\-shortcut", can be used.
.PP
These options are added to, or used to overwrite, the original command
line options to build an additional alternative launcher.
@ -206,7 +223,7 @@ this option can be used multiple times to build multiple additional
launchers.
.RE
.TP
.B \f[CB]\-\-arguments\f[R] <main class arguments>
.B \f[CB]\-\-arguments\f[R] \f[I]arguments\f[R]
Command line arguments to pass to the main class if no command line
arguments are given to the launcher
.RS
@ -214,21 +231,21 @@ arguments are given to the launcher
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-java\-options\f[R] <java options>
.B \f[CB]\-\-java\-options\f[R] \f[I]options\f[R]
Options to pass to the Java runtime
.RS
.PP
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-main\-class\f[R] <class name>
.B \f[CB]\-\-main\-class\f[R] \f[I]class\-name\f[R]
Qualified name of the application main class to execute
.RS
.PP
This option can only be used if \-\-main\-jar is specified.
.RE
.TP
.B \f[CB]\-\-main\-jar\f[R] <main jar file>
.B \f[CB]\-\-main\-jar\f[R] \f[I]main\-jar\f[R]
The main JAR of the application; containing the main class (specified as
a path relative to the input path)
.RS
@ -236,7 +253,7 @@ a path relative to the input path)
Either \-\-module or \-\-main\-jar option can be specified but not both.
.RE
.TP
.B \f[CB]\-\-module\f[R] or \f[CB]\-m\f[R] <module name>/<main class>]
.B \f[CB]\-\-module\f[R] or \f[CB]\-m\f[R] \f[I]module\-name\f[R][/\f[I]main\-class\f[R]]
The main module (and optionally main class) of the application
.RS
.PP
@ -256,7 +273,7 @@ application which requires console interactions
.RE
.SS macOS platform options (available only when running on macOS):
.TP
.B \f[CB]\-\-mac\-package\-identifier\f[R] <ID string>
.B \f[CB]\-\-mac\-package\-identifier\f[R] \f[I]identifier\f[R]
An identifier that uniquely identifies the application for macOS
.RS
.PP
@ -266,7 +283,7 @@ May only use alphanumeric (A\-Z,a\-z,0\-9), hyphen (\-), and period (.)
characters.
.RE
.TP
.B \f[CB]\-\-mac\-package\-name\f[R] <name string>
.B \f[CB]\-\-mac\-package\-name\f[R] \f[I]name\f[R]
Name of the application as it appears in the Menu Bar
.RS
.PP
@ -277,7 +294,7 @@ displaying in the menu bar and the application Info window.
Defaults to the application name.
.RE
.TP
.B \f[CB]\-\-mac\-package\-signing\-prefix\f[R] <prefix string>
.B \f[CB]\-\-mac\-package\-signing\-prefix\f[R] \f[I]prefix\f[R]
When signing the application package, this value is prefixed to all
components that need to be signed that don\[aq]t have an existing
package identifier.
@ -289,14 +306,14 @@ Request that the bundle be signed.
.RS
.RE
.TP
.B \f[CB]\-\-mac\-signing\-keychain\f[R] <keychain name>
.B \f[CB]\-\-mac\-signing\-keychain\f[R] \f[I]keychain\-name\f[R]
Name of the keychain to search for the signing identity
.RS
.PP
If not specified, the standard keychains are used.
.RE
.TP
.B \f[CB]\-\-mac\-signing\-key\-user\-name\f[R] <team name>
.B \f[CB]\-\-mac\-signing\-key\-user\-name\f[R] \f[I]name\f[R]
Team or user name portion in Apple signing identities
.RS
.RE
@ -306,13 +323,13 @@ Indicates that the jpackage output is intended for the Mac App Store.
.RS
.RE
.TP
.B \f[CB]\-\-mac\-entitlements\f[R] <file path>
.B \f[CB]\-\-mac\-entitlements\f[R] \f[I]path\f[R]
Path to file containing entitlements to use when signing executables and
libraries in the bundle
.RS
.RE
.TP
.B \f[CB]\-\-mac\-app\-category\f[R] <category string>
.B \f[CB]\-\-mac\-app\-category\f[R] \f[I]category\f[R]
String used to construct LSApplicationCategoryType in application plist
.RS
.PP
@ -320,59 +337,63 @@ The default value is "utilities".
.RE
.SS Options for creating the application package:
.TP
.B \f[CB]\-\-about\-url\f[R] <url>
.B \f[CB]\-\-about\-url\f[R] \f[I]url\f[R]
URL of the application\[aq]s home page
.RS
.RE
.TP
.B \f[CB]\-\-app\-image\f[R] <directory path>
.B \f[CB]\-\-app\-image\f[R] \f[I]directory\f[R]
Location of the predefined application image that is used to build an
installable package
.RS
.PP
(absolute path or relative to the current directory).
(absolute path or relative to the current directory)
.PP
See create\-app\-image mode options to create the application image.
.RE
.TP
.B \f[CB]\-\-file\-associations\f[R] <file path>
.B \f[CB]\-\-file\-associations\f[R] \f[I]path\f[R]
Path to a Properties file that contains list of key, value pairs
(absolute path or relative to the current directory)
.RS
.PP
(absolute path or relative to the current directory)
.PP
The keys "extension", "mime\-type", "icon", and "description" can be
used to describe the association.
.PP
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-install\-dir\f[R] <directory path>
.B \f[CB]\-\-install\-dir\f[R] \f[I]path\f[R]
Absolute path of the installation directory of the application (on macos
or linux), or relative sub\-path of the installation directory such as
"Program Files" or "AppData" (on Windows)
.RS
.RE
.TP
.B \f[CB]\-\-license\-file\f[R] <file path>
Path to the license file (absolute path or relative to the current
directory)
.B \f[CB]\-\-license\-file\f[R] \f[I]path\f[R]
Path to the license file
.RS
.PP
(absolute path or relative to the current directory)
.RE
.TP
.B \f[CB]\-\-resource\-dir\f[R] <directory path>
Path to override jpackage resources (absolute path or relative to the
current directory)
.B \f[CB]\-\-resource\-dir\f[R] \f[I]path\f[R]
Path to override jpackage resources
.RS
.PP
(absolute path or relative to the current directory)
.PP
Icons, template files, and other resources of jpackage can be
over\-ridden by adding replacement resources to this directory.
.RE
.TP
.B \f[CB]\-\-runtime\-image\f[R] <directory path>
Path of the predefined runtime image to install (absolute path or
relative to the current directory)
.B \f[CB]\-\-runtime\-image\f[R] \f[I]path\f[R]
Path of the predefined runtime image to install
.RS
.PP
(absolute path or relative to the current directory)
.PP
Option is required when creating a runtime installer.
.RE
.SS Platform dependent options for creating the application package:
@ -384,7 +405,7 @@ product is installed.
.RS
.RE
.TP
.B \f[CB]\-\-win\-help\-url\f[R] <url>
.B \f[CB]\-\-win\-help\-url\f[R] \f[I]url\f[R]
URL where user can obtain further information or technical support
.RS
.RE
@ -394,7 +415,7 @@ Request to add a Start Menu shortcut for this application
.RS
.RE
.TP
.B \f[CB]\-\-win\-menu\-group\f[R] <menu group name>
.B \f[CB]\-\-win\-menu\-group\f[R] \f[I]menu\-group\-name\f[R]
Start Menu group this application is placed in
.RS
.RE
@ -415,30 +436,30 @@ by installer
.RS
.RE
.TP
.B \f[CB]\-\-win\-update\-url\f[R] <url>
.B \f[CB]\-\-win\-update\-url\f[R] \f[I]url\f[R]
URL of available application update information
.RS
.RE
.TP
.B \f[CB]\-\-win\-upgrade\-uuid\f[R] <id string>
.B \f[CB]\-\-win\-upgrade\-uuid\f[R] \f[I]id\f[R]
UUID associated with upgrades for this package
.RS
.RE
.SS Linux platform options (available only when running on Linux):
.TP
.B \f[CB]\-\-linux\-package\-name\f[R] <package name>
.B \f[CB]\-\-linux\-package\-name\f[R] \f[I]name\f[R]
Name for Linux package
.RS
.PP
Defaults to the application name.
.RE
.TP
.B \f[CB]\-\-linux\-deb\-maintainer\f[R] <email address>
.B \f[CB]\-\-linux\-deb\-maintainer\f[R] \f[I]email\-address\f[R]
Maintainer for .deb bundle
.RS
.RE
.TP
.B \f[CB]\-\-linux\-menu\-group\f[R] <menu\-group\-name>
.B \f[CB]\-\-linux\-menu\-group\f[R] \f[I]menu\-group\-name\f[R]
Menu group this application is placed in
.RS
.RE
@ -448,20 +469,19 @@ Required packages or capabilities for the application
.RS
.RE
.TP
.B \f[CB]\-\-linux\-rpm\-license\-type\f[R] <type string>
Type of the license ("License: <value>" of the RPM .spec)
.B \f[CB]\-\-linux\-rpm\-license\-type\f[R] \f[I]type\f[R]
Type of the license ("License: \f[I]value\f[R]" of the RPM .spec)
.RS
.RE
.TP
.B \f[CB]\-\-linux\-app\-release\f[R] <release string>
.B \f[CB]\-\-linux\-app\-release\f[R] \f[I]release\f[R]
Release value of the RPM <name>.spec file or Debian revision value of
the DEB control file
.RS
.RE
.TP
.B \f[CB]\-\-linux\-app\-category\f[R] <category string>
Group value of the RPM <name>.spec file or Section value of DEB control
file
.B \f[CB]\-\-linux\-app\-category\f[R] \f[I]category\-value\f[R]
Group value of the RPM /.spec file or Section value of DEB control file
.RS
.RE
.TP
@ -469,6 +489,14 @@ file
Creates a shortcut for the application.
.RS
.RE
.SS macOS platform options (available only when running on macOS):
.TP
.B \[aq]\-\-mac\-dmg\-content \f[I]additional\-content\f[R][,\f[I]additional\-content\f[R]...]
Include all the referenced content in the dmg.
.RS
.PP
This option can be used more than once.
.RE
.SH JPACKAGE EXAMPLES
.IP
.nf

View File

@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JSHELL" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JSHELL" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JSTATD" "1" "2021" "JDK 18\-ea" "JDK Commands"
.TH "JSTATD" "1" "2022" "JDK 18" "JDK Commands"
.hy
.SH NAME
.PP