1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
.\" dpkg manual page - dpkg-scanpackages(1)
.\"
.\" Copyright © 1996 Michael Shields <shields@crosslink.net>
.\" Copyright © 2006 Frank Lichtenheld <djpig@debian.org>
.\" Copyright © 2007, 2009, 2011-2014 Guillem Jover <guillem@debian.org>
.\" Copyright © 2009 Raphaël Hertzog <hertzog@debian.org>
.\"
.\" This is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <https://www.gnu.org/licenses/>.
.
.TH dpkg\-scanpackages 1 "%RELEASE_DATE%" "%VERSION%" "dpkg suite"
.nh
.SH NAME
dpkg\-scanpackages \- create Packages index files
.
.SH SYNOPSIS
.B dpkg\-scanpackages
.RI [ option "...] " binary-path
.RI [ override-file
.RI [ path-prefix ]]
.B >
.I Packages
.
.SH DESCRIPTION
.B dpkg\-scanpackages
sorts through a tree of Debian binary packages and creates a Packages
file, used by
.BR apt (8),
.BR dselect (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
.B dpkg\-scanpackages
yourself if making a directory of local packages to install on a cluster
of machines.
.PP
.B Note:
If you want to access the generated Packages file with
.B apt
you will probably need to compress the file with
.BR xz (1)
(generating a Packages.xz file),
.BR bzip2 (1)
(generating a Packages.bz2 file) or
.BR gzip (1)
(generating a Packages.gz file). apt ignores uncompressed Packages
files except on local access (i.e.
.B file://
sources).
.PP
.I binary-path
is the name of the tree of the binary packages to process (for example,
.BR contrib/binary\-i386 ).
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
.I override-file
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
.BR deb\-override (5).
.PP
.I path-prefix
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
.TP
.BR \-t ", " \-\-type " \fItype\fP"
Scan for *.\fItype\fP packages, instead of *.deb.
.TP
.BR \-e ", " \-\-extra\-override " \fIfile\fP"
Scan \fIfile\fP to find supplementary overrides (the file can be
compressed since dpkg 1.15.5).
See
.BR deb\-extra\-override (5)
for more information on its format.
.TP
.BR \-a ", " \-\-arch " \fIarch\fP"
Use a pattern consisting of \fI*_all.deb\fP and \fI*_arch.deb\fP instead of
scanning for all debs.
.TP
.BR \-h ", " \-\-hash " \fIhash-list\fP"
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\fP, \fBsha1\fP, \fBsha256\fP.
.TP
.BR \-m ", " \-\-multiversion
Include all found packages in the output.
.TP
.BR \-M ", " \-\-medium " \fIid-string\fP"
Add an \fBX\-Medium\fP field containing the value \fIid-string\fP
(since dpkg 1.15.5).
This field is required if you want to generate \fBPackages.cd\fP files
for use by the multicd access method of dselect.
.TP
.BR \-? ", " \-\-help
Show the usage message and exit.
.TP
.BR \-\-version
Show the version and exit.
.
.SH ENVIRONMENT
.TP
.B DPKG_COLORS
Sets the color mode (since dpkg 1.18.5).
The currently accepted values are: \fBauto\fP (default), \fBalways\fP and
\fBnever\fP.
.TP
.B 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\fP and \fB1\fP (default).
.
.SH DIAGNOSTICS
.B dpkg\-scanpackages
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
.ad l
.BR dpkg (1),
.BR dselect (1),
.BR deb\-override (5),
.BR deb\-extra\-override (5),
.BR dpkg\-scansources (1).
|
