diff options
| author | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-04 12:06:20 +0200 |
|---|---|---|
| committer | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-04 12:07:43 +0200 |
| commit | c4d5b232f0358ca6c7f6c2639b8fc19dc10cc34c (patch) | |
| tree | e413d893bcd9a42b8a0b26d193ed566dd4f7ece2 | |
| parent | 4f5950e18ec7930cf0c003d683fbbe4c2d6d0f3a (diff) | |
Added some documentation about the storage format
| -rw-r--r-- | lib/Simplestore.pm | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/Simplestore.pm b/lib/Simplestore.pm index c450937..7d0834a 100644 --- a/lib/Simplestore.pm +++ b/lib/Simplestore.pm @@ -97,6 +97,13 @@ save I<hashref> in I<storefile>. Returns nothing. =back +=head1 STORAGE FORMAT + +The store file contains key-value-pairs, each of them separated by a newline, +The key and value are separated by a single tab. +If a value contains newlines, they will be printed, but the next line(s) will be +prefixed by the key. For a little example, see SYNOPSIS. + =head1 MOTIVATION B<Simplestore> aims to provide a common, simple format to store data. |