From b86570f63e533abcbcb97c2572e0e5732a96307b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 11:40:31 +0200 Subject: Adding upstream version 1.20.13. Signed-off-by: Daniel Baumann --- man/dsc.pod | 285 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 285 insertions(+) create mode 100644 man/dsc.pod (limited to 'man/dsc.pod') diff --git a/man/dsc.pod b/man/dsc.pod new file mode 100644 index 0000000..eb87e89 --- /dev/null +++ b/man/dsc.pod @@ -0,0 +1,285 @@ +# dpkg manual page - dsc(5) +# +# Copyright © 1995-1996 Ian Jackson +# Copyright © 2015 Guillem Jover +# +# This is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +=encoding utf8 + +=head1 NAME + +dsc - Debian source packages' control file format + +=head1 SYNOPSIS + +IB<.dsc> + +=head1 DESCRIPTION + +Each Debian source package is composed of a .dsc control file, which +contains a number of fields, in L format. + +Each field begins with a tag, such as +B +or +B +(case insensitive), followed by a colon, and the body of the field +(case sensitive unless stated otherwise). +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, B, B and B, +see below). + +The control data might be enclosed in an OpenPGP ASCII Armored signature, +as specified in RFC4880. + +=head1 FIELDS + +=over + +=item B I (required) + +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. + +The source formats currently supported by B are B<1.0>, +B<2.0>, B<3.0 (native)>, B<3.0 (quilt)>, B<3.0 (git)>, +B<3.0 (bzr)> and B<3.0 (custom)>. +See B(1) for their description. + +=item B I (required) + +The value of this field determines the package name, and is used to +generate file names by most installation tools. + +=item B I + +This folded field lists binary packages which this source package can produce, +separated by commas. + +This field has now been superseded by the B field, which +gives enough information about what binary packages are produced on which +architecture, build-profile and other involved restrictions. + +=item B I (recommended) + +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, +B, B, B, B, etc. + +Note that the B value is meant for packages that are architecture +independent, and B for packages that are architecture dependent. +The list may include (or consist solely of) the special value B. +When the list contains the architecture wildcard B, the only +other value allowed in the list is B. + +The field value is generally generated from B fields +from in the I in the source package. + +=item B I (required) + +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(7). + +=item B I + +The name of the distribution this package is originating from. + +=item B I (recommended) + +Should be in the format “Joe Bloggs Ejbloggs@foo.comE”, and is +typically the person who created the package, as opposed to the author +of the software that was packaged. + +=item B I + +Lists all the names and email addresses of co-maintainers of the package, +in the same format as the B field. +Multiple co-maintainers should be separated by a comma. + +=item B I + +=item B<> I + +The format for the source package description is a short brief summary on the +first line (after the 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<.>’ following +the preceding space. + +=item B I + +The upstream project home page I. + +=item B I (recommended) + +This documents the most recent version of the distribution policy standards +this package complies with. + +=item B I + +The I of a web interface to browse the Version Control System +repository. + +=item B I + +=item B I + +=item B I + +=item B I + +=item B I + +=item B I + +=item B I + +=item B I + +These fields declare the I of the Version Control System repository +used to maintain this package. +See B(5) for more details. + +=item B I + +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 value is present, a I is +expected to be present, if the file is present but not the value, then +B will automatically add it, preserving previous values. + +=item B I + +This field declares the comma-separated union of all test dependencies +(B fields in 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<@>. + +Rationale: this field is needed because otherwise to be able to get the +test dependencies, each source package would need to be unpacked. + +=item B I + +=item B I + +=item B I + +=item B I + +=item B I + +=item B I + +These fields declare relationships between the source package and packages +used to build it. +They are discussed in the B(5) manpage. + +=item B + +=item S< >I I I
I I + +This multiline field contains a list of binary packages generated by this +source package. + +The I is the binary package name. + +The I is the binary package type, usually B, another +common value is B. + +The I
and I match the binary package fields of the +same name. + +The I is a space separated IB<=>I list, +and the currently known optional keys are: + +=over + +=item B + +The architecture restriction from the binary package B +field, with spaces converted to ‘,’. + +=item B + +The normalized build-profile restriction formula from the binary package +B field, with ORs converted to ‘+’ and ANDs to +‘,’. + +=item B + +If the binary package is protected, this key will contain the value of the +B field, that is a B value. + +=item B + +If the binary package is essential, this key will contain the value of the +B field, that is a B value. + +=back + +=item B (required) + +=item B (required) + +=item B (required) + +=item S< >I I 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, SHA-1 for B and SHA-256 for +B. + +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. + +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. + +=back + +=head1 BUGS + +The B field conflates the format for the B<.dsc> file itself +and the format of the extracted source package. + +=head1 SEE ALSO + +L, +B(5), +B(7), +B(1). -- cgit v1.2.3