README
1=head1 NAME
2
3Data::Peek - A collection of low-level debug functions
4
5=head1 Description
6
7Modified and extended wrapper functions to make debugging more
8pleasurable.
9
10DDumper () is a wrapper around Data::Dumper with always sorted keys.
11The output is however reflowed and not parsable anymore (in most
12cases) as the quotation around the keys is removed.
13
14DDump () is a wrapper around perl's core function sv_dump (), which
15should enable you to use the output instead of the default behavior
16that only prints to STDERR.
17
18DPeek () is a wrapper around internals Perl_sv_peek
19
20DDump_IO () is a wrapper around perl's core function do_sv_dump (),
21which acts like sv_dump (), but to a PerlIO stream.
22
23=head1 PREREQUISITES
24
25Perl 5.8.0 and up.
26Some versions of perl on some operating system(s) might not have
27exported the internals (yet). This module won't build then.
28
29If you run a perl that did not export Perl_sv_peek (), DPeek will
30not be available. If you happen to encounter that problem, most
31likely on Windows or AIX, C<export NO_SV_PEEK=1> will make the
32build and test pass (I hope)
33
34=head1 INSTALLATION
35
36 $ perl Makefile.PL
37 $ make
38 $ make test
39 $ make install
40
41Recent changes can be (re)viewed in the public GIT repository at
42https://github.com/Tux/Data-Peek
43
44Feel free to clone your own copy:
45
46 $ git clone https://github.com/Tux/Data-Peek Data-Peek
47
48or get it as a tgz:
49
50 $ wget --output-document=Data-Peek-git.tgz \
51 https://github.com/Tux/Data-Peek/archive/master.tar.gz
52
53=head1 AUTHOR
54
55H.Merijn Brand <h.m.brand@xs4all.nl>
56
57=head1 COPYRIGHT AND LICENSE
58
59Copyright (c) 2008-2020 H.Merijn Brand. All rights reserved.
60
61This program is free software; you can redistribute it and/or modify
62it under the same terms as Perl itself.
63
64=cut
65