8304478: Initial nroff manpage generation for JDK 22

Reviewed-by: alanb, sspitsyn, mchung, lancea
This commit is contained in:
David Holmes 2023-06-19 22:30:50 +00:00
parent 7b45c8fc3a
commit b2e86aef65
28 changed files with 72 additions and 105 deletions

View File

@ -36,7 +36,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JAVA" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JAVA" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP
@ -187,7 +187,7 @@ 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.
The supported values of \f[I]N\f[R] are the current Java SE release
(\f[V]21\f[R]) and a limited number of previous releases, detailed in
(\f[V]22\f[R]) and a limited number of previous releases, detailed in
the command-line help for \f[V]javac\f[R], under the \f[V]--source\f[R]
and \f[V]--release\f[R] options.
.RE
@ -3813,7 +3813,7 @@ This option was deprecated in JDK 16 by \f[B]JEP 396\f[R]
403\f[R] [https://openjdk.org/jeps/403].
.SH REMOVED JAVA OPTIONS
.PP
These \f[V]java\f[R] options have been removed in JDK 21 and using them
These \f[V]java\f[R] options have been removed in JDK 22 and using them
results in an error of:
.RS
.PP

View File

@ -36,7 +36,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "KEYTOOL" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "KEYTOOL" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP
@ -447,7 +447,7 @@ single-element certificate chain.
When the \f[V]-signer\f[R] option is specified, a new certificate is
generated and signed by the designated signer and stored as a
multiple-element certificate chain (containing the generated certificate
itself, and the signer?s certificate chain).
itself, and the signer\[aq]s certificate chain).
The certificate chain and private key are stored in a new keystore entry
that is identified by its alias.
.PP
@ -467,8 +467,8 @@ specified.
The \f[V]-signer\f[R] value specifies the alias of a
\f[V]PrivateKeyEntry\f[R] for the signer that already exists in the
keystore.
This option is used to sign the certificate with the signer?s private
key.
This option is used to sign the certificate with the signer\[aq]s
private key.
This is especially useful for key agreement algorithms (i.e.
the \f[V]-keyalg\f[R] value is \f[V]XDH\f[R], \f[V]X25519\f[R],
\f[V]X448\f[R], or \f[V]DH\f[R]) as these keys cannot be used for
@ -476,7 +476,7 @@ digital signatures, and therefore a self-signed certificate cannot be
created.
.PP
The \f[V]-signerkeypass\f[R] value specifies the password of the
signer?s private key.
signer\[aq]s private key.
It can be specified if the private key of the signer entry is protected
by a password different from the store password.
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "RMIREGISTRY" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "RMIREGISTRY" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JRUNSCRIPT" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JRUNSCRIPT" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -1,4 +1,4 @@
.\" Copyright (c) 1994, 2020, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1994, 2023, 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
@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JAVAC" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JAVAC" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP
@ -413,12 +413,14 @@ generated class file so that the method
\f[V]java.lang.reflect.Executable.getParameters\f[R] from the Reflection
API can retrieve them.
.TP
\f[V]-proc:\f[R][\f[V]none\f[R], \f[V]only\f[R]]
\f[V]-proc:\f[R][\f[V]none\f[R], \f[V]only\f[R], \f[V]full\f[R]]
Controls whether annotation processing and compilation are done.
\f[V]-proc:none\f[R] means that compilation takes place without
annotation processing.
\f[V]-proc:only\f[R] means that only annotation processing is done,
without any subsequent compilation.
If this option is not used, or \f[V]-proc:full\f[R] is specified,
annotation processing and compilation are done.
.TP
\f[V]-processor\f[R] \f[I]class1\f[R][\f[V],\f[R]\f[I]class2\f[R]\f[V],\f[R]\f[I]class3\f[R]...]
Names of the annotation processors to run.
@ -736,7 +738,8 @@ constructors in public and protected classes in exported packages.
\f[V]options\f[R]: Warns about the issues relating to use of command
line options.
.IP \[bu] 2
\f[V]output-file-clash\f[R]: Warns if any output file is overwritten during compilation.
\f[V]output-file-clash\f[R]: Warns if any output file is overwritten
during compilation.
This can occur, for example, on case-insensitive filesystems.
.IP \[bu] 2
\f[V]overloads\f[R]: Warns about the issues related to method overloads.
@ -779,8 +782,8 @@ instances of value-based classes.
\f[V]text-blocks\f[R]: Warns about inconsistent white space characters
in text block indentation.
.IP \[bu] 2
\f[V]this-escape\f[R]: Warns about constructors leaking
\f[V]this\f[R] prior to subclass initialization.
\f[V]this-escape\f[R]: Warns about constructors leaking \f[V]this\f[R]
prior to subclass initialization.
.IP \[bu] 2
\f[V]try\f[R]: Warns about the issues relating to the use of try blocks
(that is, try-with-resources).
@ -2219,7 +2222,7 @@ Alternately, you can remove the \f[V]static\f[R] keyword from the
declaration of the method \f[V]m1\f[R].
.RE
.TP
\f[V]this\-escape\f[R]
\f[V]this-escape\f[R]
Warns about constructors leaking \f[V]this\f[R] prior to subclass
initialization.
For example, this class:
@ -2239,24 +2242,24 @@ generates the following warning:
.IP
.nf
\f[CB]
MyClass.java:3: warning: [this-escape] possible 'this' escape
MyClass.java:3: warning: [this-escape] possible \[aq]this\[aq] escape
before subclass is fully initialized
System.out.println(this.hashCode());
^
\[ha]
\f[R]
.fi
.PP
A 'this' escape warning is generated when a constructor does something
that might result in a subclass method being invoked before the
constructor returns.
A \[aq]this\[aq] escape warning is generated when a constructor does
something that might result in a subclass method being invoked before
the constructor returns.
In such cases the subclass method would be operating on an incompletely
initialized instance.
In the above example, a subclass of \f[V]MyClass\f[R] that overrides
\f[V]hashCode()\f[R] to incorporate its own fields would likely produce
an incorrect result when invoked as shown.
.PP
Warnings are only generated if a subclass could exist that is outside
of the current module (or package, if no module) being compiled.
Warnings are only generated if a subclass could exist that is outside of
the current module (or package, if no module) being compiled.
So, for example, constructors in final and non-public classes do not
generate warnings.
.RE

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "SERIALVER" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "SERIALVER" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JHSDB" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JHSDB" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JWEBSERVER" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JWEBSERVER" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JAR" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JAR" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -36,7 +36,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JARSIGNER" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JARSIGNER" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP
@ -1082,63 +1082,6 @@ name(s) cannot be set in this file.
.TP
\f[V]-version\f[R]
Prints the program version.
.SH DEPRECATED OPTIONS
.PP
The following \f[V]jarsigner\f[R] options are deprecated as of JDK 9 and
might be removed in a future JDK release.
.TP
\f[V]-altsigner\f[R] \f[I]class\f[R]
This option specifies an alternative signing mechanism.
The fully qualified class name identifies a class file that extends the
\f[V]com.sun.jarsigner.ContentSigner\f[R] abstract class.
The path to this class file is defined by the \f[V]-altsignerpath\f[R]
option.
If the \f[V]-altsigner\f[R] option is used, then the \f[V]jarsigner\f[R]
command uses the signing mechanism provided by the specified class.
Otherwise, the \f[V]jarsigner\f[R] command uses its default signing
mechanism.
.RS
.PP
For example, to use the signing mechanism provided by a class named
\f[V]com.sun.sun.jarsigner.AuthSigner\f[R], use the \f[V]jarsigner\f[R]
option \f[V]-altsigner com.sun.jarsigner.AuthSigner\f[R].
.RE
.TP
\f[V]-altsignerpath\f[R] \f[I]classpathlist\f[R]
Specifies the path to the class file and any JAR file it depends on.
The class file name is specified with the \f[V]-altsigner\f[R] option.
If the class file is in a JAR file, then this option specifies the path
to that JAR file.
.RS
.PP
An absolute path or a path relative to the current directory can be
specified.
If \f[I]classpathlist\f[R] contains multiple paths or JAR files, then
they should be separated with a:
.IP \[bu] 2
Colon (\f[V]:\f[R]) on Linux and macOS
.IP \[bu] 2
Semicolon (\f[V];\f[R]) on Windows
.PP
This option isn\[aq]t necessary when the class is already in the search
path.
.PP
The following example shows how to specify the path to a JAR file that
contains the class file.
The JAR file name is included.
.RS
.PP
\f[V]-altsignerpath /home/user/lib/authsigner.jar\f[R]
.RE
.PP
The following example shows how to specify the path to the JAR file that
contains the class file.
The JAR file name is omitted.
.RS
.PP
\f[V]-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\f[R]
.RE
.RE
.SH ERRORS AND WARNINGS
.PP
During the signing or verifying process, the \f[V]jarsigner\f[R] command

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JAVADOC" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JAVADOC" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JCMD" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JCMD" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JINFO" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JINFO" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JMAP" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JMAP" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JPS" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JPS" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JSTACK" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JSTACK" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JSTAT" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JSTAT" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JCONSOLE" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JCONSOLE" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JAVAP" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JAVAP" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JDEPRSCAN" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JDEPRSCAN" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JDEPS" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JDEPS" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP
@ -246,6 +246,7 @@ the pattern to the dependencies.
.TP
\f[V]-P\f[R] or \f[V]-profile\f[R]
Shows the profile containing a package.
This option is deprecated and may be removed in a future release.
.TP
\f[V]-R\f[R] or \f[V]--recursive\f[R]
Recursively traverses all run-time dependences.

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JDB" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JDB" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JFR" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JFR" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JLINK" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JLINK" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JMOD" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JMOD" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JPACKAGE" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JPACKAGE" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP

View File

@ -1,4 +1,4 @@
.\" Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2017, 2023, 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
@ -36,7 +36,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JSHELL" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JSHELL" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP
@ -67,6 +67,11 @@ Imports all Java SE packages.
\f[V]PRINTING\f[R]
Defines \f[V]print\f[R], \f[V]println\f[R], and \f[V]printf\f[R] as
\f[V]jshell\f[R] methods for use within the tool.
.TP
\f[V]TOOLING\f[R]
Defines \f[V]javac\f[R], \f[V]jar\f[R], and other methods for running
JDK tools via their command-line interface within the \f[V]jshell\f[R]
tool.
.PP
For more than one script, use a space to separate the names.
Scripts are run in the order in which they\[aq]re entered on the command
@ -231,6 +236,11 @@ Imports all Java SE packages.
\f[V]PRINTING\f[R]
Defines \f[V]print\f[R], \f[V]println\f[R], and \f[V]printf\f[R] as
\f[V]jshell\f[R] methods for use within the tool.
.TP
\f[V]TOOLING\f[R]
Defines \f[V]javac\f[R], \f[V]jar\f[R], and other methods for running
JDK tools via their command-line interface within the \f[V]jshell\f[R]
tool.
.PP
For more than one script, provide a separate instance of this option for
each script.
@ -451,6 +461,11 @@ Imports all Java SE packages.
\f[V]PRINTING\f[R]
Defines \f[V]print\f[R], \f[V]println\f[R], and \f[V]printf\f[R] as
\f[V]jshell\f[R] methods for use within the tool.
.TP
\f[V]TOOLING\f[R]
Defines \f[V]javac\f[R], \f[V]jar\f[R], and other methods for running
JDK tools via their command-line interface within the \f[V]jshell\f[R]
tool.
.RE
.TP
\f[V]/reload\f[R] [\f[I]options\f[R]]
@ -765,6 +780,11 @@ Imports all Java SE packages.
\f[V]PRINTING\f[R]
Defines \f[V]print\f[R], \f[V]println\f[R], and \f[V]printf\f[R] as
\f[V]jshell\f[R] methods for use within the tool.
.TP
\f[V]TOOLING\f[R]
Defines \f[V]javac\f[R], \f[V]jar\f[R], and other methods for running
JDK tools via their command-line interface within the \f[V]jshell\f[R]
tool.
.PP
The following options are valid:
.TP

View File

@ -35,7 +35,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JSTATD" "1" "2023" "JDK 21-ea" "JDK Commands"
.TH "JSTATD" "1" "2024" "JDK 22-ea" "JDK Commands"
.hy
.SH NAME
.PP