Commit | Line | Data |
---|---|---|
1479465f GJ |
1 | .\" dpkg manual page - dpkg-scansources(1) |
2 | .\" | |
3 | .\" Copyright © 2005 Roderick Schertler <roderick@argon.org> | |
4 | .\" Copyright © 2006 Frank Lichtenheld <djpig@debian.org> | |
5 | .\" Copyright © 2009 Raphaël Hertzog <hertzog@debian.org> | |
6 | .\" | |
7 | .\" This is free software; you can redistribute it and/or modify | |
8 | .\" it under the terms of the GNU General Public License as published by | |
9 | .\" the Free Software Foundation; either version 2 of the License, or | |
10 | .\" (at your option) any later version. | |
11 | .\" | |
12 | .\" This is distributed in the hope that it will be useful, | |
13 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | .\" GNU General Public License for more details. | |
16 | .\" | |
17 | .\" You should have received a copy of the GNU General Public License | |
18 | .\" along with this program. If not, see <https://www.gnu.org/licenses/>. | |
19 | . | |
20 | .TH dpkg\-scansources 1 "%RELEASE_DATE%" "%VERSION%" "dpkg suite" | |
21 | .nh | |
22 | .SH NAME | |
23 | dpkg\-scansources \- create Sources index files | |
24 | . | |
25 | .SH SYNOPSIS | |
26 | .B dpkg\-scansources | |
27 | .RI [ option "...] " binary-dir | |
28 | .RI [ override-file | |
29 | .RI [ path-prefix ]] | |
30 | .B > | |
31 | .I Sources | |
32 | . | |
33 | .SH DESCRIPTION | |
34 | \fBdpkg\-scansources\fR scans the given \fIbinary-dir\fR for \fI.dsc\fR files. | |
35 | These are used to create a Debian source index, which is output to | |
36 | stdout. | |
37 | .PP | |
38 | The \fIoverride-file\fR, if given, is used to set priorities in the resulting | |
39 | index records and to override the maintainer field given in the \fI.dsc\fR | |
40 | files. | |
41 | The file can be compressed (since dpkg 1.15.5). | |
42 | See | |
43 | .BR deb\-override (5) | |
44 | for the format of this file. Note: Since | |
45 | the override file is indexed by binary, not source packages, there's a bit | |
46 | of a problem here. The current implementation uses the highest priority of | |
47 | all the binary packages produced by a \fI.dsc\fR file for the priority of the | |
48 | source package, and the override entry for the first binary package listed | |
49 | in the \fI.dsc\fR file to modify maintainer information. This might change. | |
50 | .PP | |
51 | The \fIpath-prefix\fR, if given, is prepended to the directory field in the | |
52 | generated source index. You generally use this to make the directory | |
53 | fields contain the path from the top of the Debian archive hierarchy. | |
54 | . | |
55 | .PP | |
56 | .B Note: | |
57 | If you want to access the generated Sources file with | |
58 | .BR apt (8) | |
59 | you will probably need to compress the file with | |
60 | .BR gzip (1) | |
61 | (generating a Sources.gz file). apt ignores uncompressed Sources files | |
62 | except on local access (i.e. | |
63 | .B file:// | |
64 | sources). | |
65 | . | |
66 | .SH OPTIONS | |
67 | .IP "\fB\-n\fR, \fB\-\-no\-sort\fR" 4 | |
68 | Don't sort the index records. Normally they are sorted by source package | |
69 | name. | |
70 | .TP | |
71 | .IP "\fB\-e\fR, \fB\-\-extra\-override\fR \fIfile\fP" 4 | |
72 | Scan \fIfile\fP to find supplementary overrides (since dpkg 1.15.4; | |
73 | the file can be compressed since dpkg 1.15.5). | |
74 | See | |
75 | .BR deb\-extra\-override (5) | |
76 | for more information on its format. | |
77 | .IP "\fB\-s\fR, \fB\-\-source\-override\fR \fIfile\fR" 4 | |
78 | Use \fIfile\fR as the source override file (the file can be compressed | |
79 | since dpkg 1.15.5). | |
80 | The default is the name of the override file you specified with \fI.src\fR | |
81 | appended. | |
82 | .sp | |
83 | The source override file is in a different format from the binary override | |
84 | file. It contains only two whitespace separated fields, the first is the | |
85 | source package name and the second is the section. Blank lines and comment | |
86 | lines are ignored in the normal manner. If a package appears in both files | |
87 | the source override takes precedence for setting the section. | |
88 | .IP "\fB\-\-debug\fR" 4 | |
89 | Turn debugging on. | |
90 | .IP "\fB\-\-help\fR" 4 | |
91 | Show the usage message and exit. | |
92 | .IP "\fB\-\-version\fR" 4 | |
93 | Show the version and exit. | |
94 | . | |
95 | .SH SEE ALSO | |
96 | .BR deb\-override (5), | |
97 | .BR deb\-extra\-override (5), | |
98 | .BR dpkg\-scanpackages (1). |