rhino/repos/extra-any/rhino-jsc.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH RHINO-JSC 1 "February  12, 2005"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 rhino-jsc \- invokes the rhino JavaScript compiler
  20
  21 .SH SYNOPSIS
  22 .B rhino-jsc
  23 .I [options]
  24 .I file1.js
  25 .I [file2.js\&.\&.\&.]
  26
  27 .SH DESCRIPTION
  28 This manual page documents briefly the
  29 .B rhino-jsc
  30 command.
  31 This manual page was written for the Debian distribution because the original
  32 program does not have a manual page. It is written according to the html documentation.
  33 .PP
  34 \fBrhino-jsc\fP is a start script for the rhino JavaScript compiler. The JavaScript compiler translates JavaScript source into Java class files. The resulting Java class files can then be loaded and executed at another time, providing a convenient method for transferring JavaScript, and for avoiding translation cost.
  35 Note that the top-level functions available to the shell (such as print) are not available to compiled scripts when they are run outside the shell.
  36
  37 .SH OPTIONS
  38
  39 .IP -extends\ \fIjava_class_name\fP
  40 Specifies that a java class extending the Java class java_class_name should be generated from the incoming JavaScript source file. Each global function in the source file is made a method of the generated class, overriding any methods in the base class by the same name.
  41 .IP -implements\ \fIjava_intf_name\fP
  42 Specifies that a java class implementing the Java interface java_intf_name should be generated from the incoming JavaScript source file. Each global function in the source file is made a method of the generated class, implementing any methods in the interface by the same name.
  43 .IP -debug,\ -g
  44 Specifies that debug information should be generated. May not be combined with optimization at an optLevel greater than zero.
  45 .IP -nosource
  46 Does not save the source in the class file. Functions and scripts compiled this way cannot be decompiled. This option can be used to avoid distributing source or simply to save space in the resulting class file.
  47 .IP -o\ \fIoutputFile\fP
  48 Writes the class file to the given file (which should end in .class). The string outputFile must be a writable filename.
  49 .IP -opt,\ -O\ \fIoptLevel\fP
  50 Optimizes at level optLevel, which must be an integer between 0 and 9.
  51 .IP -package\ \fIpackageName\fP
  52 Specifies the package to generate the class into. The string packageName must be composed of valid identifier characters optionally separated by periods.
  53 .IP -version\ \fIversionNumber\fP
  54 Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, or 140. See JavaScript Language Versions for more information on language versions.
  55
  56 .SH EXAMPLE
  57
  58 Example compiling the NervousText.js applet written in JavaScript. The example is provided in the librhino-java-doc package.
  59
  60 $ rhino-jsc \-extends java.applet.Applet \-implements java.lang.Runnable NervousText.js
  61
  62 .SH SEE ALSO
  63 The online documentation under http://www.mozilla.org/rhino/jsc.html
  64
  65 .SH AUTHOR
  66 This manual page was written by Wolfgang Baer <WBaer@gmx.de>,
  67 for the Debian project (but may be used by others).