Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 108 lines (77 sloc) 3.765 kb
f022983 @rcaputo Initial revision
authored
1 $Id$
2
53cd540 @rcaputo explained more about what the hell this is
authored
3
d8788af @rcaputo Big documentation rewrite
authored
4 The bulk of this README's information has migrated to the POE manpage.
53cd540 @rcaputo explained more about what the hell this is
authored
5
1db9198 @rcaputo lots of testing changes and additions
authored
6 ------------------------------
7 Compatibility Between Versions
8 ------------------------------
53cd540 @rcaputo explained more about what the hell this is
authored
9
d8788af @rcaputo Big documentation rewrite
authored
10 As POE moves closer towards the Common Sense axis, it sometimes
11 diverges away from the Backwards Compatible axis. If this version is
12 being installed over a previous one, please check the Changes file to
13 see what it might break. Interface changes usually are documented.
1268917 @rcaputo reinvented it all again
authored
14
1db9198 @rcaputo lots of testing changes and additions
authored
15 ------------------
16 Basic Installation
17 ------------------
1268917 @rcaputo reinvented it all again
authored
18
d8788af @rcaputo Big documentation rewrite
authored
19 POE may be installed through the CPAN shell in the usual CPAN shell
20 manner. It typically is:
1268917 @rcaputo reinvented it all again
authored
21
d8788af @rcaputo Big documentation rewrite
authored
22 perl -MCPAN -e 'install POE'
1268917 @rcaputo reinvented it all again
authored
23
d8788af @rcaputo Big documentation rewrite
authored
24 It involves a little more work if you have an older CPAN shell:
1268917 @rcaputo reinvented it all again
authored
25
d8788af @rcaputo Big documentation rewrite
authored
26 perl -MCPAN -e shell
27 install POE
1268917 @rcaputo reinvented it all again
authored
28
1db9198 @rcaputo lots of testing changes and additions
authored
29 -------------------
30 Manual Installation
31 -------------------
1268917 @rcaputo reinvented it all again
authored
32
d8788af @rcaputo Big documentation rewrite
authored
33 POE can also be installed manually. The latest CPAN version can be
34 found at <ftp://ftp.cpan.org/pub/CPAN/authors/id/R/RC/RCAPUTO/> or in
35 a similarl named directory at your favorite CPAN mirror. The most
36 recent development snapshot, which only rarely contains heinous
37 showstopper bugs, is available from the author's web site at
38 <http://www.newts.org/~troc/poe.html>.
f2789c3 @rcaputo updated documentation for new contributions
authored
39
d8788af @rcaputo Big documentation rewrite
authored
40 Downloading and unpacking the distribution are left as an exercise for
41 the reader. To "build" and test it afterwards:
1268917 @rcaputo reinvented it all again
authored
42
d8788af @rcaputo Big documentation rewrite
authored
43 perl Makefile.PL
44 make test
0d6f19d @rcaputo Revised all the manpages. Split the manpages into separate PODs, and
authored
45
d8788af @rcaputo Big documentation rewrite
authored
46 The POE manpage discusses system requirements and compatibility
47 issues. You can preview it with:
0d6f19d @rcaputo Revised all the manpages. Split the manpages into separate PODs, and
authored
48
d8788af @rcaputo Big documentation rewrite
authored
49 perldoc ./POE.pm
53cd540 @rcaputo explained more about what the hell this is
authored
50
d8788af @rcaputo Big documentation rewrite
authored
51 There are several sample programs in the samples subdirectory. The
52 POE manpage briefly explains them.
6456a34 @rcaputo dunno why
authored
53
d8788af @rcaputo Big documentation rewrite
authored
54 ls -l samples
a16275a @rcaputo added credits; updated availability
authored
55
d8788af @rcaputo Big documentation rewrite
authored
56 Finally you can install it:
f2789c3 @rcaputo updated documentation for new contributions
authored
57
d8788af @rcaputo Big documentation rewrite
authored
58 make install
f2789c3 @rcaputo updated documentation for new contributions
authored
59
1db9198 @rcaputo lots of testing changes and additions
authored
60 -------------------------
61 Test Results and Coverage
62 -------------------------
63
e9f3ab2 @rcaputo TestPipe.pm; 20_accept.t; better select management
authored
64 These are the `make test' results for POE 0.1104. Hardware: Cyrix
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
65 P166+; 64MB RAM. Software: OS/2 4, fix 13; perl 5.6.0; no Perl/Tk; no
66 Event.
67
68 All tests successful, 3 tests skipped.
e9f3ab2 @rcaputo TestPipe.pm; 20_accept.t; better select management
authored
69 Files=21, Tests=365, 190 wallclock secs ( 0.00 cusr + 0.00 csys = 0.00 CPU)
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
70
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
71 These are the `make test' results for POE 0.1104. Hardware: AMD
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
72 486-40 (overclocked to 50); 16MB RAM. Software: FreeBSD 4.0-STABLE;
73 perl 5.6.0; Perl/Tk 800.021; Event 0.79.
74
75 All tests successful.
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
76 Files=21, Tests=381, 577 wallclock secs (297.42 cusr + 25.35 csys = 322.77 CPU)
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
77
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
78 These coverage results are for POE 0.1104 on the FreeBSD machine.
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
79 This machine more thoroughly tests different POE options, so the
80 coverage results are more meaningful. Even at their best, however,
81 the results are highly misleading. They are, in fact, slightly low
82 because of errors introduced by the profiling code. Please take these
83 figures with a grain of salt.
84
85 Source File = Ran / Total = Covered
86 POE.pm = 19 / 19 = 100.00%
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
87 POE/Component/Server/TCP.pm = 23 / 23 = 100.00%
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
88 POE/Driver/SysRW.pm = 42 / 54 = 77.78%
89 POE/Filter/Block.pm = 37 / 37 = 100.00%
90 POE/Filter/HTTPD.pm = 11 / 100 = 11.00%
91 POE/Filter/Line.pm = 83 / 88 = 94.32%
92 POE/Filter/Reference.pm = 60 / 66 = 90.91%
93 POE/Filter/Stream.pm = 11 / 11 = 100.00%
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
94 POE/Kernel.pm = 698 / 931 = 74.97%
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
95 POE/Preprocessor.pm = 119 / 138 = 86.23%
96 POE/Session.pm = 85 / 194 = 43.81%
97 POE/Wheel/FollowTail.pm = 68 / 86 = 79.07%
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
98 POE/Wheel/ListenAccept.pm = 32 / 45 = 71.11%
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
99 POE/Wheel/ReadWrite.pm = 106 / 185 = 57.30%
100 POE/Wheel/SocketFactory.pm = 195 / 278 = 70.14%
ed14a93 @rcaputo final doc tweaks for 0.1104 release
authored
101 All Told = 1589 / 2255 = 70.47%
9dbde82 @rcaputo finished README tweaks for 0.1103
authored
102
acd0ccd @rcaputo updated to reflect new version and features (d'oh)
authored
103
d8788af @rcaputo Big documentation rewrite
authored
104 Good luck, and thank you for reading!
f2789c3 @rcaputo updated documentation for new contributions
authored
105
0d6f19d @rcaputo Revised all the manpages. Split the manpages into separate PODs, and
authored
106
d8788af @rcaputo Big documentation rewrite
authored
107 -- Rocco Caputo / troc@netrus.net
Something went wrong with that request. Please try again.