Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 252 lines (187 sloc) 7.991 kb
f0229831 »
1998-08-15 Initial revision
1 $Id$
2
6221c666 »
2000-12-26 revise README
3 -----------
4 What POE Is
5 -----------
53cd5403 »
1998-08-18 explained more about what the hell this is
6
6221c666 »
2000-12-26 revise README
7 POE is an application kernel that uses event driven state machines as
8 threads. It includes a high-level I/O library that hides most of the
9 usual client/server tediosity. It has been developed and used in
10 mission-critical systems since August 1998.
1268917a »
1998-11-23 reinvented it all again
11
c3771043 »
2000-12-29 touch-up distribution files for Wheel::Run and pipes
12 ---------------------
13 Documentation Roadmap
14 ---------------------
15
16 The POE manpage's SEE ALSO section lists the topics covered in each
17 manpage. It's a good starting place.
18
670c4b32 »
2001-03-04 tiny tweaks for next release
19 --------------------
20 Distribution Details
21 --------------------
22
23 This distribution comes with several sample and tutorial programs in
24 its samples/ directory. These programs are NOT installed because they
25 have limited use and take up a lot of space and have limited use.
26 They will be split into a separate distribution in the near future.
27
28 The lib/ directory includes a few useful utilities, including a
29 relatively portable bidirectional pipe creator. There's also a small
30 test coverage module, harness, and report. The test coverage summary
31 at the end of this file was generated by that system. These utilities
32 aren't installed either.
33
34 The test programs, in t/, may also be interesting examples, although
35 they're more geared towards exercising POE. The tests also aren't
36 installed.
37
38 All in all, the actual installed bits of POE are probably around a
39 third of the total distribution, and about a quarter of B<that> is
40 documentation.
41
1db91984 »
2000-05-29 lots of testing changes and additions
42 ------------------
43 Basic Installation
44 ------------------
1268917a »
1998-11-23 reinvented it all again
45
d8788af8 »
2000-05-21 Big documentation rewrite
46 POE may be installed through the CPAN shell in the usual CPAN shell
47 manner. It typically is:
1268917a »
1998-11-23 reinvented it all again
48
d8788af8 »
2000-05-21 Big documentation rewrite
49 perl -MCPAN -e 'install POE'
1268917a »
1998-11-23 reinvented it all again
50
d8788af8 »
2000-05-21 Big documentation rewrite
51 It involves a little more work if you have an older CPAN shell:
1268917a »
1998-11-23 reinvented it all again
52
d8788af8 »
2000-05-21 Big documentation rewrite
53 perl -MCPAN -e shell
54 install POE
1268917a »
1998-11-23 reinvented it all again
55
6221c666 »
2000-12-26 revise README
56 --------------------------
57 Getting The Latest Version
58 --------------------------
59
60 POE can also be installed manually. Tarballs are available from at
61 least three sources:
62
63 The most recent stable release can be found at your favorite CPAN
64 mirror. If you don't have a favorite CPAN mirror, there's always:
1268917a »
1998-11-23 reinvented it all again
65
6221c666 »
2000-12-26 revise README
66 ftp://ftp.cpan.org/pub/CPAN/authors/id/R/RC/RCAPUTO/
67
68 The most recent development snapshot is available from two locations:
69
70 http://poe.perl.org/
71 http://sourceforge.net/projects/poe/
72
73 The SourceForge project includes a CVS repository browser, so you can
74 look around to see what's new. It also has facilities for people to
75 submit bug reports, patches, and support requests.
76
77 ---------------------------
78 Building The Latest Version
79 ---------------------------
f2789c3d »
1998-12-04 updated documentation for new contributions
80
d8788af8 »
2000-05-21 Big documentation rewrite
81 Downloading and unpacking the distribution are left as an exercise for
6221c666 »
2000-12-26 revise README
82 the reader. See the previous section for tarball locations.
83
84 System requirements and copatibility issues are covered in the main
85 POE manpage. You can preview them before building POE.
86
87 perldoc ./POE.pm
88
89 Please read the Changes file if you already have programs which use
90 POE. Sometimes there are changes that break compatibility with older
91 versions, and the Changes file can tell you about them before you
92 install POE.
93
94 less ./Changes
95
96 If everything looks good, build POE.
1268917a »
1998-11-23 reinvented it all again
97
d8788af8 »
2000-05-21 Big documentation rewrite
98 perl Makefile.PL
6221c666 »
2000-12-26 revise README
99 make
100
101 Then test the distribution. This is an important step since it also
102 ferrets out the modules POE needs. It reports on the POE components
103 which won't work because of missing dependencies, and it recommends
104 things to install. Please read the dependency report carefully.
105
d8788af8 »
2000-05-21 Big documentation rewrite
106 make test
0d6f19d1 »
1999-06-15 Revised all the manpages. Split the manpages into separate PODs, and
107
6221c666 »
2000-12-26 revise README
108 Now you're ready to install POE, but first you may want to look at its
f4406265 »
2001-02-12 update for 0.1205 release
109 samples. Some of the samples may not work; the important thing is
110 that the tests pass. All the programs in the samples subdirectory are
111 written to run from the distribution directory without POE being
112 installed yet.
0d6f19d1 »
1999-06-15 Revised all the manpages. Split the manpages into separate PODs, and
113
6221c666 »
2000-12-26 revise README
114 cd ./samples
115 ls -l
53cd5403 »
1998-08-18 explained more about what the hell this is
116
6221c666 »
2000-12-26 revise README
117 [try some]
6456a343 »
1998-11-25 dunno why
118
6221c666 »
2000-12-26 revise README
119 cd ..
a16275a7 »
1998-11-26 added credits; updated availability
120
d8788af8 »
2000-05-21 Big documentation rewrite
121 Finally you can install it:
f2789c3d »
1998-12-04 updated documentation for new contributions
122
d8788af8 »
2000-05-21 Big documentation rewrite
123 make install
f2789c3d »
1998-12-04 updated documentation for new contributions
124
5225b6be »
2000-11-19 readme fixes
125 ------------
126 Test Results
127 ------------
1db91984 »
2000-05-29 lots of testing changes and additions
128
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
129 All the tests have been made to run unattended, and testing has been
130 automated across the systems.
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
131
67477850 »
2001-02-22 add ReadLine wheel
132 ** POE 0.1206 on OS/2 (home-os2)
c35b51cf »
2000-12-29 tweak README for next release; fix t/06_tk.t to use the right type pipe
133
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
134 OS/2 doesn't grok system vs. user time, so the numbers are 0.
5225b6be »
2000-11-19 readme fixes
135
f4406265 »
2001-02-12 update for 0.1205 release
136 Hardware: Cyrix P166+; 64MB RAM
5225b6be »
2000-11-19 readme fixes
137 System : OS/2 4.0, Fix 13
138 Perl : v5.6.0
139 Gtk : (not installed)
140 Tk : (not installed)
141 Event : (not installed)
04d91cd4 »
2001-01-14 fix Wheel::Run pty conduits on Solaris
142 IO::Pty : 0.01
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
143
c35b51cf »
2000-12-29 tweak README for next release; fix t/06_tk.t to use the right type pipe
144 All tests successful, 4 tests and 5 subtests skipped.
670c4b32 »
2001-03-04 tiny tweaks for next release
145 Files=24, Tests=429, 148 wallclock secs ( 0.00 cusr + 0.00 csys = 0.00 CPU)
ad3be79c »
2000-10-06 gtk debugged... moving to os/2 for testing
146
67477850 »
2001-02-22 add ReadLine wheel
147 ** POE 0.1206 on FreeBSD (home-bsd)
ad3be79c »
2000-10-06 gtk debugged... moving to os/2 for testing
148
f4406265 »
2001-02-12 update for 0.1205 release
149 Hardware: AMD 486-40; 16MB RAM
5225b6be »
2000-11-19 readme fixes
150 System : FreeBSD 4.0-STABLE
151 Perl : v5.6.0
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
152 Gtk : 0.7004
5225b6be »
2000-11-19 readme fixes
153 Tk : 800.021
154 Event : 0.79
04d91cd4 »
2001-01-14 fix Wheel::Run pty conduits on Solaris
155 IO::Pty : 0.01
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
156
6221c666 »
2000-12-26 revise README
157 All tests successful.
67477850 »
2001-02-22 add ReadLine wheel
158 Files=24, Tests=455, 523 wallclock secs (317.21 cusr + 32.81 csys = 350.02 CPU)
d67e22ba »
2000-10-31 more test results to README
159
67477850 »
2001-02-22 add ReadLine wheel
160 ** POE 0.1206 on Linux (titanic)
d67e22ba »
2000-10-31 more test results to README
161
5225b6be »
2000-11-19 readme fixes
162 Hardware: dual Celeron 500; 265MB RAM
163 System : Linux 2.2.15 SMP
164 Perl : v5.6.0
165 Gtk : (not installed)
166 Tk : (not installed)
167 Event : 0.79
04d91cd4 »
2001-01-14 fix Wheel::Run pty conduits on Solaris
168 IO::Pty : 0.01
d67e22ba »
2000-10-31 more test results to README
169
44b56f9d »
2001-01-23 comment change; postbacks are official
170 All tests successful, 2 tests skipped.
670c4b32 »
2001-03-04 tiny tweaks for next release
171 Files=24, Tests=438, 100 wallclock secs (15.85 cusr + 0.81 csys = 16.66 CPU)
d67e22ba »
2000-10-31 more test results to README
172
f4406265 »
2001-02-12 update for 0.1205 release
173 ** POE 0.1205 on Solaris/SunOS 5.7 (hfb)
a7105046 »
2000-12-26 Tweak README and Makefile.PL
174
f4406265 »
2001-02-12 update for 0.1205 release
175 Hardware: SPARCstation-20; dual Sparc-75; 320MB RAM
a7105046 »
2000-12-26 Tweak README and Makefile.PL
176 System : SunOS 5.7
177 Perl : 5.005_03
178 Gtk : (not installed)
179 Tk : (not installed)
180 Event : (not installed)
04d91cd4 »
2001-01-14 fix Wheel::Run pty conduits on Solaris
181 IO::Pty : 0.01
a7105046 »
2000-12-26 Tweak README and Makefile.PL
182
44b56f9d »
2001-01-23 comment change; postbacks are official
183 All tests successful, 4 tests skipped.
f4406265 »
2001-02-12 update for 0.1205 release
184 Files=24, Tests=429, 122 wallclock secs (61.70 cusr + 5.49 csys = 67.19 CPU)
a7105046 »
2000-12-26 Tweak README and Makefile.PL
185
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
186 ** POE 0.1203 on Linux (a-mused)
c5c96e7a »
2000-12-30 partial pty code in wheel::run... need to move to another machine
187
188 Hardware: Celeron 600; unknown RAM
189 System : Linux 2.4.0-test12
190 Perl : 5.005_03
191 Gtk : (unknown)
192 Tk : (not installed)
193 Event : (installed; unknown version)
194
195 All tests successful, 2 tests skipped.
196 Files=23, Tests=415, 98 wallclock secs (14.22 cusr + 0.63 csys = 14.85 CPU)
197
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
198 ** POE 0.1203 on Solaris/SunOS 5.8 (dynweb)
940a9cad »
2000-12-27 fix noisiness when resuming unpaused handles in Gtk
199
200 Hardware: SPARCstation-80; 2x UltraSparc II-450; 1GB RAM
201 System : SunOS 5.7
202 Perl : 5.6.0
203 Gtk : (not installed)
204 Tk : (not installed)
c5c96e7a »
2000-12-30 partial pty code in wheel::run... need to move to another machine
205 Event : 0.80
940a9cad »
2000-12-27 fix noisiness when resuming unpaused handles in Gtk
206
c5c96e7a »
2000-12-30 partial pty code in wheel::run... need to move to another machine
207 All tests successful, 2 tests skipped.
208 Files=23, Tests=415, 98 wallclock secs (14.03 cusr + 0.99 csys = 15.02 CPU)
940a9cad »
2000-12-27 fix noisiness when resuming unpaused handles in Gtk
209
a7105046 »
2000-12-26 Tweak README and Makefile.PL
210 -------------
211 Test Coverage
212 -------------
213
214 The test coverage numbers are statistically meaningless. Still, 100%
215 coverage is a fun goal. Increasing the coverage percents gives the
216 author some small sense of accomplishment, and it assures users that
217 something's being done to assure POE's quality.
218
f4406265 »
2001-02-12 update for 0.1205 release
219 These results are for POE 0.1205 on the FreeBSD test machine. This
a7105046 »
2000-12-26 Tweak README and Makefile.PL
220 machine is the slowest of the bunch, but it also has the most support
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
221 libraries installed.
ececdbf5 »
2000-10-10 minor README tweaks and a missing inclusion
222
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
223 Source File = Ran / Total = Covered
d67e22ba »
2000-10-31 more test results to README
224 POE.pm = 23 / 24 = 95.83%
5225b6be »
2000-11-19 readme fixes
225 POE/Component.pm = 5 / 5 = 100.00%
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
226 POE/Component/Server/TCP.pm = 26 / 26 = 100.00%
5225b6be »
2000-11-19 readme fixes
227 POE/Driver.pm = 5 / 5 = 100.00%
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
228 POE/Driver/SysRW.pm = 42 / 54 = 77.78%
5225b6be »
2000-11-19 readme fixes
229 POE/Filter.pm = 5 / 5 = 100.00%
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
230 POE/Filter/Block.pm = 37 / 37 = 100.00%
b22f8d6e »
2000-10-12 test and coverage for README
231 POE/Filter/HTTPD.pm = 11 / 88 = 12.50%
232 POE/Filter/Line.pm = 77 / 82 = 93.90%
9dbde822 »
2000-08-07 finished README tweaks for 0.1103
233 POE/Filter/Reference.pm = 60 / 66 = 90.91%
234 POE/Filter/Stream.pm = 11 / 11 = 100.00%
f4406265 »
2001-02-12 update for 0.1205 release
235 POE/Kernel.pm = 572 / 815 = 70.18%
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
236 POE/NFA.pm = 74 / 157 = 47.13%
237 POE/Pipe/OneWay.pm = 20 / 39 = 51.28%
238 POE/Pipe/TwoWay.pm = 23 / 43 = 53.49%
239 POE/Preprocessor.pm = 147 / 167 = 88.02%
5225b6be »
2000-11-19 readme fixes
240 POE/Session.pm = 126 / 181 = 69.61%
241 POE/Wheel.pm = 11 / 11 = 100.00%
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
242 POE/Wheel/FollowTail.pm = 75 / 96 = 78.12%
243 POE/Wheel/ListenAccept.pm = 39 / 53 = 73.58%
f4406265 »
2001-02-12 update for 0.1205 release
244 POE/Wheel/ReadWrite.pm = 111 / 188 = 59.04%
245 POE/Wheel/Run.pm = 141 / 239 = 59.00%
d3e954b1 »
2001-01-13 fix readme and changes for 0.1204 release
246 POE/Wheel/SocketFactory.pm = 197 / 234 = 84.19%
f4406265 »
2001-02-12 update for 0.1205 release
247 All Told = 1838 / 2626 = 69.99%
f2789c3d »
1998-12-04 updated documentation for new contributions
248
ad3be79c »
2000-10-06 gtk debugged... moving to os/2 for testing
249 Thanks for reading!
0d6f19d1 »
1999-06-15 Revised all the manpages. Split the manpages into separate PODs, and
250
a7105046 »
2000-12-26 Tweak README and Makefile.PL
251 -- Rocco Caputo / troc@netrus.net / poe.perl.org / poe.sourceforge.net
Something went wrong with that request. Please try again.