.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" 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 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. .\" .\" 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 .\" .\" 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 "Debian::Copyright 3pm" .TH Debian::Copyright 3pm "2016-03-02" "perl v5.22.1" "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" Debian::Copyright \- manage Debian copyright files .SH "VERSION" .IX Header "VERSION" This document describes Debian::Copyright version 0.2 . .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& 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 .Ve .SH "DESCRIPTION" .IX Header "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 \fIdebian/copyright\fR file found in Debian source packages. Debian has recently started standardising its copyright files around the machine-readable \&\*(L"Format: http://www.debian.org/doc/packaging\-manuals/copyright\-format/1.0/\*(R" in \s-1DEP\-5\s0 format. .SS "note on terminology" .IX Subsection "note on terminology" The term \*(L"Stanza\*(R" derives from the dh-make-perl tool. The official term would now be \*(L"Paragraph\*(R". For the purposes of discussing the \s-1DEP\-5\s0 format the terms are used interchangeably in this documentation. .SH "FIELDS" .IX Header "FIELDS" .SS "header" .IX Subsection "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. .SS "files" .IX Subsection "files" A hash reference (actually Tie::IxHash instance) with keys being the values of the \f(CW\*(C`Files\*(C'\fR clause and values instances of Debian::Copyright::Stanza::Files class. .SS "licenses" .IX Subsection "licenses" A hash reference (actually Tie::IxHash instance) with keys being the values of the \f(CW\*(C`License\*(C'\fR clause and values instances of Debian::Copyright::Stanza::License class. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" Constructs a new Debian::Copyright instance. .PP The \f(CW\*(C`header\*(C'\fR field is initialised with an empty string. The \f(CW\*(C`files_block\*(C'\fR and \f(CW\*(C`license_block\*(C'\fR fields are initialised with an empty instance of Tie::IxHash. .SH "METHODS" .IX Header "METHODS" .SS "read \fIfile\fP" .IX Subsection "read file" Parse \*(L"copyright\*(R" in debian and accessors. .PP \&\fIfile\fR can be either a file name, an opened file handle or a string scalar reference. .SS "write \fIfile\fP" .IX Subsection "write file" Writes a debian/copyright\-like file in \fIfile\fR with the contents defined in the accessor fields. .PP \&\fIfile\fR can be either a file name, an opened file handle or a string scalar reference. .SH "LIMITATIONS" .IX Header "LIMITATIONS" .IP "This module is written with one particular version of \s-1DEP\-5\s0 in mind. Furthermore version 0.1 of this software was for a draft version the standard. The changes in going from draft to standard were such that it was not worth attempting to maintain backwards compatibility." 4 .IX Item "This module is written with one particular version of DEP-5 in mind. Furthermore version 0.1 of this software was for a draft version the standard. The changes in going from draft to standard were such that it was not worth attempting to maintain backwards compatibility." .PD 0 .IP "Test coverage is not yet complete." 4 .IX Item "Test coverage is not yet complete." .PD .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" This version is not backwards compatible with version 0.1. .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" Thanks to Charles Plessy for various comments regarding the documentation. .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright (C) 2011\-2012 Nicholas Bamber nicholas@periapt.co.uk .PP This module was adapted from Debian::Control. Copyright (C) 2009 Damyan Ivanov dmn@debian.org [Portions] .PP This program is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License version 2 as published by the Free Software Foundation. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0