--- /dev/null
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
+.\"
+.\" 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
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "YAML::Syck 3"
+.TH YAML::Syck 3 "2010-05-23" "perl v5.8.8" "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"
+YAML::Syck \- Fast, lightweight YAML loader and dumper
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use YAML::Syck;
+\&
+\& # Set this for interoperability with other YAML/Syck bindings:
+\& # e.g. Load(\*(AqYes\*(Aq) becomes 1 and Load(\*(AqNo\*(Aq) becomes \*(Aq\*(Aq.
+\& $YAML::Syck::ImplicitTyping = 1;
+\&
+\& $data = Load($yaml);
+\& $yaml = Dump($data);
+\&
+\& # $file can be an IO object, or a filename
+\& $data = LoadFile($file);
+\& DumpFile($file, $data);
+\&
+\& # A string with multiple YAML streams in it
+\& $yaml = Dump(@data);
+\& @data = Load($yaml);
+.Ve
+.SH "WARNING"
+.IX Header "WARNING"
+This module has <a lot of known
+issues>
+and hasn't been actively maintained since 2007. If you encounter an
+issue with it probably won't be fixed unless you <offer up a
+patch> in Git that's ready for
+release.
+.PP
+Consider using \s-1YAML::XS\s0 instead, or not using \s-1YAML\s0 at all. \s-1YAML\s0 is
+falling out of style in the Perl community in favor of simpler formats
+like \s-1JSON\s0, which don't suffer from the bugs and annoying
+incompatibilities that plague the ambitious \s-1YAML\s0 format.
+.PP
+There are still some good reasons to use this module, such as better
+interoperability with other syck wrappers (like Ruby's), or some edge
+case of \s-1YAML\s0's syntax that it handles better. Maybe it'll work
+perfectly for you, but if it doesn't you may be in for some pain.
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This module provides a Perl interface to the \fBlibsyck\fR data serialization
+library. It exports the \f(CW\*(C`Dump\*(C'\fR and \f(CW\*(C`Load\*(C'\fR functions for converting
+Perl data structures to \s-1YAML\s0 strings, and the other way around.
+.PP
+\&\fB\s-1NOTE\s0\fR: If you are working with other language's YAML/Syck bindings
+(such as Ruby), please set \f(CW$YAML::Syck::ImplicitTyping\fR to \f(CW1\fR before
+calling the \f(CW\*(C`Load\*(C'\fR/\f(CW\*(C`Dump\*(C'\fR functions. The default setting is for
+preserving backward-compatibility with \f(CW\*(C`YAML.pm\*(C'\fR.
+.SH "FLAGS"
+.IX Header "FLAGS"
+.ie n .SS "$YAML::Syck::Headless"
+.el .SS "\f(CW$YAML::Syck::Headless\fP"
+.IX Subsection "$YAML::Syck::Headless"
+Defaults to false. Setting this to a true value will make \f(CW\*(C`Dump\*(C'\fR omit the
+leading \f(CW\*(C`\-\-\-\en\*(C'\fR marker.
+.ie n .SS "$YAML::Syck::SortKeys"
+.el .SS "\f(CW$YAML::Syck::SortKeys\fP"
+.IX Subsection "$YAML::Syck::SortKeys"
+Defaults to false. Setting this to a true value will make \f(CW\*(C`Dump\*(C'\fR sort
+hash keys.
+.ie n .SS "$YAML::Syck::SingleQuote"
+.el .SS "\f(CW$YAML::Syck::SingleQuote\fP"
+.IX Subsection "$YAML::Syck::SingleQuote"
+Defaults to false. Setting this to a true value will make \f(CW\*(C`Dump\*(C'\fR always emit
+single quotes instead of bare strings.
+.ie n .SS "$YAML::Syck::ImplicitTyping"
+.el .SS "\f(CW$YAML::Syck::ImplicitTyping\fP"
+.IX Subsection "$YAML::Syck::ImplicitTyping"
+Defaults to false. Setting this to a true value will make \f(CW\*(C`Load\*(C'\fR recognize
+various implicit types in \s-1YAML\s0, such as unquoted \f(CW\*(C`true\*(C'\fR, \f(CW\*(C`false\*(C'\fR, as well as
+integers and floating-point numbers. Otherwise, only \f(CW\*(C`~\*(C'\fR is recognized to
+be \f(CW\*(C`undef\*(C'\fR.
+.ie n .SS "$YAML::Syck::ImplicitUnicode"
+.el .SS "\f(CW$YAML::Syck::ImplicitUnicode\fP"
+.IX Subsection "$YAML::Syck::ImplicitUnicode"
+Defaults to false. For Perl 5.8.0 or later, setting this to a true value will
+make \f(CW\*(C`Load\*(C'\fR set Unicode flag on for every string that contains valid \s-1UTF8\s0
+sequences, and make \f(CW\*(C`Dump\*(C'\fR return a unicode string.
+.PP
+Regardless of this flag, Unicode strings are dumped verbatim without escaping;
+byte strings with high-bit set will be dumped with backslash escaping.
+.PP
+However, because \s-1YAML\s0 does not distinguish between these two kinds of strings,
+so this flag will affect loading of both variants of strings.
+.ie n .SS "$YAML::Syck::ImplicitBinary"
+.el .SS "\f(CW$YAML::Syck::ImplicitBinary\fP"
+.IX Subsection "$YAML::Syck::ImplicitBinary"
+Defaults to false. For Perl 5.8.0 or later, setting this to a true value will
+make \f(CW\*(C`Dump\*(C'\fR generate Base64\-encoded \f(CW\*(C`!!binary\*(C'\fR data for all non-Unicode
+scalars containing high-bit bytes.
+.ie n .SS "$YAML::Syck::UseCode / $YAML::Syck::LoadCode / $YAML::Syck::DumpCode"
+.el .SS "\f(CW$YAML::Syck::UseCode\fP / \f(CW$YAML::Syck::LoadCode\fP / \f(CW$YAML::Syck::DumpCode\fP"
+.IX Subsection "$YAML::Syck::UseCode / $YAML::Syck::LoadCode / $YAML::Syck::DumpCode"
+These flags control whether or not to try and eval/deparse perl source code;
+each of them defaults to false.
+.PP
+Setting \f(CW$YAML::Syck::UseCode\fR to a true value is equivalent to setting
+both \f(CW$YAML::Syck::LoadCode\fR and \f(CW$YAML::Syck::DumpCode\fR to true.
+.SH "BUGS"
+.IX Header "BUGS"
+Dumping Glob/IO values does not work yet.
+.SH "CAVEATS"
+.IX Header "CAVEATS"
+This module implements the \s-1YAML\s0 1.0 spec. To deal with data in \s-1YAML\s0 1.1,
+please use the \f(CW\*(C`YAML::XS\*(C'\fR module instead.
+.PP
+The current implementation bundles libsyck source code; if your system has a
+site-wide shared libsyck, it will \fInot\fR be used.
+.PP
+Tag names such as \f(CW\*(C`!!perl/hash:Foo\*(C'\fR is blessed into the package \f(CW\*(C`Foo\*(C'\fR, but
+the \f(CW\*(C`!hs/foo\*(C'\fR and \f(CW\*(C`!!hs/Foo\*(C'\fR tags are blessed into \f(CW\*(C`hs::Foo\*(C'\fR. Note that
+this holds true even if the tag contains non-word characters; for example,
+\&\f(CW\*(C`!haskell.org/Foo\*(C'\fR is blessed into \f(CW\*(C`haskell.org::Foo\*(C'\fR. Please use
+Class::Rebless to cast it into other user-defined packages.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\s-1YAML\s0, JSON::Syck
+.PP
+<http://www.yaml.org/>
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+Audrey Tang <cpan@audreyt.org>
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright 2005\-2009 by Audrey Tang <cpan@audreyt.org>.
+.PP
+This software is released under the \s-1MIT\s0 license cited below.
+.PP
+The \fIlibsyck\fR code bundled with this library is released by
+\&\*(L"why the lucky stiff\*(R", under a BSD-style license. See the \fI\s-1COPYING\s0\fR
+file for details.
+.ie n .SS "The ""\s-1MIT\s0"" License"
+.el .SS "The ``\s-1MIT\s0'' License"
+.IX Subsection "The MIT License"
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the \*(L"Software\*(R"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+.PP
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+.PP
+\&\s-1THE\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R", \s-1WITHOUT\s0 \s-1WARRANTY\s0 \s-1OF\s0 \s-1ANY\s0 \s-1KIND\s0, \s-1EXPRESS\s0
+\&\s-1OR\s0 \s-1IMPLIED\s0, \s-1INCLUDING\s0 \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0 \s-1THE\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0,
+\&\s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0 \s-1AND\s0 \s-1NONINFRINGEMENT\s0. \s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1SHALL\s0
+\&\s-1THE\s0 \s-1AUTHORS\s0 \s-1OR\s0 \s-1COPYRIGHT\s0 \s-1HOLDERS\s0 \s-1BE\s0 \s-1LIABLE\s0 \s-1FOR\s0 \s-1ANY\s0 \s-1CLAIM\s0, \s-1DAMAGES\s0 \s-1OR\s0 \s-1OTHER\s0
+\&\s-1LIABILITY\s0, \s-1WHETHER\s0 \s-1IN\s0 \s-1AN\s0 \s-1ACTION\s0 \s-1OF\s0 \s-1CONTRACT\s0, \s-1TORT\s0 \s-1OR\s0 \s-1OTHERWISE\s0, \s-1ARISING\s0
+\&\s-1FROM\s0, \s-1OUT\s0 \s-1OF\s0 \s-1OR\s0 \s-1IN\s0 \s-1CONNECTION\s0 \s-1WITH\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1OR\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0 \s-1OTHER\s0
+\&\s-1DEALINGS\s0 \s-1IN\s0 \s-1THE\s0 \s-1SOFTWARE\s0.
projects / catagits/Gitalist.git / blobdiff