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