debian man page for data::show

Data::Show(3pm) 					User Contributed Perl Documentation					   Data::Show(3pm)

NAME
       Data::Show - Dump data structures with name and point-of-origin

VERSION
       This document describes Data::Show version 0.002001

SYNOPSIS
	   use Data::Show;

	   show %foo;
	   show @bar;
	   show (
	       @bar,
	       $baz,
	   );
	   show $baz;
	   show $ref;
	   show @bar[do{1..2;}];
	   show 2*3;
	   show 'a+b';
	   show 100 * sqrt length $baz;
	   show $foo{q[;{{{]};

DESCRIPTION
       This module provides a simple wrapper around the Data::Dump module.

       A call to "show" data-dumps its arguments, prefaced by a divider line that reports the arguments and the file and line from which "show()"
       was called.

       For example, the code in the SYNOPSIS would produce something like:

	   ======(  %foo  )========================[ 'demo.pl', line 11 ]======

	       { foo => 1, food => 'b', foon => [3, 4, 5, 6, 7, 8, 9, 10] }

	   ======(  @bar  )========================[ 'demo.pl', line 12 ]======

	       ["b", "a", "r"]

	   ======(  @bar, $baz,  )=================[ 'demo.pl', line 13 ]======

	       ("b", "a", "r", "baz")

	   ======(  $baz  )========================[ 'demo.pl', line 17 ]======

	       "baz"

	   ======(  $ref  )========================[ 'demo.pl', line 18 ]======

	       ["b", "a", "r"]

	   ======(  @bar[do{1..2;}]  )=============[ 'demo.pl', line 19 ]======

	       ("a", "r")

	   ======(  2*3  )=========================[ 'demo.pl', line 20 ]======

	       6

	   ======(  'a+b'  )=======================[ 'demo.pl', line 21 ]======

	       "a+b"

	   ======(  100 * sqrt length $baz  )======[ 'demo.pl', line 22 ]======

	       "173.205080756888"

	   ======(  $foo{q[;{{{]}  )===============[ 'demo.pl', line 23 ]======

	       undef

	   ======(  'foo' ~~ m/;{/{/  )===========[ 'demo.pl', line 25 ]======

	       ""

INTERFACE
       "show()"
	   This is the only subroutine provided by the module.	It is always exported.

	   "show()" can be called with any number of arguments and data-dumps them all with a suitable header indicating the arguments' names, and
	   the file and line from which "show()" was called.

	   "show()" does not return a useful value.

DIAGNOSTICS
       None, apart from those provided by Data::Dump;

CONFIGURATION AND ENVIRONMENT
       Data::Show requires no configuration files or environment variables.

DEPENDENCIES
       Only works under Perl 5.10 and later.

       Requires the Data::Dump module.

INCOMPATIBILITIES
       None reported.

BUGS AND LIMITATIONS
       Uses sophisticated regexes to parse out the argument list from the source. Hence subject to the usual limitations of this technique
       (namely, that it may get the argument list wrong occasionally).

       No bugs have been reported.

       Please report any bugs or feature requests to "bug-data-show@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

AUTHOR
       Damian Conway  "<DCONWAY@CPAN.org>"

LICENCE AND COPYRIGHT
       Copyright (c) 2010, Damian Conway "<DCONWAY@CPAN.org>". All rights reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
       THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF
       ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

perl v5.14.2							    2012-01-20							   Data::Show(3pm)