infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-01-28 12:09:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

8270872: Final nroff manpage update for JDK 17

Browse Source 
Reviewed-by: darcy, mr, iris, naoto
This commit is contained in:
Jonathan Gibbons 2021-08-05 22:12:27 +00:00
parent 90f85ff70f
commit dfacda488b
27 changed files with 258 additions and 172 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/java.base/share/man/java.1
View File

@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVA" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "JAVA" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -1813,6 +1813,30 @@ is needed.
.PP
You can specify values for multiple parameters by separating them with a
comma.
Event settings and .jfc options can be specified using the following
syntax:
.TP
.B \f[CB]option=\f[R]\f[I]value\f[R]
Specifies the option value to modify.
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]
Specifies the event setting value to modify.
Use the form: #= To add a new event setting, prefix the event name with
\[aq]+\[aq].
.RS
.RE
.PP
You can specify values for multiple event settings and .jfc options by
separating them with a comma.
In case of a conflict between a parameter and a .jfc option, the
parameter will take precedence.
The whitespace delimiter can be omitted for timespan values, i.e.
20ms.
For more information about the settings syntax, see Javadoc of the
jdk.jfr package.
.RE
.TP
.B \f[CB]\-XX:ThreadStackSize=\f[R]\f[I]size\f[R]

59
src/java.base/share/man/keytool.1
View File

@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "KEYTOOL" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "KEYTOOL" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -382,6 +382,10 @@ For example, an Elliptic Curve name.
.IP \[bu] 2
{\f[CB]\-sigalg\f[R] \f[I]alg\f[R]}: Signature algorithm name
.IP \[bu] 2
{\f[CB]\-signer\f[R] \f[I]alias\f[R]}: Signer alias
.IP \[bu] 2
[\f[CB]\-signerkeypass\f[R] \f[I]arg\f[R]]: Signer key password
.IP \[bu] 2
[\f[CB]\-dname\f[R] \f[I]name\f[R]]: Distinguished name
.IP \[bu] 2
{\f[CB]\-startdate\f[R] \f[I]date\f[R]}: Certificate validity start date
@ -417,16 +421,21 @@ with an optional configure argument.
.PP
Use the \f[CB]\-genkeypair\f[R] command to generate a key pair (a public
key and associated private key).
Wraps the public key in an X.509 v3 self\-signed certificate, which is
stored as a single\-element certificate chain.
This certificate chain and the private key are stored in a new keystore
entry that is identified by its alias.
When the \f[CB]\-signer\f[R] option is not specified, the public key is
wrapped in an X.509 v3 self\-signed certificate and stored as a
single\-element certificate chain.
When the \f[CB]\-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).
The certificate chain and private key are stored in a new keystore entry
that is identified by its alias.
.PP
The \f[CB]\-keyalg\f[R] value specifies the algorithm to be used to
generate the key pair, and the \f[CB]\-keysize\f[R] value specifies the
size of each key to be generated.
The \f[CB]\-sigalg\f[R] value specifies the algorithm that should be used
to sign the self\-signed certificate.
to sign the certificate.
This algorithm must be compatible with the \f[CB]\-keyalg\f[R] value.
.PP
The \f[CB]\-groupname\f[R] value specifies the named group (for example,
@ -435,9 +444,30 @@ generated.
Only one of \f[CB]\-groupname\f[R] and \f[CB]\-keysize\f[R] can be
specified.
.PP
The \f[CB]\-signer\f[R] value specifies the alias of a
\f[CB]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 is especially useful for key agreement algorithms (i.e.
the \f[CB]\-keyalg\f[R] value is \f[CB]XDH\f[R], \f[CB]X25519\f[R],
\f[CB]X448\f[R], or \f[CB]DH\f[R]) as these keys cannot be used for digital
signatures, and therefore a self\-signed certificate cannot be created.
.PP
The \f[CB]\-signerkeypass\f[R] value specifies the password of the
signer???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
The \f[CB]\-dname\f[R] value specifies the X.500 Distinguished Name to be
associated with the value of \f[CB]\-alias\f[R], and is used as the issuer
and subject fields in the self\-signed certificate.
associated with the value of \f[CB]\-alias\f[R].
If the \f[CB]\-signer\f[R] option is not specified, the issuer and subject
fields of the self\-signed certificate are populated with the specified
distinguished name.
If the \f[CB]\-signer\f[R] option is specified, the subject field of the
certificate is populated with the specified distinguished name and the
issuer field is populated with the subject field of the signer\[aq]s
certificate.
If a distinguished name is not provided at the command line, then the
user is prompted for one.
.PP
@ -1531,9 +1561,9 @@ The following examples show the defaults for various option values:
\-alias\ "mykey"
\-keysize
\ \ \ \ 2048\ (when\ using\ \-genkeypair\ and\ \-keyalg\ is\ "RSA",\ "DSA",\ or\ "RSASSA\-PSS")
\ \ \ \ 2048\ (when\ using\ \-genkeypair\ and\ \-keyalg\ is\ "RSA",\ "DSA",\ "RSASSA\-PSS",\ or\ "DH")
\ \ \ \ 256\ (when\ using\ \-genkeypair\ and\ \-keyalg\ is\ "EC")
\ \ \ \ 255\ (when\ using\ \-genkeypair\ and\ \-keyalg\ is\ "EdDSA")
\ \ \ \ 255\ (when\ using\ \-genkeypair\ and\ \-keyalg\ is\ "EdDSA",\ or\ "XDH)
\ \ \ \ 56\ (when\ using\ \-genseckey\ and\ \-keyalg\ is\ "DES")
\ \ \ \ 168\ (when\ using\ \-genseckey\ and\ \-keyalg\ is\ "DESede")
@ -2531,16 +2561,17 @@ The first certificate in the chain contains the public key that
corresponds to the private key.
.RS
.PP
When keys are first generated, the chain starts off containing a single
element, a self\-signed certificate.
When keys are first generated, the chain usually starts off containing a
single element, a self\-signed certificate.
See \-genkeypair in \f[B]Commands\f[R].
A self\-signed certificate is one for which the issuer (signer) is the
same as the subject.
The subject is the entity whose public key is being authenticated by the
certificate.
Whenever the \f[CB]\-genkeypair\f[R] command is called to generate a new
When the \f[CB]\-genkeypair\f[R] command is called to generate a new
public/private key pair, it also wraps the public key into a
self\-signed certificate.
self\-signed certificate (unless the \f[CB]\-signer\f[R] option is
specified).
.PP
Later, after a Certificate Signing Request (CSR) was generated with the
\f[CB]\-certreq\f[R] command and sent to a Certification Authority (CA),

2
src/java.rmi/share/man/rmiregistry.1
View File

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

2
src/java.scripting/share/man/jrunscript.1
View File

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

13
src/jdk.compiler/share/man/javac.1
View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVAC" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "JAVAC" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -360,6 +360,11 @@ Prints a synopsis of the set of extra options.
.RS
.RE
.TP
.B \f[CB]\-\-help\-lint\f[R]
Prints the supported keys for the \f[CB]\-Xlint\f[R] option.
.RS
.RE
.TP
.B \f[CB]\-implicit:\f[R][\f[CB]none\f[R], \f[CB]class\f[R]]
Specifies whether or not to generate class files for implicitly
referenced files:
@ -2111,18 +2116,18 @@ For example:
Warns about issues related to annotation processing.
The compiler generates this warning when you have a class that has an
annotation, and you use an annotation processor that cannot handle that
type of exception.
type of annotation.
For example, the following is a simple annotation processor:
.RS
.PP
\f[B]Source file AnnocProc.java\f[R]:
\f[B]Source file AnnoProc.java\f[R]:
.IP
.nf
\f[CB]
import\ java.util.*;
import\ javax.annotation.processing.*;
import\ javax.lang.model.*;
import\ javaz.lang.model.element.*;
import\ javax.lang.model.element.*;
\@SupportedAnnotationTypes("NotAnno")
public\ class\ AnnoProc\ extends\ AbstractProcessor\ {

2
src/jdk.compiler/share/man/serialver.1
View File

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

44
src/jdk.hotspot.agent/share/man/jhsdb.1
View File

@ -1,4 +1,4 @@
.\" Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2019, 2020, 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
@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JHSDB" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "JHSDB" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -31,12 +31,12 @@ analyze the content of a core dump from a crashed Java Virtual Machine
.SH SYNOPSIS
.PP
\f[CB]jhsdb\f[R] \f[CB]clhsdb\f[R] [\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R] \f[I]coredump\f[R] |
\f[CB]\-\-connect\f[R] \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R]\]
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R]
\f[I]coredump\f[R]]
.PP
\f[CB]jhsdb\f[R] \f[CB]hsdb\f[R] [\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R] \f[I]coredump\f[R] |
\f[CB]\-\-connect\f[R] \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R]\]
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R]
\f[I]coredump\f[R]]
.PP
\f[CB]jhsdb\f[R] \f[CB]debugd\f[R] (\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R]
@ -44,22 +44,22 @@ analyze the content of a core dump from a crashed Java Virtual Machine
.PP
\f[CB]jhsdb\f[R] \f[CB]jstack\f[R] (\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R] \f[I]coredump\f[R]
| \f[CB]\-\-connect\f[R] \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R])
| \f[CB]\-\-connect\f[R] \f[I][server\-id\@]debugd\-host\f[R])
[\f[I]options\f[R]]
.PP
\f[CB]jhsdb\f[R] \f[CB]jmap\f[R] (\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R] \f[I]coredump\f[R]
| \f[CB]\-\-connect\f[R] \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R])
| \f[CB]\-\-connect\f[R] \f[I][server\-id\@]debugd\-host\f[R])
[\f[I]options\f[R]]
.PP
\f[CB]jhsdb\f[R] \f[CB]jinfo\f[R] (\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R] \f[I]coredump\f[R]
| \f[CB]\-\-connect\f[R] \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R])
| \f[CB]\-\-connect\f[R] \f[I][server\-id\@]debugd\-host\f[R])
[\f[I]options\f[R]]
.PP
\f[CB]jhsdb\f[R] \f[CB]jsnap\f[R] (\f[CB]\-\-pid\f[R] \f[I]pid\f[R] |
\f[CB]\-\-exe\f[R] \f[I]executable\f[R] \f[CB]\-\-core\f[R] \f[I]coredump\f[R]
| \f[CB]\-\-connect\f[R] \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R])
| \f[CB]\-\-connect\f[R] \f[I][server\-id\@]debugd\-host\f[R])
[\f[I]options\f[R]]
.TP
.B \f[I]pid\f[R]
@ -81,7 +81,7 @@ The core file to which the \f[CB]jhsdb\f[R] tool should attach.
.RS
.RE
.TP
.B \f[I][serverid\@]debugd\-host[:registryport][/servername]\f[R]
.B \f[I][server\-id\@]debugd\-host\f[R]
An optional server ID and the address of the remote debug server
(debugd).
.RS
@ -158,10 +158,9 @@ Displays the options available for the \f[I]command\f[R].
.RE
.SH OPTIONS FOR THE DEBUGD MODE
.TP
.B \f[CB]\-\-serverid\f[R] \f[I]serverid\f[R]
.B \f[CB]\-\-serverid\f[R] \f[I]server\-id\f[R]
An optional unique ID for this debug server.
This is required if multiple debug servers are run on the same server instance.
It would be added to RMI object name for server instance.
This is required if multiple debug servers are run on the same machine.
.RS
.RE
.TP
@ -180,16 +179,6 @@ If the system property is not set, the default port 1099 is used.
.RS
.RE
.TP
.B \f[CB]\-\-disable-registry\f[R]
Disable starting RMI registry on startup.
This option overrides the system property
\[aq]sun.jvm.hotspot.rmi.startRegistry\[aq].
If not specified, RMI registry will be started on startup.
Otherwise it will not be started, and the already started RMI registry
will be used instead.
.RS
.RE
.TP
.B \f[CB]\-\-hostname\f[R] \f[I]hostname\f[R]
Sets the hostname the RMI connector is bound.
The value could be a hostname or an IPv4/IPv6 address.
@ -199,13 +188,6 @@ If not specified, the system property is used.
If the system property is not set, a system hostname is used.
.RS
.RE
.TP
.B \f[CB]\-\-servername\f[R] \f[I]servername\f[R]
Sets the instance name of debugd server to distinguish SA debugee.
It is used for RMI object name for server instance.
If not specified, "SARemoteDebugger" will be used.
.RS
.RE
.SH OPTIONS FOR THE JINFO MODE
.TP
.B \f[CB]\-\-flags\f[R]

2
src/jdk.jartool/share/man/jar.1
View File

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

25
src/jdk.jartool/share/man/jarsigner.1
View File

@ -1,4 +1,4 @@
.\" Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1998, 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
@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JARSIGNER" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "JARSIGNER" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -554,16 +554,19 @@ See Signature File.
.PP
One reason the hash of the manifest file that is stored in the
\f[CB]\&.SF\f[R] file header might not equal the hash of the current
manifest file is that one or more files were added to the JAR file (with
the \f[CB]jar\f[R] tool) after the signature and \f[CB]\&.SF\f[R] file were
generated.
When the \f[CB]jar\f[R] tool is used to add files, the manifest file is
changed by adding sections to it for the new files, but the
\f[CB]\&.SF\f[R] file isn\[aq]t changed.
A verification is still considered successful when none of the files
that were in the JAR file when the signature was generated have been
manifest file is that it might contain sections for newly added files
after the file was signed.
For example, suppose one or more files were added to the signed JAR file
(using the \f[CB]jar\f[R] tool) that already contains a signature and a
\f[CB]\&.SF\f[R] file.
If the JAR file is signed again by a different signer, then the manifest
file is changed (sections are added to it for the new files by the
\f[CB]jarsigner\f[R] tool) and a new \f[CB]\&.SF\f[R] file is created, but
the original \f[CB]\&.SF\f[R] file is unchanged.
A verification is still considered successful if none of the files that
were in the JAR file when the original signature was generated have been
changed since then.
This happens when the hashes in the non\-header sections of the
This is because the hashes in the non\-header sections of the
\f[CB]\&.SF\f[R] file equal the hashes of the corresponding sections in
the manifest file.
.RE

8
src/jdk.javadoc/share/man/javadoc.1
View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVADOC" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "JAVADOC" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -1095,9 +1095,9 @@ Alternately, you can use the \f[CB]\-taglet\f[R] option in place of its
.B \f[CB]\-tagletpath\f[R] \f[I]tagletpathlist\f[R]
Specifies the search paths for finding taglet class files.
The \f[I]tagletpathlist\f[R] can contain multiple paths by separating
them with a colon (\f[CB]:\f[R]).
The \f[CB]javadoc\f[R] tool searches all subdirectories of the specified
paths.
them with the platform path separator (\f[CB];\f[R] on Windows; \f[CB]:\f[R]
on other platforms.) The \f[CB]javadoc\f[R] tool searches all
subdirectories of the specified paths.
.RS
.RE
.TP

32
src/jdk.jcmd/share/man/jcmd.1
View File

@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JCMD" "1" "2021" "JDK 17\-ea" "JDK Commands"
.TH "JCMD" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -563,21 +563,25 @@ Use \f[CB]none\f[R] to start a recording without a predefined
configuration file.
(STRING, \f[CB]JAVA\-HOME\f[R]/lib/jfr/default.jfc)
.PP
Event settings and .jfc options can also be specified using the following
Event settings and .jfc options can be specified using the following
syntax:
.TP
.B \f[CB]option=\f[R]\f[I]value\f[R]
Specifies the option value to modify. To list available options, use the
JAVA_HOME/bin/jfr tool.
.TP
.B \f[CB]event-setting=\f[R]\f[I]value\f[R]
Specifies the event setting value to modify. Use the form:
<event-name>#<setting-name>=<value>
To add a new event setting, prefix the event name with '+'.
.IP \[bu] 2
\f[CB]option\f[R]: (Optional) Specifies the option value to modify.
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].
.PP
In case of a conflict between a parameter and a .jfc option, the parameter
will take precedence. The whitespace delimiter can be omitted for timespan values, i.e. 20ms. For
more information about the settings syntax, see Javadoc of the jdk.jfr package.
You can specify values for multiple event settings and .jfc options by
separating them with a whitespace.
In case of a conflict between a parameter and a .jfc option, the
parameter will take precedence.
The whitespace delimiter can be omitted for timespan values, i.e.
20ms.
For more information about the settings syntax, see Javadoc of the
jdk.jfr package.
.RE
.TP
.B \f[CB]JFR.stop\f[R] [\f[I]options\f[R]]

2
src/jdk.jcmd/share/man/jinfo.1
View File

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

2
src/jdk.jcmd/share/man/jmap.1
View File

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

2
src/jdk.jcmd/share/man/jps.1
View File

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

2
src/jdk.jcmd/share/man/jstack.1
View File

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

2
src/jdk.jcmd/share/man/jstat.1
View File

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

2
src/jdk.jconsole/share/man/jconsole.1
View File

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

2
src/jdk.jdeps/share/man/javap.1
View File

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

2
src/jdk.jdeps/share/man/jdeprscan.1
View File

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

2
src/jdk.jdeps/share/man/jdeps.1
View File

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

2
src/jdk.jdi/share/man/jdb.1
View File

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

2
src/jdk.jfr/share/man/jfr.1
View File

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

2
src/jdk.jlink/share/man/jlink.1
View File

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

2
src/jdk.jlink/share/man/jmod.1
View File

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

185
src/jdk.jpackage/share/man/jpackage.1
View File

@ -1,4 +1,4 @@
.\" Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2018, 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
@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JPACKAGE" "1" "2019" "JDK 17\-ea" "JDK Commands"
.TH "JPACKAGE" "1" "2021" "JDK 17" "JDK Commands"
.hy
.SH NAME
.PP
@ -50,7 +50,7 @@ customized in various ways.
.SS Generic Options:
.TP
.B \f[CB]\@\f[R]\f[I]filename\f[R]
Read options and/or mode from a file.
Read options from a file.
.RS
.PP
This option can be used multiple times.
@ -68,17 +68,17 @@ be created.
.RE
.TP
.B \f[CB]\-\-app\-version\f[R] <version>
Version of the application and/or package`
Version of the application and/or package
.RS
.RE
.TP
.B \f[CB]\-\-copyright\f[R] <copyright string>
Copyright for the application.
Copyright for the application
.RS
.RE
.TP
.B \f[CB]\-\-description\f[R] <description string>
Description of the application.
Description of the application
.RS
.RE
.TP
@ -88,8 +88,14 @@ 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)
.RS
.RE
.TP
.B \f[CB]\-\-name\f[R] or \f[CB]\-n\f[R] <name>
Name of the application and/or package.
Name of the application and/or package
.RS
.RE
.TP
@ -101,9 +107,9 @@ Defaults to the current working directory.
(absolute path or relative to the current directory).
.RE
.TP
.B \f[CB]\-\-temp\f[R] <file path>
.B \f[CB]\-\-temp\f[R] <directory path>
Path of a new or empty directory used to create temporary files
(absolute path or relative to the current directory).
(absolute path or relative to the current directory)
.RS
.PP
If specified, the temp dir will not be removed upon the task completion
@ -114,7 +120,7 @@ the task completion.
.RE
.TP
.B \f[CB]\-\-vendor\f[R] <vendor string>
Vendor of the application.
Vendor of the application
.RS
.RE
.TP
@ -130,7 +136,7 @@ Print the product version to the output stream and exit.
.SS Options for creating the runtime image:
.TP
.B \f[CB]\-\-add\-modules\f[R] <module name> [\f[CB],\f[R]<module name>...]
A comma (",") separated list of modules to add.
A comma (",") separated list of modules to add
.RS
.PP
This module list, along with the main module (if specified) will be
@ -143,7 +149,7 @@ This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-module\-path\f[R] or \f[CB]\-p\f[R] <module path>...
A File.pathSeparator separated list of paths.
A File.pathSeparator separated list of paths
.RS
.PP
Each path is either a directory of modules or the path to a modular jar,
@ -162,27 +168,19 @@ If not specified, defaults to "\-\-strip\-native\-commands
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-runtime\-image\f[R] <file paths>
.B \f[CB]\-\-runtime\-image\f[R] <directory path>
Path of the predefined runtime image that will be copied into the
application image (absolute path or relative to the current directory).
application image (absolute path or relative to the current directory)
.RS
.PP
If \-\-runtime\-image is not specified, jpackage will run jlink to
create the runtime image using options: \-\-strip\-debug,
\-\-no\-header\-files, \-\-no\-man\-pages, and
\-\-strip\-native\-commands.
create the runtime image using options specified by \-\-jlink\-options.
.RE
.SS Options for creating the application image:
.TP
.B \f[CB]\-\-icon\f[R] <icon file path>
Path of the icon of the application bundle (absolute path or relative to
the current directory).
.RS
.RE
.TP
.B \f[CB]\-\-input\f[R] or \f[CB]\-i\f[R] <input path>
Path of the input directory that contains the files to be packaged
(absolute path or relative to the current directory).
(absolute path or relative to the current directory)
.RS
.PP
All files in the input directory will be packaged into the application
@ -192,13 +190,12 @@ image.
.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).
of key, value pairs (absolute path or relative to the current directory)
.RS
.PP
The keys "module", "add\-modules", "main\-jar", "main\-class",
"arguments", "java\-options", "app\-version", "icon", and "win\-console"
can be used.
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.
.PP
These options are added to, or used to overwrite, the original command
line options to build an additional alternative launcher.
@ -211,21 +208,21 @@ launchers.
.TP
.B \f[CB]\-\-arguments\f[R] <main class arguments>
Command line arguments to pass to the main class if no command line
arguments are given to the launcher.
arguments are given to the launcher
.RS
.PP
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-java\-options\f[R] <java options>
Options to pass to the Java runtime.
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>
Qualified name of the application main class to execute.
Qualified name of the application main class to execute
.RS
.PP
This option can only be used if \-\-main\-jar is specified.
@ -233,17 +230,18 @@ This option can only be used if \-\-main\-jar is specified.
.TP
.B \f[CB]\-\-main\-jar\f[R] <main jar file>
The main JAR of the application; containing the main class (specified as
a path relative to the input path).
a path relative to the input path)
.RS
.PP
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>]
The main module (and optionally main class) of the application This
module must be located on the module path.
The main module (and optionally main class) of the application
.RS
.PP
This module must be located on the module path.
.PP
When this option is specified, the main module will be linked in the
Java runtime image.
Either \-\-module or \-\-main\-jar option can be specified but not both.
@ -259,7 +257,7 @@ application which requires console interactions
.SS macOS platform options (available only when running on macOS):
.TP
.B \f[CB]\-\-mac\-package\-identifier\f[R] <ID string>
An identifier that uniquely identifies the application for macOSX.
An identifier that uniquely identifies the application for macOS
.RS
.PP
Defaults to the the main class name.
@ -269,7 +267,7 @@ characters.
.RE
.TP
.B \f[CB]\-\-mac\-package\-name\f[R] <name string>
Name of the application as it appears in the Menu Bar.
Name of the application as it appears in the Menu Bar
.RS
.PP
This can be different from the application name.
@ -279,10 +277,10 @@ displaying in the menu bar and the application Info window.
Defaults to the application name.
.RE
.TP
.B \f[CB]\-\-mac\-bundle\-signing\-prefix\f[R] <prefix string>
When signing the application bundle, this value is prefixed to all
components that need to be signed that don\[aq]t have an existing bundle
identifier.
.B \f[CB]\-\-mac\-package\-signing\-prefix\f[R] <prefix string>
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.
.RS
.RE
.TP
@ -291,34 +289,55 @@ Request that the bundle be signed.
.RS
.RE
.TP
.B \f[CB]\-\-mac\-signing\-keychain\f[R] <file path>
Path of the keychain to search for the signing identity (absolute path
or relative to the current directory).
.B \f[CB]\-\-mac\-signing\-keychain\f[R] <keychain name>
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>
Team name portion in Apple signing identities\[aq] names.
Team or user name portion in Apple signing identities
.RS
.RE
.TP
.B \f[CB]\-\-mac\-app\-store\f[R]
Indicates that the jpackage output is intended for the Mac App Store.
.RS
.RE
.TP
.B \f[CB]\-\-mac\-entitlements\f[R] <file path>
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>
String used to construct LSApplicationCategoryType in application plist
.RS
.PP
For example "Developer ID Application: <team name>"
The default value is "utilities".
.RE
.SS Options for creating the application package:
.TP
.B \f[CB]\-\-app\-image\f[R] <file path>
Location of the predefined application image that is used to build an
installable package (absolute path or relative to the current
directory).
.B \f[CB]\-\-about\-url\f[R] <url>
URL of the application\[aq]s home page
.RS
.RE
.TP
.B \f[CB]\-\-app\-image\f[R] <directory path>
Location of the predefined application image that is used to build an
installable package
.RS
.PP
(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>
Path to a Properties file that contains list of key, value pairs
(absolute path or relative to the current directory).
(absolute path or relative to the current directory)
.RS
.PP
The keys "extension", "mime\-type", "icon", and "description" can be
@ -327,32 +346,31 @@ used to describe the association.
This option can be used multiple times.
.RE
.TP
.B \f[CB]\-\-install\-dir\f[R] <file path>
Absolute path of the installation directory of the application on OS X
or Linux.
Relative sub\-path of the installation location of the application such
as "Program Files" or "AppData" on Windows.
.B \f[CB]\-\-install\-dir\f[R] <directory path>
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).
directory)
.RS
.RE
.TP
.B \f[CB]\-\-resource\-dir\f[R] <path>
.B \f[CB]\-\-resource\-dir\f[R] <directory path>
Path to override jpackage resources (absolute path or relative to the
current directory).
current directory)
.RS
.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] <file\-path>
.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).
relative to the current directory)
.RS
.PP
Option is required when creating a runtime installer.
@ -366,44 +384,62 @@ product is installed.
.RS
.RE
.TP
.B \f[CB]\-\-win\-help\-url\f[R] <url>
URL where user can obtain further information or technical support
.RS
.RE
.TP
.B \f[CB]\-\-win\-menu\f[R]
Adds the application to the system menu.
Request to add a Start Menu shortcut for this application
.RS
.RE
.TP
.B \f[CB]\-\-win\-menu\-group\f[R] <menu group name>
Start Menu group this application is placed in.
Start Menu group this application is placed in
.RS
.RE
.TP
.B \f[CB]\-\-win\-per\-user\-install\f[R]
Request to perform an install on a per\-user basis.
Request to perform an install on a per\-user basis
.RS
.RE
.TP
.B \f[CB]\-\-win\-shortcut\f[R]
Creates a desktop shortcut for the application.
Request to create a desktop shortcut for this application
.RS
.RE
.TP
.B \f[CB]\-\-win\-shortcut\-prompt\f[R]
Adds a dialog to enable the user to choose if shortcuts will be created
by installer
.RS
.RE
.TP
.B \f[CB]\-\-win\-update\-url\f[R] <url>
URL of available application update information
.RS
.RE
.TP
.B \f[CB]\-\-win\-upgrade\-uuid\f[R] <id string>
UUID associated with upgrades for this package.
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>
Name for Linux package, defaults to the application name.
Name for Linux package
.RS
.PP
Defaults to the application name.
.RE
.TP
.B \f[CB]\-\-linux\-deb\-maintainer\f[R] <email address>
Maintainer for .deb bundle.
Maintainer for .deb bundle
.RS
.RE
.TP
.B \f[CB]\-\-linux\-menu\-group\f[R] <menu\-group\-name>
Menu group this application is placed in.
Menu group this application is placed in
.RS
.RE
.TP
@ -413,24 +449,24 @@ Required packages or capabilities for the application
.RE
.TP
.B \f[CB]\-\-linux\-rpm\-license\-type\f[R] <type string>
Type of the license ("License: <value>" of the RPM .spec).
Type of the license ("License: <value>" of the RPM .spec)
.RS
.RE
.TP
.B \f[CB]\-\-linux\-app\-release\f[R] <release string>
Release value of the RPM <name>.spec file or Debian revision value of
the DEB control file.
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.
file
.RS
.RE
.TP
.B \f[CB]\-\-linux\-shortcut\f[R]
Creates a shortcut for the application
Creates a shortcut for the application.
.RS
.RE
.SH JPACKAGE EXAMPLES
@ -468,7 +504,8 @@ For\ a\ non\-modular\ application:
\ \ \ \ jpackage\ \-\-type\ app\-image\ \-i\ inputDir\ \-n\ name\ \\
\ \ \ \ \ \ \ \ \-\-main\-class\ className\ \-\-main\-jar\ myJar.jar
To\ provide\ your\ own\ options\ to\ jlink,\ run\ jlink\ separately:
\ \ \ \ jlink\ \-\-output\ appRuntimeImage\ \-p\ modulePath\ \-m\ moduleName\ \\
\ \ \ \ jlink\ \-\-output\ appRuntimeImage\ \-p\ modulePath\ \\
\ \ \ \ \ \ \ \ \-\-add\-modules\ moduleName\ \\
\ \ \ \ \ \ \ \ \-\-no\-header\-files\ [<additional\ jlink\ options>...]
\ \ \ \ jpackage\ \-\-type\ app\-image\ \-n\ name\ \\
\ \ \ \ \ \ \ \ \-m\ moduleName/className\ \-\-runtime\-image\ appRuntimeImage

2
src/jdk.jshell/share/man/jshell.1
View File

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

2
src/jdk.jstatd/share/man/jstatd.1
View File

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