--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. | will give a
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "Data::Dump 3"
+.TH Data::Dump 3 "2009-07-26" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+Data::Dump \- Pretty printing of data structures
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use Data::Dump qw(dump ddx);
+.Ve
+.PP
+.Vb 2
+\& $str = dump(@list);
+\& @copy_of_list = eval $str;
+.Ve
+.PP
+.Vb 2
+\& # or use it for easy debug printout
+\& ddx localtime;
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This module provide functions that takes a list of values as their
+argument and produces a string as its result. The string contains
+Perl code that, when \f(CW\*(C`eval\*(C'\fRed, produces a deep copy of the original
+arguments.
+.PP
+The main feature of the module is that it strives to produce output
+that is easy to read. Example:
+.PP
+.Vb 2
+\& @a = (1, [2, 3], {4 => 5});
+\& dump(@a);
+.Ve
+.PP
+Produces:
+.PP
+.Vb 1
+\& (1, [2, 3], { 4 => 5 })
+.Ve
+.PP
+If you dump just a little data, it is output on a single line. If
+you dump data that is more complex or there is a lot of it, line breaks
+are automatically added to keep it easy to read.
+.PP
+The following functions are provided (only the dd* functions are exported by default):
+.IP "dump( ... )" 4
+.IX Item "dump( ... )"
+.PD 0
+.IP "pp( ... )" 4
+.IX Item "pp( ... )"
+.PD
+Returns a string containing a Perl expression. If you pass this
+string to Perl's built-in \fIeval()\fR function it should return a copy of
+the arguments you passed to \fIdump()\fR.
+.Sp
+If you call the function with multiple arguments then the output will
+be wrapped in parenthesis \*(L"( ..., ... )\*(R". If you call the function with a
+single argument the output will not have the wrapping. If you call the function with
+a single scalar (non\-reference) argument it will just return the
+scalar quoted if needed, but never break it into multiple lines. If you
+pass multiple arguments or references to arrays of hashes then the
+return value might contain line breaks to format it for easier
+reading. The returned string will never be \*(L"\en\*(R" terminated, even if
+contains multiple lines. This allows code like this to place the
+semicolon in the expected place:
+.Sp
+.Vb 1
+\& print '$obj = ', dump($obj), ";\en";
+.Ve
+.Sp
+If \fIdump()\fR is called in void context, then the dump is printed on
+\&\s-1STDERR\s0 and then \*(L"\en\*(R" terminated. You might find this useful for quick
+debug printouts, but the dd*() functions might be better alternatives
+for this.
+.Sp
+There is no difference between \fIdump()\fR and \fIpp()\fR, except that \fIdump()\fR
+shares its name with a not-so-useful perl builtin. Because of this
+some might want to avoid using that name.
+.ie n .IP "quote( $string )" 4
+.el .IP "quote( \f(CW$string\fR )" 4
+.IX Item "quote( $string )"
+Returns a quoted version of the provided string.
+.Sp
+It differs from \f(CW\*(C`dump($string)\*(C'\fR in that it will quote even numbers and
+not try to come up with clever expressions that might shorten the
+output.
+.IP "dd( ... )" 4
+.IX Item "dd( ... )"
+.PD 0
+.IP "ddx( ... )" 4
+.IX Item "ddx( ... )"
+.PD
+These functions will call \fIdump()\fR on their argument and print the
+result to \s-1STDOUT\s0 (actually, it's the currently selected output handle, but
+\&\s-1STDOUT\s0 is the default for that).
+.Sp
+The difference between them is only that \fIddx()\fR will prefix the lines
+it prints with \*(L"# \*(R" and mark the first line with the file and line
+number where it was called. This is meant to be useful for debug
+printouts of state within programs.
+.SH "LIMITATIONS"
+.IX Header "LIMITATIONS"
+Code references will be displayed as simply 'sub { \*(L"???\*(R" }' when
+dumped. Thus, \f(CW\*(C`eval\*(C'\fRing them will not reproduce the original routine.
+.PP
+If you forget to explicitly import the \f(CW\*(C`dump\*(C'\fR function, your code will
+core dump. That's because you just called the builtin \f(CW\*(C`dump\*(C'\fR function
+by accident, which intentionally dumps core. Because of this you can
+also import the same function as \f(CW\*(C`pp\*(C'\fR, mnemonic for \*(L"pretty\-print\*(R".
+.SH "HISTORY"
+.IX Header "HISTORY"
+The \f(CW\*(C`Data::Dump\*(C'\fR module grew out of frustration with Sarathy's
+in-most-cases-excellent \f(CW\*(C`Data::Dumper\*(C'\fR. Basic ideas and some code
+are shared with Sarathy's module.
+.PP
+The \f(CW\*(C`Data::Dump\*(C'\fR module provides a much simpler interface than
+\&\f(CW\*(C`Data::Dumper\*(C'\fR. No \s-1OO\s0 interface is available and there are no
+configuration options to worry about (yet :\-). The other benefit is
+that the dump produced does not try to set any variables. It only
+returns what is needed to produce a copy of the arguments. This means
+that \f(CW\*(C`dump("foo")\*(C'\fR simply returns \f(CW"foo"\fR, and \f(CW\*(C`dump(1..5)\*(C'\fR simply
+returns \f(CW\*(C`(1, 2, 3, 4, 5)\*(C'\fR.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+Data::Dumper, Storable
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+The \f(CW\*(C`Data::Dump\*(C'\fR module is written by Gisle Aas <gisle@aas.no>, based
+on \f(CW\*(C`Data::Dumper\*(C'\fR by Gurusamy Sarathy <gsar@umich.edu>.
+.PP
+.Vb 2
+\& Copyright 1998\-2000,2003\-2004,2008 Gisle Aas.
+\& Copyright 1996\-1998 Gurusamy Sarathy.
+.Ve
+.PP
+This library is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
projects / catagits/Gitalist.git / blobdiff