man/deb.pod

   1 # dpkg manual page - deb(5)
   2 #
   3 # Copyright © 1995 Raul Miller
   4 # Copyright © 1996 Ian Jackson <ijackson@chiark.greenend.org.uk>
   5 # Copyright © 2000 Wichert Akkerman <wakkerma@debian.org>
   6 # Copyright © 2006-2017 Guillem Jover <guillem@debian.org>
   7 #
   8 # This is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  20
  21 =encoding utf8
  22
  23 =head1 NAME
  24
  25 deb - Debian binary package format
  26
  27 =head1 SYNOPSIS
  28
  29 I<filename>B<.deb>
  30
  31 =head1 DESCRIPTION
  32
  33 The
  34 B<.deb>
  35 format is the Debian binary package file format. It is understood
  36 since dpkg 0.93.76, and is generated by default since dpkg 1.2.0 and
  37 1.1.1elf (i386/ELF builds).
  38
  39 The format described here is used since Debian 0.93; details of the
  40 old format are described in
  41 B<deb-old>(5).
  42
  43 =head1 FORMAT
  44
  45 The file is an
  46 B<ar>
  47 archive with a magic value of
  48 B<!E<lt>archE<gt>>.
  49 Only the common B<ar> archive format is supported, with no long file
  50 name extensions, but with file names containing an optional trailing
  51 slash, which limits their length to 15 characters (from the 16 allowed).
  52 File sizes are limited to 10 ASCII decimal digits, allowing for up to
  53 approximately 9536.74 MiB member files.
  54
  55 The B<tar> archives currently allowed are, the old-style (v7) format,
  56 the pre-POSIX ustar format, a subset of the GNU format (new style long
  57 pathnames and long linknames, supported since dpkg 1.4.1.17; large file
  58 metadata since dpkg 1.18.24),
  59 and the POSIX ustar format (long names supported since dpkg 1.15.0).
  60 Unrecognized tar typeflags are considered an error.
  61 Each tar entry size inside a tar archive is limited to 11 ASCII octal
  62 digits, allowing for up to 8 GiB tar entries.
  63 The GNU large file metadata support permits 95-bit tar entry sizes and
  64 negative timestamps, and 63-bit UID, GID and device numbers.
  65
  66 The first member is named
  67 B<debian-binary>
  68 and contains a series of lines, separated by newlines. Currently only
  69 one line is present, the format version number,
  70 B<2.0>
  71 at the time this manual page was written.
  72 Programs which read new-format archives should be prepared for the
  73 minor number to be increased and new lines to be present, and should
  74 ignore these if this is the case.
  75
  76 If the major number has changed, an incompatible change has been made
  77 and the program should stop. If it has not, then the program should
  78 be able to safely continue, unless it encounters an unexpected member
  79 in the archive (except at the end), as described below.
  80
  81 The second required member is named
  82 B<control.tar>.
  83 It is a tar archive containing the package control information, either
  84 not compressed (supported since dpkg 1.17.6), or compressed with
  85 gzip (with B<.gz> extension) or
  86 xz (with B<.xz> extension, supported since 1.17.6),
  87 zstd (with B<.zst> extension, supported since dpkg 1.21.18),
  88 as a series of plain files, of which the file
  89 B<control>
  90 is mandatory and contains the core control information, the
  91 B<md5sums>,
  92 B<conffiles>, B<triggers>, B<shlibs>
  93 and
  94 B<symbols>
  95 files contain optional control information, and the
  96 B<preinst>, B<postinst>, B<prerm>
  97 and
  98 B<postrm>
  99 files are optional maintainer scripts.
 100 The control tarball may optionally contain an entry for
 101 ‘B<.>’,
 102 the current directory.
 103
 104 The third, last required member is named
 105 B<data.tar>.
 106 It contains the filesystem as a tar archive, either
 107 not compressed (supported since dpkg 1.10.24), or compressed with
 108 gzip (with B<.gz> extension),
 109 xz (with B<.xz> extension, supported since dpkg 1.15.6),
 110 zstd (with B<.zst> extension, supported since dpkg 1.21.18),
 111 bzip2 (with B<.bz2> extension, supported since dpkg 1.10.24) or
 112 lzma (with B<.lzma> extension, supported since dpkg 1.13.25).
 113
 114 These members must occur in this exact order. Current implementations
 115 should ignore any additional members after
 116 B<data.tar>.
 117 Further members may be defined in the future, and (if possible) will be
 118 placed after these three. Any additional members that may need to be
 119 inserted after
 120 B<debian-binary>
 121 and before
 122 B<control.tar>
 123 or
 124 B<data.tar>
 125 and which should be safely ignored by older programs, will have names
 126 starting with an underscore,
 127 ‘B<_>’.
 128
 129 Those new members which won't be able to be safely ignored will be
 130 inserted before
 131 B<data.tar>
 132 with names starting with something other than underscores, or will
 133 (more likely) cause the major version number to be increased.
 134
 135 =head1 MEDIA TYPE
 136
 137 =head2 Current
 138
 139 application/vnd.debian.binary-package
 140
 141 =head2 Deprecated
 142
 143 application/x-debian-package
 144
 145 application/x-deb
 146
 147 =head1 SEE ALSO
 148
 149 B<deb-old>(5),
 150 B<dpkg-deb>(1),
 151 B<deb-control>(5),
 152 B<deb-conffiles>(5),
 153 B<deb-md5sums>(5),
 154 B<deb-triggers>(5),
 155 B<deb-shlibs>(5),
 156 B<deb-symbols>(5),
 157 B<deb-preinst>(5),
 158 B<deb-postinst>(5),
 159 B<deb-prerm>(5),
 160 B<deb-postrm>(5).