diff options
author | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-09 23:55:20 +0200 |
---|---|---|
committer | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-09 23:55:20 +0200 |
commit | 5575943be7498a2c313e6ec630966bec237c1fa8 (patch) | |
tree | b90ebb1233ba7226793834b26f7dd7e326337c01 /lib/Simplestore.pm | |
parent | c4d5b232f0358ca6c7f6c2639b8fc19dc10cc34c (diff) |
Minor documentation improvements
Diffstat (limited to 'lib/Simplestore.pm')
-rw-r--r-- | lib/Simplestore.pm | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/Simplestore.pm b/lib/Simplestore.pm index 7d0834a..77c83a5 100644 --- a/lib/Simplestore.pm +++ b/lib/Simplestore.pm @@ -63,13 +63,14 @@ Simplestore - simple storage format for hash refs say $hash->{word}; # purrl $hash->{foo} = 'bar'; - $hash->{word} = "Yeah, this is more than\none word, I know"; + $hash->{sentence} = "Mind the\nnewnile.; save('somefile', $hash); # somefile contains: - # word Yeah, this is more than - # word one word, I know + # word purrl # foo bar + # sentence Mind the + # sentence newline. =head1 DESCRIPTION @@ -100,7 +101,7 @@ save I<hashref> in I<storefile>. Returns nothing. =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. +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. |