--- /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 "JSON::Syck 3"
+.TH JSON::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"
+JSON::Syck \- JSON is YAML (but consider using \s-1JSON::XS\s0 instead!)
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use JSON::Syck; # no exports by default
+\&
+\& my $data = JSON::Syck::Load($json);
+\& my $json = JSON::Syck::Dump($data);
+\&
+\& # $file can be an IO object, or a filename
+\& my $data = JSON::Syck::LoadFile($file);
+\& JSON::Syck::DumpFile($file, $data);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+JSON::Syck is a syck implementation of \s-1JSON\s0 parsing and generation. Because
+\&\s-1JSON\s0 is \s-1YAML\s0 (<http://redhanded.hobix.com/inspect/yamlIsJson.html>), using
+syck gives you a fast and memory-efficient parser and dumper for \s-1JSON\s0 data
+representation.
+.PP
+However, a newer module \s-1JSON::XS\s0, has since emerged. It is more flexible,
+efficient and robust, so please consider using it instead of this module.
+.SH "DIFFERENCE WITH JSON"
+.IX Header "DIFFERENCE WITH JSON"
+You might want to know the difference between the \fI\s-1JSON\s0\fR module and
+this one.
+.PP
+Since \s-1JSON\s0 is a pure-perl module and JSON::Syck is based on libsyck,
+JSON::Syck is supposed to be very fast and memory efficient. See
+chansen's benchmark table at
+<http://idisk.mac.com/christian.hansen/Public/perl/serialize.pl>
+.PP
+\&\s-1JSON\s0.pm comes with dozens of ways to do the same thing and lots of
+options, while JSON::Syck doesn't. There's only \f(CW\*(C`Load\*(C'\fR and \f(CW\*(C`Dump\*(C'\fR.
+.PP
+Oh, and JSON::Syck doesn't use camelCase method names :\-)
+.SH "REFERENCES"
+.IX Header "REFERENCES"
+.SS "\s-1SCALAR\s0 \s-1REFERENCE\s0"
+.IX Subsection "SCALAR REFERENCE"
+For now, when you pass a scalar reference to JSON::Syck, it
+dereferences to get the actual scalar value.
+.PP
+JSON::Syck raises an exception when you pass in circular references.
+.PP
+If you want to serialize self refernecing stuff, you should use
+\&\s-1YAML\s0 which supports it.
+.SS "\s-1SUBROUTINE\s0 \s-1REFERENCE\s0"
+.IX Subsection "SUBROUTINE REFERENCE"
+When you pass subroutine reference, JSON::Syck dumps it as null.
+.SH "UTF\-8 FLAGS"
+.IX Header "UTF-8 FLAGS"
+By default this module doesn't touch any of utf\-8 flags set in
+strings, and assumes \s-1UTF\-8\s0 bytes to be passed and emit.
+.PP
+However, when you set \f(CW$JSON::Syck::ImplicitUnicode\fR to 1, this
+module properly decodes \s-1UTF\-8\s0 binaries and sets \s-1UTF\-8\s0 flag everywhere,
+as in:
+.PP
+.Vb 4
+\& JSON (UTF\-8 bytes) => Perl (UTF\-8 flagged)
+\& JSON (UTF\-8 flagged) => Perl (UTF\-8 flagged)
+\& Perl (UTF\-8 bytes) => JSON (UTF\-8 flagged)
+\& Perl (UTF\-8 flagged) => JSON (UTF\-8 flagged)
+.Ve
+.PP
+Unfortunately, there's no implicit way to dump Perl \s-1UTF\-8\s0 flagged data
+structure to utf\-8 encoded \s-1JSON\s0. To do this, simply use Encode module, e.g.:
+.PP
+.Vb 2
+\& use Encode;
+\& use JSON::Syck qw(Dump);
+\&
+\& my $json = encode_utf8( Dump($data) );
+.Ve
+.PP
+Alternatively you can use Encode::JavaScript::UCS to encode Unicode
+strings as in \fI\f(CI%uXXXX\fI\fR form.
+.PP
+.Vb 3
+\& use Encode;
+\& use Encode::JavaScript::UCS;
+\& use JSON::Syck qw(Dump);
+\&
+\& my $json_unicode_escaped = encode( \*(AqJavaScript\-UCS\*(Aq, Dump($data) );
+.Ve
+.SH "QUOTING"
+.IX Header "QUOTING"
+According to the \s-1JSON\s0 specification, all \s-1JSON\s0 strings are to be double-quoted.
+However, when embedding JavaScript in \s-1HTML\s0 attributes, it may be more
+convenient to use single quotes.
+.PP
+Set \f(CW$JSON::Syck::SingleQuote\fR to 1 will make both \f(CW\*(C`Dump\*(C'\fR and \f(CW\*(C`Load\*(C'\fR expect
+single-quoted string literals.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\s-1JSON::XS\s0,
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+Audrey Tang <cpan@audreyt.org>
+.PP
+Tatsuhiko Miyagawa <miyagawa@gmail.com>
+.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