debian::copyright::stanza::files(3pm) [debian man page]

Debian::Copyright::Stanza::Files(3pm)			User Contributed Perl Documentation		     Debian::Copyright::Stanza::Files(3pm)

NAME

       Debian::Copyright::Stanza::Files - Files stanza of Debian copyright file

VERSION

       This document describes Debian::Copyright::Stanza::Files version 0.1 .

SYNOPSIS

	   my $copy = Debian::Copyright::Stanza::Files->new(\%data);
	   print $copy; 			# auto-stringification

DESCRIPTION

       Debian::Copyright::Stanza::Files can be used for representation and manipulation of a "Files:" stanza of Debian copyright files in an
       object-oriented way. Converts itself to a textual representation in string context.

FIELDS

       The supported fields for Files stanzas are listed below.

       Note that real copyright fields may contain dashes in their names. These are replaced with underscores.

       Files
       License
       Copyright
       X_Comment

CONSTRUCTOR

   new( { field => value, ... } )
       Creates a new Debian::Copyright::Stanza::Files object and optionally initialises it with the supplied data.

METHODS

   is_or_separated($field)
       Returns true for the "License" field.

SEE ALSO

       Debian::Copyright::Stanza::Files inherits most of its functionality from Debian::Copyright::Stanza

COPYRIGHT &; LICENSE
       Copyright (C) 2011 Nicholas Bamber nicholas@periapt.co.uk

       This module is substantially based upon Debian::Control::Stanza::Source.  Copyright (C) 2009 Damyan Ivanov dmn@debian.org

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as
       published by the Free Software Foundation.

       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.

perl v5.12.4							    2011-08-27				     Debian::Copyright::Stanza::Files(3pm)

Debian::Copyright(3pm)					User Contributed Perl Documentation				    Debian::Copyright(3pm)

NAME

       Debian::Copyright - manage Debian copyright files

VERSION

       This document describes Debian::Copyright version 0.1 .

SYNOPSIS

	   my $c = Debian::Copyright->new();	   # construct a new
	   $c->read($file1);			   # parse debian copyright file
	   $c->read($file2);			   # parse a second
	   $c->write($ofile);			    # write to file

DESCRIPTION

       Debian::Copyright can be used for the representation, manipulation and merging of Debian copyright files in an object-oriented way. It
       provides easy reading and writing of the debian/copyright file found in Debian source packages.

FIELDS

   header
       An instance of Debian::Copyright::Stanza::Header class. Contains the the first stanza of the copyright file. If multiple files were parsed
       only the first will be retained.

   files
       A hash reference (actually Tie::IxHash instance) with keys being the values of the "Files" clause and values instances of
       Debian::Copyright::Stanza::Files class.

   licenses
       A hash reference (actually Tie::IxHash instance) with keys being the values of the "License" clause and values instances of
       Debian::Copyright::Stanza::License class.

CONSTRUCTOR

   new
       Constructs a new Debian::Copyright instance.

       The "header" field is initialised with an empty string.	The "files_block" and "license_block" fields are initialised with an empty
       instance of Tie::IxHash.

METHODS

   read file
       Parse "copyright" in debian and accessors.

       file can be either a file name, an opened file handle or a string scalar reference.

   write file
       Writes a debian/copyright-like file in file with the contents defined in the accessor fields.

       file can be either a file name, an opened file handle or a string scalar reference.

LIMITATIONS

       This module is written with one particular version of DEP-5
       <http://anonscm.debian.org/viewvc/dep/web/deps/dep5.mdwn?view=markup&pathrev=135> in mind. When required it should be easy to add support
       for extra versions, but at the moment the supported version is the one generally used in the Debian Perl Group.
       Test coverage is not yet complete.

COPYRIGHT &; LICENSE
       Copyright (C) 2011 Nicholas Bamber nicholas@periapt.co.uk

       This module was adapted from Debian::Control.  Copyright (C) 2009 Damyan Ivanov dmn@debian.org [Portions]

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as
       published by the Free Software Foundation.

       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.

perl v5.12.4							    2011-08-27						    Debian::Copyright(3pm)