.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" 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 "Zoidberg::Utils::Output 3" .TH Zoidberg::Utils::Output 3 "2008-01-12" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Zoidberg::Utils::Output \- Zoidberg output routines .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Zoidberg::Utils qw/:output/; .Ve .PP .Vb 3 \& # use this instead of perlfunc print \& output "get some string outputted"; \& output { string => 'or some data struct dumped' }; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides some routines used by various Zoidberg modules to output data. .PP Although when working within the Zoidberg framework this module should be used through the Zoidberg::Utils interface, it also can be used on it's own. .SH "EXPORT" .IX Header "EXPORT" By default all of the below except \f(CW\*(C`typed_output\*(C'\fR. .SH "METHODS" .IX Header "METHODS" .ie n .IP """output(@_)""" 4 .el .IP "\f(CWoutput(@_)\fR" 4 .IX Item "output(@_)" Output a list of possibly mixed data structs as nice as possible. .Sp A reference to an array of plain scalars may be outputted as a multicolumn list, more complex data will be dumped using Data::Dumper. .ie n .IP """message(@_)""" 4 .el .IP "\f(CWmessage(@_)\fR" 4 .IX Item "message(@_)" Like \f(CW\*(C`output()\*(C'\fR but tags data as a message, in non-interactive mode these may not be printed at all. .ie n .IP """debug(@_)""" 4 .el .IP "\f(CWdebug(@_)\fR" 4 .IX Item "debug(@_)" Like \f(CW\*(C`output()\*(C'\fR tags the data as debug output, will only be printed when in debug mode. Debug ouput will be printed to \s-1STDERR\s0 if printed at all. .ie n .IP """complain(@_)""" 4 .el .IP "\f(CWcomplain(@_)\fR" 4 .IX Item "complain(@_)" Like \f(CW\*(C`output\*(C'\fR but intended for error messages, data will be printed to \s-1STDERR\s0. Has some glue for error objects created by Zoidberg::Utils::Error. Prints \f(CW$@\fR when no argument is given. .ie n .IP """typed_output($type, @_)""" 4 .el .IP "\f(CWtyped_output($type, @_)\fR" 4 .IX Item "typed_output($type, @_)" Method that can be used to define output types that don't fit in the above group. \&\f(CW$type\fR must be a plain string that is used as output 'tag'. .ie n .IP """output_is_captured($type, @_)""" 4 .el .IP "\f(CWoutput_is_captured($type, @_)\fR" 4 .IX Item "output_is_captured($type, @_)" Method that returns a boolean that tells whether output is captured or not. This can be used to make terminal output different from data struct output. .SH "AUTHOR" .IX Header "AUTHOR" Jaap Karssenberg || Pardus [Larus] .PP Copyright (c) 2003 Jaap G Karssenberg. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" Zoidberg, Zoidberg::Utils