| .TH dpkg\-scansources 1 "2011-08-14" "Debian Project" "dpkg utilities" |
| .SH NAME |
| dpkg\-scansources \- create Sources index files |
| . |
| .SH SYNOPSIS |
| .B dpkg\-scansources |
| .RI [ option "...] " binary-dir |
| .RI [ override-file |
| .RI [ path-prefix ]] |
| .B > |
| .I Sources |
| . |
| .SH DESCRIPTION |
| \fBdpkg\-scansources\fR scans the given \fIbinary-dir\fR for \fI.dsc\fR files. |
| These are used to create a Debian source index, which is output to |
| stdout. |
| .PP |
| The \fIoverride-file\fR, if given, is used to set priorities in the resulting |
| index records and to override the maintainer field given in the \fI.dsc\fR |
| files. The file can be compressed. See |
| .BR deb\-override (5) |
| for the format of this file. \s-1NB:\s0 Since |
| the override file is indexed by binary, not source, packages, there's a bit |
| of a problem here. The current implementation uses the highest priority of |
| all the binary packages produced by a \fI.dsc\fR file for the priority of the |
| source package, and the override entry for the first binary package listed |
| in the \fI.dsc\fR file to modify maintainer information. This might change. |
| .PP |
| The \fIpath-prefix\fR, if given, is prepended to the directory field in the |
| generated source index. You generally use this to make the directory |
| fields contain the path from the top of the Debian archive hierarchy. |
| . |
| .PP |
| .B Note: |
| If you want to access the generated Sources file with |
| .BR apt (8) |
| you will probably need to compress the file with |
| .BR gzip (1) |
| (generating a Sources.gz file). apt ignores uncompressed Sources files |
| except on local access (i.e. |
| .B file:// |
| sources). |
| . |
| .SH OPTIONS |
| .IP "\fB\-n\fR, \fB\-\-no\-sort\fR" 4 |
| Don't sort the index records. Normally they are sorted by source package |
| name. |
| .TP |
| .IP "\fB\-e\fR, \fB\-\-extra\-override\fR \fIfile\fP" 4 |
| Scan \fIfile\fP to find supplementary overrides (the file can be |
| compressed). See |
| .BR deb\-extra\-override (5) |
| for more information on its format. |
| .IP "\fB\-s\fR, \fB\-\-source\-override\fR \fIfile\fR" 4 |
| Use \fIfile\fR as the source override file (the file can be compressed). |
| The default is the name of the override file you specified with \fI.src\fR |
| appended. |
| .sp |
| The source override file is in a different format from the binary override |
| file. It contains only two whitespace separated fields, the first is the |
| source package name and the second is the section. Blank lines and comment |
| lines are ignored in the normal manner. If a package appears in both files |
| the source override takes precedence for setting the section. |
| .IP "\fB\-\-debug\fR" 4 |
| Turn debugging on. |
| .IP "\fB\-\-help\fR" 4 |
| Show the usage message and exit. |
| .IP "\fB\-\-version\fR" 4 |
| Show the version and exit. |
| . |
| .SH "SEE ALSO" |
| .BR deb\-override (5), |
| .BR deb\-extra\-override (5), |
| .BR dpkg\-scanpackages (1). |
| . |
| .SH AUTHOR |
| Roderick Schertler <roderick@argon.org> |
