Added DDsort ()
[Data-Peek.git] / README
blob47f4359775169e55babafe4dd466181f12a0375a
1 Module:
2     Data::Peek - A collection of low-level debug functions
4 Description:
5     Modified and extended wrapper functions to make debugging more
6     pleasureable.
8     DDumper is a wrapper around Data::Dumper with always sorted keys.
9     The output is however reflowed and not parseable anymore (in most
10     cases) as the quotation around the keys is removed.
12     DDump is a wrapper around perl's core function sv_dump (), which
13     should enable you to use the output instead of the default behaviour
14     that only prints to STDERR.
16     DPeek is a wrapper around internals Perl_sv_peek
18     DDump_IO is a wrapper around perl's core function do_sv_dump (),
19     which acts like sv_dump (), but to a PerlIO stream, which is only
20     available in perl 5.8 and higher.
22     Recent changes can be (re)viewed in the public GIT repository at
23     http://repo.or.cz/w/Data-Peek.git
25 Copying:
26     Copyright (c) 2008-2009 H.Merijn Brand.  All rights reserved.
28     This program is free software; you can redistribute it and/or modify
29     it under the same terms as Perl itself.
31 Prerequisites:
32     Perl 5.6.0 and up.
33     Some versions of perl on some operating system(s) might not have
34     exported the internals (yet). This module won't build then.
36     If you run a perl that did not export Perl_sv_peek (), DPeek will
37     not be available. If you happen to encounter that problem, most
38     likely on Windows or AIX, C<export NO_SV_PEEK=1> will make the
39     build and test pass (I hope)
41 Build/Installation:
42     Standard build/installation:
43         perl Makefile.PL
44         make
45         make test
46         make install
48 Author:
49     H.Merijn Brand <h.m.brand@xs4all.nl>