components/beanshell/beansh.1
author Rich Burridge <rich.burridge@oracle.com>
Thu, 13 Apr 2017 13:20:29 -0700
changeset 7864 f11e8d81786a
parent 261 f7fc4962fa91
permissions -rw-r--r--
PSARC 2017/057 pcre2 25783625 Add pcre2 10.23 to Userland because vte 0.47.90 requires it
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
261
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     1
'\" t
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     2
.TH  BeanShell 2.0b4 "3 Jun 2009"
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     3
.SH NAME
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     4
beansh | beanshell \- BeanShell, a small and embeddable Java source interpreter
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     5
.SH SYNOPSIS
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     6
beansh | beanshell [-g] [\fIBeanShell Script\fR]
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     7
.SH DESCRIPTION
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     8
BeanShell is a small, free, embeddable Java source interpreter with object scripting language features, written in Java. BeanShell dynamically executes standard Java syntax and extends it with common scripting conveniences such as loose types, commands, and method closures like those in Perl and JavaScript.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
     9
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    10
You can use BeanShell interactively for Java experimentation and debugging as well as to extend your applications in new ways. Scripting Java lends itself to a wide variety of applications including rapid prototyping, user scripting extension, rules engines, configuration, testing, dynamic deployment, embedded systems, and even Java education.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    11
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    12
BeanShell is small and embeddable, so you can call BeanShell from your Java applications to execute Java code dynamically at run-time or to provide extensibility in your applications. Alternatively, you can use standalone BeanShell scripts to manipulate Java applications; working with Java objects and APIs dynamically. Since BeanShell is written in Java and runs in the same VM as your application, you can freely pass references to "live" objects into scripts and return them as results.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    13
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    14
In short, BeanShell is dynamically interpreted Java, plus a scripting language and flexible environment all rolled into one clean package.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    15
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    16
For additional information on using BeanShell, browse the complete documentation at:
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    17
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    18
file:/usr/share/lib/java/javadoc/beanshell/index.html
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    19
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    20
.SH OPTIONS
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    21
.sp
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    22
.ne 2
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    23
.mk
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    24
-g
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    25
.in +24n
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    26
.rt
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    27
Start in graphics mode. Command-line mode by default.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    28
.sp
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    29
.sp 1
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    30
.in -24n
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    31
.sp
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    32
.ne 1
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    33
.mk
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    34
\fIBeanShell Script\fR.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    35
.in +24n
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    36
.rt
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    37
Use pre-written BeanShell script.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    38
.sp
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    39
.sp1
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    40
.in -24n
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    41
.SH LICENSE
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    42
Sun Public License 1.0
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    43
.SH FILES
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    44
/usr/bin/beansh
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    45
/usr/bin/beanshell
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    46
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    47
Command to start BeanShell.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    48
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    49
/usr/share/lib/java/javadoc/beanshell/index.html
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    50
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    51
API documentation generated with javadoc.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    52
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    53
/usr/share/doc/beanshell/bshcommands-bshdoc.xml
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    54
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    55
Auto-generated command documentation.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    56
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    57
/usr/share/lib/java/bsh-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    58
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    59
BeanShell 2.0b4 jar file. This jar contains all of the other jar files listed below.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    60
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    61
/usr/share/lib/java/bsh-core-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    62
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    63
Core interpreter only - The minimal footprint, interpreter only.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    64
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    65
/usr/share/lib/java/bsh-classgen-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    66
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    67
BeanShell class generation - Adds the ability for BeanShell to script full Java classes and interpret standard Java code.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    68
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    69
/usr/share/lib/java/bsh-commands-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    70
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    71
Shell commands - adds useful beanshell shell commands to the core package.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    72
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    73
/usr/share/lib/java/bsh-util-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    74
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    75
BeanShell utilities - Adds misc. utilities used by other packages and commands.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    76
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    77
/usr/share/lib/java/bsh-classpath-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    78
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    79
BeanShell classpath management - Adds class reloading and classpath capabilities to the core package. Requires Java 1.2 or greater to activate.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    80
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    81
/usr/share/lib/java/bsh-reflect-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    82
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    83
BeanShell reflective accessibility - Adds the ability for BeanShell to access private/protected fields, methods, and non-public classes (subject to any Java runtime security). Requires Java 1.2 or greater to activate.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    84
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    85
/usr/share/lib/java/bsh-bsf-2.0b4.jar
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    86
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    87
Apache/IBM Bean Scripting Framework (BSF) Adapter for BeanShell - This is the necessary adapter for BeanShell to be used with BSF.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    88
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    89
/usr/demo/bsh/webapps/bshservlet.war
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    90
/usr/demo/bsh/webapps/bshservlet-wbsh.war
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    91
.IP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    92
A small test servlet and webapp example for BeanShell. Here are two versions - one that comes with the BeanShell JAR included in the WAR file and one that expects the BeanShell JAR to be in the app server's classpath.
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    93
.LP
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    94
f7fc4962fa91 7045306 migrate beanshell to userland
Kevin Crowe <Kevin.Crowe@oracle.com>
parents:
diff changeset
    95
.PD