home *** CD-ROM | disk | FTP | other *** search
/ Java 1.2 How-To / JavaHowTo.iso / 3rdParty / Jtoexe / jre-1.1.6 / README < prev   
Encoding:
Text File  |  1998-04-23  |  21.0 KB  |  478 lines
  1.  
  2.                              README
  3.  
  4.                   The Java(tm) Runtime Environment
  5.                            JRE 1.1.6  
  6.  
  7. -----------------------------------------------------------------------
  8. CONTENTS
  9.  
  10.   Overview of the Java Runtime Environment
  11.     - Introduction
  12.     - The Java Runtime Interpreter
  13.     - Required vs. Optional Files
  14.     - Win 32 Files 
  15.        - Required Files
  16.        - Optional Files
  17.     - Solaris Files 
  18.        - Required Files
  19.        - Optional Files
  20.  
  21.   Bundling and Running the Java Runtime
  22.     - Bundling the Java Runtime
  23.     - Java Runtime Example
  24.     - Runtime Documentation
  25.  
  26.  
  27. =======================================================================
  28.                  Overview of the Java Runtime Environment
  29. =======================================================================
  30.  
  31. -----------------------------------------------------------------------
  32. Introduction
  33. -----------------------------------------------------------------------
  34.  
  35. This is version 1.1.6 of the Java Runtime Environment, also known as 
  36. the Java Runtime, or JRE.  The Java Runtime is the minimum standard
  37. Java Platform for running Java programs.  It contains the Java 
  38. Virtual Machine, Java Core Classes and supporting files. 
  39.  
  40. The JRE can be invoked from the command line by using the jre tool 
  41. (see the following section). On Windows platforms, the jre tool will 
  42. ignore the CLASSPATH environment variable. For both Windows and 
  43. Solaris platforms, the -cp option is recommended to specify an 
  44. application's class path.
  45.  
  46. Although this is a maintenance release, the Win32 version of the Java 
  47. Runtime Environment includes a significant performance enhancement. A 
  48. production-quality version of Symantec JIT bytecode compiler is 
  49. included. This is the same JIT previously packaged as an early-access 
  50. product in the Win32 Performance Pack. Because the JIT compiler is now 
  51. included in the JRE software, the Performance Pack has been 
  52. discontinued.  The JIT compiler is enabled by default on the Win32 
  53. JRE.  To disable the compiler, you can use the -nojit option of 
  54. the Java runtime interpreter (see following section).
  55.  
  56. The Symantec JIT compiler is copyrighted (c), 1996-1998, by Symantec 
  57. Corporation. All rights reserved.
  58.  
  59. This document uses the term "vendors" to refer to licensees, 
  60. developers, and independent software vendors (ISVs) who 
  61. license and distribute the JRE with their Java programs.
  62.  
  63. The Win32 version of JRE 1.1.6 has an installer suitable for use 
  64. by end-users. This gives software developers the option of not 
  65. bundling the JRE with their applications. Instead, they can direct 
  66. end-users to download and install the JRE themselves.
  67.  
  68. An installer is not available for Solaris versions of the JRE. 
  69. Developers should bundle the JRE and an installer with their Solaris 
  70. applications. 
  71.  
  72. The JRE includes all of the non-debuggable .dll or .so files plus
  73. the necessary classes from the JDK 1.1.6 to support a runtime-only 
  74. program.  The JRE does not include any of the development tools
  75. (such as appletviewer or javac) or classes that would pertain only 
  76. to a development system.
  77.  
  78. Vendors must follow the terms of the JRE Binary Code License agreement, 
  79. which includes these terms:
  80.  
  81.  - Don't arbitrarily subset the JRE. You may omit only the
  82.    files listed below as optional.  See the section entitled 
  83.    Required vs. Optional Files. 
  84.  
  85.  - Include in your product's license the provisions called out
  86.    in the JRE Binary Code License.
  87.  
  88. Comments regarding the JRE are welcome. Please send them to 
  89. jre-comments@java.sun.com. Due to the large volume of email received 
  90. each day, JavaSoft usually cannot respond to your email personally.
  91.     
  92. The JRE is a product of Sun Microsystems, Inc.  
  93. JavaSoft is an operating company of Sun, and develops the JRE.
  94.  
  95.  
  96. -----------------------------------------------------------------------
  97. The Java Runtime Interpreter
  98. -----------------------------------------------------------------------
  99.  
  100. The jre tool invokes the Java Runtime interpreter for executing Java 
  101. applications. The tool is available in the Win32, Solaris-Sparc, and 
  102. Solaris x86 downloads of the JRE. The syntax for the jre command is:
  103.  
  104.     jre [ options ] classname <args>
  105.  
  106. The classname argument is the name of the class file to be 
  107. executed. Any arguments to be passed to the class must be placed 
  108. after the classname on the command line.
  109.  
  110. An alternative version of the tool, jrew, is available for Win32. The 
  111. jrew command is identical to jre, except that a console window is not 
  112. invoked. The syntax of the jrew command is 
  113.  
  114.     jrew [ options ] classname <args>
  115.  
  116. On Windows platforms, the jre tool will ignore the CLASSPATH 
  117. environment variable. For both Windows and Solaris platforms, the 
  118. -cp option is recommended to specify an application's class path.
  119.  
  120. Options for the jre and the jrew commands are as follows:
  121.  
  122.    -classpath path    Specifies the path that jre uses to 
  123.                look up classes. Overrides the default 
  124.                classpath.  
  125.  
  126.    -cp path        Prepends the specified path to the default 
  127.                classpath that jre uses to look up classes. 
  128.  
  129.    -help        Print a usage message.
  130.  
  131.    -mx x        Sets the maximum size of the memory allocation 
  132.                pool (the garbage collected heap) to x. The 
  133.                default is 16 megabytes of memory. x must be
  134.             greater than or equal to 1000 bytes.
  135.  
  136.    -ms x        Sets the startup size of the memory allocation 
  137.                pool (the garbage collected heap) to x. The 
  138.                default is 1 megabyte of memory. x must be
  139.             greater than 1000 bytes.
  140.  
  141.    -noasyncgc        Turns off asynchronous garbage collection. When 
  142.                activated, no garbage collection takes place 
  143.                unless it is explicitly called or the program 
  144.             runs out of memory.
  145.  
  146.    -noclassgc        Turns off garbage collection of Java classes. 
  147.                By default, the Java interpreter reclaims space 
  148.                for unused Java classes during garbage collection.
  149.  
  150.    -nojit        Don't invoke the Just In Time bytecode
  151.                 compiler. The virtual machine directly
  152.             interprets bytecodes, without converting them
  153.             to native code.
  154.  
  155.    -ss x        The -ss option sets the maximum stack size that 
  156.                can be used by C code in a thread to x. The 
  157.             default units for x are bytes. The value of x 
  158.             must be greater than or equal to 1000 bytes.
  159.  
  160.    -oss x        The -oss option sets the maximum stack size 
  161.             that can be used by Java code in a thread to x. 
  162.             The default units for x are bytes. The value of 
  163.             x must be greater than or equal to 1000 bytes.
  164.  
  165.    -v, -verbose        Causes jre to print a message to stdout each 
  166.             time a class file is loaded.
  167.  
  168.    -verify        Performs byte-code verification on the class 
  169.             file. Beware, however, that java -verify does 
  170.             not perform a full verification in all 
  171.             situations. Any code path that is not actually 
  172.             executed by the interpreter is not verified. 
  173.             Therefore, java -verify cannot be relied upon to 
  174.             certify class files unless all code paths in 
  175.             the class file are actually run.
  176.  
  177.    -verifyremote    Runs the verifier on all code that is loaded 
  178.             into the system via a classloader. verifyremote 
  179.             is the default for the interpreter.
  180.  
  181.    -noverify        Turns verification off.
  182.  
  183.    -verbosegc        Causes the garbage collector to print out 
  184.             messages whenever it frees memory.
  185.    
  186.    -DpropName=value    Defines a property value. propName is the name 
  187.             of the property whose value you want to change 
  188.             and value is the value to change it to. For 
  189.             example, the command 
  190.             java -Dawt.button.color=green ...
  191.             sets the value of the property awt.button.color 
  192.             to "green".
  193.  
  194.  
  195. -----------------------------------------------------------------------
  196. Required vs. Optional Files
  197. -----------------------------------------------------------------------
  198.  
  199. Licensees must follow the terms of the accompanying LICENSE.  
  200. The files that make up the JRE are divided into two categories:
  201. required and optional.  To paraphrase that license, files that 
  202. are marked "optional" here do not need to be included in 
  203. redistributions of the JRE with the licensee's program. Most of the 
  204. optional files provide localization support for languages.
  205.  
  206. The term "required" means licensees who distribute the runtime 
  207. must include those files with their program, whether or not their 
  208. program ever uses those files.  Those files are a required part of 
  209. the Java Platform.
  210.  
  211. The JRE includes the bin and lib directories which both must
  212. reside in the same directory.  We call this directory <runtime-dir>.
  213. In the following lists, all paths are relative to the <runtime-dir>
  214. directory (which is originally "jre1.1.6").
  215.  
  216. -----------------------------------------------------------------------
  217. Win32 Files
  218. -----------------------------------------------------------------------
  219.  
  220. Two versions of JRE 1.1.6 for Win32 are available. One version contains 
  221. files for internationalization support. The version with 
  222. internationalization support contains all the files listed below under 
  223. both the REQUIRED FILES and OPTIONAL FILES subsections. A smaller 
  224. version of the Win32 JRE is available that does not contain those 
  225. optional files that provide internationalization support.
  226.  
  227.  
  228. Required Files --------------------------------------------------------
  229.  
  230. The Win32 bin directory contains the executables and native libraries:
  231.  
  232.    bin\jre.exe                   Java runtime executable
  233.    bin\jrew.exe                  Java runtime executable, no console window
  234.    bin\rmiregistry.exe           rmiregistry executable
  235.    bin\javai.dll                 Java runtime native code library
  236.    bin\JdbcOdbc.dll              native code support for sun.jdbc
  237.    bin\jpeg.dll                  native code support for sun.jpeg
  238.    bin\math.dll                  native code support for java.math
  239.    bin\mmedia.dll                native code support for sun.audio
  240.    bin\net.dll                   native code support for java.net
  241.    bin\sysresource.dll           native code support for sun.net.www.protocol
  242.    bin\winawt.dll                native code support for sun.awt
  243.    bin\zip.dll                   native code support for java.util.zip
  244.    bin\msvcrt.dll                native code C runtime library
  245.  
  246. The Win32 lib directory contains the classes and property files:
  247.  
  248.    lib\rt.jar                    Java runtime core classes
  249.    lib\content-types.properties  MIME-type properties 
  250.    lib\awt.properties            properties for key events for java.awt
  251.    lib\font.properties           Win32 font properties for java.awt
  252.    lib\serialver.properties      serialization properties
  253.    lib\security\java.security    properties for java.security
  254.  
  255. Optional Files --------------------------------------------------------
  256.  
  257. The following files are optional:
  258.  
  259.    lib\i18n.jar                  I18N character conversion classes from 
  260.                                    sun.io
  261.    lib\font.properties.ar        AWT font properties for Arabic locale 
  262.    lib\font.properties.iw        AWT font properties for Hebrew locale
  263.    lib\font.properties.ja        AWT font properties for Japanese locale
  264.    lib\font.properties.ko        AWT font properties for Korean locale
  265.    lib\font.properties.ru        AWT font properties for Russian locale
  266.    lib\font.properties.th        AWT font properties for Thai locale
  267.    lib\font.properties.zh_TW     AWT font properties for Traditional 
  268.                                    Chinese locale
  269.    lib\font.properties.zh        AWT font properties for Simplified 
  270.                                    Chinese locale
  271.    bin\symcjit.dll               JIT compiler
  272.  
  273.  
  274. -----------------------------------------------------------------------
  275. Solaris Files
  276. -----------------------------------------------------------------------
  277.   
  278. You can optionally install the Solaris Native Threads Pack 1.1.6 in the 
  279. Solaris versions of the JRE. (The Native Threads Pack is available for 
  280. download from the JDK download site.)  With the native threads pack 
  281. installed, you can use either the native threads files or the default 
  282. set of threads files (called "green threads") when running programs 
  283. with the JRE. If you redistribute the JRE, you must include either the 
  284. entire set of default green threads files, or the entire set of native 
  285. threads files, or both entire sets.
  286.  
  287.  
  288. Required Files --------------------------------------------------------
  289.  
  290. The directory <sys> varies depending on the hardware architecture 
  291. (either "sparc" or "i386") and threads implementation (either 
  292. "green_threads" or "native_threads"). To indicate the green threads 
  293. implementation on Solaris-SPARC, for example, <sys> would stand for 
  294. "sparc/green_threads".  If the Solaris native threads pack is installed 
  295. in the Solaris-x86 JRE, for another example, <sys> could stand for 
  296. "i386/native_threads". When redistributing the JRE, you must include 
  297. either the entire set of default green threads files, or the entire set 
  298. of native threads files, or both entire sets.
  299.  
  300.    The Solaris bin directory contains the shell scripts and executables:
  301.  
  302.    bin/jre                      Java runtime shell script wrapper
  303.    bin/rmiregistry              rmiregistry shell script wrapper
  304.    bin/<sys>/jre                Java runtime executable
  305.    bin/<sys>/rmiregistry        rmiregistry executable
  306.  
  307.    The Solaris lib directory and its subdirectories contain the 
  308.    classes, properties files and native libraries:
  309.  
  310.    lib/rt.jar                    Java runtime core classes
  311.    lib/content-types.properties  MIME-type properties 
  312.    lib/awt.properties            properties for key events for java.awt
  313.    lib/font.properties           Solaris font properties for java.awt
  314.    lib/serialver.properties      properties for servialver
  315.    lib/security/java.security    properties for java.security
  316.  
  317.    lib/<sys>/libjava.so          Java runtime library
  318.    lib/<sys>/libnet.so           native code support for java.net
  319.    lib/<sys>/libmath.so          native code support for java.math
  320.    lib/<sys>/libmmedia.so        native code support for sun.audio
  321.    lib/<sys>/libawt.so           native code support for sun.awt
  322.    lib/<sys>/libjpeg.so          native code support for sun.jpeg
  323.    lib/<sys>/libJdbcOdbc.so      native code support for sun.jdbc
  324.    lib/<sys>/libsysresource.so   native code support for sun.net
  325.    lib/<sys>/libzip.so           native code support for java.util.zip
  326.  
  327. Optional Files --------------------------------------------------------
  328.  
  329. The following files are optional.
  330.  
  331.    lib/i18n.jar                  I18N character conversion classes from sun.io
  332.    lib/font.properties.cs        AWT font properties for Czech locale
  333.    lib/font.properties.pl        AWT font properties for Polish locale
  334.    lib/font.properties.hu        AWT font properties for Hungarian locale
  335.    lib/font.properties.lt        AWT font properties for Lithuanian locale
  336.    lib/font.properties.lv        AWT font properties for Latvian locale
  337.    lib/font.properties.el        AWT font properties for Greek locale
  338.    lib/font.properties.tr        AWT font properties for Turkish locale
  339.    lib/font.properties.ja        AWT font properties for Japanese locale
  340.    lib/psfont.properties.ja      AWT psfont properties for Japanese locale
  341.    lib/font.properties.ru        AWT font properties for Russian locale
  342.    lib/font.properties.ko        AWT font properties for Korean locale
  343.    lib/font.properties.zh_EUC_CN  AWT font properites for Simplified 
  344.                                     Chinese locale
  345.    lib/font.properties.zh_TW_Big5  AWT font properties for Traditional 
  346.                                      Chinese locale
  347.    lib/font.properties.zh_TW_EUC_TW  Alternative AWT font properties for 
  348.                                        Traditional Chinese locale
  349.    lib/<sys>/libXm.so            Symbolic link to Motif runtime library 
  350.    lib/<sys>/libXm.so.3          Motif runtime library
  351.  
  352. libXm.so.3 is present in Solaris 2.5 and later, so is needed only if 
  353. your program is to run on Solaris 2.4 or earlier.
  354.  
  355.  
  356. =======================================================================
  357.                 Bundling and Running the Java Runtime
  358. =======================================================================
  359.  
  360. -----------------------------------------------------------------------
  361. Bundling the Java Runtime
  362. -----------------------------------------------------------------------
  363.  
  364. This release of the JRE for Win32 comes with its own installer that 
  365. makes is suitable for downloading by end users. Java application 
  366. developers have the option of not bundling the JRE with their software. 
  367. Instead, they can direct end-users to download and install the JRE 
  368. themselves.
  369.  
  370. Solaris versions of the JRE do not have an installer. Software 
  371. developers should bundle the JRE and installer with their Solaris 
  372. software. 
  373.  
  374. When bundling the JRE with application software on Solaris, the 
  375. following points should be considered:
  376.  
  377. 1) It is suggested that the JRE be installed in its own subdirectory
  378.    (referred to below as <runtime-dir>).  Include all the the required
  379.    files listed above in the bin and lib subdirectories of 
  380.    <runtime-dir>, following the same directory hierarchy and 
  381.    relative placement of files.  The internationalization files 
  382.    marked optional can be included for language localization support.
  383.  
  384. 2) It is suggested that all application-specific classes be placed 
  385.    in a directory other than <runtime-dir>. Application-specific 
  386.    classes may be individual .class files, .jar files, or .zip 
  387.    files.
  388.  
  389.    An example directory structure might look like the following:
  390.  
  391.                <app-dir>
  392.        ________________|___________
  393.       |         |               |
  394.          bin       lib           <runtime-dir>
  395.           |         |          ________|________
  396.                  app.jar      |                 | 
  397.                              bin               lib         
  398.                               |                 |
  399.                        
  400.  
  401. 3) If native code support is required, then the native library must be 
  402.    located in LD_LIBRARY_PATH on Solaris or the executable search PATH 
  403.    on Win32. The best way to do this is to install the native libraries
  404.    in either <app-dir>/lib/<sys> on Solaris or <app-dir>\bin 
  405.    on Win32. LD_LIBRARY_PATH (on Solaris) or PATH (on Win32) should 
  406.    then be set to include these directories.
  407.  
  408. 4) The application can be invoked by using the jre command-line tool, 
  409.    using the -cp option to specify the application's class path. In 
  410.    the example directory tree above, for example, the command might 
  411.    look like this:
  412.  
  413.    <app-dir>/<runtime-dir>/bin/jre -cp <app-dir>/lib/app.jar <classname>
  414.  
  415.    Information on the jre command-line tool can be found in the 
  416.    JRE 1.1.6 CHANGES file and on the JavaSoft web site at 
  417.    http://java.sun.com/products/jdk1.1/docs/tooldocs/solaris/jre.html
  418.    and
  419.    http://java.sun.com/products/jdk1.1/docs/tooldocs/win32/jre.html
  420.  
  421.    Source code for the jre tool can be found in the Windows JDK 1.1.6 
  422.    directory tree in the jdk1.1.6\demo\jre\win32 folder. For the 
  423.    Solaris JDK 1.1.6, jre source code files can be found in the 
  424.    jdk1.1.6/demo/jre/solaris directory.
  425.  
  426.   
  427. For more information that might be relevant to installing and running
  428. the JRE, refer to the JDK installation instructions:
  429.  
  430.     http://java.sun.com/products/jdk/1.1/installation-win32-x86.html
  431.     http://java.sun.com/products/jdk/1.1/installation-solaris2.html
  432.  
  433.  
  434. -----------------------------------------------------------------------
  435. Java Runtime Example
  436. -----------------------------------------------------------------------
  437.  
  438. The following web page has a Hello World example that you can download 
  439. demonstrating how to create a simple Java application that runs on, 
  440. and is bundled with, the Java Runtime Environment.  
  441.  
  442.      http://java.sun.com/products/jdk/1.1/jre/example/
  443.  
  444. This example shows how to make a simple, seamless transition
  445. from developing an application with the JDK, to deploying it with 
  446. the more-lightweight JRE.
  447.  
  448.  
  449. -----------------------------------------------------------------------
  450. Runtime Documentation
  451. -----------------------------------------------------------------------
  452.  
  453. Runtime documentation is any documentation that an end-user might
  454. need after they have installed a Java program that runs on the JRE.
  455.  
  456. We supply the following runtime documentation:
  457.  
  458.   - Each property file contains comments that describe what the
  459.     file is useful for and how to modify it.
  460.  
  461.   - awt.properties file - KeyEvent uses it to print out properties of
  462.     key events, usually for debugging purposes.  This might be used
  463.     by a GUI debugger that needs to print out events.
  464.  
  465.   - fontprop.html file has a web page describing how to add 
  466.     fonts to the runtime.  This document is part of the 
  467.     JDK documentation, and is located both in the JDK documentation
  468.     download bundle and at the JavaSoft website:
  469.  
  470.     http://java.sun.com/products/jdk/1.1/docs/guide/intl/fontprop.html
  471.  
  472.  
  473. -----------------------------------------------------------------------
  474. Copyright ⌐ 1997, 1998 Sun Microsystems, Inc.
  475. 901 San Antonio Rd., Palo Alto, CA 94303 USA.
  476. All rights reserved.
  477.  
  478.