man/dpkg-gencontrol.pod

   1 # dpkg manual page - dpkg-gencontrol(1)
   2 #
   3 # Copyright © 1995-1996 Ian Jackson <ijackson@chiark.greenend.org.uk>
   4 # Copyright © 2000 Wichert Akkerman <wakkerma@debian.org>
   5 # Copyright © 2006, 2012-2013, 2015 Guillem Jover <guillem@debian.org>
   6 # Copyright © 2007-2008 Raphaël Hertzog <hertzog@debian.org>
   7 #
   8 # This is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  20
  21 =encoding utf8
  22
  23 =head1 NAME
  24
  25 dpkg-gencontrol - generate Debian control files
  26
  27 =head1 SYNOPSIS
  28
  29 B<dpkg-gencontrol>
  30 [I<option>...]
  31
  32 =head1 DESCRIPTION
  33
  34 B<dpkg-gencontrol>
  35 reads information from an unpacked Debian source tree and generates a
  36 binary package control file (which defaults to debian/tmp/DEBIAN/control);
  37 during this process it will simplify the relation fields.
  38
  39 Thus
  40 B<Pre-Depends>, B<Depends>, B<Recommends> and B<Suggests>
  41 are simplified in this
  42 order by removing dependencies which are known to be true according to the
  43 stronger dependencies already parsed.
  44 It will also remove any self-dependency
  45 (in fact it will remove any dependency which evaluates to true given the
  46 current version of the package as installed).
  47 Logically it keeps the intersection of multiple dependencies on the same
  48 package.
  49 The order
  50 of dependencies is preserved as best as possible: if any dependency
  51 must be discarded due to another dependency appearing further
  52 in the field, the superseding dependency will take the place of the
  53 discarded one.
  54
  55 The other relation fields
  56 (B<Enhances>, B<Conflicts>, B<Breaks>, B<Replaces> and B<Provides>)
  57 are also simplified individually by computing the union of the various
  58 dependencies when a package is listed multiple times in the field.
  59
  60 B<dpkg-gencontrol>
  61 also adds an entry for the binary package to
  62 B<debian/files>.
  63
  64 =head1 OPTIONS
  65
  66 =over
  67
  68 =item B<-v>I<version>
  69
  70 Sets the version number of the binary package which will be generated.
  71
  72 =item B<-V>I<name>B<=>I<value>
  73
  74 Set an output substitution variable.
  75 See L<deb-substvars(5)> for
  76 discussion of output substitution.
  77
  78 =item B<-T>I<substvars-file>
  79
  80 Read substitution variables in
  81 I<substvars-file>;
  82 the default is
  83 B<debian/substvars>.
  84 This option can be used multiple times to read substitution variables from
  85 multiple files (since dpkg 1.15.6).
  86
  87 =item B<-D>I<field>B<=>I<value>
  88
  89 Override or add an output control file field.
  90
  91 =item B<-U>I<field>
  92
  93 Remove an output control file field.
  94
  95 =item B<-c>I<control-file>
  96
  97 Specifies the main source control file to read information from.
  98 The
  99 default is
 100 B<debian/control>.
 101
 102 =item B<-l>I<changelog-file>
 103
 104 Specifies the changelog file to read information from.
 105 The
 106 default is
 107 B<debian/changelog>.
 108
 109 =item B<-f>I<files-list-file>
 110
 111 Read or write the list of files to be uploaded here, rather than using
 112 B<debian/files>.
 113
 114 =item B<-F>I<changelog-format>
 115
 116 Specifies the format of the changelog.
 117 See L<dpkg-parsechangelog(1)>
 118 for information about alternative formats.
 119
 120 =item B<-p>I<package>
 121
 122 Generate information for the binary package
 123 I<package>.
 124 If the source control file lists only one binary package then this
 125 option may be omitted; otherwise it is essential to select which
 126 binary package's information to generate.
 127
 128 =item B<-n>I<filename>
 129
 130 Assume the filename of the package will be
 131 I<filename>
 132 instead of the normal package_version_arch.deb filename.
 133
 134 =item B<-is>, B<-ip>, B<-isp>
 135
 136 These options are ignored for compatibility with older versions of the dpkg
 137 build scripts but are now deprecated.
 138 Previously they were used to tell
 139 B<dpkg-gencontrol> to include the Section and Priority fields in the
 140 control file.
 141 This is now the default behavior.
 142 If you want to
 143 get the old behavior you can use the
 144 B<-U>
 145 option to delete the fields from the control file.
 146
 147 =item B<-P>I<package-build-dir>
 148
 149 Scan
 150 I<package-build-dir>
 151 instead of
 152 B<debian/tmp>.
 153 This value is used to find the default value of the
 154 B<Installed-Size>
 155 substitution variable and control file field,
 156 and for the default location of the output file.
 157
 158 =item B<-O>[I<filename>]
 159
 160 Print the control file to standard output (or I<filename> if specified,
 161 since dpkg 1.17.2), rather than to
 162 B<debian/tmp/DEBIAN/control>
 163 (or
 164 I<package-build-dir>B</DEBIAN/control>
 165 if
 166 B<-P>
 167 was used).
 168
 169 =item B<-?>, B<--help>
 170
 171 Show the usage message and exit.
 172
 173 =item B<--version>
 174
 175 Show the version and exit.
 176
 177 =back
 178
 179 =head1 ENVIRONMENT
 180
 181 =over
 182
 183 =item B<DPKG_COLORS>
 184
 185 Sets the color mode (since dpkg 1.18.5).
 186 The currently accepted values are: B<auto> (default), B<always> and
 187 B<never>.
 188
 189 =item B<DPKG_NLS>
 190
 191 If set, it will be used to decide whether to activate Native Language Support,
 192 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 193 The accepted values are: B<0> and B<1> (default).
 194
 195 =back
 196
 197 =head1 FILES
 198
 199 =over
 200
 201 =item B<debian/control>
 202
 203 The main source control information file, giving version-independent
 204 information about the source package and the binary packages it can
 205 produce.
 206
 207 =item B<debian/files>
 208
 209 The list of generated files which are part of the upload being
 210 prepared.
 211 B<dpkg-gencontrol>
 212 adds the presumed filenames of binary packages whose control files it
 213 generates here.
 214
 215 =back
 216
 217 =head1 SEE ALSO
 218
 219 L<deb-substvars(5)>,
 220 L<deb-src-control(5)>,
 221 L<deb-changelog(5)>,
 222 L<deb-control(5)>.