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