| 18 |
"#0000FF" vlink="#840084" alink="#0000FF"> |
"#0000FF" vlink="#840084" alink="#0000FF"> |
| 19 |
<pre><code>Title: Machine-readable debian/copyright |
<pre><code>Title: Machine-readable debian/copyright |
| 20 |
DEP: 5 |
DEP: 5 |
| 21 |
State: CANDIDATE |
State: ACCEPTED |
| 22 |
Drivers: Steve Langasek <vorlon@debian.org> |
Drivers: Steve Langasek <vorlon@debian.org> |
| 23 |
Date: 2011-10-10 |
Date: 2012-02-24 |
| 24 |
URL: http://dep.debian.net/deps/dep5 (this page) |
URL: http://dep.debian.net/deps/dep5 (this page) |
| 25 |
http://anonscm.debian.org/loggerhead/dep/dep5/trunk/annotate/head:/dep5/copyright-format.xml (the source) |
http://anonscm.debian.org/loggerhead/dep/dep5/trunk/annotate/head:/dep5/copyright-format.xml (the source) |
| 26 |
License: |
License: |
| 57 |
|
|
| 58 |
<dt><a href="#paragraphs">Paragraphs</a></dt> |
<dt><a href="#paragraphs">Paragraphs</a></dt> |
| 59 |
|
|
| 60 |
|
<dt><a href="#fields">Fields</a></dt> |
| 61 |
|
|
| 62 |
<dt><a href="#license-specification">License |
<dt><a href="#license-specification">License |
| 63 |
specification</a></dt> |
specification</a></dt> |
| 64 |
|
|
| 70 |
<h2 class="section"><a name="introduction" id= |
<h2 class="section"><a name="introduction" id= |
| 71 |
"introduction">Introduction</a></h2> |
"introduction">Introduction</a></h2> |
| 72 |
|
|
| 73 |
|
<div class="note"> |
| 74 |
|
<blockquote class="note"> |
| 75 |
|
<p><b>Current Version:</b> This specification is now |
| 76 |
|
maintained as a <a href= |
| 77 |
|
"http://www.debian.org/doc/packaging-manuals/copyright-format/" |
| 78 |
|
target="_top">standard</a> that is part of the <tt class= |
| 79 |
|
"filename">debian-policy</tt> package. Please refer to it |
| 80 |
|
for the most up to date version of this |
| 81 |
|
specification.</p> |
| 82 |
|
</blockquote> |
| 83 |
|
</div> |
| 84 |
|
|
| 85 |
<p>This is a proposal to make <tt class= |
<p>This is a proposal to make <tt class= |
| 86 |
"filename">debian/copyright</tt> machine-interpretable. This |
"filename">debian/copyright</tt> machine-interpretable. This |
| 87 |
file is one of the most important files in Debian packaging, |
file is one of the most important files in Debian packaging, |
| 169 |
attempt to avoid conflicting specifications for widely used |
attempt to avoid conflicting specifications for widely used |
| 170 |
extra fields.</p> |
extra fields.</p> |
| 171 |
|
|
| 172 |
<p>There are four kinds values for fields. Each field |
<p>The file consists of two or more paragraphs. At minimum, |
| 173 |
specifies which kind is allowed.</p> |
the file must include one <a href="#header-paragraph">header |
| 174 |
|
paragraph</a> and one <a href="#files-paragraph">Files |
| 175 |
|
paragraph</a>.</p> |
| 176 |
|
|
| 177 |
|
<p>The value of each field is of one of the four types listed |
| 178 |
|
below. The definition for each field in this document |
| 179 |
|
indicates which type of value it takes.</p> |
| 180 |
|
|
| 181 |
<div class="section"> |
<div class="section"> |
| 182 |
<hr> |
<hr> |
| 186 |
|
|
| 187 |
<p>A single-line value means that the whole value of a |
<p>A single-line value means that the whole value of a |
| 188 |
field must fit on a single line. For example, the |
field must fit on a single line. For example, the |
| 189 |
<code class="varname">Format</code> field has a single line |
<code class="varname">Format</code> field has a single-line |
| 190 |
value specifying the version of the machine-readable format |
value specifying the version of the machine-readable format |
| 191 |
that is used.</p> |
that is used.</p> |
| 192 |
</div> |
</div> |
| 209 |
<hr> |
<hr> |
| 210 |
|
|
| 211 |
<h3 class="section"><a name="line-based-lists" id= |
<h3 class="section"><a name="line-based-lists" id= |
| 212 |
"line-based-lists">Line based lists</a></h3> |
"line-based-lists">Line-based lists</a></h3> |
| 213 |
|
|
| 214 |
<p>Another kind of list value has one value per line. For |
<p>Another kind of list value has one value per line. For |
| 215 |
example, <code class="varname">Copyright</code> can list |
example, <code class="varname">Copyright</code> can list |
| 243 |
<h2 class="section"><a name="paragraphs" id= |
<h2 class="section"><a name="paragraphs" id= |
| 244 |
"paragraphs">Paragraphs</a></h2> |
"paragraphs">Paragraphs</a></h2> |
| 245 |
|
|
| 246 |
<p>There are three kinds of paragraphs: the first paragraph |
<p>There are three kinds of paragraphs. The first paragraph |
| 247 |
in the file is called the <a href="#header-paragraph">header |
in the file is called the <a href="#header-paragraph">header |
| 248 |
paragraph</a>. Every other paragraph is either a <a href= |
paragraph</a>. Every other paragraph is either a <a href= |
| 249 |
"#files-paragraph">Files</a> paragraph or a <a href= |
"#files-paragraph">Files paragraph</a> or a <a href= |
| 250 |
"#stand-alone-license-paragraph">stand-alone license</a> |
"#stand-alone-license-paragraph">stand-alone License |
| 251 |
paragraph. This is similar to source and binary package |
paragraph</a>. This is similar to source and binary package |
| 252 |
paragraphs in <tt class="filename">debian/control</tt> |
paragraphs in <tt class="filename">debian/control</tt> |
| 253 |
files.</p> |
files.</p> |
| 254 |
|
|
| 258 |
<h3 class="section"><a name="header-paragraph" id= |
<h3 class="section"><a name="header-paragraph" id= |
| 259 |
"header-paragraph">Header paragraph (Once)</a></h3> |
"header-paragraph">Header paragraph (Once)</a></h3> |
| 260 |
|
|
| 261 |
<div class="section"> |
<p>The following fields may be present in a header |
| 262 |
<h4 class="section"><a name="format-header-field" id= |
paragraph.</p> |
|
"format-header-field"><code class= |
|
|
"varname">Format</code></a></h4> |
|
|
|
|
|
<p>Required single line: URI of the format specification, |
|
|
such as: <tt class= |
|
|
"literal">http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</tt></p> |
|
|
</div> |
|
|
|
|
|
<div class="section"> |
|
|
<hr> |
|
|
|
|
|
<h4 class="section"><a name="upstream-name-header-field" |
|
|
id="upstream-name-header-field"><code class= |
|
|
"varname">Upstream-Name</code></a></h4> |
|
|
|
|
|
<p>Optional single line: the name upstream uses for the |
|
|
software</p> |
|
|
</div> |
|
|
|
|
|
<div class="section"> |
|
|
<hr> |
|
| 263 |
|
|
| 264 |
<h4 class="section"><a name= |
<ul> |
| 265 |
"upstream-contact-header-field" id= |
<li> |
| 266 |
"upstream-contact-header-field"><code class= |
<p><a href="#format-field">Format</a>: required.</p> |
| 267 |
"varname">Upstream-Contact</code></a></h4> |
</li> |
| 268 |
|
|
| 269 |
<p>Optional line based list: the preferred address(es) to |
<li> |
| 270 |
reach the upstream project. May be free-form text, but by |
<p><a href="#upstream-name-field">Upstream-Name</a>: |
| 271 |
convention will usually be written as a list of RFC5322 |
optional.</p> |
| 272 |
addresses or URIs.</p> |
</li> |
| 273 |
</div> |
|
| 274 |
|
<li> |
| 275 |
<div class="section"> |
<p><a href= |
| 276 |
<hr> |
"#upstream-contact-field">Upstream-Contact</a>: |
| 277 |
|
optional.</p> |
| 278 |
<h4 class="section"><a name="source-header-field" id= |
</li> |
| 279 |
"source-header-field"><code class= |
|
| 280 |
"varname">Source</code></a></h4> |
<li> |
| 281 |
|
<p><a href="#source-field">Source</a>: optional.</p> |
| 282 |
<p>Optional formatted text, no synopsis: an explanation |
</li> |
| 283 |
from where the upstream source came from. Typically this |
|
| 284 |
would be a URL, but it might be a free-form explanation. |
<li> |
| 285 |
The Debian Policy section <a href= |
<p><a href="#disclaimer-field">Disclaimer</a>: |
| 286 |
"http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile" |
optional.</p> |
| 287 |
target="_top">12.5</a> requires this information unless |
</li> |
| 288 |
there are no upstream sources, which is mainly the case |
|
| 289 |
for native Debian packages. If the upstream source has |
<li> |
| 290 |
been modified to remove non-free parts, that should be |
<p><a href="#comment-field">Comment</a>: optional.</p> |
| 291 |
explained in this field.</p> |
</li> |
| 292 |
</div> |
|
| 293 |
|
<li> |
| 294 |
<div class="section"> |
<p><a href="#license-field">License</a>: optional.</p> |
| 295 |
<hr> |
</li> |
| 296 |
|
|
| 297 |
<h4 class="section"><a name="disclaimer-header-field" id= |
<li> |
| 298 |
"disclaimer-header-field"><code class= |
<p><a href="#copyright-field">Copyright</a>: |
| 299 |
"varname">Disclaimer</code></a></h4> |
optional.</p> |
| 300 |
|
</li> |
| 301 |
<p>Optional formatted text, no synopsis: this field can |
</ul> |
| 302 |
be used in the case of non-free and contrib packages (see |
|
| 303 |
<a href= |
<p>The <code class="varname">Copyright</code> and |
| 304 |
"http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile" |
<code class="varname">License</code> fields in the |
| 305 |
target="_top">12.5</a>)</p> |
<span class="emphasis"><i class="emphasis">header |
| 306 |
</div> |
paragraph</i></span> may complement but do not replace the |
| 307 |
|
<span class="emphasis"><i class="emphasis">Files |
| 308 |
<div class="section"> |
paragraphs</i></span>. They can be used to summarise the |
| 309 |
<hr> |
contributions and redistribution terms for the whole |
| 310 |
|
package, for instance when a work combines a permissive and |
| 311 |
<h4 class="section"><a name="comment-header-field" id= |
a copyleft license, or to document a <span class= |
| 312 |
"comment-header-field"><code class= |
"emphasis"><i class="emphasis">compilation |
| 313 |
"varname">Comment</code></a></h4> |
copyright</i></span> and license. It is possible to use |
| 314 |
|
only <code class="varname">License</code> in the header |
| 315 |
<p>Optional formatted text, no synopsis: this field can |
paragraph, but <code class="varname">Copyright</code> alone |
| 316 |
provide additional information. For example, it might |
makes no sense.</p> |
|
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.</p> |
|
|
</div> |
|
|
|
|
|
<div class="section"> |
|
|
<hr> |
|
|
|
|
|
<h4 class="section"><a name="license-header-field" id= |
|
|
"license-header-field"><code class= |
|
|
"varname">License</code></a></h4> |
|
|
|
|
|
<p>Optional formatted text, with synopsis: in the header |
|
|
paragraph (no <code class="varname">Files</code> |
|
|
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. See also <code class= |
|
|
"varname">License</code> below in the <a href= |
|
|
"#files-paragraph">Files paragraph</a> section.</p> |
|
|
</div> |
|
|
|
|
|
<div class="section"> |
|
|
<hr> |
|
|
|
|
|
<h4 class="section"><a name="copyright-header-field" id= |
|
|
"copyright-header-field"><code class= |
|
|
"varname">Copyright</code></a></h4> |
|
|
|
|
|
<p>Optional line based list: in the header paragraph (no |
|
|
<code class="varname">Files</code> 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 <code class="varname">Copyright</code> below in |
|
|
the <a href="#files-paragraph">Files paragraph</a> |
|
|
section.</p> |
|
|
|
|
|
<p>The <code class="varname">Copyright</code> and |
|
|
<code class="varname">License</code> fields in the |
|
|
<span class="emphasis"><i class="emphasis">header |
|
|
paragraph</i></span> may complement but do not replace |
|
|
the <span class="emphasis"><i class="emphasis">files |
|
|
paragraphs</i></span>. 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 <span class= |
|
|
"emphasis"><i class="emphasis">compilation |
|
|
copyright</i></span> and license. It is possible to use |
|
|
only <code class="varname">License</code> in the header |
|
|
paragraph, but <code class="varname">Copyright</code> |
|
|
alone makes no sense.</p> |
|
|
</div> |
|
| 317 |
|
|
| 318 |
<div class="section"> |
<div class="section"> |
| 319 |
<hr> |
<hr> |
| 341 |
single paragraph can be used which applies to all files and |
single paragraph can be used which applies to all files and |
| 342 |
lists all applicable copyrights and licenses.</p> |
lists all applicable copyrights and licenses.</p> |
| 343 |
|
|
| 344 |
<div class="section"> |
<p>The following fields may be present in a Files |
| 345 |
<hr> |
paragraph.</p> |
|
|
|
|
<h4 class="section"><a name="files-files-field" id= |
|
|
"files-files-field"><code class= |
|
|
"varname">Files</code></a></h4> |
|
|
|
|
|
<p>Required whitespace-separated list: list of patterns |
|
|
indicating files covered by the license and copyright |
|
|
specified in this paragraph.</p> |
|
|
|
|
|
<p>Filename patterns in the <code class= |
|
|
"varname">Files</code> field are specified using a |
|
|
simplified shell glob syntax. Patterns are separated by |
|
|
whitespace.</p> |
|
|
|
|
|
<ul> |
|
|
<li> |
|
|
<p>Only the wildcards <tt class="literal">*</tt> and |
|
|
<tt class="literal">?</tt> apply; the former matches |
|
|
any number of characters (including none), the latter |
|
|
a single character. Both match a slash (<tt class= |
|
|
"literal">/</tt>) and a leading dot.</p> |
|
|
</li> |
|
|
|
|
|
<li> |
|
|
<p>Patterns match pathnames that start at the root of |
|
|
the source tree. Thus, <span class= |
|
|
"QUOTE">"<tt class="filename">Makefile.in</tt>"</span> |
|
|
matches only the file at the root of the tree, but |
|
|
<span class="QUOTE">"<tt class= |
|
|
"filename">*/Makefile.in</tt>"</span> matches at any |
|
|
depth.</p> |
|
|
</li> |
|
|
|
|
|
<li> |
|
|
<p>The backslash (<tt class="literal">\</tt>) is used |
|
|
to remove the magic from the next character; see |
|
|
table below.</p> |
|
|
</li> |
|
|
</ul> |
|
|
|
|
|
<div class="informaltable"> |
|
|
<a name="AEN142" id="AEN142"></a> |
|
|
|
|
|
<table border="1" class="CALSTABLE"> |
|
|
<col> |
|
|
<col> |
|
|
|
|
|
<thead> |
|
|
<tr> |
|
|
<th>Escape sequence</th> |
|
|
|
|
|
<th>Matches</th> |
|
|
</tr> |
|
|
</thead> |
|
|
|
|
|
<tbody> |
|
|
<tr> |
|
|
<td><tt class="literal">\*</tt></td> |
|
|
|
|
|
<td>star (asterisk)</td> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td><tt class="literal">\?</tt></td> |
|
|
|
|
|
<td>question mark</td> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td><tt class="literal">\\</tt></td> |
|
|
|
|
|
<td>backslash</td> |
|
|
</tr> |
|
|
</tbody> |
|
|
</table> |
|
|
</div>Any other character following a backslash is an |
|
|
error. |
|
|
|
|
|
<p>Multiple <code class="varname">Files</code> paragraphs |
|
|
are allowed. The last paragraph that matches a particular |
|
|
file applies to it.</p> |
|
| 346 |
|
|
| 347 |
<p>Exclusions are done by having multiple <code class= |
<ul> |
| 348 |
"varname">Files</code> paragraphs.</p> |
<li> |
| 349 |
</div> |
<p><a href="#files-field">Files</a>: required.</p> |
| 350 |
|
</li> |
| 351 |
<div class="section"> |
|
| 352 |
<hr> |
<li> |
| 353 |
|
<p><a href="#license-field">Copyright</a>: |
| 354 |
<h4 class="section"><a name="copyright-files-field" id= |
required.</p> |
| 355 |
"copyright-files-field"><code class= |
</li> |
| 356 |
"varname">Copyright</code></a></h4> |
|
| 357 |
|
<li> |
| 358 |
<p>Required line based list: one or more free-form |
<p><a href="#license-field">License</a>: required.</p> |
| 359 |
copyright statement(s), one per line, that apply to the |
</li> |
| 360 |
files matched by the above pattern. If a work has no |
|
| 361 |
copyright holder (i.e., it is in the public domain), that |
<li> |
| 362 |
information should be recorded here.</p> |
<p><a href="#comment-field">Comment</a>: optional.</p> |
| 363 |
|
</li> |
| 364 |
<p>The <code class="varname">Copyright</code> field |
</ul> |
|
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:</p> |
|
|
<pre class="programlisting"> |
|
|
Copyright 2008 John Smith |
|
|
Copyright 2009 Angela Watts |
|
|
</pre>and file B has: |
|
|
<pre class="programlisting"> |
|
|
Copyright 2010 Angela Watts |
|
|
</pre>the <code class="varname">Copyright</code> field for a stanza |
|
|
covering both file A and file B need contain only: |
|
|
<pre class="programlisting"> |
|
|
Copyright 2008 John Smith |
|
|
Copyright 2009, 2010 Angela Watts |
|
|
</pre> |
|
|
|
|
|
<p>The <code class="varname">Copyright</code> field may |
|
|
contain the original copyright statement copied exactly |
|
|
(including the word <span class= |
|
|
"QUOTE">"Copyright"</span>), or it can shorten the text, |
|
|
as long as it does not sacrifice information. Examples in |
|
|
this specification use both forms.</p> |
|
|
</div> |
|
|
|
|
|
<div class="section"> |
|
|
<hr> |
|
|
|
|
|
<h4 class="section"><a name="license-files-field" id= |
|
|
"license-files-field"><code class= |
|
|
"varname">License</code></a></h4> |
|
|
|
|
|
<p>Required formatted text, with synopsis: licensing |
|
|
terms for the files listed in <code class= |
|
|
"varname">Files</code> field for this paragraph.</p> |
|
|
|
|
|
<p>First line: an abbreviated name for the license, or |
|
|
expression giving alternatives (see <a href= |
|
|
"#license-short-name">Short names</a> 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.</p> |
|
|
|
|
|
<p>Remaining lines: if left blank here, the file |
|
|
<span class="emphasis"><i class= |
|
|
"emphasis">must</i></span> include a stand-alone |
|
|
<code class="varname">License</code> paragraph matching |
|
|
each license short name listed on the first line (see the |
|
|
<a href="#stand-alone-license-paragraph">Standalone |
|
|
License Paragraph</a> section). Otherwise, this field |
|
|
should either include the full text of the license(s) or |
|
|
include a pointer to the license file under <tt class= |
|
|
"filename">/usr/share/common-licenses</tt>. 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 (<a href= |
|
|
"http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile" |
|
|
target="_top">12.5</a>), and any license requirements to |
|
|
include warranty disclaimers or other notices with the |
|
|
binary package.</p> |
|
|
</div> |
|
|
|
|
|
<div class="section"> |
|
|
<hr> |
|
|
|
|
|
<h4 class="section"><a name="comment-files-field" id= |
|
|
"comment-files-field"><code class= |
|
|
"varname">Comment</code></a></h4> |
|
|
|
|
|
<p>Same as the <a href="#comment-header-field"> |
|
|
<code class="varname">Comment</code></a> field in the |
|
|
header paragraph.</p> |
|
|
</div> |
|
| 365 |
|
|
| 366 |
<div class="section"> |
<div class="section"> |
| 367 |
<hr> |
<hr> |
| 401 |
<hr> |
<hr> |
| 402 |
|
|
| 403 |
<h3 class="section"><a name="stand-alone-license-paragraph" |
<h3 class="section"><a name="stand-alone-license-paragraph" |
| 404 |
id="stand-alone-license-paragraph">Standalone License |
id="stand-alone-license-paragraph">Stand-alone License |
| 405 |
Paragraph (Optional, Repeatable)</a></h3> |
Paragraph (Optional, Repeatable)</a></h3> |
| 406 |
|
|
| 407 |
<p>Where a set of files are dual (tri, etc) licensed, or |
<p>Where a set of files are dual (tri, etc) licensed, or |
| 408 |
when the same license occurs multiple times, you can use a |
when the same license occurs multiple times, you can use a |
| 409 |
single line <code class="varname">License</code> field and |
single-line <code class="varname">License</code> field and |
| 410 |
standalone <code class="varname">License</code> paragraphs |
stand-alone <code class="varname">License</code> paragraphs |
| 411 |
to expand the license short names.</p> |
to expand the license short names.</p> |
| 412 |
|
|
| 413 |
|
<p>The following fields may be present in a stand-alone |
| 414 |
|
License paragraph.</p> |
| 415 |
|
|
| 416 |
|
<ul> |
| 417 |
|
<li> |
| 418 |
|
<p><a href="#license-field">License</a>: required.</p> |
| 419 |
|
</li> |
| 420 |
|
|
| 421 |
|
<li> |
| 422 |
|
<p><a href="#comment-field">Comment</a>: optional.</p> |
| 423 |
|
</li> |
| 424 |
|
</ul> |
| 425 |
|
|
| 426 |
<div class="example"> |
<div class="example"> |
| 427 |
<a name="AEN206" id="AEN206"></a> |
<a name="AEN145" id="AEN145"></a> |
| 428 |
|
|
| 429 |
<p><b>Example 1. tri-licensed files</b></p> |
<p><b>Example 1. tri-licensed files</b></p> |
| 430 |
<pre class="programlisting"> |
<pre class="programlisting"> |
| 445 |
</div> |
</div> |
| 446 |
|
|
| 447 |
<div class="example"> |
<div class="example"> |
| 448 |
<a name="AEN209" id="AEN209"></a> |
<a name="AEN148" id="AEN148"></a> |
| 449 |
|
|
| 450 |
<p><b>Example 2. recurrent license</b></p> |
<p><b>Example 2. recurrent license</b></p> |
| 451 |
<pre class="programlisting"> |
<pre class="programlisting"> |
| 468 |
<div class="section"> |
<div class="section"> |
| 469 |
<hr> |
<hr> |
| 470 |
|
|
| 471 |
|
<h2 class="section"><a name="fields" id= |
| 472 |
|
"fields">Fields</a></h2> |
| 473 |
|
|
| 474 |
|
<p>The following fields are defined for use in <tt class= |
| 475 |
|
"filename">debian/copyright</tt>.</p> |
| 476 |
|
|
| 477 |
|
<div class="section"> |
| 478 |
|
<hr> |
| 479 |
|
|
| 480 |
|
<h3 class="section"><a name="format-field" id= |
| 481 |
|
"format-field"><code class="varname">Format</code></a></h3> |
| 482 |
|
|
| 483 |
|
<p>Single-line: URI of the format specification, such as: |
| 484 |
|
<tt class= |
| 485 |
|
"literal">http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</tt>.</p> |
| 486 |
|
</div> |
| 487 |
|
|
| 488 |
|
<div class="section"> |
| 489 |
|
<hr> |
| 490 |
|
|
| 491 |
|
<h3 class="section"><a name="upstream-name-field" id= |
| 492 |
|
"upstream-name-field"><code class= |
| 493 |
|
"varname">Upstream-Name</code></a></h3> |
| 494 |
|
|
| 495 |
|
<p>Single-line: the name upstream uses for the software</p> |
| 496 |
|
</div> |
| 497 |
|
|
| 498 |
|
<div class="section"> |
| 499 |
|
<hr> |
| 500 |
|
|
| 501 |
|
<h3 class="section"><a name="upstream-contact-field" id= |
| 502 |
|
"upstream-contact-field"><code class= |
| 503 |
|
"varname">Upstream-Contact</code></a></h3> |
| 504 |
|
|
| 505 |
|
<p>Line-based list: the preferred address(es) to reach the |
| 506 |
|
upstream project. May be free-form text, but by convention |
| 507 |
|
will usually be written as a list of RFC5322 addresses or |
| 508 |
|
URIs.</p> |
| 509 |
|
</div> |
| 510 |
|
|
| 511 |
|
<div class="section"> |
| 512 |
|
<hr> |
| 513 |
|
|
| 514 |
|
<h3 class="section"><a name="source-field" id= |
| 515 |
|
"source-field"><code class="varname">Source</code></a></h3> |
| 516 |
|
|
| 517 |
|
<p>Formatted text, no synopsis: an explanation from where |
| 518 |
|
the upstream source came from. Typically this would be a |
| 519 |
|
URL, but it might be a free-form explanation. The Debian |
| 520 |
|
Policy section <a href= |
| 521 |
|
"http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile" |
| 522 |
|
target="_top">12.5</a> requires this information unless |
| 523 |
|
there are no upstream sources, which is mainly the case for |
| 524 |
|
native Debian packages. If the upstream source has been |
| 525 |
|
modified to remove non-free parts, that should be explained |
| 526 |
|
in this field.</p> |
| 527 |
|
</div> |
| 528 |
|
|
| 529 |
|
<div class="section"> |
| 530 |
|
<hr> |
| 531 |
|
|
| 532 |
|
<h3 class="section"><a name="disclaimer-field" id= |
| 533 |
|
"disclaimer-field"><code class= |
| 534 |
|
"varname">Disclaimer</code></a></h3> |
| 535 |
|
|
| 536 |
|
<p>Formatted text, no synopsis: this field can be used in |
| 537 |
|
the case of non-free and contrib packages (see <a href= |
| 538 |
|
"http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile" |
| 539 |
|
target="_top">12.5</a>).</p> |
| 540 |
|
</div> |
| 541 |
|
|
| 542 |
|
<div class="section"> |
| 543 |
|
<hr> |
| 544 |
|
|
| 545 |
|
<h3 class="section"><a name="comment-field" id= |
| 546 |
|
"comment-field"><code class= |
| 547 |
|
"varname">Comment</code></a></h3> |
| 548 |
|
|
| 549 |
|
<p>Formatted text, no synopsis: this field can provide |
| 550 |
|
additional information. For example, it might quote an |
| 551 |
|
e-mail from upstream justifying why the license is |
| 552 |
|
acceptable to the main archive, or an explanation of how |
| 553 |
|
this version of the package has been forked from a version |
| 554 |
|
known to be DFSG-free, even though the current upstream |
| 555 |
|
version is not.</p> |
| 556 |
|
</div> |
| 557 |
|
|
| 558 |
|
<div class="section"> |
| 559 |
|
<hr> |
| 560 |
|
|
| 561 |
|
<h3 class="section"><a name="license-field" id= |
| 562 |
|
"license-field"><code class= |
| 563 |
|
"varname">License</code></a></h3> |
| 564 |
|
|
| 565 |
|
<p>Formatted text, with synopsis. In the header paragraph, |
| 566 |
|
this field gives the license information for the package as |
| 567 |
|
a whole, which may be different or simplified from a |
| 568 |
|
combination of all the per-file license information. In a |
| 569 |
|
Files paragraph, this field gives the licensing terms for |
| 570 |
|
the files listed in the <code class="varname">Files</code> |
| 571 |
|
field for this paragraph. In a stand-alone License |
| 572 |
|
paragraph, it gives the licensing terms for those |
| 573 |
|
paragraphs which reference it.</p> |
| 574 |
|
|
| 575 |
|
<p>First line: an abbreviated name for the license, or |
| 576 |
|
expression giving alternatives (see <a href= |
| 577 |
|
"#license-short-name">Short names</a> section for a list of |
| 578 |
|
standard abbreviations). If there are licenses present in |
| 579 |
|
the package without a standard short name, an arbitrary |
| 580 |
|
short name may be assigned for these licenses. These |
| 581 |
|
arbitrary names are only guaranteed to be unique within a |
| 582 |
|
single copyright file.</p> |
| 583 |
|
|
| 584 |
|
<p>Remaining lines: if left blank here, the file |
| 585 |
|
<span class="emphasis"><i class="emphasis">must</i></span> |
| 586 |
|
include a <a href= |
| 587 |
|
"#stand-alone-license-paragraph">stand-alone License |
| 588 |
|
paragraph</a> matching each license short name listed on |
| 589 |
|
the first line. Otherwise, this field should either include |
| 590 |
|
the full text of the license(s) or include a pointer to the |
| 591 |
|
license file under <tt class= |
| 592 |
|
"filename">/usr/share/common-licenses</tt>. This field |
| 593 |
|
should include all text needed in order to fulfill both |
| 594 |
|
Debian Policy's requirement for including a copy of the |
| 595 |
|
software's distribution license (<a href= |
| 596 |
|
"http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile" |
| 597 |
|
target="_top">12.5</a>), and any license requirements to |
| 598 |
|
include warranty disclaimers or other notices with the |
| 599 |
|
binary package.</p> |
| 600 |
|
</div> |
| 601 |
|
|
| 602 |
|
<div class="section"> |
| 603 |
|
<hr> |
| 604 |
|
|
| 605 |
|
<h3 class="section"><a name="copyright-field" id= |
| 606 |
|
"copyright-field"><code class= |
| 607 |
|
"varname">Copyright</code></a></h3> |
| 608 |
|
|
| 609 |
|
<p>Formatted text, no synopsis: one or more free-form |
| 610 |
|
copyright statement(s). Any formatting is permitted; see |
| 611 |
|
the examples below for some ideas for how to structure the |
| 612 |
|
field to make it easier to read. In the header paragraph, |
| 613 |
|
this field gives the copyright information for the package |
| 614 |
|
as a whole, which may be different or simplified from a |
| 615 |
|
combination of all the per-file copyright information. In |
| 616 |
|
the Files paragraphs, it gives the copyright information |
| 617 |
|
that applies to the files matched by the <code class= |
| 618 |
|
"varname">Files</code> pattern. If a work has no copyright |
| 619 |
|
holder (i.e., it is in the public domain), that information |
| 620 |
|
should be recorded here.</p> |
| 621 |
|
|
| 622 |
|
<p>The <code class="varname">Copyright</code> field |
| 623 |
|
collects all relevant copyright notices for the files of |
| 624 |
|
this paragraph. Not all copyright notices may apply to |
| 625 |
|
every individual file, and years of publication for one |
| 626 |
|
copyright holder may be gathered together. For example, if |
| 627 |
|
file A has:</p> |
| 628 |
|
<pre class="programlisting"> |
| 629 |
|
Copyright 2008 John Smith |
| 630 |
|
Copyright 2009 Angela Watts |
| 631 |
|
</pre>and file B has: |
| 632 |
|
<pre class="programlisting"> |
| 633 |
|
Copyright 2010 Angela Watts |
| 634 |
|
</pre>the <code class="varname">Copyright</code> field for a stanza |
| 635 |
|
covering both file A and file B need contain only: |
| 636 |
|
<pre class="programlisting"> |
| 637 |
|
Copyright 2008 John Smith |
| 638 |
|
Copyright 2009, 2010 Angela Watts |
| 639 |
|
</pre> |
| 640 |
|
|
| 641 |
|
<p>The <code class="varname">Copyright</code> field may |
| 642 |
|
contain the original copyright statement copied exactly |
| 643 |
|
(including the word <span class= |
| 644 |
|
"QUOTE">"Copyright"</span>), or it can shorten the text, as |
| 645 |
|
long as it does not sacrifice information. Examples in this |
| 646 |
|
specification use both forms.</p> |
| 647 |
|
</div> |
| 648 |
|
|
| 649 |
|
<div class="section"> |
| 650 |
|
<hr> |
| 651 |
|
|
| 652 |
|
<h3 class="section"><a name="files-field" id= |
| 653 |
|
"files-field"><code class="varname">Files</code></a></h3> |
| 654 |
|
|
| 655 |
|
<p>Whitespace-separated list: list of patterns indicating |
| 656 |
|
files covered by the license and copyright specified in |
| 657 |
|
this paragraph.</p> |
| 658 |
|
|
| 659 |
|
<p>Filename patterns in the <code class= |
| 660 |
|
"varname">Files</code> field are specified using a |
| 661 |
|
simplified shell glob syntax. Patterns are separated by |
| 662 |
|
whitespace.</p> |
| 663 |
|
|
| 664 |
|
<ul> |
| 665 |
|
<li> |
| 666 |
|
<p>Only the wildcards <tt class="literal">*</tt> and |
| 667 |
|
<tt class="literal">?</tt> apply; the former matches |
| 668 |
|
any number of characters (including none), the latter a |
| 669 |
|
single character. Both match a slash (<tt class= |
| 670 |
|
"literal">/</tt>) and a leading dot.</p> |
| 671 |
|
</li> |
| 672 |
|
|
| 673 |
|
<li> |
| 674 |
|
<p>Patterns match pathnames that start at the root of |
| 675 |
|
the source tree. Thus, <span class="QUOTE">"<tt class= |
| 676 |
|
"filename">Makefile.in</tt>"</span> matches only the |
| 677 |
|
file at the root of the tree, but <span class= |
| 678 |
|
"QUOTE">"<tt class= |
| 679 |
|
"filename">*/Makefile.in</tt>"</span> matches at any |
| 680 |
|
depth.</p> |
| 681 |
|
</li> |
| 682 |
|
|
| 683 |
|
<li> |
| 684 |
|
<p>The backslash (<tt class="literal">\</tt>) is used |
| 685 |
|
to remove the magic from the next character; see table |
| 686 |
|
below.</p> |
| 687 |
|
</li> |
| 688 |
|
</ul> |
| 689 |
|
|
| 690 |
|
<div class="informaltable"> |
| 691 |
|
<a name="AEN229" id="AEN229"></a> |
| 692 |
|
|
| 693 |
|
<table border="1" class="CALSTABLE"> |
| 694 |
|
<col> |
| 695 |
|
<col> |
| 696 |
|
|
| 697 |
|
<thead> |
| 698 |
|
<tr> |
| 699 |
|
<th>Escape sequence</th> |
| 700 |
|
|
| 701 |
|
<th>Matches</th> |
| 702 |
|
</tr> |
| 703 |
|
</thead> |
| 704 |
|
|
| 705 |
|
<tbody> |
| 706 |
|
<tr> |
| 707 |
|
<td><tt class="literal">\*</tt></td> |
| 708 |
|
|
| 709 |
|
<td>star (asterisk)</td> |
| 710 |
|
</tr> |
| 711 |
|
|
| 712 |
|
<tr> |
| 713 |
|
<td><tt class="literal">\?</tt></td> |
| 714 |
|
|
| 715 |
|
<td>question mark</td> |
| 716 |
|
</tr> |
| 717 |
|
|
| 718 |
|
<tr> |
| 719 |
|
<td><tt class="literal">\\</tt></td> |
| 720 |
|
|
| 721 |
|
<td>backslash</td> |
| 722 |
|
</tr> |
| 723 |
|
</tbody> |
| 724 |
|
</table> |
| 725 |
|
</div>Any other character following a backslash is an |
| 726 |
|
error. |
| 727 |
|
|
| 728 |
|
<p>Multiple <code class="varname">Files</code> paragraphs |
| 729 |
|
are allowed. The last paragraph that matches a particular |
| 730 |
|
file applies to it.</p> |
| 731 |
|
|
| 732 |
|
<p>Exclusions are done by having multiple <code class= |
| 733 |
|
"varname">Files</code> paragraphs.</p> |
| 734 |
|
</div> |
| 735 |
|
</div> |
| 736 |
|
|
| 737 |
|
<div class="section"> |
| 738 |
|
<hr> |
| 739 |
|
|
| 740 |
<h2 class="section"><a name="license-specification" id= |
<h2 class="section"><a name="license-specification" id= |
| 741 |
"license-specification">License specification</a></h2> |
"license-specification">License specification</a></h2> |
| 742 |
|
|
| 774 |
requirements in the license of the work regarding |
requirements in the license of the work regarding |
| 775 |
reproduction of legal notices. This information must still |
reproduction of legal notices. This information must still |
| 776 |
be included in the <code class="varname">License</code> |
be included in the <code class="varname">License</code> |
| 777 |
field, either in a stand-alone license paragraph or in the |
field, either in a stand-alone License paragraph or in the |
| 778 |
relevant files paragraph.</p> |
relevant files paragraph.</p> |
| 779 |
|
|
| 780 |
<p>For licenses which have multiple versions in use, the |
<p>For licenses which have multiple versions in use, the |
| 795 |
"_top">SPDX Open Source License Registry</a>.</p> |
"_top">SPDX Open Source License Registry</a>.</p> |
| 796 |
|
|
| 797 |
<div class="informaltable"> |
<div class="informaltable"> |
| 798 |
<a name="AEN234" id="AEN234"></a> |
<a name="AEN274" id="AEN274"></a> |
| 799 |
|
|
| 800 |
<table border="1" class="CALSTABLE"> |
<table border="1" class="CALSTABLE"> |
| 801 |
<col> |
<col> |
| 1138 |
than because of added permissions, a distinct short name |
than because of added permissions, a distinct short name |
| 1139 |
should be used instead of <tt class="literal">with |
should be used instead of <tt class="literal">with |
| 1140 |
<code class="varname"><tt class= |
<code class="varname"><tt class= |
| 1141 |
"replaceable"><i>keywords</i></tt></code>exception</tt>.</p> |
"replaceable"><i>keywords</i></tt></code> |
| 1142 |
|
exception</tt>.</p> |
| 1143 |
|
|
| 1144 |
<p>Only one exception may be specified for each license |
<p>Only one exception may be specified for each license |
| 1145 |
within a given license specification. If more than one |
within a given license specification. If more than one |
| 1337 |
"examples">Examples</a></h2> |
"examples">Examples</a></h2> |
| 1338 |
|
|
| 1339 |
<div class="example"> |
<div class="example"> |
| 1340 |
<a name="AEN463" id="AEN463"></a> |
<a name="AEN503" id="AEN503"></a> |
| 1341 |
|
|
| 1342 |
<p><b>Example 3. Simple</b></p> |
<p><b>Example 3. Simple</b></p> |
| 1343 |
|
|
| 1382 |
</div> |
</div> |
| 1383 |
|
|
| 1384 |
<div class="example"> |
<div class="example"> |
| 1385 |
<a name="AEN470" id="AEN470"></a> |
<a name="AEN510" id="AEN510"></a> |
| 1386 |
|
|
| 1387 |
<p><b>Example 4. Complex</b></p> |
<p><b>Example 4. Complex</b></p> |
| 1388 |
|
|