Skip to content

Commit 5a45c25

Browse files
8297164: Update troff man pages and CheckManPageOptions.java
Reviewed-by: dholmes
1 parent f12710e commit 5a45c25

File tree

29 files changed

+7376
-8492
lines changed

29 files changed

+7376
-8492
lines changed

src/java.base/share/man/java.1

+1,670-2,047
Large diffs are not rendered by default.

src/java.base/share/man/keytool.1

+1,053-1,057
Large diffs are not rendered by default.

src/java.rmi/share/man/rmiregistry.1

+32-24
Original file line numberDiff line numberDiff line change
@@ -19,39 +19,49 @@
1919
.\" or visit www.oracle.com if you need additional information or have any
2020
.\" questions.
2121
.\"
22-
.\" Automatically generated by Pandoc 2.3.1
22+
.\" Automatically generated by Pandoc 2.19.2
2323
.\"
24-
.TH "RMIREGISTRY" "1" "2023" "JDK 20\-ea" "JDK Commands"
24+
.\" Define V font for inline verbatim, using C font in formats
25+
.\" that render this, and otherwise B font.
26+
.ie "\f[CB]x\f[R]"x" \{\
27+
. ftr V B
28+
. ftr VI BI
29+
. ftr VB B
30+
. ftr VBI BI
31+
.\}
32+
.el \{\
33+
. ftr V CR
34+
. ftr VI CI
35+
. ftr VB CB
36+
. ftr VBI CBI
37+
.\}
38+
.TH "RMIREGISTRY" "1" "2023" "JDK 20-ea" "JDK Commands"
2539
.hy
2640
.SH NAME
2741
.PP
28-
rmiregistry \- create and start a remote object registry on the
29-
specified port on the current host
42+
rmiregistry - create and start a remote object registry on the specified
43+
port on the current host
3044
.SH SYNOPSIS
3145
.PP
32-
\f[CB]rmiregistry\f[R] [\f[I]options\f[R]] [\f[I]port\f[R]]
46+
\f[V]rmiregistry\f[R] [\f[I]options\f[R]] [\f[I]port\f[R]]
3347
.TP
34-
.B \f[I]options\f[R]
35-
This represents the option for the \f[CB]rmiregistry\f[R] command.
48+
\f[I]options\f[R]
49+
This represents the option for the \f[V]rmiregistry\f[R] command.
3650
See \f[B]Options\f[R]
37-
.RS
38-
.RE
3951
.TP
40-
.B \f[I]port\f[R]
52+
\f[I]port\f[R]
4153
The number of a port on the current host at which to start the remote
4254
object registry.
43-
.RS
44-
.RE
4555
.SH DESCRIPTION
4656
.PP
47-
The \f[CB]rmiregistry\f[R] command creates and starts a remote object
57+
The \f[V]rmiregistry\f[R] command creates and starts a remote object
4858
registry on the specified port on the current host.
4959
If the port is omitted, then the registry is started on port 1099.
50-
The \f[CB]rmiregistry\f[R] command produces no output and is typically run
51-
in the background, for example:
60+
The \f[V]rmiregistry\f[R] command produces no output and is typically
61+
run in the background, for example:
5262
.RS
5363
.PP
54-
\f[CB]rmiregistry\ &\f[R]
64+
\f[V]rmiregistry &\f[R]
5565
.RE
5666
.PP
5767
A remote object registry is a bootstrap naming service that\[aq]s used
@@ -61,14 +71,14 @@ make remote method invocations.
6171
.PP
6272
The registry is typically used to locate the first remote object on
6373
which an application needs to call methods.
64-
That object then provides application\-specific support for finding
65-
other objects.
74+
That object then provides application-specific support for finding other
75+
objects.
6676
.PP
67-
The methods of the \f[CB]java.rmi.registry.LocateRegistry\f[R] class are
77+
The methods of the \f[V]java.rmi.registry.LocateRegistry\f[R] class are
6878
used to get a registry operating on the local host or local host and
6979
port.
7080
.PP
71-
The URL\-based methods of the \f[CB]java.rmi.Naming\f[R] class operate on
81+
The URL-based methods of the \f[V]java.rmi.Naming\f[R] class operate on
7282
a registry and can be used to:
7383
.IP \[bu] 2
7484
Bind the specified name to a remote object
@@ -84,9 +94,7 @@ Destroy the binding for the specified name that\[aq]s associated with a
8494
remote object
8595
.SH OPTIONS
8696
.TP
87-
.B \f[CB]\-J\f[R]\f[I]option\f[R]
97+
\f[V]-J\f[R]\f[I]option\f[R]
8898
Used with any Java option to pass the \f[I]option\f[R] following the
89-
\f[CB]\-J\f[R] (no spaces between the \f[CB]\-J\f[R] and the option) to the
99+
\f[V]-J\f[R] (no spaces between the \f[V]-J\f[R] and the option) to the
90100
Java interpreter.
91-
.RS
92-
.RE

src/java.scripting/share/man/jrunscript.1

+60-70
Original file line numberDiff line numberDiff line change
@@ -19,157 +19,147 @@
1919
.\" or visit www.oracle.com if you need additional information or have any
2020
.\" questions.
2121
.\"
22-
.\" Automatically generated by Pandoc 2.3.1
22+
.\" Automatically generated by Pandoc 2.19.2
2323
.\"
24-
.TH "JRUNSCRIPT" "1" "2023" "JDK 20\-ea" "JDK Commands"
24+
.\" Define V font for inline verbatim, using C font in formats
25+
.\" that render this, and otherwise B font.
26+
.ie "\f[CB]x\f[R]"x" \{\
27+
. ftr V B
28+
. ftr VI BI
29+
. ftr VB B
30+
. ftr VBI BI
31+
.\}
32+
.el \{\
33+
. ftr V CR
34+
. ftr VI CI
35+
. ftr VB CB
36+
. ftr VBI CBI
37+
.\}
38+
.TH "JRUNSCRIPT" "1" "2023" "JDK 20-ea" "JDK Commands"
2539
.hy
2640
.SH NAME
2741
.PP
28-
jrunscript \- run a command\-line script shell that supports interactive
42+
jrunscript - run a command-line script shell that supports interactive
2943
and batch modes
3044
.SH SYNOPSIS
3145
.PP
3246
\f[B]Note:\f[R]
3347
.PP
3448
This tool is \f[B]experimental\f[R] and unsupported.
3549
.PP
36-
\f[CB]jrunscript\f[R] [\f[I]options\f[R]] [\f[I]arguments\f[R]]
50+
\f[V]jrunscript\f[R] [\f[I]options\f[R]] [\f[I]arguments\f[R]]
3751
.TP
38-
.B \f[I]options\f[R]
39-
This represents the \f[CB]jrunscript\f[R] command\-line options that can
52+
\f[I]options\f[R]
53+
This represents the \f[V]jrunscript\f[R] command-line options that can
4054
be used.
4155
See \f[B]Options for the jrunscript Command\f[R].
42-
.RS
43-
.RE
4456
.TP
45-
.B \f[I]arguments\f[R]
57+
\f[I]arguments\f[R]
4658
Arguments, when used, follow immediately after options or the command
4759
name.
4860
See \f[B]Arguments\f[R].
49-
.RS
50-
.RE
5161
.SH DESCRIPTION
5262
.PP
53-
The \f[CB]jrunscript\f[R] command is a language\-independent command\-line
63+
The \f[V]jrunscript\f[R] command is a language-independent command-line
5464
script shell.
55-
The \f[CB]jrunscript\f[R] command supports both an interactive
56-
(read\-eval\-print) mode and a batch (\f[CB]\-f\f[R] option) mode of
57-
script execution.
58-
By default, JavaScript is the language used, but the \f[CB]\-l\f[R] option
65+
The \f[V]jrunscript\f[R] command supports both an interactive
66+
(read-eval-print) mode and a batch (\f[V]-f\f[R] option) mode of script
67+
execution.
68+
By default, JavaScript is the language used, but the \f[V]-l\f[R] option
5969
can be used to specify a different language.
6070
By using Java to scripting language communication, the
61-
\f[CB]jrunscript\f[R] command supports an exploratory programming style.
71+
\f[V]jrunscript\f[R] command supports an exploratory programming style.
6272
.PP
6373
If JavaScript is used, then before it evaluates a user defined script,
64-
the \f[CB]jrunscript\f[R] command initializes certain built\-in functions
74+
the \f[V]jrunscript\f[R] command initializes certain built-in functions
6575
and objects, which are documented in the API Specification for
66-
\f[CB]jrunscript\f[R] JavaScript built\-in functions.
76+
\f[V]jrunscript\f[R] JavaScript built-in functions.
6777
.SH OPTIONS FOR THE JRUNSCRIPT COMMAND
6878
.TP
69-
.B \f[CB]\-cp\f[R] \f[I]path\f[R] or \f[CB]\-classpath\f[R] \f[I]path\f[R]
79+
\f[V]-cp\f[R] \f[I]path\f[R] or \f[V]-classpath\f[R] \f[I]path\f[R]
7080
Indicates where any class files are that the script needs to access.
71-
.RS
72-
.RE
7381
.TP
74-
.B \f[CB]\-D\f[R]\f[I]name\f[R]\f[CB]=\f[R]\f[I]value\f[R]
82+
\f[V]-D\f[R]\f[I]name\f[R]\f[V]=\f[R]\f[I]value\f[R]
7583
Sets a Java system property.
76-
.RS
77-
.RE
7884
.TP
79-
.B \f[CB]\-J\f[R]\f[I]flag\f[R]
85+
\f[V]-J\f[R]\f[I]flag\f[R]
8086
Passes \f[I]flag\f[R] directly to the Java Virtual Machine where the
81-
\f[CB]jrunscript\f[R] command is running.
82-
.RS
83-
.RE
87+
\f[V]jrunscript\f[R] command is running.
8488
.TP
85-
.B \f[CB]\-l\f[R] \f[I]language\f[R]
89+
\f[V]-l\f[R] \f[I]language\f[R]
8690
Uses the specified scripting language.
8791
By default, JavaScript is used.
8892
To use other scripting languages, you must specify the corresponding
89-
script engine\[aq]s JAR file with the \f[CB]\-cp\f[R] or
90-
\f[CB]\-classpath\f[R] option.
91-
.RS
92-
.RE
93+
script engine\[aq]s JAR file with the \f[V]-cp\f[R] or
94+
\f[V]-classpath\f[R] option.
9395
.TP
94-
.B \f[CB]\-e\f[R] \f[I]script\f[R]
96+
\f[V]-e\f[R] \f[I]script\f[R]
9597
Evaluates the specified script.
96-
This option can be used to run one\-line scripts that are specified
98+
This option can be used to run one-line scripts that are specified
9799
completely on the command line.
98-
.RS
99-
.RE
100100
.TP
101-
.B \f[CB]\-encoding\f[R] \f[I]encoding\f[R]
101+
\f[V]-encoding\f[R] \f[I]encoding\f[R]
102102
Specifies the character encoding used to read script files.
103-
.RS
104-
.RE
105103
.TP
106-
.B \f[CB]\-f\f[R] \f[I]script\-file\f[R]
104+
\f[V]-f\f[R] \f[I]script-file\f[R]
107105
Evaluates the specified script file (batch mode).
108-
.RS
109-
.RE
110106
.TP
111-
.B \f[CB]\-f\ \-\f[R]
107+
\f[V]-f -\f[R]
112108
Enters interactive mode to read and evaluate a script from standard
113109
input.
114-
.RS
115-
.RE
116110
.TP
117-
.B \f[CB]\-help\f[R] or \f[CB]\-?\f[R]
111+
\f[V]-help\f[R] or \f[V]-?\f[R]
118112
Displays a help message and exits.
119-
.RS
120-
.RE
121113
.TP
122-
.B \f[CB]\-q\f[R]
114+
\f[V]-q\f[R]
123115
Lists all script engines available and exits.
124-
.RS
125-
.RE
126116
.SH ARGUMENTS
127117
.PP
128-
If arguments are present and if no \f[CB]\-e\f[R] or \f[CB]\-f\f[R] option
118+
If arguments are present and if no \f[V]-e\f[R] or \f[V]-f\f[R] option
129119
is used, then the first argument is the script file and the rest of the
130120
arguments, if any, are passed as script arguments.
131-
If arguments and the \f[CB]\-e\f[R] or the \f[CB]\-f\f[R] option are used,
121+
If arguments and the \f[V]-e\f[R] or the \f[V]-f\f[R] option are used,
132122
then all arguments are passed as script arguments.
133-
If arguments \f[CB]\-e\f[R] and \f[CB]\-f\f[R] are missing, then the
123+
If arguments \f[V]-e\f[R] and \f[V]-f\f[R] are missing, then the
134124
interactive mode is used.
135125
.SH EXAMPLE OF EXECUTING INLINE SCRIPTS
136126
.RS
137127
.PP
138-
\f[CB]jrunscript\ \-e\ "print(\[aq]hello\ world\[aq])"\f[R]
128+
\f[V]jrunscript -e \[dq]print(\[aq]hello world\[aq])\[dq]\f[R]
139129
.RE
140130
.RS
141131
.PP
142-
\f[CB]jrunscript\ \-e\ "cat(\[aq]http://www.example.com\[aq])"\f[R]
132+
\f[V]jrunscript -e \[dq]cat(\[aq]http://www.example.com\[aq])\[dq]\f[R]
143133
.RE
144134
.SH EXAMPLE OF USING SPECIFIED LANGUAGE AND EVALUATE THE SCRIPT FILE
145135
.RS
146136
.PP
147-
\f[CB]jrunscript\ \-l\ js\ \-f\ test.js\f[R]
137+
\f[V]jrunscript -l js -f test.js\f[R]
148138
.RE
149139
.SH EXAMPLE OF INTERACTIVE MODE
150140
.IP
151141
.nf
152142
\f[CB]
153143
jrunscript
154-
js>\ print(\[aq]Hello\ World\\n\[aq]);
155-
Hello\ World
156-
js>\ 34\ +\ 55
144+
js> print(\[aq]Hello World\[rs]n\[aq]);
145+
Hello World
146+
js> 34 + 55
157147
89.0
158-
js>\ t\ =\ new\ java.lang.Thread(function()\ {\ print(\[aq]Hello\ World\\n\[aq]);\ })
159-
Thread[Thread\-0,5,main]
160-
js>\ t.start()
161-
js>\ Hello\ World
148+
js> t = new java.lang.Thread(function() { print(\[aq]Hello World\[rs]n\[aq]); })
149+
Thread[Thread-0,5,main]
150+
js> t.start()
151+
js> Hello World
162152

163153
js>
164154
\f[R]
165155
.fi
166156
.SH RUN SCRIPT FILE WITH SCRIPT ARGUMENTS
167157
.PP
168-
In this example, the \f[CB]test.js\f[R] file is the script file.
169-
The \f[CB]arg1\f[R], \f[CB]arg2\f[R], and \f[CB]arg3\f[R] arguments are passed
170-
to the script.
158+
In this example, the \f[V]test.js\f[R] file is the script file.
159+
The \f[V]arg1\f[R], \f[V]arg2\f[R], and \f[V]arg3\f[R] arguments are
160+
passed to the script.
171161
The script can access these arguments with an arguments array.
172162
.RS
173163
.PP
174-
\f[CB]jrunscript\ test.js\ arg1\ arg2\ arg3\f[R]
164+
\f[V]jrunscript test.js arg1 arg2 arg3\f[R]
175165
.RE

0 commit comments

Comments
 (0)