man/dpkg-scansources.pod

   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 =encoding utf8
  21
  22 =head1 NAME
  23
  24 dpkg-scansources - create Sources index files
  25
  26 =head1 SYNOPSIS
  27
  28 B<dpkg-scansources>
  29 [I<option>...] I<binary-dir>
  30 [I<override-file>
  31 [I<path-prefix>]]
  32 B<E<gt>>
  33 I<Sources>
  34
  35 =head1 DESCRIPTION
  36
  37 B<dpkg-scansources> scans the given I<binary-dir> for I<.dsc> files.
  38 These are used to create a Debian source index, which is output to
  39 stdout.
  40
  41 The I<override-file>, if given, is used to set priorities in the resulting
  42 index stanzas and to override the maintainer field given in the I<.dsc>
  43 files.
  44 The file can be compressed (since dpkg 1.15.5).
  45 See
  46 B<deb-override>(5)
  47 for the format of this file.
  48
  49 B<Note>: Since
  50 the override file is indexed by binary, not source packages, there's a bit
  51 of a problem here. The current implementation uses the highest priority of
  52 all the binary packages produced by a I<.dsc> file for the priority of the
  53 source package, and the override entry for the first binary package listed
  54 in the I<.dsc> file to modify maintainer information. This might change.
  55
  56 The I<path-prefix>, if given, is prepended to the directory field in the
  57 generated source index. You generally use this to make the directory
  58 fields contain the path from the top of the Debian archive hierarchy.
  59
  60 B<Note>:
  61 If you want to access the generated Sources file with
  62 B<apt>(8)
  63 you will probably need to compress the file with
  64 B<gzip>(1)
  65 (generating a Sources.gz file).
  66 B<apt>(8)
  67 ignores uncompressed Sources files except on local access (i.e.
  68 B<file://>
  69 sources).
  70
  71 =head1 OPTIONS
  72
  73 =over
  74
  75 =item B<-n>, B<--no-sort>
  76
  77 Do not sort the index stanzas.
  78 Normally they are sorted by source package name.
  79
  80 =item B<-e>, B<--extra-override> I<file>
  81
  82 Scan I<file> to find supplementary overrides (since dpkg 1.15.4;
  83 the file can be compressed since dpkg 1.15.5).
  84 See
  85 B<deb-extra-override>(5)
  86 for more information on its format.
  87
  88 =item B<-s>, B<--source-override> I<file>
  89
  90 Use I<file> as the source override file (the file can be compressed
  91 since dpkg 1.15.5).
  92 The default is the name of the override file you specified with I<.src>
  93 appended.
  94
  95 The source override file is in a different format from the binary override
  96 file. It contains only two whitespace separated fields, the first is the
  97 source package name and the second is the section. Blank lines and comment
  98 lines are ignored in the normal manner. If a package appears in both files
  99 the source override takes precedence for setting the section.
 100
 101 =item B<--debug>
 102
 103 Turn debugging on.
 104
 105 =item B<--help>
 106
 107 Show the usage message and exit.
 108
 109 =item B<--version>
 110
 111 Show the version and exit.
 112
 113 =back
 114
 115 =head1 ENVIRONMENT
 116
 117 =over
 118
 119 =item B<DPKG_COLORS>
 120
 121 Sets the color mode (since dpkg 1.18.5).
 122 The currently accepted values are: B<auto> (default), B<always> and
 123 B<never>.
 124
 125 =item B<DPKG_NLS>
 126
 127 If set, it will be used to decide whether to activate Native Language Support,
 128 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 129 The accepted values are: B<0> and B<1> (default).
 130
 131 =back
 132
 133 =head1 SEE ALSO
 134
 135 B<deb-override>(5),
 136 B<deb-extra-override>(5),
 137 B<dpkg-scanpackages>(1).