# PODNAME: Config::Model::models::Dpkg::Copyright
# ABSTRACT:  Configuration class Dpkg::Copyright

=encoding utf8

=head1 NAME

Config::Model::models::Dpkg::Copyright - Configuration class Dpkg::Copyright

=head1 DESCRIPTION

Configuration classes used by L<Config::Model>

Machine-readable debian/copyright. Parameters from former version 
of DEP-5 are flagged as deprecated. The idea is to enable migration from older 
specs to CANDIDATE spec.

To edit a copyright file, go into your package development directory and run:

  cme edit dpkg-copyright
   
To check you file run:

  cme check dpkg-copyright
    
To upgrade your file from an old spec, run:

  cme migrate dpkg-copyright


=head1 Elements

=head2 Format

URI of the format specification. I< Mandatory. Type uniline.  > 

=over 4

=item default value :

https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

=back



=head2 Source

An explanation from where the upstream source came from. Typically this would be a URL, but it might be a free-form explanation. The Debian Policy, 12.5 requires this information unless there are no upstream sources, which is mainly the case for native Debian packages. If the upstream source has been modified to remove non-free parts, that should be explained in this field. I< Optional. Type string.  > 

Note: Source is migrated with 'C<$old || $older ;>' and with: 

=over

=item *

C<$old> => C<- Upstream-Source>

=item *

C<$older> => C<- Original-Source-Location>

=back



=head2 Upstream-Name

The name upstream uses for the software. I< Optional. Type uniline.  > 

Note: Upstream-Name is migrated with 'C<$name>' and with: 

=over

=item *

C<$name> => C<- Name>

=back



=head2 Upstream-Contact

The preferred address(es) to reach the upstream project. May be free-form text, but by convention will usually be written as a list of RFC5822 addresses or URIs. I< Optional. Type list of uniline.  > 

Note: Upstream-Contact values are migrated from '- Upstream-Maintainer'

=head2 Disclaimer

This field can be used in the case of non-free and contrib packages (see [Policy 12.5]( http://www.debian.org/doc/debian-policy/ch-docs.html#s-copyrightfile)) I< Optional. Type string.  > 

=head2 Comment

This field can provide additional information. For example, it might quote an e-mail from upstream justifying why the license is acceptable to the main archive, or an explanation of how this version of the package has been forked from a version known to be DFSG-free, even though the current upstream version is not. I< Optional. Type string.  > 

Note: Comment is migrated with 'C<$old>' and with: 

=over

=item *

C<$old> => C<- X-Comment>

=back



=head2 Copyright

Copyright information for the package as a whole, which may be different or simplified from a combination of all the per-file copyright information. See also Copyright below in the Files paragraph section. I< Optional. Type string.  > 

=head2 Files

Patterns indicating files having the same license and sharing copyright holders.
See L<files pattern documentation|https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/#files-field> for details. I< Optional. Type hash of node of class L<Dpkg::Copyright::Content|Config::Model::models::Dpkg::Copyright::Content> .  > 

=head2 Files-Excluded

White space separated list of file patterns to exclude from the package. This field is only used by L<uscan>. Example: C<*/Makefile.in aclocal.m4>. See also L<UscanEnhancements|https://wiki.debian.org/UscanEnhancements> and the L<files pattern documentation|https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/#files-field>. I< Optional. Type string.  > 

=head2 Global-License

I< Optional. Type node of class L<Dpkg::Copyright::GlobalLicense|Config::Model::models::Dpkg::Copyright::GlobalLicense> .  > 

=head2 Format-Specification

B<Deprecated> I< Optional. Type uniline.  > 

=head2 Name

B<Deprecated> I< Optional. Type uniline.  > 

=head2 Maintainer

Line(s) containing the preferred address(es) to reach current upstream maintainer(s). May be free-form text, but by convention will usually be written as a list of RFC2822 addresses or URIs. B<Deprecated> I< Optional. Type list of uniline.  > 

=head2 Upstream-Maintainer

B<Deprecated> I< Optional. Type list of uniline.  > 

Note: Upstream-Maintainer values are migrated from '- Maintainer'

=head2 Upstream-Source

B<Deprecated> I< Optional. Type string.  > 

=head2 Original-Source-Location

B<Deprecated> I< Optional. Type string.  > 

=head2 License

I< Optional. Type hash of node of class L<Dpkg::Copyright::LicenseSpec|Config::Model::models::Dpkg::Copyright::LicenseSpec> .  > 

=head2 X-Comment

B<Deprecated> I< Optional. Type string.  > 

=head1 SEE ALSO

=over

=item *

L<cme>

=item *

L<Config::Model::models::Dpkg::Copyright::Content>

=item *

L<Config::Model::models::Dpkg::Copyright::GlobalLicense>

=item *

L<Config::Model::models::Dpkg::Copyright::LicenseSpec>

=back

=head1 AUTHOR

=over

=item Dominique Dumont


=back

=head1 COPYRIGHT

=over

=item 2010,2011 Dominique Dumont


=back

=head1 LICENSE

=over

=item LGPL2


=back

=cut

