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