components/beanshell/beansh.1
changeset 261 f7fc4962fa91
equal deleted inserted replaced
260:cc1837bbe69e 261:f7fc4962fa91
       
     1 '\" t
       
     2 .TH  BeanShell 2.0b4 "3 Jun 2009"
       
     3 .SH NAME
       
     4 beansh | beanshell \- BeanShell, a small and embeddable Java source interpreter
       
     5 .SH SYNOPSIS
       
     6 beansh | beanshell [-g] [\fIBeanShell Script\fR]
       
     7 .SH DESCRIPTION
       
     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.
       
     9 
       
    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.
       
    11 
       
    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.
       
    13 
       
    14 In short, BeanShell is dynamically interpreted Java, plus a scripting language and flexible environment all rolled into one clean package.
       
    15 
       
    16 For additional information on using BeanShell, browse the complete documentation at:
       
    17 
       
    18 file:/usr/share/lib/java/javadoc/beanshell/index.html
       
    19 
       
    20 .SH OPTIONS
       
    21 .sp
       
    22 .ne 2
       
    23 .mk
       
    24 -g
       
    25 .in +24n
       
    26 .rt
       
    27 Start in graphics mode. Command-line mode by default.
       
    28 .sp
       
    29 .sp 1
       
    30 .in -24n
       
    31 .sp
       
    32 .ne 1
       
    33 .mk
       
    34 \fIBeanShell Script\fR.
       
    35 .in +24n
       
    36 .rt
       
    37 Use pre-written BeanShell script.
       
    38 .sp
       
    39 .sp1
       
    40 .in -24n
       
    41 .SH LICENSE
       
    42 Sun Public License 1.0
       
    43 .SH FILES
       
    44 /usr/bin/beansh
       
    45 /usr/bin/beanshell
       
    46 .IP
       
    47 Command to start BeanShell.
       
    48 .LP
       
    49 /usr/share/lib/java/javadoc/beanshell/index.html
       
    50 .IP
       
    51 API documentation generated with javadoc.
       
    52 .LP
       
    53 /usr/share/doc/beanshell/bshcommands-bshdoc.xml
       
    54 .IP
       
    55 Auto-generated command documentation.
       
    56 .LP
       
    57 /usr/share/lib/java/bsh-2.0b4.jar
       
    58 .IP
       
    59 BeanShell 2.0b4 jar file. This jar contains all of the other jar files listed below.
       
    60 .LP
       
    61 /usr/share/lib/java/bsh-core-2.0b4.jar
       
    62 .IP
       
    63 Core interpreter only - The minimal footprint, interpreter only.
       
    64 .LP
       
    65 /usr/share/lib/java/bsh-classgen-2.0b4.jar
       
    66 .IP
       
    67 BeanShell class generation - Adds the ability for BeanShell to script full Java classes and interpret standard Java code.
       
    68 .LP
       
    69 /usr/share/lib/java/bsh-commands-2.0b4.jar
       
    70 .IP
       
    71 Shell commands - adds useful beanshell shell commands to the core package.
       
    72 .LP
       
    73 /usr/share/lib/java/bsh-util-2.0b4.jar
       
    74 .IP
       
    75 BeanShell utilities - Adds misc. utilities used by other packages and commands.
       
    76 .LP
       
    77 /usr/share/lib/java/bsh-classpath-2.0b4.jar
       
    78 .IP
       
    79 BeanShell classpath management - Adds class reloading and classpath capabilities to the core package. Requires Java 1.2 or greater to activate.
       
    80 .LP
       
    81 /usr/share/lib/java/bsh-reflect-2.0b4.jar
       
    82 .IP
       
    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.
       
    84 .LP
       
    85 /usr/share/lib/java/bsh-bsf-2.0b4.jar
       
    86 .IP
       
    87 Apache/IBM Bean Scripting Framework (BSF) Adapter for BeanShell - This is the necessary adapter for BeanShell to be used with BSF.
       
    88 .LP
       
    89 /usr/demo/bsh/webapps/bshservlet.war
       
    90 /usr/demo/bsh/webapps/bshservlet-wbsh.war
       
    91 .IP
       
    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.
       
    93 .LP
       
    94 
       
    95 .PD