CPAN::Meta::YAML(3p) Perl Programmers Reference Guide CPAN::Meta::YAML(3p) #

CPAN::Meta::YAML(3p) Perl Programmers Reference Guide CPAN::Meta::YAML(3p)

NNAAMMEE #

 CPAN::Meta::YAML - Read and write a subset of YAML for CPAN Meta files

VVEERRSSIIOONN #

 version 0.018

SSYYNNOOPPSSIISS #

     use CPAN::Meta::YAML;

     # reading a META file
     open $fh, "<:utf8", "META.yml";
     $yaml_text = do { local $/; <$fh> };
     $yaml = CPAN::Meta::YAML->read_string($yaml_text)
       or die CPAN::Meta::YAML->errstr;

     # finding the metadata
     $meta = $yaml->[0];

     # writing a META file
     $yaml_text = $yaml->write_string
       or die CPAN::Meta::YAML->errstr;
     open $fh, ">:utf8", "META.yml";
     print $fh $yaml_text;

DDEESSCCRRIIPPTTIIOONN #

 This module implements a subset of the YAML specification for use in
 reading and writing CPAN metadata files like _M_E_T_A_._y_m_l and _M_Y_M_E_T_A_._y_m_l.  It
 should not be used for any other general YAML parsing or generation task.

 NOTE: _M_E_T_A_._y_m_l (and _M_Y_M_E_T_A_._y_m_l) files should be UTF-8 encoded.  Users are
 responsible for proper encoding and decoding.  In particular, the "read"
 and "write" methods do nnoott support UTF-8 and should not be used.

SSUUPPPPOORRTT #

 This module is currently derived from YAML::Tiny by Adam Kennedy.  If
 there are bugs in how it parses a particular META.yml file, please file a
 bug report in the YAML::Tiny bugtracker:
 <https://github.com/Perl-Toolchain-Gang/YAML-Tiny/issues>

SSEEEE AALLSSOO #

 YAML::Tiny, YAML, YAML::XS

AAUUTTHHOORRSS #

 •   Adam Kennedy <adamk@cpan.org>

 •   David Golden <dagolden@cpan.org>

CCOOPPYYRRIIGGHHTT AANNDD LLIICCEENNSSEE #

 This software is copyright (c) 2010 by Adam Kennedy.

 This is free software; you can redistribute it and/or modify it under the
 same terms as the Perl 5 programming language system itself.

perl v5.36.3 2017-02-05 CPAN::Meta::YAML(3p)