Tree [b0e7f6] v0_1010 /
History



File Date Author Commit
docs 2000-01-24 Rocco Caputo Rocco Caputo [12d9e3] Document compression mode in Changes
lib 2000-06-21 Rocco Caputo Rocco Caputo [b0e7f6] tweaked the version number
mylib 2000-06-21 Rocco Caputo Rocco Caputo [faff6c] test tweaks and followtail fix
samples 2000-05-23 Rocco Caputo Rocco Caputo [1635ac] better tk test; need to move to os/2 for plain ...
tests 2000-06-21 Rocco Caputo Rocco Caputo [faff6c] test tweaks and followtail fix
Changes 2000-06-21 Rocco Caputo Rocco Caputo [faff6c] test tweaks and followtail fix
HISTORY 1998-11-23 Rocco Caputo Rocco Caputo [bfdcb0] pointless...
MANIFEST 2000-06-19 Rocco Caputo Rocco Caputo [e0749f] Removed $kernel->fork(); added new tests to atone
Makefile.PL 2000-06-03 Rocco Caputo Rocco Caputo [1b3c88] many signal changes
README 2000-06-21 Rocco Caputo Rocco Caputo [faff6c] test tweaks and followtail fix

Read Me

$Id$


The bulk of this README's information has migrated to the POE manpage.

------------------------------
Compatibility Between Versions
------------------------------

As POE moves closer towards the Common Sense axis, it sometimes
diverges away from the Backwards Compatible axis.  If this version is
being installed over a previous one, please check the Changes file to
see what it might break.  Interface changes usually are documented.

------------------
Basic Installation
------------------

POE may be installed through the CPAN shell in the usual CPAN shell
manner.  It typically is:

  perl -MCPAN -e 'install POE'

It involves a little more work if you have an older CPAN shell:

  perl -MCPAN -e shell
  install POE

-------------------
Manual Installation
-------------------

POE can also be installed manually.  The latest CPAN version can be
found at <ftp://ftp.cpan.org/pub/CPAN/authors/id/R/RC/RCAPUTO/> or in
a similarl named directory at your favorite CPAN mirror.  The most
recent development snapshot, which only rarely contains heinous
showstopper bugs, is available from the author's web site at
<http://www.newts.org/~troc/poe.html>.

Downloading and unpacking the distribution are left as an exercise for
the reader.  To "build" and test it afterwards:

  perl Makefile.PL
  make test

The POE manpage discusses system requirements and compatibility
issues.  You can preview it with:

  perldoc ./POE.pm

There are several sample programs in the samples subdirectory.  The
POE manpage briefly explains them.

  ls -l samples

Finally you can install it:

  make install

-------------------------
Test Results and Coverage
-------------------------

Test results for 0.1010 running FreeBSD 4.0-STABLE with perl 5.6.0,
Event 0.79, and Perl/Tk 800.021:

All tests successful.
Files=17, Tests=212, 479 wallclock secs (238.52 cusr + 23.65 csys = 262.16 CPU)

POE's development after 0.1005 consists of a big push to test
everything.  To further this effort, the author wrote a test coverage
reporting program; then he discovered Devel::Coverage.  Oh well!
Anyway, here's the test coverage summary for version 0.1009.  The numbers
don't match up yet, but this is a general guideline for how well-tested
POE is.

Source File                         =   Ran / Total = Covered
POE.pm                              =    19 /    19 = 100.00%
POE/Component/Server/TCP.pm         =    22 /    23 =  95.65%
POE/Driver/SysRW.pm                 =    42 /    54 =  77.78%
POE/Filter/Block.pm                 =    34 /    37 =  91.89%
POE/Filter/HTTPD.pm                 =    11 /    85 =  12.94%
POE/Filter/Line.pm                  =    15 /    20 =  75.00%
POE/Filter/Reference.pm             =     4 /    66 =   6.06%
POE/Filter/Stream.pm                =    11 /    11 = 100.00%
POE/KernePOE/Kernel.pm              =     0 /     2 =   0.00%
POE/Kernel.pm                       =   712 /   904 =  78.76%
POE/Preprocessor.pm                 =   119 /   138 =  86.23%
POE/Session.pm                      =    85 /   194 =  43.81%
POE/Wheel/FollowTail.pm             =    54 /    69 =  78.26%
POE/Wheel/ListenAccept.pm           =     5 /    43 =  11.63%
POE/Wheel/ReadWrite.pm              =   100 /   183 =  54.64%
POE/Wheel/SocketFactory.pm          =   194 /   275 =  70.55%
All Told                            =  1427 /  2123 =  67.22%

Good luck, and thank you for reading!


-- Rocco Caputo / troc@netrus.net