dpkg (1.18.25) stretch; urgency=medium
[dpkg] / man / deb-split.man
CommitLineData
1479465f
GJ
1.\" dpkg manual page - deb-split(5)
2.\"
3.\" Copyright © 2009-2012 Guillem Jover <guillem@debian.org>
4.\"
5.\" This is free software; you can redistribute it and/or modify
6.\" it under the terms of the GNU General Public License as published by
7.\" the Free Software Foundation; either version 2 of the License, or
8.\" (at your option) any later version.
9.\"
10.\" This is distributed in the hope that it will be useful,
11.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13.\" GNU General Public License for more details.
14.\"
15.\" You should have received a copy of the GNU General Public License
16.\" along with this program. If not, see <https://www.gnu.org/licenses/>.
17.
18.TH deb\-split 5 "%RELEASE_DATE%" "%VERSION%" "dpkg suite"
19.nh
20.SH NAME
21deb\-split \- Debian multi-part binary package format
22.SH SYNOPSIS
23.IB filename .deb
24.SH DESCRIPTION
25The multi-part \fB.deb\fP format is used to split big packages into smaller
26pieces to ease transport in small media.
27.SH FORMAT
28The file is an \fBar\fP archive with a magic value of \fB!<arch>\fP.
29The file names might contain a trailing slash (since dpkg 1.15.6).
30.PP
31The first member is named \fBdebian\-split\fP and contains a series
32of lines, separated by newlines. Currently eight lines are present:
33.IP • 4
34The format version number, \fB2.1\fP at the time this manual page was
35written.
36.IP •
37The package name.
38.IP •
39The package version.
40.IP •
41The md5sum of the package.
42.IP •
43The total size of the package.
44.IP •
45The maximum part size.
46.IP •
47The current part number, followed by a slash and the total amount of
48parts (as in ‘1/10’).
49.IP •
50The package architecture (since dpkg 1.16.1).
51.PP
52Programs which read multi-part archives should be prepared for the minor
53format version number to be increased and additional lines to be present,
54and should ignore these if this is the case.
55.PP
56If the major format version number has changed, an incompatible change has
57been made and the program should stop. If it has not, then the program should
58be able to safely continue, unless it encounters an unexpected member
59in the archive (except at the end), as described below.
60.PP
61The second, last required member is named \fBdata.\fP\fIN\fP, where \fIN\fP
62denotes the part number. It contains the raw part data.
63.PP
64These members must occur in this exact order. Current implementations
65should ignore any additional members after \fBdata.\fP\fIN\fP.
66Further members may be defined in the future, and (if possible) will be
67placed after these two.
68.SH SEE ALSO
69.BR deb (5),
70.BR dpkg\-split (1).