README

   1 =head1 NAME
   2
   3 Data::Peek - A collection of low-level debug functions
   4
   5 =head1 Description
   6
   7 Modified and extended wrapper functions to make debugging more
   8 pleasurable.
   9
  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.
  13
  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.
  17
  18 DPeek () is a wrapper around internals Perl_sv_peek
  19
  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, which is only
  22 available in perl 5.8 and higher.
  23
  24 =head1 PREREQUISITES
  25
  26 Perl 5.6.0 and up.
  27 Some versions of perl on some operating system(s) might not have
  28 exported the internals (yet). This module won't build then.
  29
  30 If you run a perl that did not export Perl_sv_peek (), DPeek will
  31 not be available. If you happen to encounter that problem, most
  32 likely on Windows or AIX, C<export NO_SV_PEEK=1> will make the
  33 build and test pass (I hope)
  34
  35 =head1 INSTALLATION
  36
  37   $ perl Makefile.PL
  38   $ make
  39   $ make test
  40   $ make install
  41
  42 Recent changes can be (re)viewed in the public GIT repository at
  43 http://repo.or.cz/w/Data-Peek.git
  44
  45 Feel free to clone your own copy:
  46
  47  $ git clone http://repo.or.cz/r/Data-Peek.git Data-Peek
  48
  49 or get it as a tgz:
  50
  51  $ wget --output-document=Data-Peek-git.tgz \
  52            'http://repo.or.cz/w/Data-Peek.git?a=snapshot;sf=tgz'
  53
  54 =head1 AUTHOR
  55
  56 H.Merijn Brand <h.m.brand@xs4all.nl>
  57
  58 =head1 COPYRIGHT AND LICENSE
  59
  60 Copyright (c) 2008-2010 H.Merijn Brand.  All rights reserved.
  61
  62 This program is free software; you can redistribute it and/or modify
  63 it under the same terms as Perl itself.
  64
  65 =cut