Software Version Description for Tie::Layers - read and write files pipelined through a stack of subroutine layers


Title Page

 Software Version Description
 for
 Tie::Layers - read and write files pipelined through a stack of subroutine layers
 Revision: B
 Version: 0.03
 Date: 2004/05/10
 Prepared for: General Public
 Prepared by:  SoftwareDiamonds.com E<lt>support@SoftwareDiamonds.comE<gt>
 Copyright: copyright  2003 Software Diamonds
 Classification: NONE

'Back to Top'


1.0 SCOPE

This paragraph identifies and provides an overview of the released files.

1.1 Identification

This release, identified in 3.2, is a collection of Perl modules that extend the capabilities of the Perl language.

1.2 System overview

The Tie::Layers program module contains the tie file handle Tie::Layers package. The Tie::Layers package provides the ability to insert a stack of subroutines between file subroutines print and realine and the underlying $file. The syntax of the subroutines of each layer of the readline stack and the print stack must comply to the the requirements described herein below. This is necessary so that the Tie::Layers READLINE and PRINT subroutines know how to transfer the output from one layer to the input of another layer. The stacks are setup by supplying options with a reference to the subroutine for each layer in the print stack and the readline stack. The Tie::Layers are line orientated and do not support any character file subrouintes. The getc, read, and write file subroutines are supported by the Tie::Layers package. The seek routines are line oriented in that the seek and tell subroutine positions are the line in the underlying file and not the character position in the file.

1.3 Document overview.

This document releases Tie::Layers version 0.03 providing a description of the inventory, installation instructions and other information necessary to utilize and track this release.

'Back to Top'


3.0 VERSION DESCRIPTION

All file specifications in this SVD use the Unix operating system file specification.

3.1 Inventory of materials released.

This document releases the file

 Tie-Layers-0.03.tar.gz

found at the following repository(s):

  http://www.softwarediamonds/packages/
  http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/

Restrictions regarding duplication and license provisions are as follows:

Copyright.
copyright 2003 Software Diamonds

Copyright holder contact.
 603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
License.
Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:
  1. Redistributions of source code, modified or unmodified must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. 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.

SOFTWARE DIAMONDS, http://www.SoftwareDiamonds.com, PROVIDES THIS SOFTWARE '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 SOFTWARE DIAMONDS 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 USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.

3.2 Inventory of software contents

The content of the released, compressed, archieve file, consists of the following files:

 file                                                         version date       comment
 ------------------------------------------------------------ ------- ---------- ------------------------
 lib/Docs/Site_SVD/Tie_Layers.pm                              0.03    2004/05/10 revised 0.02
 MANIFEST                                                     0.03    2004/05/10 generated, replaces 0.02
 Makefile.PL                                                  0.03    2004/05/10 generated, replaces 0.02
 README                                                       0.03    2004/05/10 generated, replaces 0.02
 lib/Tie/Layers.pm                                            0.03    2004/05/10 revised 0.02
 t/Tie/Layers.pm                                              0.01    2004/05/09 unchanged
 t/Tie/Layers.t                                               0.01    2004/05/09 unchanged
 t/Tie/Layers.d                                               0.01    2004/05/09 unchanged
 t/Tie/File/Package.pm                                        1.16    2004/05/10 unchanged
 t/Tie/Test/Tech.pm                                           1.22    2004/05/10 unchanged
 t/Tie/Data/Secs2.pm                                          1.2     2004/05/10 unchanged
 t/Tie/Data/SecsPack.pm                                       0.05    2004/05/10 unchanged
 t/Tie/Data/Startup.pm                                        0.04    2004/05/10 unchanged

3.3 Changes

Changes are as follows

Tie::Layers-0.01
Originated

Tie::Layers-0.02
Sometimes get a DESTROY when coming out of TIEHANDLE. Do not want TIEHANDLE going around closing stuff, especially for an OPEN with a file handle like DATA. If something needs closing, call CLOSE directly.

Tie::Layers-0.03
Added Data::Startup as perquisite.

3.4 Adaptation data.

This installation requires that the installation site has the Perl programming language installed. There are no other additional requirements or tailoring needed of configurations files, adaptation data or other software needed for this installation particular to any installation site.

3.5 Related documents.

There are no related documents needed for the installation and test of this release.

3.6 Installation instructions.

Instructions for installation, installation tests and installation support are as follows:

Installation Instructions.
To installed the release file, use the CPAN module pr PPM module in the Perl release or the INSTALL.PL script at the following web site:
 http://packages.SoftwareDiamonds.com

Follow the instructions for the the chosen installation software.

If all else fails, the file may be manually installed. Enter one of the following repositories in a web browser:

  http://www.softwarediamonds/packages/
  http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/

Right click on 'Tie-Layers-0.03.tar.gz' and download to a temporary installation directory. Enter the following where $make is 'nmake' for microsoft windows; otherwise 'make'.

 gunzip Tie-Layers-0.03.tar.gz
 tar -xf Tie-Layers-0.03.tar
 perl Makefile.PL
 $make test
 $make install

On Microsoft operating system, nmake, tar, and gunzip must be in the exeuction path. If tar and gunzip are not install, download and install unxutils from

 http://packages.softwarediamonds.com

Prerequistes.
 None.
Security, privacy, or safety precautions.
None.

Installation Tests.
Most Perl installation software will run the following test script(s) as part of the installation:
 t/Tie/Layers.t

Installation support.
If there are installation problems or questions with the installation contact
 603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>

3.7 Possible problems and known errors

There are no known open issues.

'Back to Top'


4.0 NOTES

The following are useful acronyms:

.d
extension for a Perl demo script file

.pm
extension for a Perl Library Module

.t
extension for a Perl test script file

'Back to Top'


2.0 SEE ALSO

Docs::US_DOD::SVD

'Back to Top'

 Software Version Description for Tie::Layers - read and write files pipelined through a stack of subroutine layers