man: Document version when new programs where introduced
[dpkg.git] / man / deb-split.pod
blob1d8cbb1c0a3f00968d7d283c02e46f6bb0734b18
1 # dpkg manual page - deb-split(5)
3 # Copyright © 2009-2012 Guillem Jover <guillem@debian.org>
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.
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.
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/>.
18 =encoding utf8
20 =head1 NAME
22 deb-split - Debian multi-part binary package format
24 =head1 SYNOPSIS
26 I<filename>B<.deb>
28 =head1 DESCRIPTION
30 The multi-part B<.deb> format is used to split big packages into smaller
31 pieces to ease transport in small media.
33 =head1 FORMAT
35 The file is an B<ar> archive with a magic value of B<!E<lt>archE<gt>>.
36 The file names might contain a trailing slash (since dpkg 1.15.6).
38 The first member is named B<debian-split> and contains a series
39 of lines, separated by newlines. Currently eight lines are present:
41 =over
43 =item *
45 The format version number, B<2.1> at the time this manual page was
46 written.
48 =item *
50 The package name.
52 =item *
54 The package version.
56 =item *
58 The md5sum of the package.
60 =item *
62 The total size of the package.
64 =item *
66 The maximum part size.
68 =item *
70 The current part number, followed by a slash and the total amount of
71 parts (as in ‘1/10’).
73 =item *
75 The package architecture (since dpkg 1.16.1).
77 =back
79 Programs which read multi-part archives should be prepared for the minor
80 format version number to be increased and additional lines to be present,
81 and should ignore these if this is the case.
83 If the major format version number has changed, an incompatible change has
84 been made and the program should stop. If it has not, then the program should
85 be able to safely continue, unless it encounters an unexpected member
86 in the archive (except at the end), as described below.
88 The second, last required member is named B<data.>I<N>, where I<N>
89 denotes the part number. It contains the raw part data.
91 These members must occur in this exact order. Current implementations
92 should ignore any additional members after B<data.>I<N>.
93 Further members may be defined in the future, and (if possible) will be
94 placed after these two.
96 =head1 SEE ALSO
98 B<deb>(5),
99 B<dpkg-split>(1).