local-lib5/man/man3/Parse::CPAN::Meta.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Parse::CPAN::Meta 3"
 132 .TH Parse::CPAN::Meta 3 "2009-07-27" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Parse::CPAN::Meta \- Parse META.yml and other similar CPAN metadata files\r
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&    #############################################\r
 139 \&    # In your file
 140 .Ve
 141 .PP
 142 .Vb 7
 143 \&    \-\-\-\r
 144 \&    rootproperty: blah\r
 145 \&    section:\r
 146 \&      one: two\r
 147 \&      three: four\r
 148 \&      Foo: Bar\r
 149 \&      empty: ~
 150 .Ve
 151 .PP
 152 .Vb 2
 153 \&    #############################################\r
 154 \&    # In your program
 155 .Ve
 156 .PP
 157 .Vb 1
 158 \&    use Parse::CPAN::Meta;
 159 .Ve
 160 .PP
 161 .Vb 2
 162 \&    # Create a YAML file\r
 163 \&    my @yaml = Parse::CPAN::Meta::LoadFile( 'Meta.yml' );
 164 .Ve
 165 .PP
 166 .Vb 4
 167 \&    # Reading properties\r
 168 \&    my $root = $yaml[0]\->{rootproperty};\r
 169 \&    my $one  = $yaml[0]\->{section}\->{one};\r
 170 \&    my $Foo  = $yaml[0]\->{section}\->{Foo};
 171 .Ve
 172 .SH "DESCRIPTION"
 173 .IX Header "DESCRIPTION"
 174 \&\fBParse::CPAN::Meta\fR is a parser for \fI\s-1META\s0.yml\fR files, based on the\r
 175 parser half of YAML::Tiny.\r
 176 .PP
 177 It supports a basic subset of the full \s-1YAML\s0 specification, enough to\r
 178 implement parsing of typical \fI\s-1META\s0.yml\fR files, and other similarly simple\r
 179 \&\s-1YAML\s0 files.\r
 180 .PP
 181 If you need something with more power, move up to a full \s-1YAML\s0 parser such\r
 182 as \s-1YAML\s0, YAML::Syck or YAML::LibYAML.\r
 183 .PP
 184 \&\fBParse::CPAN::Meta\fR provides a very simply \s-1API\s0 of only two functions,\r
 185 based on the \s-1YAML\s0 functions of the same name. Wherever possible,\r
 186 identical calling semantics are used.\r
 187 .PP
 188 All error reporting is done with exceptions (die'ing).\r
 189 .SH "FUNCTIONS"
 190 .IX Header "FUNCTIONS"
 191 For maintenance clarity, no functions are exported.\r
 192 .Sh "Load"
 193 .IX Subsection "Load"
 194 .Vb 1
 195 \&  my @yaml = Load( $string );
 196 .Ve
 197 .PP
 198 Parses a string containing a valid \s-1YAML\s0 stream into a list of Perl data\r
 199 structures.\r
 200 .Sh "LoadFile"
 201 .IX Subsection "LoadFile"
 202 .Vb 1
 203 \&  my @yaml = LoadFile( 'META.yml' );
 204 .Ve
 205 .PP
 206 Reads the \s-1YAML\s0 stream from a file instead of a string.\r
 207 .SH "SUPPORT"
 208 .IX Header "SUPPORT"
 209 Bugs should be reported via the \s-1CPAN\s0 bug tracker at\r
 210 .PP
 211 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse\-CPAN\-Meta>\r
 212 .SH "AUTHOR"
 213 .IX Header "AUTHOR"
 214 Adam Kennedy <adamk@cpan.org>\r
 215 .SH "SEE ALSO"
 216 .IX Header "SEE ALSO"
 217 \&\s-1YAML\s0, YAML::Syck, Config::Tiny, CSS::Tiny,\r
 218 <http://use.perl.org/~Alias/journal/29427>, <http://ali.as/>\r
 219 .SH "COPYRIGHT"
 220 .IX Header "COPYRIGHT"
 221 Copyright 2006 \- 2009 Adam Kennedy.\r
 222 .PP
 223 This program is free software; you can redistribute\r
 224 it and/or modify it under the same terms as Perl itself.\r
 225 .PP
 226 The full text of the license can be found in the\r
 227 \&\s-1LICENSE\s0 file included with this module.\r