src/java.scripting/share/man/jrunscript.1
author prr
Tue, 24 Sep 2019 09:09:15 -0700
changeset 58593 da02c2254989
parent 55140 d4890c3721be
permissions -rw-r--r--
8231243: [TESTBUG] CustomFont.java cannot find font file Reviewed-by: serb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
     1
.\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
31876
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     2
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     3
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     4
.\" This code is free software; you can redistribute it and/or modify it
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     5
.\" under the terms of the GNU General Public License version 2 only, as
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     6
.\" published by the Free Software Foundation.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     7
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     8
.\" This code is distributed in the hope that it will be useful, but WITHOUT
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     9
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    10
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    11
.\" version 2 for more details (a copy is included in the LICENSE file that
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    12
.\" accompanied this code).
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    13
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    14
.\" You should have received a copy of the GNU General Public License version
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    15
.\" 2 along with this work; if not, write to the Free Software Foundation,
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    16
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    17
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    18
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    19
.\" or visit www.oracle.com if you need additional information or have any
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    20
.\" questions.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    21
.\"
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    22
.\" Automatically generated by Pandoc 2.3.1
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    23
.\"
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    24
.TH "JRUNSCRIPT" "1" "2018" "JDK 13" "JDK Commands"
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    25
.hy
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    26
.SH NAME
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    27
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    28
jrunscript \- run a command\-line script shell that supports interactive
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    29
and batch modes
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    30
.SH SYNOPSIS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    31
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    32
\f[B]Note:\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    33
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    34
This tool is \f[B]experimental\f[R]\ and unsupported.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    35
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    36
\f[CB]jrunscript\f[R] [\f[I]options\f[R]] [\f[I]arguments\f[R]]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    37
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    38
.B \f[I]options\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    39
This represents the \f[CB]jrunscript\f[R] command\-line options that can
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    40
be used.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    41
See \f[B]Options for the jrunscript Command\f[R].
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    42
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    43
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    44
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    45
.B \f[I]arguments\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    46
Arguments, when used, follow immediately after options or the command
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    47
name.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    48
See \f[B]Arguments\f[R].
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    49
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    50
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    51
.SH DESCRIPTION
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    52
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    53
The \f[CB]jrunscript\f[R] command is a language\-independent command\-line
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    54
script shell.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    55
The \f[CB]jrunscript\f[R] command supports both an interactive
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    56
(read\-eval\-print) mode and a batch (\f[CB]\-f\f[R] option) mode of
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    57
script execution.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    58
By default, JavaScript is the language used, but the \f[CB]\-l\f[R] option
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    59
can be used to specify a different language.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    60
By using Java to scripting language communication, the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    61
\f[CB]jrunscript\f[R] command supports an exploratory programming style.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    62
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    63
If JavaScript is used, then before it evaluates a user defined script,
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    64
the \f[CB]jrunscript\f[R] command initializes certain built\-in functions
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    65
and objects, which are documented in the API Specification for
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    66
\f[CB]jrunscript\f[R] JavaScript built\-in functions.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    67
.SH OPTIONS FOR THE JRUNSCRIPT COMMAND
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    68
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    69
.B \f[CB]\-cp\f[R] \f[I]path\f[R] or \f[CB]\-classpath\f[R] \f[I]path\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    70
Indicates where any class files are that the script needs to access.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    71
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    72
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    73
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    74
.B \f[CB]\-D\f[R]\f[I]name\f[R]\f[CB]=\f[R]\f[I]value\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    75
Sets a Java system property.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    76
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    77
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    78
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    79
.B \f[CB]\-J\f[R]\f[I]flag\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    80
Passes \f[I]flag\f[R] directly to the Java Virtual Machine where the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    81
\f[CB]jrunscript\f[R] command is running.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    82
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    83
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    84
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    85
.B \f[CB]\-l\f[R] \f[I]language\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    86
Uses the specified scripting language.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    87
By default, JavaScript is used.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    88
To use other scripting languages, you must specify the corresponding
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    89
script engine\[aq]s JAR file with the \f[CB]\-cp\f[R] or
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    90
\f[CB]\-classpath\f[R] option.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    91
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    92
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    93
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    94
.B \f[CB]\-e\f[R] \f[I]script\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    95
Evaluates the specified script.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    96
This option can be used to run one\-line scripts that are specified
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    97
completely on the command line.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    98
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    99
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   100
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   101
.B \f[CB]\-encoding\f[R] \f[I]encoding\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   102
Specifies the character encoding used to read script files.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   103
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   104
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   105
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   106
.B \f[CB]\-f\f[R] \f[I]script\-file\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   107
Evaluates the specified script file (batch mode).
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   108
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   109
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   110
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   111
.B \f[CB]\-f\ \-\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   112
Enters interactive mode to read and evaluate a script from standard
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   113
input.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   114
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   115
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   116
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   117
.B \f[CB]\-help\f[R] or \f[CB]\-?\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   118
Displays a help message and exits.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   119
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   120
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
   121
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   122
.B \f[CB]\-q\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   123
Lists all script engines available and exits.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   124
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   125
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   126
.SH ARGUMENTS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   127
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   128
If arguments are present and if no \f[CB]\-e\f[R] or \f[CB]\-f\f[R] option
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   129
is used, then the first argument is the script file and the rest of the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   130
arguments, if any, are passed as script arguments.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   131
If arguments and the \f[CB]\-e\f[R] or the \f[CB]\-f\f[R] option are used,
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   132
then all arguments are passed as script arguments.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   133
If arguments \f[CB]\-e\f[R] and \f[CB]\-f\f[R] are missing, then the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   134
interactive mode is used.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   135
.SH EXAMPLE OF EXECUTING INLINE SCRIPTS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   136
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   137
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   138
\f[CB]jrunscript\ \-e\ "print(\[aq]hello\ world\[aq])"\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   139
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   140
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   141
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   142
\f[CB]jrunscript\ \-e\ "cat(\[aq]http://www.example.com\[aq])"\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   143
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   144
.SH EXAMPLE OF USING SPECIFIED LANGUAGE AND EVALUATE THE SCRIPT FILE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   145
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   146
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   147
\f[CB]jrunscript\ \-l\ js\ \-f\ test.js\f[R]
31876
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
   148
.RE
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   149
.SH EXAMPLE OF INTERACTIVE MODE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   150
.IP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   151
.nf
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   152
\f[CB]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   153
jrunscript
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   154
js>\ print(\[aq]Hello\ World\\n\[aq]);
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   155
Hello\ World
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   156
js>\ 34\ +\ 55
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   157
89.0
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   158
js>\ t\ =\ new\ java.lang.Thread(function()\ {\ print(\[aq]Hello\ World\\n\[aq]);\ })
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   159
Thread[Thread\-0,5,main]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   160
js>\ t.start()
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   161
js>\ Hello\ World
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   162
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   163
js>
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   164
\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   165
.fi
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   166
.SH RUN SCRIPT FILE WITH SCRIPT ARGUMENTS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   167
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   168
In this example, the \f[CB]test.js\f[R] file is the script file.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   169
The \f[CB]arg1\f[R], \f[CB]arg2\f[R], and \f[CB]arg3\f[R] arguments are passed
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   170
to the script.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   171
The script can access these arguments with an arguments array.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   172
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   173
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   174
\f[CB]jrunscript\ test.js\ arg1\ arg2\ arg3\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
   175
.RE