Commit | Line | Data |
9e21b3d0 |
1 | Storable 1.0 |
7a6a85bf |
2 | Copyright (c) 1995-2000, Raphael Manfredi |
3 | |
4 | ------------------------------------------------------------------------ |
5 | This program is free software; you can redistribute it and/or modify |
9e21b3d0 |
6 | it under the same terms as Perl 5 itself. |
7a6a85bf |
7 | |
8 | This program is distributed in the hope that it will be useful, |
9 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
10 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
9e21b3d0 |
11 | Perl 5 License schemes for more details. |
7a6a85bf |
12 | ------------------------------------------------------------------------ |
13 | |
7a6a85bf |
14 | +======================================================================= |
9e21b3d0 |
15 | | Storable is distributed as a module, but is also part of the official |
16 | | Perl core distribution. Maintenance is still done by the Author, |
17 | | whilst the perl5-porters ensure that no change to the Perl internals |
18 | | can break the version of Storable distributed with it. |
7a6a85bf |
19 | +======================================================================= |
20 | |
21 | The Storable extension brings persistency to your data. |
22 | |
23 | You may recursively store to disk any data structure, no matter how |
24 | complex and circular it is, provided it contains only SCALAR, ARRAY, |
25 | HASH (possibly tied) and references (possibly blessed) to those items. |
26 | |
27 | At a later stage, or in another program, you may retrieve data from |
28 | the stored file and recreate the same hiearchy in memory. If you |
29 | had blessed references, the retrieved references are blessed into |
30 | the same package, so you must make sure you have access to the |
31 | same perl class than the one used to create the relevant objects. |
32 | |
33 | There is also a dclone() routine which performs an optimized mirroring |
34 | of any data structure, preserving its topology. |
35 | |
36 | Objects (blessed references) may also redefine the way storage and |
37 | retrieval is performed, and/or what deep cloning should do on those |
38 | objects. |
39 | |
40 | To compile this extension, run: |
41 | |
42 | perl Makefile.PL [PERL_SRC=...where you put perl sources...] |
43 | make |
44 | make install |
45 | |
46 | There is an embeded POD manual page in Storable.pm. |
47 | |
48 | Raphael Manfredi <Raphael_Manfredi@pobox.com> |
49 | |
50 | ------------------------------------------------------------------------ |
9e21b3d0 |
51 | Thanks to (in chronological order): |
7a6a85bf |
52 | |
53 | Jarkko Hietaniemi <jhi@iki.fi> |
54 | Ulrich Pfeifer <pfeifer@charly.informatik.uni-dortmund.de> |
55 | Benjamin A. Holzman <bah@ecnvantage.com> |
56 | Andrew Ford <A.Ford@ford-mason.co.uk> |
57 | Gisle Aas <gisle@aas.no> |
58 | Jeff Gresham <gresham_jeffrey@jpmorgan.com> |
59 | Murray Nesbitt <murray@activestate.com> |
60 | Albert N. Micheev <Albert.N.Micheev@f80.n5049.z2.fidonet.org> |
61 | Marc Lehmann <pcg@opengroup.org> |
9e21b3d0 |
62 | Justin Banks <justinb@wamnet.com> |
63 | Jarkko Hietaniemi <jhi@iki.fi> (AGAIN, as perl 5.7.0 Pumpkin!) |
7a6a85bf |
64 | |
65 | for their contributions. |
66 | |
67 | There is a Japanese translation of this man page available at |
68 | http://member.nifty.ne.jp/hippo2000/perltips/storable.htm, |
69 | courtesy of Kawai, Takanori <kawai@nippon-rad.co.jp>. |
70 | ------------------------------------------------------------------------ |