1XXX(3)                User Contributed Perl Documentation               XXX(3)
2
3
4

NAME

6       XXX - See Your Data in the Nude
7

SYNOPSIS

9           use XXX;
10           XXX my $dog = Dog->new({has => ['fleas', 'style']});
11           my $dog = XXX Dog->new({has => ['fleas', 'style']});
12           my $dog = Dog->new(XXX {has => ['fleas', 'style']});
13           my $dog = Dog->new({XXX has => ['fleas', 'style']});
14           my $dog = Dog->new({has => XXX ['fleas', 'style']});
15           my $dog = Dog->new({has => [XXX 'fleas', 'style']});
16

DESCRIPTION

18       XXX.pm exports a function called XXX that you can put just about
19       anywhere
20           in your Perl code to make it die with a YAML dump of the arguments
21       to
22           its right.
23
24       The charm of XXX-debugging is that it is easy to type, rarely requires
25       parens and stands out visually so that you remember to remove it.
26
27       XXX.pm also exports WWW, YYY and ZZZ which do similar debugging things.
28

FUNCTIONS

30       WWW WWW will warn a dump of its arguments, and then return the original
31           arguments.  This means you can stick it in the middle of
32           expressions.
33
34           NOTE: If you use WWW with Test::More, it will "diag()" rather than
35           "warn()".
36
37           mnemonic: W for warn
38
39       XXX XXX will die with a dump of its arguments.
40
41           mnemonic: XXX == Death, Nudity
42
43       YYY YYY will print a dump of its arguments, and then return the
44           original arguments. This means you can stick it in the middle of
45           expressions.
46
47           NOTE: If you use YYY with Test::More, it will "note()" rather than
48                 "print()".
49
50           mnemonic: YYY == Why Why Why??? or YAML YAML YAML
51
52       ZZZ ZZZ will Carp::confess a dump of its arguments.
53
54           mnemonic: You should confess all your sins before you sleep.
55           zzzzzzzz
56

CONFIGURATION

58       By default, XXX uses YAML.pm to dump your data. You can change this
59       like so:
60
61           use XXX -with => 'Data::Dumper';
62           use XXX -with => 'Data::Dump';
63           use XXX -with => 'Data::Dump::Color';
64           use XXX -with => 'YAML::XS';
65           use XXX -with => 'YAML::SomeOtherYamlModule';
66           use XXX -with => 'JSON::Color';
67           use XXX -with => 'JSON::SomeOtherJsonModule';
68
69       You can also use the environment variable "PERL_XXX_DUMPER" to set the
70       module, for example;
71
72           PERL_XXX_DUMPER=JSON::Color perl script.pl
73           PERL_XXX_DUMPER=YAML::PP::Highlight perl script.pl
74
75       Only modules with names beginning with 'YAML' or 'JSON', and the
76       Data::Dumper, Data::Dump, and Data::Dump::Color modules are supported.
77
78       If you need to load XXX with "require", you can set the dumper module
79       with the $XXX::DumpModule global variable.
80
81           require XXX;
82           $XXX::DumpModule = 'YAML::Syck';
83
84           XXX::XXX($variable);
85

STACK TRACE LEVEL

87       If you call a debugging function that calls XXX for you, XXX will print
88       the wrong file and line number. To force XXX to skip a package in the
89       call stack, just define the "XXX_skip" constant like this:
90
91           package MyDebugger;
92           use constant XXX_skip => 1;
93           sub debug {
94               require XXX;
95               XXX::XXX(@_);
96           }
97
98       Now calls to MyDebugger::debug will print the file name you called it
99       from, not from MyDebugger itself.
100

AUTHOR

102       Ingy döt Net <ingy@cpan.org>
103

105       Copyright 2006-2014. Ingy döt Net.
106
107       This program is free software; you can redistribute it and/or modify it
108       under the same terms as Perl itself.
109
110       See <http://www.perl.com/perl/misc/Artistic.html>
111
112
113
114perl v5.30.0                      2019-07-26                            XXX(3)
Impressum