.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Data::Printer::Config 3pm" .TH Data::Printer::Config 3pm "2021-02-28" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Data::Printer::Config \- Load run\-control (.dataprinter) files for Data::Printer .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is used internally to load \f(CW\*(C`.dataprinter\*(C'\fR files. .SH "THE RC FILE" .IX Header "THE RC FILE" .Vb 12 \& # line comments are ok with "#" or ";" \& ; this is also a full line comment. \& ; Comments at the end of a line (inline) are not allowed \& multiline = 0 \& hash_max = 5 \& array_max = 5 \& string_max = 50 \& # use quotes if you need spaces to be significant: \& hash_separator = " => " \& class.show_methods = none \& class.internals = 0 \& filters = DB, Web \& \& # if you tag a class, those settings will override your basic ones \& # whenever you call p() inside that class. \& [MyApp::Some::Class] \& multiline = 1 \& show_tainted: 1 \& class.format_inheritance = lines \& filters = MyAwesomeDebugFilter \& \& [Other::Class] \& theme = Monokai \& \& ; use "begin filter NAME" and "end filter" to add custom filter code. \& ; it will expose $obj (the data structure to be parsed) and $ddp \& ; (data printer\*(Aqs object). YOU MAY ONLY DO THIS IF YOUR FILE IS ONLY \& ; READABLE AND WRITEABLE BY THE USER (i.e. chmod 0600). \& begin filter HTTP::Request \& return $ddp\->maybe_colorize($obj\->method . \*(Aq \*(Aq . $obj\->uri, \*(Aqstring\*(Aq) \& . $obj\->decoded_content; \& end filter .Ve .SH "PUBLIC INTERFACE" .IX Header "PUBLIC INTERFACE" This module is not meant for public use. However, because Data::Printer changed the format of the configuration file, we provide the following public function for people to use: .ie n .SS "convert( $filename )" .el .SS "convert( \f(CW$filename\fP )" .IX Subsection "convert( $filename )" .Vb 1 \& perl \-MDDP \-E \*(Aqsay Data::Printer::Config::convert( q(/path/to/my/.dataprinter) )\*(Aq .Ve .PP Loads a deprecated (pre\-1.0) configuration file and returns a string with a (hopefully) converted version, which you can use for newer (post\-1.0) versions. .PP Other public functions, not really meant for general consumption, are: .IP "\(bu" 4 \&\f(CW\*(C`load_rc_file( $filename )\*(C'\fR \- loads a configuration file and returns the associated data structure. If no filename is provided, looks for \f(CW\*(C`.dataprinter\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" Data::Printer