319 lines
10 KiB
HTML
319 lines
10 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of dsc</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>dsc</H1>
|
|
Section: dpkg suite (5)<BR>Updated: 2020-03-23<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
dsc - Debian source packages' control file format
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<I>filename</I><B>.dsc</B>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
Each Debian source package is composed of a .dsc control file, which
|
|
contains a number of fields.
|
|
Each field begins with a tag, such as
|
|
<B>Source</B>
|
|
|
|
or
|
|
<B>Binary</B>
|
|
|
|
(case insensitive), followed by a colon, and the body of the field.
|
|
Fields are delimited only by field tags.
|
|
In other words, field text may be multiple lines in length, but the
|
|
installation tools will generally join lines when processing the body
|
|
of the field (except in case of the multiline fields
|
|
<B>Package-List</B>, <B>Files</B>, <B>Checksums-Sha1</B> and <B>Checksums-Sha256</B>,
|
|
|
|
see below).
|
|
<P>
|
|
|
|
The control data might be enclosed in an OpenPGP ASCII Armored signature,
|
|
as specified in RFC4880.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>FIELDS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>Format:</B> <I>format-version</I> (required)
|
|
|
|
<DD>
|
|
The value of this field declares the format version of the source package.
|
|
The field value is used by programs acting on a source package to
|
|
interpret the list of files in the source package and determine how
|
|
to unpack it.
|
|
The syntax of the field value is a numeric major revision ("0-9"), a
|
|
period ("."), a numeric minor revision ("0-9"), and then an optional
|
|
subtype after whitespace (" \t"), which if specified is a lowercase
|
|
alphanumeric ("a-z0-9") word in parentheses ("()").
|
|
The subtype is optional in the syntax but may be mandatory for particular
|
|
source format revisions.
|
|
<P>
|
|
The source formats currently supported by <B>dpkg</B> are <B>1.0</B>,
|
|
<B>2.0</B>, <B>3.0 (native)</B>, <B>3.0 (quilt)</B>, <B>3.0 (git)</B>,
|
|
<B>3.0 (bzr)</B> and <B>3.0 (custom)</B>.
|
|
See <B><A HREF="/cgi-bin/man/man2html?1+dpkg-source">dpkg-source</A></B>(1) for their description.
|
|
<DT id="2"><B>Source:</B> <I>source-name</I> (required)
|
|
|
|
<DD>
|
|
The value of this field determines the package name, and is used to
|
|
generate file names by most installation tools.
|
|
<DT id="3"><B>Binary:</B><I> binary-package-list</I>
|
|
|
|
<DD>
|
|
This folded field lists binary packages which this source package can produce,
|
|
separated by commas.
|
|
<P>
|
|
This field has now been superseded by the <B>Package-List</B> field, which
|
|
gives enough information about what binary packages are produced on which
|
|
architecture, build-profile and other involved restrictions.
|
|
<DT id="4"><B>Architecture:</B> <I>arch-list</I> (recommended)
|
|
|
|
<DD>
|
|
A list of architectures and architecture wildcards separated by spaces
|
|
which specify the type of hardware this package can be compiled for.
|
|
Common architecture names and architecture wildcards are <B>amd64</B>,
|
|
<B>armel</B>, <B>i386</B>, <B>linux-any</B>, <B>any-amd64</B>, etc.
|
|
<P>
|
|
Note that the <B>all</B> value is meant for packages that are architecture
|
|
independent, and <B>any</B> for packages that are architecture dependent.
|
|
The list may include (or consist solely of) the special value <B>all</B>.
|
|
When the list contains the architecture wildcard <B>any</B>, the only
|
|
other value allowed in the list is <B>all</B>.
|
|
<P>
|
|
The field value is generally generated from <B>Architecture</B> fields
|
|
from in the <I>debian/control</I> in the source package.
|
|
<DT id="5"><B>Version:</B> <I>version-string</I> (required)
|
|
|
|
<DD>
|
|
Typically, this is the original package's version number in whatever form
|
|
the program's author uses.
|
|
It may also include a Debian revision number (for non-native packages).
|
|
The exact format and sorting algorithm are described in
|
|
<B><A HREF="/cgi-bin/man/man2html?7+deb-version">deb-version</A></B>(7).
|
|
|
|
<DT id="6"><B>Origin:</B><I> name</I>
|
|
|
|
<DD>
|
|
The name of the distribution this package is originating from.
|
|
<DT id="7"><B>Maintainer:</B> <I>fullname-email</I> (recommended)
|
|
|
|
<DD>
|
|
Should be in the format "Joe Bloggs <<A HREF="mailto:jbloggs@foo.com">jbloggs@foo.com</A>>", and is
|
|
typically the person who created the package, as opposed to the author
|
|
of the software that was packaged.
|
|
<DT id="8"><B>Uploaders:</B><I> fullname-email-list</I>
|
|
|
|
<DD>
|
|
Lists all the names and email addresses of co-maintainers of the package,
|
|
in the same format as the <B>Maintainer</B> field.
|
|
Multiple co-maintainers should be separated by a comma.
|
|
<DT id="9"><B>Description</B><I> short-description</I>
|
|
|
|
<DD>
|
|
|
|
<B> </B><I>long-description</I>
|
|
|
|
The format for the source package description is a short brief summary on the
|
|
first line (after the <B>Description</B> field).
|
|
The following lines should be used as a longer, more detailed description.
|
|
Each line of the long description must be preceded by a space, and blank
|
|
lines in the long description must contain a single '<B>.</B>' following
|
|
the preceding space.
|
|
<DT id="10"><B>Homepage:</B><I> url</I>
|
|
|
|
<DD>
|
|
The upstream project home page <I>url</I>.
|
|
<DT id="11"><B>Standards-Version:</B> <I>version-string</I> (recommended)
|
|
|
|
<DD>
|
|
This documents the most recent version of the distribution policy standards
|
|
this package complies with.
|
|
<DT id="12"><B>Vcs-Browser:</B><I> url</I>
|
|
|
|
<DD>
|
|
The <I>url</I> of a web interface to browse the Version Control System
|
|
repository.
|
|
<DT id="13"><B>Vcs-Arch:</B><I> url</I>
|
|
|
|
<DD>
|
|
|
|
<B>Vcs-Bzr:</B><I> url</I>
|
|
|
|
|
|
<B>Vcs-Cvs:</B><I> url</I>
|
|
|
|
|
|
<B>Vcs-Darcs:</B><I> url</I>
|
|
|
|
|
|
<B>Vcs-Git:</B><I> url</I>
|
|
|
|
|
|
<B>Vcs-Hg:</B><I> url</I>
|
|
|
|
|
|
<B>Vcs-Mtn:</B><I> url</I>
|
|
|
|
|
|
<B>Vcs-Svn:</B><I> url</I>
|
|
|
|
These fields declare the <I>url</I> of the Version Control System repository
|
|
used to maintain this package.
|
|
See <B><A HREF="/cgi-bin/man/man2html?5+deb-src-control">deb-src-control</A></B>(5) for more details.
|
|
<DT id="14"><B>Testsuite:</B><I> name-list</I>
|
|
|
|
<DD>
|
|
This field declares that the source package contains the specified test suites.
|
|
The value is a comma-separated list of test suites.
|
|
If the <B>autopkgtest</B> value is present, a <I>debian/tests/control</I> is
|
|
expected to be present, if the file is present but not the value, then
|
|
<B>dpkg-source</B> will automatically add it, preserving previous values.
|
|
<DT id="15"><B>Testsuite-Triggers:</B><I> package-list</I>
|
|
|
|
<DD>
|
|
This field declares the comma-separated union of all test dependencies
|
|
(<B>Depends</B> fields in <I>debian/tests/control</I> file), with all
|
|
restrictions removed, and OR dependencies flattened (that is, converted to
|
|
separate AND relationships), except for binaries generated by this source
|
|
package and its meta-dependency equivalent <B>@</B>.
|
|
<P>
|
|
Rationale: this field is needed because otherwise to be able to get the
|
|
test dependencies, each source package would need to be unpacked.
|
|
<DT id="16"><B>Build-Depends:</B><I> package-list</I>
|
|
|
|
<DD>
|
|
|
|
<B>Build-Depends-Arch:</B><I> package-list</I>
|
|
|
|
|
|
<B>Build-Depends-Indep:</B><I> package-list</I>
|
|
|
|
|
|
<B>Build-Conflicts:</B><I> package-list</I>
|
|
|
|
|
|
<B>Build-Conflicts-Arch:</B><I> package-list</I>
|
|
|
|
|
|
<B>Build-Conflicts-Indep:</B><I> package-list</I>
|
|
|
|
These fields declare relationships between the source package and packages
|
|
used to build it.
|
|
They are discussed in the <B><A HREF="/cgi-bin/man/man2html?5+deb-src-control">deb-src-control</A></B>(5) manpage.
|
|
<DT id="17"><B>Package-List:</B>
|
|
|
|
<DD>
|
|
|
|
<I>package</I> <I>package-type</I> <I>section</I> <I>priority</I> <I>key-value-list</I>
|
|
|
|
This multiline field contains a list of binary packages generated by this
|
|
source package.
|
|
<P>
|
|
The <I>package</I> is the binary package name.
|
|
<P>
|
|
The <I>package-type</I> is the binary package type, usually <B>deb</B>, another
|
|
common value is <B>udeb</B>.
|
|
<P>
|
|
The <I>section</I> and <I>priority</I> match the binary package fields of the
|
|
same name.
|
|
<P>
|
|
The <I>key-value-list</I> is a space separated <I>key</I><B>=</B><I>value</I> list,
|
|
and the currently known optional keys are:
|
|
<P>
|
|
<DL COMPACT><DT id="18"><DD>
|
|
<DL COMPACT>
|
|
<DT id="19"><B>arch</B>
|
|
|
|
<DD>
|
|
The architecture restriction from the binary package <B>Architecture</B>
|
|
field, with spaces converted to ','.
|
|
<DT id="20"><B>profile</B>
|
|
|
|
<DD>
|
|
The normalized build-profile restriction formula from the binary package
|
|
<B>Build-Profile</B> field, with ORs converted to '+' and ANDs to
|
|
','.
|
|
<DT id="21"><B>essential</B>
|
|
|
|
<DD>
|
|
If the binary package is essential, this key will contain the value of the
|
|
<B>Essential</B> field, that is a <B>yes</B> value.
|
|
</DL>
|
|
</DL>
|
|
|
|
<DT id="22"><B>Files:</B> (required)
|
|
|
|
<DD>
|
|
|
|
<B>Checksums-Sha1:</B> (required)
|
|
|
|
|
|
<B>Checksums-Sha256:</B> (required)
|
|
|
|
|
|
<I>checksum</I> <I>size</I> <I>filename</I>
|
|
|
|
These multiline fields contain a list of files with a checksum and size
|
|
for each one.
|
|
These fields have the same syntax and differ only in the checksum algorithm
|
|
used: MD5 for <B>Files</B>, SHA-1 for <B>Checksums-Sha1</B> and SHA-256 for
|
|
<B>Checksums-Sha256</B>.
|
|
<P>
|
|
The first line of the field value (the part on the same line as the field
|
|
name followed by a colon) is always empty.
|
|
The content of the field is expressed as continuation lines, one line per file.
|
|
Each line consists of the checksum, a space, the file size, a space, and the
|
|
file name.
|
|
<P>
|
|
These fields list all files that make up the source package.
|
|
The list of files in these fields must match the list of files in the
|
|
other related fields.
|
|
|
|
|
|
|
|
|
|
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
The <B>Format</B> field conflates the format for the <B>.dsc</B> file itself
|
|
and the format of the extracted source package.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+deb-src-control">deb-src-control</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+deb-version">deb-version</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+dpkg-source">dpkg-source</A></B>(1).
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="23"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="24"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="25"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="26"><A HREF="#lbAE">FIELDS</A><DD>
|
|
<DT id="27"><A HREF="#lbAF">BUGS</A><DD>
|
|
<DT id="28"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:03 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|