man/dpkg-scanpackages.pod

   1 # dpkg manual page - dpkg-scanpackages(1)
   2 #
   3 # Copyright © 1996 Michael Shields <shields@crosslink.net>
   4 # Copyright © 2006 Frank Lichtenheld <djpig@debian.org>
   5 # Copyright © 2007, 2009, 2011-2014 Guillem Jover <guillem@debian.org>
   6 # Copyright © 2009 Raphaël Hertzog <hertzog@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 dpkg-scanpackages - create Packages index files
  26
  27 =head1 SYNOPSIS
  28
  29 B<dpkg-scanpackages>
  30 [I<option>...] I<binary-path>
  31 [I<override-file>
  32 [I<path-prefix>]]
  33 B<E<gt>>
  34 I<Packages>
  35
  36 =head1 DESCRIPTION
  37
  38 B<dpkg-scanpackages>
  39 sorts through a tree of Debian binary packages and creates a Packages
  40 file, used by
  41 B<apt>(8),
  42 B<dselect>(1),
  43 etc, to tell the user what packages are available for installation. These
  44 Packages files are the same as those found on Debian archive sites
  45 and CD-ROMs. You might use
  46 B<dpkg-scanpackages>
  47 yourself if making a directory of local packages to install on a cluster
  48 of machines.
  49
  50 B<Note>:
  51 If you want to access the generated Packages file with
  52 B<apt>(8)
  53 you will probably need to compress the file with
  54 B<xz>(1)
  55 (generating a Packages.xz file),
  56 B<bzip2>(1)
  57 (generating a Packages.bz2 file) or
  58 B<gzip>(1)
  59 (generating a Packages.gz file).
  60 B<apt>(8)
  61 ignores uncompressed Packages files except on local access (i.e.
  62 B<file://>
  63 sources).
  64
  65 I<binary-path>
  66 is the name of the tree of the binary packages to process (for example,
  67 B<contrib/binary-i386>).
  68 It is best to make this relative to the root of the Debian archive,
  69 because every Filename field in the new Packages file will start with
  70 this string.
  71
  72 I<override-file>
  73 is the name of a file to read which contains information about how the
  74 package fits into the distribution (the file can be compressed
  75 since dpkg 1.15.5); see
  76 B<deb-override>(5).
  77
  78 I<path-prefix>
  79 is an optional string to be prepended to the Filename fields.
  80
  81 If more than one version of a package is found only the newest one
  82 is included in the output. If they have the same version and only
  83 differ in architecture only the first one found is used.
  84
  85 =head1 OPTIONS
  86
  87 =over
  88
  89 =item B<-t>, B<--type> I<type>
  90
  91 Scan for *.I<type> packages, instead of *.deb.
  92
  93 =item B<-e>, B<--extra-override> I<file>
  94
  95 Scan I<file> to find supplementary overrides (the file can be
  96 compressed since dpkg 1.15.5).
  97 See
  98 B<deb-extra-override>(5)
  99 for more information on its format.
 100
 101 =item B<-a>, B<--arch> I<arch>
 102
 103 Use a pattern consisting of I<*_all.deb> and I<*_arch.deb> instead of
 104 scanning for all debs.
 105
 106 =item B<-h>, B<--hash> I<hash-list>
 107
 108 Only generate file hashes for the comma-specified list specified
 109 (since dpkg 1.17.14).
 110 The default is to generate all currently supported hashes.
 111 Supported values: B<md5>, B<sha1>, B<sha256>.
 112
 113 =item B<-m>, B<--multiversion>
 114
 115 Include all found packages in the output.
 116
 117 =item B<-M>, B<--medium> I<id-string>
 118
 119 Add an B<X-Medium> field containing the value I<id-string>
 120 (since dpkg 1.15.5).
 121 This field is required if you want to generate B<Packages.cd> files
 122 for use by the B<media> access method of B<dselect>.
 123
 124 =item B<-?>, B<--help>
 125
 126 Show the usage message and exit.
 127
 128 =item B<--version>
 129
 130 Show the version and exit.
 131
 132 =back
 133
 134 =head1 ENVIRONMENT
 135
 136 =over
 137
 138 =item B<DPKG_COLORS>
 139
 140 Sets the color mode (since dpkg 1.18.5).
 141 The currently accepted values are: B<auto> (default), B<always> and
 142 B<never>.
 143
 144 =item B<DPKG_NLS>
 145
 146 If set, it will be used to decide whether to activate Native Language Support,
 147 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 148 The accepted values are: B<0> and B<1> (default).
 149
 150 =back
 151
 152 =head1 DIAGNOSTICS
 153
 154 B<dpkg-scanpackages>
 155 outputs the usual self-explanatory errors. It also warns about packages
 156 that are in the wrong subdirectory, are duplicated, have a Filename
 157 field in their control file, are missing from the override file, or have
 158 maintainer substitutions which do not take effect.
 159
 160 =head1 SEE ALSO
 161
 162 B<dpkg>(1),
 163 B<dselect>(1),
 164 B<deb-override>(5),
 165 B<deb-extra-override>(5),
 166 B<dpkg-scansources>(1).