summaryrefslogtreecommitdiff
path: root/devel/p5-Storable/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'devel/p5-Storable/pkg-descr')
-rw-r--r--devel/p5-Storable/pkg-descr17
1 files changed, 17 insertions, 0 deletions
diff --git a/devel/p5-Storable/pkg-descr b/devel/p5-Storable/pkg-descr
new file mode 100644
index 000000000000..b300ed7f49c1
--- /dev/null
+++ b/devel/p5-Storable/pkg-descr
@@ -0,0 +1,17 @@
+ The Storable package brings you persistency for your perl
+ data structures containing SCALAR, ARRAY, HASH or REF
+ objects, i.e. anything that can be convenientely stored to
+ disk and retrieved at a later time.
+
+ It can be used in the regular procedural way by calling
+ store with a reference to the object to store, and
+ providing a file name. The routine returns undef for I/O
+ problems or other internal error, a true value otherwise.
+ Serious errors are propagated as a die exception.
+
+ To retrieve data stored to disk, you use retrieve with a
+ file name, and the objects stored into that file are
+ recreated into memory for you, and a reference to the root
+ object is returned. In case an I/O error occurred while
+ reading, undef is returned instead. Other serious errors
+ are propagated via die.