.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "dpkg-scanpackages 1"
.TH dpkg-scanpackages 1 "2022-09-01" "1.20.12" "dpkg suite"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
dpkg\-scanpackages \- create Packages index files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdpkg-scanpackages\fR
[\fIoption\fR...] \fIbinary-path\fR
[\fIoverride-file\fR
[\fIpath-prefix\fR]]
\&\fB>\fR
\&\fIPackages\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdpkg-scanpackages\fR
sorts through a tree of Debian binary packages and creates a Packages
file, used by
\&\fBapt\fR(8),
\&\fBdselect\fR(1),
etc, to tell the user what packages are available for installation. These
Packages files are the same as those found on Debian archive sites
and CD-ROMs. You might use
\&\fBdpkg-scanpackages\fR
yourself if making a directory of local packages to install on a cluster
of machines.
.PP
\&\fBNote:\fR
If you want to access the generated Packages file with
\&\fBapt\fR(8)
you will probably need to compress the file with
\&\fBxz\fR(1)
(generating a Packages.xz file),
\&\fBbzip2\fR(1)
(generating a Packages.bz2 file) or
\&\fBgzip\fR(1)
(generating a Packages.gz file).
\&\fBapt\fR(8)
ignores uncompressed Packages files except on local access (i.e.
\&\fBfile://\fR
sources).
.PP
\&\fIbinary-path\fR
is the name of the tree of the binary packages to process (for example,
\&\fBcontrib/binary\-i386\fR).
It is best to make this relative to the root of the Debian archive,
because every Filename field in the new Packages file will start with
this string.
.PP
\&\fIoverride-file\fR
is the name of a file to read which contains information about how the
package fits into the distribution (the file can be compressed
since dpkg 1.15.5); see
\&\fBdeb-override\fR(5).
.PP
\&\fIpath-prefix\fR
is an optional string to be prepended to the Filename fields.
.PP
If more than one version of a package is found only the newest one
is included in the output. If they have the same version and only
differ in architecture only the first one found is used.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-t\fR, \fB\-\-type\fR \fItype\fR" 4
.IX Item "-t, --type type"
Scan for *.\fItype\fR packages, instead of *.deb.
.IP "\fB\-e\fR, \fB\-\-extra\-override\fR \fIfile\fR" 4
.IX Item "-e, --extra-override file"
Scan \fIfile\fR to find supplementary overrides (the file can be
compressed since dpkg 1.15.5).
See
\&\fBdeb-extra-override\fR(5)
for more information on its format.
.IP "\fB\-a\fR, \fB\-\-arch\fR \fIarch\fR" 4
.IX Item "-a, --arch arch"
Use a pattern consisting of \fI*_all.deb\fR and \fI*_arch.deb\fR instead of
scanning for all debs.
.IP "\fB\-h\fR, \fB\-\-hash\fR \fIhash-list\fR" 4
.IX Item "-h, --hash hash-list"
Only generate file hashes for the comma-specified list specified
(since dpkg 1.17.14).
The default is to generate all currently supported hashes.
Supported values: \fBmd5\fR, \fBsha1\fR, \fBsha256\fR.
.IP "\fB\-m\fR, \fB\-\-multiversion\fR" 4
.IX Item "-m, --multiversion"
Include all found packages in the output.
.IP "\fB\-M\fR, \fB\-\-medium\fR \fIid-string\fR" 4
.IX Item "-M, --medium id-string"
Add an \fBX\-Medium\fR field containing the value \fIid-string\fR
(since dpkg 1.15.5).
This field is required if you want to generate \fBPackages.cd\fR files
for use by the multicd access method of dselect.
.IP "\fB\-?\fR, \fB\-\-help\fR" 4
.IX Item "-?, --help"
Show the usage message and exit.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Show the version and exit.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\fB\s-1DPKG_COLORS\s0\fR" 4
.IX Item "DPKG_COLORS"
Sets the color mode (since dpkg 1.18.5).
The currently accepted values are: \fBauto\fR (default), \fBalways\fR and
\&\fBnever\fR.
.IP "\fB\s-1DPKG_NLS\s0\fR" 4
.IX Item "DPKG_NLS"
If set, it will be used to decide whether to activate Native Language Support,
also known as internationalization (or i18n) support (since dpkg 1.19.0).
The accepted values are: \fB0\fR and \fB1\fR (default).
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
\&\fBdpkg-scanpackages\fR
outputs the usual self-explanatory errors. It also warns about packages
that are in the wrong subdirectory, are duplicated, have a Filename
field in their control file, are missing from the override file, or have
maintainer substitutions which do not take effect.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdpkg\fR(1),
\&\fBdselect\fR(1),
\&\fBdeb-override\fR(5),
\&\fBdeb-extra-override\fR(5),
\&\fBdpkg-scansources\fR(1).