========================================================================
* README
========================================================================
NAME
YAML - YAML Ain't Markup Language (tm)
NOTE
This module has been released to CPAN as YAML::Old, and soon YAML.pm
will be changed to just be a frontend interface module for all the
various Perl YAML implementation modules, including YAML::Old.
If you want robust and fast YAML processing using the normal Dump/Load
API, please consider switching to YAML::XS. It is by far the best Perl
module for YAML at this time. It requires that you have a C compiler,
since it is written in C.
If you really need to use this version of YAML.pm it will always be
available as YAML::Old.
If you don't care which YAML module use, as long as it's the best one
installed on your system, use YAML::Any.
The rest of this documentation is left unchanged, until YAML.pm is
switched over to the new UI-only version.
SYNOPSIS
use YAML;
# Load a YAML stream of 3 YAML documents into Perl data structures.
my ($hashref, $arrayref, $string) = Load(<<'...');
---
name: ingy
age: old
weight: heavy
# I should comment that I also like pink, but don't tell anybody.
favorite colors:
- red
- green
- blue
---
- Clark Evans
- Oren Ben-Kiki
- Ingy döt Net
--- >
You probably think YAML stands for "Yet Another Markup Language". It
ain't! YAML is really a data serialization language. But if you want
to think of it as a markup, that's OK with me. A lot of people try
to use XML as a serialization format.
"YAML" is catchy and fun to say. Try it. "YAML, YAML, YAML!!!"
...
# Dump the Perl data structures back into YAML.
print Dump($string, $arrayref, $hashref);
# YAML::Dump is used the same way you'd use Data::Dumper::Dumper
use Data::Dumper;
print Dumper($string, $arrayref, $hashref);
DESCRIPTION
The YAML.pm module implements a YAML Loader and Dumper based on the YAML
1.0 specification.
YAML is a generic data serialization language that is optimized for
human readability. It can be used to express the data structures of most
modern programming languages. (Including Perl!!!)
For information on the YAML syntax, please refer to the YAML
specification.
WHY YAML IS COOL
YAML is readable for people.
It makes clear sense out of complex data structures. You should find
that YAML is an exceptional data dumping tool. Structure is shown
through indentation, YAML supports recursive data, and hash keys are
sorted by default. In addition, YAML supports several styles of
scalar formatting for different types of data.
YAML is editable.
YAML was designed from the ground up to be an excellent syntax for
configuration files. Almost all programs need configuration files,
so why invent a new syntax for each one? And why subject users to
the complexities of XML or native Perl code?
YAML is multilingual.
Yes, YAML supports Unicode. But I'm actually referring to
programming languages. YAML was designed to meet the serialization
needs of Perl, Python, Ruby, Tcl, PHP, Javascript and Java. It was
also designed to be interoperable between those languages. That
means YAML serializations produced by Perl can be processed by
Python.
YAML is taint safe.
Using modules like Data::Dumper for serialization is fine as long as
you can be sure that nobody can tamper with your data files or
transmissions. That's because you need to use Perl's "eval()"
built-in to deserialize the data. Somebody could add a snippet of
Perl to erase your files.
YAML's parser does not need to eval anything.
YAML is full featured.
YAML can accurately serialize all of the common Perl data structures
and deserialize them again without losing data relationships.
Although it is not 100% perfect (no serializer is or can be
perfect), it fares as well as the popular current modules:
Data::Dumper, Storable, XML::Dumper and Data::Denter.
YAML.pm also has the ability to handle code (subroutine) references
and typeglobs. (Still experimental) These features are not found in
Perl's other serialization modules.
YAML is extensible.
The YAML language has been designed to be flexible enough to solve
it's own problems. The markup itself has 3 basic construct which
resemble Perl's hash, array and scalar. By default, these map to
their Perl equivalents. But each YAML node also supports a tagging
mechanism (type system) which can cause that node to be interpreted
in a completely different manner. That's how YAML can support object
serialization and oddball structures like Perl's typeglob.
YAML IMPLEMENTATIONS IN PERL
This module, YAML.pm, is really just the interface module for YAML
modules written in Perl. The basic interface for YAML consists of two
functions: "Dump" and "Load". The real work is done by the modules
YAML::Dumper and YAML::Loader.
Different YAML module distributions can be created by subclassing
YAML.pm and YAML::Loader and YAML::Dumper. For example, YAML-Simple
consists of YAML::Simple YAML::Dumper::Simple and YAML::Loader::Simple.
Why would there be more than one implementation of YAML? Well, despite
YAML's offering of being a simple data format, YAML is actually very
deep and complex. Implementing the entirety of the YAML specification is
a daunting task.
For this reason I am currently working on 3 different YAML
implementations.
YAML
The main YAML distribution will keeping evolving to support the
entire YAML specification in pure Perl. This may not be the fastest
or most stable module though. Currently, YAML.pm has lots of known
bugs. It is mostly a great tool for dumping Perl data structures to
a readable form.
YAML::Tiny
The point of YAML::Tiny is to strip YAML down to the 90% that people
use most and offer that in a small, fast, stable, pure Perl form.
YAML::Tiny will simply die when it is asked to do something it
can't.
YAML::Syck
"libsyck" is the C based YAML processing library used by the Ruby
programming language (and also Python, PHP and Pugs). YAML::Syck is
the Perl binding to "libsyck". It should be very fast, but may have
problems of its own. It will also require C compilation.
NOTE: Audrey Tang has actually completed this module and it works
great and is 10 times faster than YAML.pm.
In the future, there will likely be even more YAML modules. Remember,
people other than Ingy are allowed to write YAML modules!
FUNCTIONAL USAGE
YAML is completely OO under the hood. Still it exports a few useful top
level functions so that it is dead simple to use. These functions just
do the OO stuff for you. If you want direct access to the OO API see the
documentation for YAML::Dumper and YAML::Loader.
Exported Functions
The following functions are exported by YAML.pm by default. The reason
they are exported is so that YAML works much like Data::Dumper. If you
don't want functions to be imported, just use YAML with an empty import
list:
use YAML ();
Dump(list-of-Perl-data-structures)
Turn Perl data into YAML. This function works very much like
Data::Dumper::Dumper(). It takes a list of Perl data strucures and
dumps them into a serialized form. It returns a string containing
the YAML stream. The structures can be references or plain scalars.
Load(string-containing-a-YAML-stream)
Turn YAML into Perl data. This is the opposite of Dump. Just like
Storable's thaw() function or the eval() function in relation to
Data::Dumper. It parses a string containing a valid YAML stream into
a list of Perl data structures.
Exportable Functions
These functions are not exported by default but you can request them in
an import list like this:
use YAML qw'freeze thaw Bless';
freeze() and thaw()
Aliases to Dump() and Load() for Storable fans. This will also allow
YAML.pm to be plugged directly into modules like POE.pm, that use
the freeze/thaw API for internal serialization.
DumpFile(filepath, list)
Writes the YAML stream to a file instead of just returning a string.
LoadFile(filepath)
Reads the YAML stream from a file instead of a string.
Bless(perl-node, [yaml-node | class-name])
Associate a normal Perl node, with a yaml node. A yaml node is an
object tied to the YAML::Node class. The second argument is either a
yaml node that you've already created or a class (package) name that
supports a yaml_dump() function. A yaml_dump() function should take
a perl node and return a yaml node. If no second argument is
provided, Bless will create a yaml node. This node is not returned,
but can be retrieved with the Blessed() function.
Here's an example of how to use Bless. Say you have a hash
containing three keys, but you only want to dump two of them.
Furthermore the keys must be dumped in a certain order. Here's how
you do that:
use YAML qw(Dump Bless);
$hash = {apple => 'good', banana => 'bad', cauliflower => 'ugly'};
print Dump $hash;
Bless($hash)->keys(['banana', 'apple']);
print Dump $hash;
produces:
---
apple: good
banana: bad
cauliflower: ugly
---
banana: bad
apple: good
Bless returns the tied part of a yaml-node, so that you can call the
YAML::Node methods. This is the same thing that YAML::Node::ynode()
returns. So another way to do the above example is:
use YAML qw(Dump Bless);
use YAML::Node;
$hash = {apple => 'good', banana => 'bad', cauliflower => 'ugly'};
print Dump $hash;
Bless($hash);
$ynode = ynode(Blessed($hash));
$ynode->keys(['banana', 'apple']);
print Dump $hash;
Note that Blessing a Perl data structure does not change it anyway.
The extra information is stored separately and looked up by the
Blessed node's memory address.
Blessed(perl-node)
Returns the yaml node that a particular perl node is associated with
(see above). Returns undef if the node is not (YAML) Blessed.
GLOBAL OPTIONS
YAML options are set using a group of global variables in the YAML
namespace. This is similar to how Data::Dumper works.
For example, to change the indentation width, do something like:
local $YAML::Indent = 3;
The current options are:
DumperClass
You can override which module/class YAML uses for Dumping data.
LoaderClass
You can override which module/class YAML uses for Loading data.
Indent
This is the number of space characters to use for each indentation
level when doing a Dump(). The default is 2.
By the way, YAML can use any number of characters for indentation at
any level. So if you are editing YAML by hand feel free to do it
anyway that looks pleasing to you; just be consistent for a given
level.
SortKeys
Default is 1. (true)
Tells YAML.pm whether or not to sort hash keys when storing a
document.
YAML::Node objects can have their own sort order, which is usually
what you want. To override the YAML::Node order and sort the keys
anyway, set SortKeys to 2.
Stringify
Default is 0. (false)
Objects with string overloading should honor the overloading and
dump the stringification of themselves, rather than the actual
object's guts.
UseHeader
Default is 1. (true)
This tells YAML.pm whether to use a separator string for a Dump
operation. This only applies to the first document in a stream.
Subsequent documents must have a YAML header by definition.
UseVersion
Default is 0. (false)
Tells YAML.pm whether to include the YAML version on the
separator/header.
--- %YAML:1.0
AnchorPrefix
Default is ''.
Anchor names are normally numeric. YAML.pm simply starts with '1'
and increases by one for each new anchor. This option allows you to
specify a string to be prepended to each anchor number.
UseCode
Setting the UseCode option is a shortcut to set both the DumpCode
and LoadCode options at once. Setting UseCode to '1' tells YAML.pm
to dump Perl code references as Perl (using B::Deparse) and to load
them back into memory using eval(). The reason this has to be an
option is that using eval() to parse untrusted code is, well,
untrustworthy.
DumpCode
Determines if and how YAML.pm should serialize Perl code references.
By default YAML.pm will dump code references as dummy placeholders
(much like Data::Dumper). If DumpCode is set to '1' or 'deparse',
code references will be dumped as actual Perl code.
DumpCode can also be set to a subroutine reference so that you can
write your own serializing routine. YAML.pm passes you the code ref.
You pass back the serialization (as a string) and a format
indicator. The format indicator is a simple string like: 'deparse'
or 'bytecode'.
LoadCode
LoadCode is the opposite of DumpCode. It tells YAML if and how to
deserialize code references. When set to '1' or 'deparse' it will
use "eval()". Since this is potentially risky, only use this option
if you know where your YAML has been.
LoadCode can also be set to a subroutine reference so that you can
write your own deserializing routine. YAML.pm passes the
serialization (as a string) and a format indicator. You pass back
the code reference.
UseBlock
YAML.pm uses heuristics to guess which scalar style is best for a
given node. Sometimes you'll want all multiline scalars to use the
'block' style. If so, set this option to 1.
NOTE: YAML's block style is akin to Perl's here-document.
UseFold
If you want to force YAML to use the 'folded' style for all
multiline scalars, then set $UseFold to 1.
NOTE: YAML's folded style is akin to the way HTML folds text, except
smarter.
UseAliases
YAML has an alias mechanism such that any given structure in memory
gets serialized once. Any other references to that structure are
serialized only as alias markers. This is how YAML can serialize
duplicate and recursive structures.
Sometimes, when you KNOW that your data is nonrecursive in nature,
you may want to serialize such that every node is expressed in full.
(ie as a copy of the original). Setting $YAML::UseAliases to 0 will
allow you to do this. This also may result in faster processing
because the lookup overhead is by bypassed.
THIS OPTION CAN BE DANGEROUS. *If* your data is recursive, this
option *will* cause Dump() to run in an endless loop, chewing up
your computers memory. You have been warned.
CompressSeries
Default is 1.
Compresses the formatting of arrays of hashes:
-
foo: bar
-
bar: foo
becomes:
- foo: bar
- bar: foo
Since this output is usually more desirable, this option is turned
on by default.
YAML TERMINOLOGY
YAML is a full featured data serialization language, and thus has its
own terminology.
It is important to remember that although YAML is heavily influenced by
Perl and Python, it is a language in its own right, not merely just a
representation of Perl structures.
YAML has three constructs that are conspicuously similar to Perl's hash,
array, and scalar. They are called mapping, sequence, and string
respectively. By default, they do what you would expect. But each
instance may have an explicit or implicit tag (type) that makes it
behave differently. In this manner, YAML can be extended to represent
Perl's Glob or Python's tuple, or Ruby's Bigint.
stream
A YAML stream is the full sequence of unicode characters that a YAML
parser would read or a YAML emitter would write. A stream may
contain one or more YAML documents separated by YAML headers.
---
a: mapping
foo: bar
---
- a
- sequence
document
A YAML document is an independent data structure representation
within a stream. It is a top level node. Each document in a YAML
stream must begin with a YAML header line. Actually the header is
optional on the first document.
---
This: top level mapping
is:
- a
- YAML
- document
header
A YAML header is a line that begins a YAML document. It consists of
three dashes, possibly followed by more info. Another purpose of the
header line is that it serves as a place to put top level tag and
anchor information.
--- !recursive-sequence &001
- * 001
- * 001
node
A YAML node is the representation of a particular data stucture.
Nodes may contain other nodes. (In Perl terms, nodes are like
scalars. Strings, arrayrefs and hashrefs. But this refers to the
serialized format, not the in-memory structure.)
tag This is similar to a type. It indicates how a particular YAML node
serialization should be transferred into or out of memory. For
instance a Foo::Bar object would use the tag 'perl/Foo::Bar':
- !perl/Foo::Bar
foo: 42
bar: stool
collection
A collection is the generic term for a YAML data grouping. YAML has
two types of collections: mappings and sequences. (Similar to hashes
and arrays)
mapping
A mapping is a YAML collection defined by unordered key/value pairs
with unique keys. By default YAML mappings are loaded into Perl
hashes.
a mapping:
foo: bar
two: times two is 4
sequence
A sequence is a YAML collection defined by an ordered list of
elements. By default YAML sequences are loaded into Perl arrays.
a sequence:
- one bourbon
- one scotch
- one beer
scalar
A scalar is a YAML node that is a single value. By default YAML
scalars are loaded into Perl scalars.
a scalar key: a scalar value
YAML has many styles for representing scalars. This is important
because varying data will have varying formatting requirements to
retain the optimum human readability.
plain scalar
A plain scalar is unquoted. All plain scalars are automatic
candidates for "implicit tagging". This means that their tag may be
determined automatically by examination. The typical uses for this
are plain alpha strings, integers, real numbers, dates, times and
currency.
- a plain string
- -42
- 3.1415
- 12:34
- 123 this is an error
single quoted scalar
This is similar to Perl's use of single quotes. It means no escaping
except for single quotes which are escaped by using two adjacent
single quotes.
- 'When I say ''\n'' I mean "backslash en"'
double quoted scalar
This is similar to Perl's use of double quotes. Character escaping
can be used.
- "This scalar\nhas two lines, and a bell -->\a"
folded scalar
This is a multiline scalar which begins on the next line. It is
indicated by a single right angle bracket. It is unescaped like the
single quoted scalar. Line folding is also performed.
- >
This is a multiline scalar which begins on
the next line. It is indicated by a single
carat. It is unescaped like the single
quoted scalar. Line folding is also
performed.
block scalar
This final multiline form is akin to Perl's here-document except
that (as in all YAML data) scope is indicated by indentation.
Therefore, no ending marker is required. The data is verbatim. No
line folding.
- |
QTY DESC PRICE TOTAL
--- ---- ----- -----
1 Foo Fighters $19.95 $19.95
2 Bar Belles $29.95 $59.90
parser
A YAML processor has four stages: parse, load, dump, emit.
A parser parses a YAML stream. YAML.pm's Load() function contains a
parser.
loader
The other half of the Load() function is a loader. This takes the
information from the parser and loads it into a Perl data structure.
dumper
The Dump() function consists of a dumper and an emitter. The dumper
walks through each Perl data structure and gives info to the
emitter.
emitter
The emitter takes info from the dumper and turns it into a YAML
stream.
NOTE: In YAML.pm the parser/loader and the dumper/emitter code are
currently very closely tied together. In the future they may be
broken into separate stages.
For more information please refer to the immensely helpful YAML
specification available at .
ysh - The YAML Shell
The YAML distribution ships with a script called 'ysh', the YAML shell.
ysh provides a simple, interactive way to play with YAML. If you type in
Perl code, it displays the result in YAML. If you type in YAML it turns
it into Perl code.
To run ysh, (assuming you installed it along with YAML.pm) simply type:
ysh [options]
Please read the "ysh" documentation for the full details. There are lots
of options.
BUGS & DEFICIENCIES
If you find a bug in YAML, please try to recreate it in the YAML Shell
with logging turned on ('ysh -L'). When you have successfully reproduced
the bug, please mail the LOG file to the author (ingy@cpan.org).
WARNING: This is still *ALPHA* code. Well, most of this code has been
around for years...
BIGGER WARNING: YAML.pm has been slow in the making, but I am committed
to having top notch YAML tools in the Perl world. The YAML team is close
to finalizing the YAML 1.1 spec. This version of YAML.pm is based off of
a very old pre 1.0 spec. In actuality there isn't a ton of difference,
and this YAML.pm is still fairly useful. Things will get much better in
the future.
RESOURCES
is the mailing
list. This is where the language is discussed and designed.
is the official YAML website.
is the YAML 1.0 specification.
is the official YAML wiki.
SEE ALSO
See YAML::XS. Fast!
AUTHOR
Ingy döt Net
is resonsible for YAML.pm.
The YAML serialization language is the result of years of collaboration
between Oren Ben-Kiki, Clark Evans and Ingy döt Net. Several others have
added help along the way.
COPYRIGHT
Copyright (c) 2005, 2006, 2008, 2011-2012. Ingy döt Net.
Copyright (c) 2001, 2002, 2005. Brian Ingerson.
Some parts copyright (c) 2009 - 2010 Adam Kennedy
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See
========================================================================
* LICENSE
========================================================================
This software is copyright (c) 2012 by Ingy döt Net .
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Terms of the Perl programming language system itself
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License"
--- The GNU General Public License, Version 1, February 1989 ---
This software is Copyright (c) 2012 by Ingy döt Net .
This is free software, licensed under:
The GNU General Public License, Version 1, February 1989
GNU GENERAL PUBLIC LICENSE
Version 1, February 1989
Copyright (C) 1989 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The license agreements of most software companies try to keep users
at the mercy of those companies. By contrast, our General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. The
General Public License applies to the Free Software Foundation's
software and to any other program whose authors commit to using it.
You can use it for your programs, too.
When we speak of free software, we are referring to freedom, not
price. Specifically, the General Public License is designed to make
sure that you have the freedom to give away or sell copies of free
software, that you receive source code or can get it if you want it,
that you can change the software or use pieces of it in new free
programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of a such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must tell them their rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any program or other work which
contains a notice placed by the copyright holder saying it may be
distributed under the terms of this General Public License. The
"Program", below, refers to any such program or work, and a "work based
on the Program" means either the Program or any work containing the
Program or a portion of it, either verbatim or with modifications. Each
licensee is addressed as "you".
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this
General Public License and to the absence of any warranty; and give any
other recipients of the Program a copy of this General Public License
along with the Program. You may charge a fee for the physical act of
transferring a copy.
2. You may modify your copy or copies of the Program or any portion of
it, and copy and distribute such modifications under the terms of Paragraph
1 above, provided that you also do the following:
a) cause the modified files to carry prominent notices stating that
you changed the files and the date of any change; and
b) cause the whole of any work that you distribute or publish, that
in whole or in part contains the Program or any part thereof, either
with or without modifications, to be licensed at no charge to all
third parties under the terms of this General Public License (except
that you may choose to grant warranty protection to some or all
third parties, at your option).
c) If the modified program normally reads commands interactively when
run, you must cause it, when started running for such interactive use
in the simplest and most usual way, to print or display an
announcement including an appropriate copyright notice and a notice
that there is no warranty (or else, saying that you provide a
warranty) and that users may redistribute the program under these
conditions, and telling the user how to view a copy of this General
Public License.
d) You may charge a fee for the physical act of transferring a
copy, and you may at your option offer warranty protection in
exchange for a fee.
Mere aggregation of another independent work with the Program (or its
derivative) on a volume of a storage or distribution medium does not bring
the other work under the scope of these terms.
3. You may copy and distribute the Program (or a portion or derivative of
it, under Paragraph 2) in object code or executable form under the terms of
Paragraphs 1 and 2 above provided that you also do one of the following:
a) accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of
Paragraphs 1 and 2 above; or,
b) accompany it with a written offer, valid for at least three
years, to give any third party free (except for a nominal charge
for the cost of distribution) a complete machine-readable copy of the
corresponding source code, to be distributed under the terms of
Paragraphs 1 and 2 above; or,
c) accompany it with the information you received as to where the
corresponding source code may be obtained. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form alone.)
Source code for a work means the preferred form of the work for making
modifications to it. For an executable file, complete source code means
all the source code for all modules it contains; but, as a special
exception, it need not include source code for modules which are standard
libraries that accompany the operating system on which the executable
file runs, or for standard header files or definitions files that
accompany that operating system.
4. You may not copy, modify, sublicense, distribute or transfer the
Program except as expressly provided under this General Public License.
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
the Program is void, and will automatically terminate your rights to use
the Program under this License. However, parties who have received
copies, or rights to use copies, from you under this General Public
License will not have their licenses terminated so long as such parties
remain in full compliance.
5. By copying, distributing or modifying the Program (or any work based
on the Program) you indicate your acceptance of this license to do so,
and all its terms and conditions.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these
terms and conditions. You may not impose any further restrictions on the
recipients' exercise of the rights granted herein.
7. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of the license which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
the license, you may choose any version ever published by the Free Software
Foundation.
8. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" 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 PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
10. IN 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING 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 PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to humanity, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively convey
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
Copyright (C) 19yy
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19xx name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
program `Gnomovision' (a program to direct compilers to make passes
at assemblers) written by James Hacker.
, 1 April 1989
Ty Coon, President of Vice
That's all there is to it!
--- The Artistic License 1.0 ---
This software is Copyright (c) 2012 by Ingy döt Net .
This is free software, licensed under:
The Artistic License 1.0
The Artistic License
Preamble
The intent of this document is to state the conditions under which a Package
may be copied, such that the Copyright Holder maintains some semblance of
artistic control over the development of the package, while giving the users of
the package the right to use and distribute the Package in a more-or-less
customary fashion, plus the right to make reasonable modifications.
Definitions:
- "Package" refers to the collection of files distributed by the Copyright
Holder, and derivatives of that collection of files created through
textual modification.
- "Standard Version" refers to such a Package if it has not been modified,
or has been modified in accordance with the wishes of the Copyright
Holder.
- "Copyright Holder" is whoever is named in the copyright or copyrights for
the package.
- "You" is you, if you're thinking about copying or distributing this Package.
- "Reasonable copying fee" is whatever you can justify on the basis of media
cost, duplication charges, time of people involved, and so on. (You will
not be required to justify it to the Copyright Holder, but only to the
computing community at large as a market that must bear the fee.)
- "Freely Available" means that no fee is charged for the item itself, though
there may be fees involved in handling the item. It also means that
recipients of the item may redistribute it under the same conditions they
received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications derived
from the Public Domain or from the Copyright Holder. A Package modified in such
a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided that
you insert a prominent notice in each changed file stating how and when you
changed that file, and provided that you do at least ONE of the following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or an
equivalent medium, or placing the modifications on a major archive site
such as ftp.uu.net, or by allowing the Copyright Holder to include your
modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict with
standard executables, which must also be provided, and provide a separate
manual page for each non-standard executable that clearly documents how it
differs from the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or executable
form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where to
get the Standard Version.
b) accompany the distribution with the machine-readable source of the Package
with your modifications.
c) accompany any non-standard executables with their corresponding Standard
Version executables, giving the non-standard executables non-standard
names, and clearly documenting the differences in manual pages (or
equivalent), together with instructions on where to get the Standard
Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this
Package. You may charge any fee you choose for support of this Package. You
may not charge a fee for this Package itself. However, you may distribute this
Package in aggregate with other (possibly commercial) programs as part of a
larger (possibly commercial) software distribution provided that you do not
advertise this Package as a product of your own.
6. The scripts and library files supplied as input to or produced as output
from the programs of this Package do not automatically fall under the copyright
of this Package, but belong to whomever generated them, and may be sold
commercially, and may be aggregated with this Package.
7. C or perl subroutines supplied by you and linked into this Package shall not
be considered part of this Package.
8. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
The End