.\" 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::YAML 3pm" .TH Data::YAML 3pm "2021-01-06" "perl v5.32.0" "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::YAML \- Easy YAML serialisation of Perl data structures .SH "VERSION" .IX Header "VERSION" This document describes Data::YAML version 0.0.7 .SH "DESCRIPTION" .IX Header "DESCRIPTION" In the spirit of YAML::Tiny, Data::YAML::Reader and Data::YAML::Writer provide lightweight, dependency-free \s-1YAML\s0 handling. While \f(CW\*(C`YAML::Tiny\*(C'\fR is designed principally for working with configuration files \f(CW\*(C`Data::YAML\*(C'\fR concentrates on the transparent round\- tripping of \s-1YAML\s0 serialized Perl data structures. .PP As an example of why this distinction matters consider that \&\f(CW\*(C`YAML::Tiny\*(C'\fR doesn't handle hashes with keys containing non-printable characters. This is fine for configuration files but likely to cause problems when handling arbitrary Perl data structures. \f(CW\*(C`Data::YAML\*(C'\fR handles exotic hash keys correctly. .PP The syntax accepted by \f(CW\*(C`Data::YAML\*(C'\fR is a subset of \s-1YAML.\s0 Specifically it is the same subset of \s-1YAML\s0 that Data::YAML::Writer produces. See Data::YAML for more information. .SS "\s-1YAML\s0 syntax" .IX Subsection "YAML syntax" Although \s-1YAML\s0 appears to be a simple language the entire \s-1YAML\s0 specification is huge. \f(CW\*(C`Data::YAML\*(C'\fR implements a small subset of the complete syntax trading completeness for compactness and simplicity. This restricted syntax is known (to me at least) as 'YAMLish'. .PP These examples demonstrates the full range of supported syntax. .PP All \s-1YAML\s0 documents must begin with '\-\-\-' and end with a line containing '...'. .PP .Vb 2 \& \-\-\- Simple scalar \& ... .Ve .PP Unprintable characters are represented using standard escapes in double quoted strings. .PP .Vb 2 \& \-\-\- "\et\ex01\ex02\en" \& ... .Ve .PP Array and hashes are represented thusly .PP .Vb 6 \& \-\-\- \& \- "This" \& \- "is" \& \- "an" \& \- "array" \& ... \& \& \-\-\- \& This: is \& a: hash \& ... .Ve .PP Structures may nest arbitrarily .PP .Vb 8 \& \-\-\- \& \- \& name: \*(AqHash one\*(Aq \& value: 1 \& \- \& name: \*(AqHash two\*(Aq \& value: 2 \& ... .Ve .PP Undef is a tilde .PP .Vb 2 \& \-\-\- ~ \& ... .Ve .SS "Uses" .IX Subsection "Uses" Use \f(CW\*(C`Data::YAML\*(C'\fR may be used any time you need to freeze and thaw Perl data structures into a human readable format. The output from \&\f(CW\*(C`Data::YAML::Writer\*(C'\fR should be readable by any \s-1YAML\s0 parser. .PP \&\f(CW\*(C`Data::YAML\*(C'\fR was originally written to allow machine-readable diagnostic information to be passed from test scripts to TAP::Harness. That means that if you're writing a testing system that needs to output \s-1TAP\s0 version 13 or later syntax you might find \&\f(CW\*(C`Data::YAML\*(C'\fR useful. .PP Read more about \s-1TAP\s0 and YAMLish here: .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`data\-yaml@rt.cpan.org\*(C'\fR, or through the web interface at . .SH "AUTHOR" .IX Header "AUTHOR" Andy Armstrong \f(CW\*(C`\*(C'\fR .SH "LICENCE AND COPYRIGHT" .IX Header "LICENCE AND COPYRIGHT" Copyright (c) 2007, Andy Armstrong \f(CW\*(C`\*(C'\fR. All rights reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0 .PP \&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0