Tree [r8492] / docs / trunk / readme /
History



File Date Author Commit
Makefile 2010-03-29 wdashley [r5759] Rename sgml files to xml.
docbook-1.png 2006-08-29 wdashley [r1] Initial SVN load.
hyperref.cfg 2009-05-09 miesfeld [r4623] Set the proper eol style
new_rexxla.jpg 2006-08-29 wdashley [r1] Initial SVN load.
newinrelease.xml 2010-05-04 wdashley [r5888] Renamed file.
readme.xml 2010-03-29 wdashley [r5759] Rename sgml files to xml.
unix.xml 2010-03-29 wdashley [r5759] Rename sgml files to xml.
windows.xml 2010-03-29 wdashley [r5759] Rename sgml files to xml.

Read Me

<?xml version="1.0" standalone="no">
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
[
<!ENTITY newinrelease     SYSTEM "newinrelease.xml">
<!ENTITY windows          SYSTEM "windows.xml">
<!ENTITY unix             SYSTEM "unix.xml">
<!ENTITY gethelp          SYSTEM "../shared/gethelp.xml">
<!ENTITY notices          SYSTEM "../shared/notices.xml">
<!ENTITY cplv10           SYSTEM "../shared/CPLv1.0.xml">
]>
<!--#########################################################################
    #
    # Description: Open Object Rexx: Release Notes SGML File
    #
    # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved.
    # Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
    #
    # This program and the accompanying materials are made available under
    # the terms of the Common Public License v1.0 which accompanies this
    # distribution. A copy is also available at the following address:
    # http://www.oorexx.org/license.html
    #
    # Redistribution and use in source and binary forms, with or
    # without modification, are permitted provided that the following
    # conditions are met:
    #
    # Redistributions of source code must retain the above copyright
    # notice, this list of conditions and the following disclaimer.
    # Redistributions in binary form must reproduce the above copyright
    # notice, this list of conditions and the following disclaimer in
    # the documentation and/or other materials provided with the distribution.
    #
    # Neither the name of Rexx Language Association nor the names
    # of its contributors may be used to endorse or promote products
    # derived from this software without specific prior written permission.
    #
    # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
    # TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
    # OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
    # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    #
    # Author(s):
    #      W. David Ashley <dashley@us.ibm.com>
    #
    #########################################################################
-->
<article>
<articleinfo>
<title>Open Object Rexx&trade;</title>
<subtitle>Release Notes</subtitle>

<orgname>Rexx Language Association</orgname>
<copyright>
   <year>2005 - 2009</year>
   <holder>Rexx Language Association. All rights reserved.</holder>
</copyright>

<!--#######################################################################
    # The following need to be modified for each release!
    #######################################################################-->
<releaseinfo>Version 4.0.0</releaseinfo>
<edition>Version 4.0.0</edition>
<pubdate>April 15, 2009</pubdate>
<!--#######################################################################
    # End of modification area.
    #######################################################################-->

<legalnotice>
<para>
  This program and the accompanying materials are made available under the terms of the <link
  linkend="cplv10" endterm="cplv10.title"></link>.
</para>
</legalnotice>

</articleinfo>

<section><title>About The 4.0.0 Release</title>
<para>
  Open Object Rexx Version 4.0.0 is based on the previous version of ooRexx&trade; (3.2.0). Version 4.0.0
  has both enhancements and bug fixes.
</para>
<note><title>IMPORTANT</title>
<para>
  If you have a version of IBM Object Rexx&trade; installed on your system, you must remove it before
  starting with the installation of this package. The two packages, Object Rexx and ooRexx can not be
  installed side-by-side.
</para>
<para>
  Note that an <emphasis role="underline">upgrade</emphasis> type installation is not supported on any platform.
  If a previous version of ooRexx is installed, it should be completely uninstalled prior to installing 4.0.0.
  Failure to completely uninstall the previous version will produce unpredictable results.
</para>
<para>
  On a Unix-like system use the appropriate package manager to uninstall the previous version. For
  instance, on Linux with a rpm install, you could use the command:
<programlisting>
<![CDATA[
rpm -iv ooRexx
]]>
</programlisting>
  to uninstall ooRexx. On a Debian-based system you could use the <computeroutput>-r</computeroutput> or the
  <computeroutput>-P</computeroutput> option of <computeroutput>dpkg</computeroutput> to uninstall ooRexx:
<programlisting>
<![CDATA[
dpkg -P ooRexx
]]>
</programlisting>
</para>
<para>
  On Windows, when the installation program is started, the installer will recognize that a previous
  version is installed. It will then present an option to uninstall the previous version before
  proceeding with the 4.0.0 install. Alternatively, you can completely uninstall the previous version
  prior to starting the 4.0.0 installation.
</para>
</note>

<!-- New in this Release -->
&newinrelease;

</section>

<!-- Install/config info for Windows -->
&windows;

<!-- Install/config info for Unix/Linux -->
&unix;

<section><title>The <computeroutput>rxapi</computeroutput> Daemon Process</title>
<para>
  Part of ooRexx is <computeroutput>rxapi</computeroutput> which is a daemon process that manages all
  data that can persist across interpreter invocations or is used for cross-process communications. The
  <computeroutput>rxapi</computeroutput> process manages the Rexx data queues, the macrospace, and all of
  the external function, subcommand handler and exit registrations.
</para>
<para>
  In ooRexx 4.0.0 the interpreter and <computeroutput>rxapi</computeroutput> communicate through a socket
  interface, rather than through shared memory as in previous versions of ooRexx.
</para>
<para>
  Ideally, <computeroutput>rxapi</computeroutput> should run as a service. When you install ooRexx from a
  package on Linux, <computeroutput>rxapi</computeroutput> will be set up to run as a system service.
  When installing the Windows package, the default is to install <computeroutput>rxapi</computeroutput>
  as a Windows service. In this scenario, the operating system will start the
  <computeroutput>rxapi</computeroutput> daemon on boot up and shut the daemon down when the system is
  halted.
</para>
<para>
  If <computeroutput>rxapi</computeroutput> is not installed as a service, the first time the interpreter
  executes, and needs the function provided by <computeroutput>rxapi</computeroutput>, the intepreter
  will start the daemon process. Once started, the <computeroutput>rxapi</computeroutput> process will
  continue to run until the system is halted.
</para>
<para>
  There is little or no point in stopping the <computeroutput>rxapi</computeroutput> process once it is
  started. <emphasis role="bold">Be aware</emphasis> that if you do stop the
  <computeroutput>rxapi</computeroutput> process, all queues, all registered subcommand handlers, system
  exits, and external functions, and the macrospace,
  disappear.
</para>
<para>
  When <computeroutput>rxapi</computeroutput> is installed as a service, it can be started and stopped by
  the user, if the user has the proper authority, in the same manner as other services. On Windows, the
  services manager can be used to start or stop <computeroutput>rxapi</computeroutput>. Or, from the
  command line, net stop or net start can also be used:
<programlisting>
<![CDATA[
C:\work.ooRexx>net stop rxapi
The RXAPI service is stopping.
The RXAPI service was stopped successfully.

C:\work.ooRexx>net start rxapi

The RXAPI service was started successfully.

C:\work.ooRexx>
]]>
</programlisting>
</para>
<para>
  On Linux, the following can be used from the command line:
<programlisting>
<![CDATA[

[root@Falcon work.ooRexx]# /etc/init.d/rxapid stop
Stopping rxapi:                                            [  OK  ]
[root@Falcon work.ooRexx]# /etc/init.d/rxapid start
Starting rxapi:                                            [  OK  ]
[root@Falcon work.ooRexx]#
]]>
</programlisting>
  It is likely that your installation of Linux also has a graphical means of starting or stopping
  services.
</para>

<para>
  On AIX, the following can be used from the command line:
<programlisting>
<![CDATA[

[root@myhost]# stopsrc -s rxapi
0513-044 The rxapi Subsystem was requested to stop.
[root@myhost]# startsrc -s rxapi
0513-059 The rxapi Subsystem has been started. Subsystem PID is 1134614.
[root@myhost]# lssrc -s rxapi
Subsystem         Group            PID          Status
 rxapi                             1134614      active
[root@Falcon work.ooRexx]#
]]>
</programlisting>
</para>
<para>
  If <computeroutput>rxapi</computeroutput> is not installed as a service, it can be stopped by using an
  appropriate process killer for your platform.  Typically the Task Manager on Windows and
  <computeroutput>kill</computeroutput> on a unix-like system.
</para>

</section>

<section><title>Known Limitations, Problems and Workarounds</title>
<itemizedlist>
<listitem>
<para>
  The global directory .environment is process local, not global to the system.
</para>
</listitem>
<listitem>
<para>
  Under Unix/Linux only piped "|" input and redirected output ("&gt;") can be evaluated by Open Object
  Rexx. Redirected input ("&lt;") can not be evaluated.
</para>
</listitem>
</itemizedlist>
</section>

<section><title>Documentation</title>
<para>
All documentation is contained in PDF files and zipped HTML package files and is available online at
http://www.oorexx.org/docs.html.
</para>
<para>
The following documents are available:
</para>
<variablelist>
<varlistentry>
<term>rexxref.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: Reference</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>rexxpg.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: Programming Guide</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>winextensions.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: Windows Extensions Reference</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>oodialog.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: Windows OODialog Reference</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>rxsock.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: TCP/IP Socket Library Functions Reference</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>rxftp.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: FTP Class Library Reference</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>rxmath.pdf</term>
<listitem><para>This is the <citetitle>Open Object Rexx: Mathematical Functions Reference</citetitle>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>readme.pdf</term>
<listitem><para>This document is in PDF and HTML format.
</para></listitem>
</varlistentry>
</variablelist>
</section>

&gethelp;

&notices;

&cplv10;

</article>