.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Parse::PlainConfig::Settings 3pm" .TH Parse::PlainConfig::Settings 3pm "2016-10-16" "perl v5.24.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" Parse::PlainConfig::Settings \- Settings Class .SH "VERSION" .IX Header "VERSION" \&\f(CW$Id:\fR lib/Parse/PlainConfig/Settings.pm, 3.03 2016/08/09 16:11:12 acorliss Exp $ .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Parse::PlainConfig::Settings; \& \& my $settings = new Parse::PlainConfig::Settings; \& \& $ts = $settings\->tabStop; \& $subindent = $settings\->subindentation; \& $comment = $settings\->comment; \& $delim = $settings\->delimiter; \& $ldelim = $settings\->listDelimiter; \& $hdelim = $settings\->hashDelimiter; \& $hdoc = $settings\->hereDoc; \& %propTypes = $settings\->propertyTypes; \& %propRegex = $settings\->propertyRegexes; \& %prototypes = $settings\->prototypes; \& %protoRegex = $settings\->prototypeRegexes; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The settings object is created and initialized automatically by Parse::PlainConfig. .SH "SUBROUTINES/METHODS" .IX Header "SUBROUTINES/METHODS" .SS "tabStop" .IX Subsection "tabStop" .Vb 1 \& $ts = $settings\->tabStop; .Ve .PP Default column width for tab stops. .SS "subindentation" .IX Subsection "subindentation" .Vb 1 \& $subindent = $settings\->subindentation; .Ve .PP Default columns for indentation on line continuations. .SS "comment" .IX Subsection "comment" .Vb 1 \& $comment = $settings\->comment; .Ve .PP Default character sequence for comments. .SS "delimiter" .IX Subsection "delimiter" .Vb 1 \& $delim = $settings\->delimiter; .Ve .PP Default character sequence used as the delimiter between the parameter name and the parameter value. .SS "listDelimiter" .IX Subsection "listDelimiter" .Vb 1 \& $ldelim = $settings\->listDelimiter; .Ve .PP Default character sequence used as the delimiter between array elements. .SS "hashDelimiter" .IX Subsection "hashDelimiter" .Vb 1 \& $hdelim = $settings\->hashDelimiter; .Ve .PP Default character sequence used as the delimiter between key/value pairs. .SS "hereDoc" .IX Subsection "hereDoc" .Vb 1 \& $hdoc = $settings\->hereDoc; .Ve .PP Default character sequence used as the token marking the end of here docs. .SS "propertyTypes" .IX Subsection "propertyTypes" .Vb 1 \& %propTypes = $settings\->propertyTypes; .Ve .PP Hash of property names => data types. .SS "propertyRegexes" .IX Subsection "propertyRegexes" .Vb 1 \& %propRegex = $settings\->propertyRegexes; .Ve .PP Hash of property names to regular expression to extract data from the line. .SS "prototypes" .IX Subsection "prototypes" .Vb 1 \& %prototypes = $settings\->prototypes; .Ve .PP Hash of prototype names => data types. .SS "prototypeRegexes" .IX Subsection "prototypeRegexes" .Vb 1 \& %protoRegex = $settings\->prototypeRegexes; .Ve .PP Hash of prototype names to regular expression to extract data from the line. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" .IP "o" 4 .IX Item "o" Class::EHierarchy .IP "o" 4 .IX Item "o" Paranoid .IP "o" 4 .IX Item "o" Paranoid::Debug .IP "o" 4 .IX Item "o" Parse::PlainConfig::Constants .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" .SH "AUTHOR" .IX Header "AUTHOR" Arthur Corliss (corliss@digitalmages.com) .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This software is licensed under the same terms as Perl, itself. Please see http://dev.perl.org/licenses/ for more information. .PP (c) 2015, Arthur Corliss (corliss@digitalmages.com)