.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "inc::CPAN::Meta::YAML 3"
.TH inc::CPAN::Meta::YAML 3 "2017-07-10" "perl v5.10.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"
CPAN::Meta::YAML \- Read and write a subset of YAML for CPAN Meta files
.SH "VERSION"
.IX Header "VERSION"
version 0.011
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& 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;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a subset of the \s-1YAML\s0 specification for use in reading
and writing \s-1CPAN\s0 metadata files like \fI\s-1META\s0.yml\fR and \fI\s-1MYMETA\s0.yml\fR. It should
not be used for any other general \s-1YAML\s0 parsing or generation task.
.PP
\&\s-1NOTE:\s0 \fI\s-1META\s0.yml\fR (and \fI\s-1MYMETA\s0.yml\fR) files should be \s-1UTF\-8\s0 encoded. Users are
responsible for proper encoding and decoding. In particular, the \f(CW\*(C`read\*(C'\fR and
\&\f(CW\*(C`write\*(C'\fR methods do \fBnot\fR support \s-1UTF\-8\s0 and should not be used.
.SH "SUPPORT"
.IX Header "SUPPORT"
This module is currently derived from YAML::Tiny by Adam Kennedy. If
there are bugs in how it parses a particular \s-1META\s0.yml file, please file
a bug report in the YAML::Tiny bugtracker:
<https://rt.cpan.org/Public/Dist/Display.html?Name=YAML\-Tiny>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
YAML::Tiny, \s-1YAML\s0, \s-1YAML::XS\s0
.SH "SUPPORT"
.IX Header "SUPPORT"
.SS "Bugs / Feature Requests"
.IX Subsection "Bugs / Feature Requests"
Please report any bugs or feature requests through the issue tracker
at <https://github.com/dagolden/CPAN\-Meta\-YAML/issues>.
You will be notified automatically of any progress on your issue.
.SS "Source Code"
.IX Subsection "Source Code"
This is open source software. The code repository is available for
public review and contribution under the terms of the license.
.PP
<https://github.com/dagolden/CPAN\-Meta\-YAML>
.PP
.Vb 1
\& git clone https://github.com/dagolden/CPAN\-Meta\-YAML.git
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Adam Kennedy <adamk@cpan.org>
.IP "\(bu" 4
David Golden <dagolden@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by Adam Kennedy.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Copyright 2K16 - 2K18 Indonesian Hacker Rulez