Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JDK-8297164: Update troff man pages and CheckManPageOptions.java #11223

Closed
Show file tree
Hide file tree
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
3,717 changes: 1,670 additions & 2,047 deletions src/java.base/share/man/java.1

Large diffs are not rendered by default.

2,110 changes: 1,053 additions & 1,057 deletions src/java.base/share/man/keytool.1

Large diffs are not rendered by default.

56 changes: 32 additions & 24 deletions src/java.rmi/share/man/rmiregistry.1
Expand Up @@ -19,39 +19,49 @@
.\" or visit www.oracle.com if you need additional information or have any
.\" questions.
.\"
.\" Automatically generated by Pandoc 2.3.1
.\" Automatically generated by Pandoc 2.19.2
.\"
.TH "RMIREGISTRY" "1" "2023" "JDK 20\-ea" "JDK Commands"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[R]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "RMIREGISTRY" "1" "2023" "JDK 20-ea" "JDK Commands"
.hy
.SH NAME
.PP
rmiregistry \- create and start a remote object registry on the
specified port on the current host
rmiregistry - create and start a remote object registry on the specified
port on the current host
.SH SYNOPSIS
.PP
\f[CB]rmiregistry\f[R] [\f[I]options\f[R]] [\f[I]port\f[R]]
\f[V]rmiregistry\f[R] [\f[I]options\f[R]] [\f[I]port\f[R]]
.TP
.B \f[I]options\f[R]
This represents the option for the \f[CB]rmiregistry\f[R] command.
\f[I]options\f[R]
This represents the option for the \f[V]rmiregistry\f[R] command.
See \f[B]Options\f[R]
.RS
.RE
.TP
.B \f[I]port\f[R]
\f[I]port\f[R]
The number of a port on the current host at which to start the remote
object registry.
.RS
.RE
.SH DESCRIPTION
.PP
The \f[CB]rmiregistry\f[R] command creates and starts a remote object
The \f[V]rmiregistry\f[R] command creates and starts a remote object
registry on the specified port on the current host.
If the port is omitted, then the registry is started on port 1099.
The \f[CB]rmiregistry\f[R] command produces no output and is typically run
in the background, for example:
The \f[V]rmiregistry\f[R] command produces no output and is typically
run in the background, for example:
.RS
.PP
\f[CB]rmiregistry\ &\f[R]
\f[V]rmiregistry &\f[R]
.RE
.PP
A remote object registry is a bootstrap naming service that\[aq]s used
Expand All @@ -61,14 +71,14 @@ make remote method invocations.
.PP
The registry is typically used to locate the first remote object on
which an application needs to call methods.
That object then provides application\-specific support for finding
other objects.
That object then provides application-specific support for finding other
objects.
.PP
The methods of the \f[CB]java.rmi.registry.LocateRegistry\f[R] class are
The methods of the \f[V]java.rmi.registry.LocateRegistry\f[R] class are
used to get a registry operating on the local host or local host and
port.
.PP
The URL\-based methods of the \f[CB]java.rmi.Naming\f[R] class operate on
The URL-based methods of the \f[V]java.rmi.Naming\f[R] class operate on
a registry and can be used to:
.IP \[bu] 2
Bind the specified name to a remote object
Expand All @@ -84,9 +94,7 @@ Destroy the binding for the specified name that\[aq]s associated with a
remote object
.SH OPTIONS
.TP
.B \f[CB]\-J\f[R]\f[I]option\f[R]
\f[V]-J\f[R]\f[I]option\f[R]
Used with any Java option to pass the \f[I]option\f[R] following the
\f[CB]\-J\f[R] (no spaces between the \f[CB]\-J\f[R] and the option) to the
\f[V]-J\f[R] (no spaces between the \f[V]-J\f[R] and the option) to the
Java interpreter.
.RS
.RE
130 changes: 60 additions & 70 deletions src/java.scripting/share/man/jrunscript.1
Expand Up @@ -19,157 +19,147 @@
.\" or visit www.oracle.com if you need additional information or have any
.\" questions.
.\"
.\" Automatically generated by Pandoc 2.3.1
.\" Automatically generated by Pandoc 2.19.2
.\"
.TH "JRUNSCRIPT" "1" "2023" "JDK 20\-ea" "JDK Commands"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[R]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "JRUNSCRIPT" "1" "2023" "JDK 20-ea" "JDK Commands"
.hy
.SH NAME
.PP
jrunscript \- run a command\-line script shell that supports interactive
jrunscript - run a command-line script shell that supports interactive
and batch modes
.SH SYNOPSIS
.PP
\f[B]Note:\f[R]
.PP
This tool is \f[B]experimental\f[R] and unsupported.
.PP
\f[CB]jrunscript\f[R] [\f[I]options\f[R]] [\f[I]arguments\f[R]]
\f[V]jrunscript\f[R] [\f[I]options\f[R]] [\f[I]arguments\f[R]]
.TP
.B \f[I]options\f[R]
This represents the \f[CB]jrunscript\f[R] command\-line options that can
\f[I]options\f[R]
This represents the \f[V]jrunscript\f[R] command-line options that can
be used.
See \f[B]Options for the jrunscript Command\f[R].
.RS
.RE
.TP
.B \f[I]arguments\f[R]
\f[I]arguments\f[R]
Arguments, when used, follow immediately after options or the command
name.
See \f[B]Arguments\f[R].
.RS
.RE
.SH DESCRIPTION
.PP
The \f[CB]jrunscript\f[R] command is a language\-independent command\-line
The \f[V]jrunscript\f[R] command is a language-independent command-line
script shell.
The \f[CB]jrunscript\f[R] command supports both an interactive
(read\-eval\-print) mode and a batch (\f[CB]\-f\f[R] option) mode of
script execution.
By default, JavaScript is the language used, but the \f[CB]\-l\f[R] option
The \f[V]jrunscript\f[R] command supports both an interactive
(read-eval-print) mode and a batch (\f[V]-f\f[R] option) mode of script
execution.
By default, JavaScript is the language used, but the \f[V]-l\f[R] option
can be used to specify a different language.
By using Java to scripting language communication, the
\f[CB]jrunscript\f[R] command supports an exploratory programming style.
\f[V]jrunscript\f[R] command supports an exploratory programming style.
.PP
If JavaScript is used, then before it evaluates a user defined script,
the \f[CB]jrunscript\f[R] command initializes certain built\-in functions
the \f[V]jrunscript\f[R] command initializes certain built-in functions
and objects, which are documented in the API Specification for
\f[CB]jrunscript\f[R] JavaScript built\-in functions.
\f[V]jrunscript\f[R] JavaScript built-in functions.
.SH OPTIONS FOR THE JRUNSCRIPT COMMAND
.TP
.B \f[CB]\-cp\f[R] \f[I]path\f[R] or \f[CB]\-classpath\f[R] \f[I]path\f[R]
\f[V]-cp\f[R] \f[I]path\f[R] or \f[V]-classpath\f[R] \f[I]path\f[R]
Indicates where any class files are that the script needs to access.
.RS
.RE
.TP
.B \f[CB]\-D\f[R]\f[I]name\f[R]\f[CB]=\f[R]\f[I]value\f[R]
\f[V]-D\f[R]\f[I]name\f[R]\f[V]=\f[R]\f[I]value\f[R]
Sets a Java system property.
.RS
.RE
.TP
.B \f[CB]\-J\f[R]\f[I]flag\f[R]
\f[V]-J\f[R]\f[I]flag\f[R]
Passes \f[I]flag\f[R] directly to the Java Virtual Machine where the
\f[CB]jrunscript\f[R] command is running.
.RS
.RE
\f[V]jrunscript\f[R] command is running.
.TP
.B \f[CB]\-l\f[R] \f[I]language\f[R]
\f[V]-l\f[R] \f[I]language\f[R]
Uses the specified scripting language.
By default, JavaScript is used.
To use other scripting languages, you must specify the corresponding
script engine\[aq]s JAR file with the \f[CB]\-cp\f[R] or
\f[CB]\-classpath\f[R] option.
.RS
.RE
script engine\[aq]s JAR file with the \f[V]-cp\f[R] or
\f[V]-classpath\f[R] option.
.TP
.B \f[CB]\-e\f[R] \f[I]script\f[R]
\f[V]-e\f[R] \f[I]script\f[R]
Evaluates the specified script.
This option can be used to run one\-line scripts that are specified
This option can be used to run one-line scripts that are specified
completely on the command line.
.RS
.RE
.TP
.B \f[CB]\-encoding\f[R] \f[I]encoding\f[R]
\f[V]-encoding\f[R] \f[I]encoding\f[R]
Specifies the character encoding used to read script files.
.RS
.RE
.TP
.B \f[CB]\-f\f[R] \f[I]script\-file\f[R]
\f[V]-f\f[R] \f[I]script-file\f[R]
Evaluates the specified script file (batch mode).
.RS
.RE
.TP
.B \f[CB]\-f\ \-\f[R]
\f[V]-f -\f[R]
Enters interactive mode to read and evaluate a script from standard
input.
.RS
.RE
.TP
.B \f[CB]\-help\f[R] or \f[CB]\-?\f[R]
\f[V]-help\f[R] or \f[V]-?\f[R]
Displays a help message and exits.
.RS
.RE
.TP
.B \f[CB]\-q\f[R]
\f[V]-q\f[R]
Lists all script engines available and exits.
.RS
.RE
.SH ARGUMENTS
.PP
If arguments are present and if no \f[CB]\-e\f[R] or \f[CB]\-f\f[R] option
If arguments are present and if no \f[V]-e\f[R] or \f[V]-f\f[R] option
is used, then the first argument is the script file and the rest of the
arguments, if any, are passed as script arguments.
If arguments and the \f[CB]\-e\f[R] or the \f[CB]\-f\f[R] option are used,
If arguments and the \f[V]-e\f[R] or the \f[V]-f\f[R] option are used,
then all arguments are passed as script arguments.
If arguments \f[CB]\-e\f[R] and \f[CB]\-f\f[R] are missing, then the
If arguments \f[V]-e\f[R] and \f[V]-f\f[R] are missing, then the
interactive mode is used.
.SH EXAMPLE OF EXECUTING INLINE SCRIPTS
.RS
.PP
\f[CB]jrunscript\ \-e\ "print(\[aq]hello\ world\[aq])"\f[R]
\f[V]jrunscript -e \[dq]print(\[aq]hello world\[aq])\[dq]\f[R]
.RE
.RS
.PP
\f[CB]jrunscript\ \-e\ "cat(\[aq]http://www.example.com\[aq])"\f[R]
\f[V]jrunscript -e \[dq]cat(\[aq]http://www.example.com\[aq])\[dq]\f[R]
.RE
.SH EXAMPLE OF USING SPECIFIED LANGUAGE AND EVALUATE THE SCRIPT FILE
.RS
.PP
\f[CB]jrunscript\ \-l\ js\ \-f\ test.js\f[R]
\f[V]jrunscript -l js -f test.js\f[R]
.RE
.SH EXAMPLE OF INTERACTIVE MODE
.IP
.nf
\f[CB]
jrunscript
js>\ print(\[aq]Hello\ World\\n\[aq]);
Hello\ World
js>\ 34\ +\ 55
js> print(\[aq]Hello World\[rs]n\[aq]);
Hello World
js> 34 + 55
89.0
js>\ t\ =\ new\ java.lang.Thread(function()\ {\ print(\[aq]Hello\ World\\n\[aq]);\ })
Thread[Thread\-0,5,main]
js>\ t.start()
js>\ Hello\ World
js> t = new java.lang.Thread(function() { print(\[aq]Hello World\[rs]n\[aq]); })
Thread[Thread-0,5,main]
js> t.start()
js> Hello World

js>
\f[R]
.fi
.SH RUN SCRIPT FILE WITH SCRIPT ARGUMENTS
.PP
In this example, the \f[CB]test.js\f[R] file is the script file.
The \f[CB]arg1\f[R], \f[CB]arg2\f[R], and \f[CB]arg3\f[R] arguments are passed
to the script.
In this example, the \f[V]test.js\f[R] file is the script file.
The \f[V]arg1\f[R], \f[V]arg2\f[R], and \f[V]arg3\f[R] arguments are
passed to the script.
The script can access these arguments with an arguments array.
.RS
.PP
\f[CB]jrunscript\ test.js\ arg1\ arg2\ arg3\f[R]
\f[V]jrunscript test.js arg1 arg2 arg3\f[R]
.RE