| 42 |
automatically extract licensing information. |
automatically extract licensing information. |
| 43 |
</para> |
</para> |
| 44 |
<para> |
<para> |
| 45 |
This is not a proposal to change the policy in the short term. In |
This specification is not part of the Debian Policy, and its use is |
| 46 |
particular, nothing in this proposal supersedes or modifies any of the |
optional. |
| 47 |
|
</para> |
| 48 |
|
<para> |
| 49 |
|
Nothing in this proposal supersedes or modifies any of the |
| 50 |
requirements specified in Debian Policy regarding the appropriate detail |
requirements specified in Debian Policy regarding the appropriate detail |
| 51 |
or granularity to use when documenting copyright and license status in |
or granularity to use when documenting copyright and license status in |
| 52 |
<filename>debian/copyright</filename>. |
<filename>debian/copyright</filename>. |
| 121 |
avoid conflicting specifications for widely used extra fields. |
avoid conflicting specifications for widely used extra fields. |
| 122 |
</para> |
</para> |
| 123 |
<para> |
<para> |
| 124 |
There are four kinds values for fields. Each field specifies which kind |
The file consists of two or more paragraphs. At minimum, the file |
| 125 |
is allowed. |
must include one <link linkend="header-paragraph">header |
| 126 |
|
paragraph</link> and one <link linkend="files-paragraph">Files |
| 127 |
|
paragraph</link>. |
| 128 |
|
</para> |
| 129 |
|
<para> |
| 130 |
|
The value of each field is of one of the four types listed below. The |
| 131 |
|
definition for each field in this document indicates which type of |
| 132 |
|
value it takes. |
| 133 |
</para> |
</para> |
| 134 |
|
|
| 135 |
<section id="single-line"> |
<section id="single-line"> |
| 136 |
<title>Single-line values</title> |
<title>Single-line values</title> |
| 137 |
<para> |
<para> |
| 138 |
A single-line value means that the whole value of a field must fit on a |
A single-line value means that the whole value of a field must fit |
| 139 |
single line. For example, the <varname>Format</varname> field has a |
on a single line. For example, the <varname>Format</varname> field |
| 140 |
single line value specifying the version of the machine-readable format |
has a single-line value specifying the version of the |
| 141 |
that is used. |
machine-readable format that is used. |
| 142 |
</para> |
</para> |
| 143 |
</section> |
</section> |
| 144 |
|
|
| 154 |
</section> |
</section> |
| 155 |
|
|
| 156 |
<section id="line-based-lists"> |
<section id="line-based-lists"> |
| 157 |
<title>Line based lists</title> |
<title>Line-based lists</title> |
| 158 |
<para> |
<para> |
| 159 |
Another kind of list value has one value per line. For example, |
Another kind of list value has one value per line. For example, |
| 160 |
<varname>Copyright</varname> can list many copyright statements, one per |
<varname>Copyright</varname> can list many copyright statements, one per |
| 179 |
<section id="paragraphs"> |
<section id="paragraphs"> |
| 180 |
<title>Paragraphs</title> |
<title>Paragraphs</title> |
| 181 |
<para> |
<para> |
| 182 |
There are three kinds of paragraphs: the first one is called the |
There are three kinds of paragraphs. The first paragraph in the file |
| 183 |
<link linkend="header-paragraph">header paragraph</link>. Every other |
is called the <link linkend="header-paragraph">header paragraph</link>. |
| 184 |
paragraph is either a <link linkend="files-paragraph">Files</link> |
Every other paragraph is either a <link |
| 185 |
paragraph or a <link linkend="stand-alone-license-paragraph">stand-alone |
linkend="files-paragraph">Files paragraph</link> or a <link |
| 186 |
license</link> paragraph. This is similar to source and binary package |
linkend="stand-alone-license-paragraph">stand-alone License |
| 187 |
|
paragraph</link>. This is similar to source and binary package |
| 188 |
paragraphs in <filename>debian/control</filename> files. |
paragraphs in <filename>debian/control</filename> files. |
| 189 |
</para> |
</para> |
| 190 |
|
|
| 191 |
<section id="header-paragraph"> |
<section id="header-paragraph"> |
| 192 |
<title>Header paragraph (Once)</title> |
<title>Header paragraph (Once)</title> |
| 193 |
<section id="format-header-field"> |
<para> |
| 194 |
<title><varname>Format</varname></title> |
The following fields may be present in a header paragraph. |
| 195 |
<para> |
</para> |
| 196 |
Required single line: URI of the format specification, such as: |
<itemizedlist> |
| 197 |
<literal>http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</literal> |
<listitem> |
| 198 |
</para> |
<para> |
| 199 |
</section> |
<link linkend="format-field">Format</link>: required. |
| 200 |
|
</para> |
| 201 |
<section id="upstream-name-header-field"> |
</listitem> |
| 202 |
<title><varname>Upstream-Name</varname></title> |
<listitem> |
| 203 |
<para> |
<para> |
| 204 |
Optional single line: the name upstream uses for the software |
<link linkend="upstream-name-field">Upstream-Name</link>: |
| 205 |
</para> |
optional. |
| 206 |
</section> |
</para> |
| 207 |
|
</listitem> |
| 208 |
<section id="upstream-contact-header-field"> |
<listitem> |
| 209 |
<title><varname>Upstream-Contact</varname></title> |
<para> |
| 210 |
<para> |
<link |
| 211 |
Optional line based list: the preferred address(es) to reach the |
linkend="upstream-contact-field">Upstream-Contact</link>: |
| 212 |
upstream project. May be free-form text, but by convention will |
optional. |
| 213 |
usually be written as a list of RFC5322 addresses or URIs. |
</para> |
| 214 |
</para> |
</listitem> |
| 215 |
</section> |
<listitem> |
| 216 |
|
<para> |
| 217 |
<section id="source-header-field"> |
<link linkend="source-field">Source</link>: optional. |
| 218 |
<title><varname>Source</varname></title> |
</para> |
| 219 |
<para> |
</listitem> |
| 220 |
Optional formatted text, no synopsis: an explanation from where the |
<listitem> |
| 221 |
upstream source came from. Typically this would be a URL, but it might |
<para> |
| 222 |
be a free-form explanation. The Debian Policy section <ulink |
<link linkend="disclaimer-field">Disclaimer</link>: |
| 223 |
url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink> |
optional. |
| 224 |
requires this information unless there are no upstream sources, which |
</para> |
| 225 |
is mainly the case for native Debian packages. If the upstream source |
</listitem> |
| 226 |
has been modified to remove non-free parts, that should be explained |
<listitem> |
| 227 |
in this field. |
<para> |
| 228 |
</para> |
<link linkend="comment-field">Comment</link>: optional. |
| 229 |
</section> |
</para> |
| 230 |
|
</listitem> |
| 231 |
<section id="disclaimer-header-field"> |
<listitem> |
| 232 |
<title><varname>Disclaimer</varname></title> |
<para> |
| 233 |
<para> |
<link linkend="license-field">License</link>: optional. |
| 234 |
Optional formatted text, no synopsis: this field can be used in the |
</para> |
| 235 |
case of non-free and contrib packages (see <ulink |
</listitem> |
| 236 |
url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>) |
<listitem> |
| 237 |
</para> |
<para> |
| 238 |
</section> |
<link linkend="copyright-field">Copyright</link>: optional. |
| 239 |
|
</para> |
| 240 |
<section id="comment-header-field"> |
</listitem> |
| 241 |
<title><varname>Comment</varname></title> |
</itemizedlist> |
| 242 |
<para> |
<para> |
| 243 |
Optional formatted text, no synopsis: this field can provide |
The <varname>Copyright</varname> and <varname>License</varname> |
| 244 |
additional information. For example, it might quote an e-mail from |
fields in the <emphasis>header paragraph</emphasis> may complement |
| 245 |
upstream justifying why the license is acceptable to the main archive, |
but do not replace the <emphasis>Files paragraphs</emphasis>. They |
| 246 |
or an explanation of how this version of the package has been forked |
can be used to summarise the contributions and redistribution terms |
| 247 |
from a version known to be DFSG-free, even though the current upstream |
for the whole package, for instance when a work combines a |
| 248 |
version is not. |
permissive and a copyleft license, or to document a |
| 249 |
</para> |
<emphasis>compilation copyright</emphasis> and license. It is |
| 250 |
</section> |
possible to use only <varname>License</varname> in the header |
| 251 |
|
paragraph, but <varname>Copyright</varname> alone makes no sense. |
| 252 |
<section id="license-header-field"> |
</para> |
|
<title><varname>License</varname></title> |
|
|
<para> |
|
|
Optional formatted text, with synopsis: in the header paragraph |
|
|
(no <varname>Files</varname> specification), this field gives the |
|
|
license information for the package as a whole, which may be different |
|
|
or simplified from a combination of all the per-file license |
|
|
information. <varname>License</varname> below in the <link |
|
|
linkend="files-paragraph">Files paragraph</link> section. |
|
|
</para> |
|
|
</section> |
|
|
|
|
|
<section id="copyright-header-field"> |
|
|
<title><varname>Copyright</varname></title> |
|
|
<para> |
|
|
Optional line based list: in the header paragraph (no |
|
|
<varname>Files</varname> specification), this field gives the |
|
|
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 <varname>Copyright</varname> below |
|
|
in the <link linkend="files-paragraph">Files paragraph</link> |
|
|
section. |
|
|
</para> |
|
|
<para> |
|
|
The <varname>Copyright</varname> and <varname>License</varname> fields |
|
|
in the <emphasis>header paragraph</emphasis> may complement but do not |
|
|
replace the <emphasis>files paragraphs</emphasis>. They can be used |
|
|
to summarise the contributions and redistribution terms for the whole |
|
|
package, for instance when a work combines a permissive and a copyleft |
|
|
license, or to document a <emphasis>compilation copyright</emphasis> |
|
|
and license. It is possible to use only <varname>License</varname> in |
|
|
the header paragraph, but <varname>Copyright</varname> alone makes no |
|
|
sense. |
|
|
</para> |
|
|
</section> |
|
| 253 |
|
|
| 254 |
<section id="example-header-paragraph"> |
<section id="example-header-paragraph"> |
| 255 |
<title>Example header paragraph</title> |
<title>Example header paragraph</title> |
| 260 |
</section> |
</section> |
| 261 |
</section> |
</section> |
| 262 |
|
|
| 263 |
<section id="files-paragraph"> |
<section id="files-paragraph"> |
| 264 |
<title>Files paragraph (Repeatable)</title> |
<title>Files paragraph (Repeatable)</title> |
| 265 |
<para> |
<para> |
| 266 |
The declaration of copyright and license for files is done in one or |
The declaration of copyright and license for files is done in one or |
| 267 |
more paragraphs. In the simplest case, a single paragraph can be used |
more paragraphs. In the simplest case, a single paragraph can be used |
| 268 |
which applies to all files and lists all applicable copyrights and |
which applies to the whole package. Only the license and copyright |
| 269 |
licenses. |
information required by the Debian archive is required to be listed |
| 270 |
</para> |
here. |
| 271 |
|
</para> |
| 272 |
<section id="files-files-field"> |
<para> |
| 273 |
<title><varname>Files</varname></title> |
The following fields may be present in a Files paragraph. |
| 274 |
<para> |
</para> |
| 275 |
Required whitespace-separated list: list of patterns indicating files |
|
| 276 |
covered by the license and copyright specified in this paragraph. |
<itemizedlist> |
| 277 |
</para> |
<listitem> |
| 278 |
<para> |
<para> |
| 279 |
Filename patterns in the <varname>Files</varname> field are specified |
<link linkend="files-field">Files</link>: required. |
| 280 |
using a simplified shell glob syntax. Patterns are separated by |
</para> |
| 281 |
whitespace. |
</listitem> |
| 282 |
<itemizedlist> |
<listitem> |
| 283 |
<listitem> |
<para> |
| 284 |
<para> |
<link linkend="copyright-field">Copyright</link>: required. |
| 285 |
Only the wildcards <literal>*</literal> and <literal>?</literal> |
</para> |
| 286 |
apply; the former matches any number of characters (including |
</listitem> |
| 287 |
none), the latter a single character. Both match a slash |
<listitem> |
| 288 |
(<literal>/</literal>) and a leading dot. |
<para> |
| 289 |
</para> |
<link linkend="license-field">License</link>: required. |
| 290 |
</listitem> |
</para> |
| 291 |
<listitem> |
</listitem> |
| 292 |
<para> |
<listitem> |
| 293 |
Patterns match pathnames that start at the root of the source |
<para> |
| 294 |
tree. Thus, <quote><filename>Makefile.in</filename></quote> |
<link linkend="comment-field">Comment</link>: optional. |
| 295 |
matches only the file at the root of the tree, but |
</para> |
| 296 |
<quote><filename>*/Makefile.in</filename></quote> matches at any |
</listitem> |
| 297 |
depth. |
</itemizedlist> |
|
</para> |
|
|
</listitem> |
|
|
<listitem> |
|
|
<para> |
|
|
The backslash (<literal>\</literal>) is used to remove the magic |
|
|
from the next character; see table below. |
|
|
</para> |
|
|
</listitem> |
|
|
</itemizedlist> |
|
|
<informaltable> |
|
|
<tgroup cols="2"> |
|
|
<thead> |
|
|
<row> |
|
|
<entry>Escape sequence</entry> |
|
|
<entry>Matches</entry> |
|
|
</row> |
|
|
</thead> |
|
|
<tbody> |
|
|
<row> |
|
|
<entry><literal>\*</literal></entry> |
|
|
<entry>star (asterisk)</entry> |
|
|
</row> |
|
|
<row> |
|
|
<entry><literal>\?</literal></entry> |
|
|
<entry>question mark</entry> |
|
|
</row> |
|
|
<row> |
|
|
<entry><literal>\\</literal></entry> |
|
|
<entry>backslash</entry> |
|
|
</row> |
|
|
</tbody> |
|
|
</tgroup> |
|
|
</informaltable> |
|
|
Any other character following a backslash is an error. |
|
|
</para> |
|
|
<para> |
|
|
Multiple <varname>Files</varname> paragraphs are allowed. The last |
|
|
paragraph that matches a particular file applies to it. |
|
|
</para> |
|
|
<para> |
|
|
Exclusions are done by having multiple <varname>Files</varname> |
|
|
paragraphs. |
|
|
</para> |
|
|
</section> |
|
|
|
|
|
<section id="copyright-files-field"> |
|
|
<title><varname>Copyright</varname></title> |
|
|
<para> |
|
|
Required line based list: one or more free-form copyright |
|
|
statement(s), one per line, that apply to the files matched by the |
|
|
above pattern. If a work has no copyright holder (i.e., it is in |
|
|
the public domain), that information should be recorded here. |
|
|
</para> |
|
|
<para> |
|
|
The <varname>Copyright</varname> field collects all relevant copyright |
|
|
notices for the files of this paragraph. Not all copyright notices |
|
|
may apply to every individual file, and years of publication for one |
|
|
copyright holder may be gathered together. For example, if file A |
|
|
has: |
|
|
<programlisting>Copyright 2008 John Smith |
|
|
Copyright 2009 Angela Watts</programlisting> |
|
|
and file B has: |
|
|
<programlisting>Copyright 2010 Angela Watts</programlisting> |
|
|
the <varname>Copyright</varname> field for a stanza |
|
|
covering both file A and file B need contain only: |
|
|
<programlisting>Copyright 2008 John Smith |
|
|
Copyright 2009, 2010 Angela Watts</programlisting> |
|
|
</para> |
|
|
<para> |
|
|
The <varname>Copyright</varname> field may contain the original |
|
|
copyright statement copied exactly (including the word |
|
|
<quote>Copyright</quote>), or it can shorten the text, as long |
|
|
as it does not sacrifice information. Examples in this specification |
|
|
use both forms. |
|
|
</para> |
|
|
</section> |
|
|
|
|
|
<section id="license-files-field"> |
|
|
<title><varname>License</varname></title> |
|
|
<para> |
|
|
Required formatted text, with synopsis: licensing terms for the files |
|
|
listed in <varname>Files</varname> field for this paragraph. |
|
|
</para> |
|
|
<para> |
|
|
First line: an abbreviated name for the license, or expression |
|
|
giving alternatives (see <link linkend="license-short-name">Short |
|
|
names</link> section for a list of standard abbreviations). If there |
|
|
are licenses present in the package without a standard short name, an |
|
|
arbitrary short name may be assigned for these licenses. These |
|
|
arbitrary names are only guaranteed to be unique within a single |
|
|
copyright file. |
|
|
</para> |
|
|
<para> |
|
|
Remaining lines: if left blank here, the file |
|
|
<emphasis>must</emphasis> include a stand-alone |
|
|
<varname>License</varname> paragraph matching each license short |
|
|
name listed on the first line (see the <link |
|
|
linkend="stand-alone-license-paragraph">Standalone License |
|
|
Paragraph</link> section). Otherwise, this field should either |
|
|
include the full text of the license(s) or include a pointer to the |
|
|
license file under <filename>/usr/share/common-licenses</filename>. |
|
|
This field should include all text needed in order to fulfill both |
|
|
Debian Policy's requirement for including a copy of the software's |
|
|
distribution license (<ulink |
|
|
url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>), |
|
|
and any license requirements to include warranty disclaimers or other |
|
|
notices with the binary package. |
|
|
</para> |
|
|
</section> |
|
|
|
|
|
<section id="comment-files-field"> |
|
|
<title><varname>Comment</varname></title> |
|
|
<para> |
|
|
Same as the <link linkend="comment-header-field"> |
|
|
<varname>Comment</varname></link> field in the header paragraph. |
|
|
</para> |
|
|
</section> |
|
| 298 |
|
|
| 299 |
<section id="example-files-paragraph"> |
<section id="example-files-paragraph"> |
| 300 |
<title>Example files paragraphs</title> |
<title>Example files paragraphs</title> |
| 325 |
</section> |
</section> |
| 326 |
|
|
| 327 |
<section id="stand-alone-license-paragraph"> |
<section id="stand-alone-license-paragraph"> |
| 328 |
<title>Standalone License Paragraph (Optional, Repeatable)</title> |
<title>Stand-alone License Paragraph (Optional, Repeatable)</title> |
| 329 |
<para> |
<para> |
| 330 |
Where a set of files are dual (tri, etc) licensed, or when the same |
Where a set of files are dual (tri, etc) licensed, or when the same |
| 331 |
license occurs multiple times, you can use a single line |
license occurs multiple times, you can use a single-line |
| 332 |
<varname>License</varname> field and standalone |
<varname>License</varname> field and stand-alone |
| 333 |
<varname>License</varname> paragraphs to expand the license short names. |
<varname>License</varname> paragraphs to expand the license short names. |
| 334 |
</para> |
</para> |
| 335 |
|
<para> |
| 336 |
|
The following fields may be present in a stand-alone License |
| 337 |
|
paragraph. |
| 338 |
|
</para> |
| 339 |
|
|
| 340 |
|
<itemizedlist> |
| 341 |
|
<listitem> |
| 342 |
|
<para> |
| 343 |
|
<link linkend="license-field">License</link>: required. |
| 344 |
|
</para> |
| 345 |
|
</listitem> |
| 346 |
|
<listitem> |
| 347 |
|
<para> |
| 348 |
|
<link linkend="comment-field">Comment</link>: optional. |
| 349 |
|
</para> |
| 350 |
|
</listitem> |
| 351 |
|
</itemizedlist> |
| 352 |
<example> |
<example> |
| 353 |
<title>tri-licensed files</title> |
<title>tri-licensed files</title> |
| 354 |
<programlisting>Files: src/js/editline/* |
<programlisting>Files: src/js/editline/* |
| 383 |
</section> |
</section> |
| 384 |
</section> |
</section> |
| 385 |
|
|
| 386 |
|
<section id="fields"> |
| 387 |
|
<title>Fields</title> |
| 388 |
|
<para> |
| 389 |
|
The following fields are defined for use in |
| 390 |
|
<filename>debian/copyright</filename>. |
| 391 |
|
</para> |
| 392 |
|
|
| 393 |
|
<section id="format-field"> |
| 394 |
|
<title><varname>Format</varname></title> |
| 395 |
|
<para> |
| 396 |
|
Single-line: URI of the format specification, such as: |
| 397 |
|
<literal>http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</literal>. |
| 398 |
|
</para> |
| 399 |
|
</section> |
| 400 |
|
|
| 401 |
|
<section id="upstream-name-field"> |
| 402 |
|
<title><varname>Upstream-Name</varname></title> |
| 403 |
|
<para> |
| 404 |
|
Single-line: the name upstream uses for the software |
| 405 |
|
</para> |
| 406 |
|
</section> |
| 407 |
|
|
| 408 |
|
<section id="upstream-contact-field"> |
| 409 |
|
<title><varname>Upstream-Contact</varname></title> |
| 410 |
|
<para> |
| 411 |
|
Line-based list: the preferred address(es) to reach the upstream |
| 412 |
|
project. May be free-form text, but by convention will usually be |
| 413 |
|
written as a list of RFC5322 addresses or URIs. |
| 414 |
|
</para> |
| 415 |
|
</section> |
| 416 |
|
|
| 417 |
|
<section id="source-field"> |
| 418 |
|
<title><varname>Source</varname></title> |
| 419 |
|
<para> |
| 420 |
|
Formatted text, no synopsis: an explanation from where the upstream |
| 421 |
|
source came from. Typically this would be a URL, but it might be a |
| 422 |
|
free-form explanation. The Debian Policy section <ulink |
| 423 |
|
url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink> |
| 424 |
|
requires this information unless there are no upstream sources, |
| 425 |
|
which is mainly the case for native Debian packages. If the |
| 426 |
|
upstream source has been modified to remove non-free parts, that |
| 427 |
|
should be explained in this field. |
| 428 |
|
</para> |
| 429 |
|
</section> |
| 430 |
|
|
| 431 |
|
<section id="disclaimer-field"> |
| 432 |
|
<title><varname>Disclaimer</varname></title> |
| 433 |
|
<para> |
| 434 |
|
Formatted text, no synopsis: this field can be used in the case of |
| 435 |
|
non-free and contrib packages (see <ulink |
| 436 |
|
url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>). |
| 437 |
|
</para> |
| 438 |
|
</section> |
| 439 |
|
|
| 440 |
|
<section id="comment-field"> |
| 441 |
|
<title><varname>Comment</varname></title> |
| 442 |
|
<para> |
| 443 |
|
Formatted text, no synopsis: this field can provide additional |
| 444 |
|
information. For example, it might quote an e-mail from upstream |
| 445 |
|
justifying why the license is acceptable to the main archive, or an |
| 446 |
|
explanation of how this version of the package has been forked from |
| 447 |
|
a version known to be DFSG-free, even though the current upstream |
| 448 |
|
version is not. |
| 449 |
|
</para> |
| 450 |
|
</section> |
| 451 |
|
|
| 452 |
|
<section id="license-field"> |
| 453 |
|
<title><varname>License</varname></title> |
| 454 |
|
<para> |
| 455 |
|
Formatted text, with synopsis. In the header paragraph, this field |
| 456 |
|
gives the license information for the package as a whole, which may |
| 457 |
|
be different or simplified from a combination of all the per-file |
| 458 |
|
license information. In a Files paragraph, this field gives the |
| 459 |
|
licensing terms for the files listed in the <varname>Files</varname> |
| 460 |
|
field for this paragraph. In a stand-alone License paragraph, it |
| 461 |
|
gives the licensing terms for those paragraphs which reference it. |
| 462 |
|
</para> |
| 463 |
|
<para> |
| 464 |
|
First line: an abbreviated name for the license, or expression |
| 465 |
|
giving alternatives (see <link linkend="license-short-name">Short |
| 466 |
|
names</link> section for a list of standard abbreviations). If |
| 467 |
|
there are licenses present in the package without a standard short |
| 468 |
|
name, an arbitrary short name may be assigned for these licenses. |
| 469 |
|
These arbitrary names are only guaranteed to be unique within a |
| 470 |
|
single copyright file. |
| 471 |
|
</para> |
| 472 |
|
<para> |
| 473 |
|
Remaining lines: if left blank here, the file |
| 474 |
|
<emphasis>must</emphasis> include a <link |
| 475 |
|
linkend="stand-alone-license-paragraph">stand-alone License |
| 476 |
|
paragraph</link> matching each license short |
| 477 |
|
name listed on the first line. |
| 478 |
|
Otherwise, this field should either |
| 479 |
|
include the full text of the license(s) or include a pointer to the |
| 480 |
|
license file under <filename>/usr/share/common-licenses</filename>. |
| 481 |
|
This field should include all text needed in order to fulfill both |
| 482 |
|
Debian Policy's requirement for including a copy of the software's |
| 483 |
|
distribution license (<ulink |
| 484 |
|
url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile">12.5</ulink>), |
| 485 |
|
and any license requirements to include warranty disclaimers or |
| 486 |
|
other notices with the binary package. |
| 487 |
|
</para> |
| 488 |
|
</section> |
| 489 |
|
|
| 490 |
|
<section id="copyright-field"> |
| 491 |
|
<title><varname>Copyright</varname></title> |
| 492 |
|
<para> |
| 493 |
|
Formatted text, no synopsis: one or more free-form copyright |
| 494 |
|
statement(s). Any formatting is permitted; see the examples below |
| 495 |
|
for some ideas for how to structure the field to make it easier to |
| 496 |
|
read. In the header paragraph, this field gives the copyright |
| 497 |
|
information for the package as a whole, which may be different or |
| 498 |
|
simplified from a combination of all the per-file copyright |
| 499 |
|
information. In the Files paragraphs, it gives the copyright |
| 500 |
|
information that applies to the files matched by the |
| 501 |
|
<varname>Files</varname> pattern. If a work has no copyright holder |
| 502 |
|
(i.e., it is in the public domain), that information should be |
| 503 |
|
recorded here. |
| 504 |
|
</para> |
| 505 |
|
<para> |
| 506 |
|
The <varname>Copyright</varname> field collects all relevant |
| 507 |
|
copyright notices for the files of this paragraph. Not all |
| 508 |
|
copyright notices may apply to every individual file, and years of |
| 509 |
|
publication for one copyright holder may be gathered together. For |
| 510 |
|
example, if file A has: |
| 511 |
|
<programlisting>Copyright 2008 John Smith |
| 512 |
|
Copyright 2009 Angela Watts</programlisting> |
| 513 |
|
and file B has: |
| 514 |
|
<programlisting>Copyright 2010 Angela Watts</programlisting> |
| 515 |
|
the <varname>Copyright</varname> field for a stanza covering both |
| 516 |
|
file A and file B need contain only: |
| 517 |
|
<programlisting>Copyright 2008 John Smith |
| 518 |
|
Copyright 2009, 2010 Angela Watts</programlisting> |
| 519 |
|
</para> |
| 520 |
|
<para> |
| 521 |
|
The <varname>Copyright</varname> field may contain the original |
| 522 |
|
copyright statement copied exactly (including the word |
| 523 |
|
<quote>Copyright</quote>), or it can shorten the text, as long as it |
| 524 |
|
does not sacrifice information. Examples in this specification use |
| 525 |
|
both forms. |
| 526 |
|
</para> |
| 527 |
|
</section> |
| 528 |
|
|
| 529 |
|
<section id="files-field"> |
| 530 |
|
<title><varname>Files</varname></title> |
| 531 |
|
<para> |
| 532 |
|
Whitespace-separated list: list of patterns indicating files covered |
| 533 |
|
by the license and copyright specified in this paragraph. |
| 534 |
|
</para> |
| 535 |
|
<para> |
| 536 |
|
Filename patterns in the <varname>Files</varname> field are |
| 537 |
|
specified using a simplified shell glob syntax. Patterns are |
| 538 |
|
separated by whitespace. |
| 539 |
|
<itemizedlist> |
| 540 |
|
<listitem> |
| 541 |
|
<para> |
| 542 |
|
Only the wildcards <literal>*</literal> and <literal>?</literal> |
| 543 |
|
apply; the former matches any number of characters (including |
| 544 |
|
none), the latter a single character. Both match a slash |
| 545 |
|
(<literal>/</literal>) and a leading dot. |
| 546 |
|
</para> |
| 547 |
|
</listitem> |
| 548 |
|
<listitem> |
| 549 |
|
<para> |
| 550 |
|
Patterns match pathnames that start at the root of the source |
| 551 |
|
tree. Thus, <quote><filename>Makefile.in</filename></quote> |
| 552 |
|
matches only the file at the root of the tree, but |
| 553 |
|
<quote><filename>*/Makefile.in</filename></quote> matches at |
| 554 |
|
any depth. |
| 555 |
|
</para> |
| 556 |
|
</listitem> |
| 557 |
|
<listitem> |
| 558 |
|
<para> |
| 559 |
|
The backslash (<literal>\</literal>) is used to remove the |
| 560 |
|
magic from the next character; see table below. |
| 561 |
|
</para> |
| 562 |
|
</listitem> |
| 563 |
|
</itemizedlist> |
| 564 |
|
<informaltable> |
| 565 |
|
<tgroup cols="2"> |
| 566 |
|
<thead> |
| 567 |
|
<row> |
| 568 |
|
<entry>Escape sequence</entry> |
| 569 |
|
<entry>Matches</entry> |
| 570 |
|
</row> |
| 571 |
|
</thead> |
| 572 |
|
<tbody> |
| 573 |
|
<row> |
| 574 |
|
<entry><literal>\*</literal></entry> |
| 575 |
|
<entry>star (asterisk)</entry> |
| 576 |
|
</row> |
| 577 |
|
<row> |
| 578 |
|
<entry><literal>\?</literal></entry> |
| 579 |
|
<entry>question mark</entry> |
| 580 |
|
</row> |
| 581 |
|
<row> |
| 582 |
|
<entry><literal>\\</literal></entry> |
| 583 |
|
<entry>backslash</entry> |
| 584 |
|
</row> |
| 585 |
|
</tbody> |
| 586 |
|
</tgroup> |
| 587 |
|
</informaltable> |
| 588 |
|
Any other character following a backslash is an error. |
| 589 |
|
</para> |
| 590 |
|
<para> |
| 591 |
|
Multiple <varname>Files</varname> paragraphs are allowed. The last |
| 592 |
|
paragraph that matches a particular file applies to it. |
| 593 |
|
</para> |
| 594 |
|
<para> |
| 595 |
|
Exclusions are done by having multiple <varname>Files</varname> |
| 596 |
|
paragraphs. |
| 597 |
|
</para> |
| 598 |
|
</section> |
| 599 |
|
|
| 600 |
|
</section> |
| 601 |
<section id="license-specification"> |
<section id="license-specification"> |
| 602 |
<title>License specification</title> |
<title>License specification</title> |
| 603 |
|
|
| 631 |
<filename>debian/copyright</filename>, nor any requirements in the |
<filename>debian/copyright</filename>, nor any requirements in the |
| 632 |
license of the work regarding reproduction of legal notices. This |
license of the work regarding reproduction of legal notices. This |
| 633 |
information must still be included in the <varname>License</varname> |
information must still be included in the <varname>License</varname> |
| 634 |
field, either in a stand-alone license paragraph or in the relevant |
field, either in a stand-alone License paragraph or in the relevant |
| 635 |
files paragraph. |
files paragraph. |
| 636 |
</para> |
</para> |
| 637 |
<para> |
<para> |
| 984 |
license differs from a common license because of added restrictions |
license differs from a common license because of added restrictions |
| 985 |
rather than because of added permissions, a distinct short name should |
rather than because of added permissions, a distinct short name should |
| 986 |
be used instead of <literal>with |
be used instead of <literal>with |
| 987 |
<varname><replaceable>keywords</replaceable></varname>exception</literal>. |
<varname><replaceable>keywords</replaceable></varname> |
| 988 |
|
exception</literal>. |
| 989 |
</para> |
</para> |
| 990 |
<para> |
<para> |
| 991 |
Only one exception may be specified for each license within a given |
Only one exception may be specified for each license within a given |