scripts/Dpkg.pm

   1 # This program is free software; you can redistribute it and/or modify
   2 # it under the terms of the GNU General Public License as published by
   3 # the Free Software Foundation; either version 2 of the License, or
   4 # (at your option) any later version.
   5 #
   6 # This program is distributed in the hope that it will be useful,
   7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
   8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9 # GNU General Public License for more details.
  10 #
  11 # You should have received a copy of the GNU General Public License
  12 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  13
  14 =encoding utf8
  15
  16 =head1 NAME
  17
  18 Dpkg - module with core variables
  19
  20 =head1 DESCRIPTION
  21
  22 The Dpkg module provides a set of variables with information concerning
  23 this system installation.
  24
  25 It is also the entry point to the Dpkg module hierarchy.
  26
  27 =cut
  28
  29 package Dpkg 2.00;
  30
  31 use strict;
  32 use warnings;
  33
  34 our @EXPORT_OK = qw(
  35     $PROGNAME
  36     $PROGVERSION
  37     $PROGMAKE
  38     $PROGTAR
  39     $PROGPATCH
  40     $CONFDIR
  41     $ADMINDIR
  42     $LIBDIR
  43     $DATADIR
  44 );
  45
  46 use Exporter qw(import);
  47
  48 =head1 VARIABLES
  49
  50 =over 4
  51
  52 =item $Dpkg::PROGNAME
  53
  54 Contains the name of the current program.
  55
  56 =item $Dpkg::PROGVERSION
  57
  58 Contains the version of the dpkg suite.
  59
  60 =item $Dpkg::PROGMAKE
  61
  62 Contains the name of the system GNU make program.
  63
  64 =item $Dpkg::PROGTAR
  65
  66 Contains the name of the system GNU tar program.
  67
  68 =item $Dpkg::PROGPATCH
  69
  70 Contains the name of the system GNU patch program (or another implementation
  71 that is directory traversal resistant).
  72
  73 =item $Dpkg::CONFDIR
  74
  75 Contains the path to the dpkg system configuration directory.
  76
  77 =item $Dpkg::ADMINDIR
  78
  79 Contains the path to the dpkg database directory.
  80
  81 =item $Dpkg::LIBDIR
  82
  83 Contains the path to the dpkg methods and plugins directory.
  84
  85 =item $Dpkg::DATADIR
  86
  87 Contains the path to the dpkg architecture tables directory.
  88
  89 =back
  90
  91 =cut
  92
  93 our ($PROGNAME) = $0 =~ m{(?:.*/)?([^/]*)};
  94
  95 # The following lines are automatically fixed at install time
  96 our $PROGVERSION = '1.22.x';
  97 our $PROGMAKE = $ENV{DPKG_PROGMAKE} // 'make';
  98 our $PROGTAR = $ENV{DPKG_PROGTAR} // 'tar';
  99 our $PROGPATCH = $ENV{DPKG_PROGPATCH} // 'patch';
 100
 101 our $CONFDIR = '/etc/dpkg';
 102 our $ADMINDIR = '/var/lib/dpkg';
 103 our $LIBDIR = '.';
 104 our $DATADIR = '../data';
 105
 106 $DATADIR = $ENV{DPKG_DATADIR} if defined $ENV{DPKG_DATADIR};
 107
 108 =head1 MODULES
 109
 110 The following is the list of public modules within the Dpkg hierarchy. Only
 111 modules with versions 1.00 or higher, and only the interfaces documented in
 112 their POD are considered public.
 113
 114 =over
 115
 116 =item L<Dpkg>
 117
 118 This module, core variables.
 119
 120 =item L<Dpkg::Arch>
 121
 122 Architecture handling functions.
 123
 124 =item L<Dpkg::BuildFlags>
 125
 126 Set, modify and query compilation build flags.
 127
 128 =item L<Dpkg::BuildInfo>
 129
 130 Build information functions.
 131
 132 =item L<Dpkg::BuildOptions>
 133
 134 Parse and manipulate B<DEB_BUILD_OPTIONS>.
 135
 136 =item L<Dpkg::BuildProfiles>
 137
 138 Parse and manipulate build profiles.
 139
 140 =item L<Dpkg::Changelog>
 141
 142 Parse changelogs.
 143
 144 =item L<Dpkg::Changelog::Entry>
 145
 146 Represents a changelog entry.
 147
 148 =item L<Dpkg::Changelog::Parse>
 149
 150 Generic changelog parser for F<dpkg-parsechangelog>.
 151
 152 =item L<Dpkg::Checksums>
 153
 154 Generate and parse checksums.
 155
 156 =item L<Dpkg::Compression>
 157
 158 Simple database of available compression methods.
 159
 160 =item L<Dpkg::Compression::FileHandle>
 161
 162 Transparently compress and decompress files.
 163
 164 =item L<Dpkg::Compression::Process>
 165
 166 Wrapper around compression tools.
 167
 168 =item L<Dpkg::Conf>
 169
 170 Parse F<dpkg> configuration files.
 171
 172 =item L<Dpkg::Control>
 173
 174 Parse and manipulate Debian control information (F<.dsc>, F<.changes>,
 175 F<Packages>/F<Sources> entries, etc.).
 176
 177 =item L<Dpkg::Control::Changelog>
 178
 179 Represent fields output by F<dpkg-parsechangelog>.
 180
 181 =item L<Dpkg::Control::Fields>
 182
 183 Manage (list of known) control fields.
 184
 185 =item L<Dpkg::Control::Hash>
 186
 187 Parse and manipulate a stanza of deb822 fields.
 188
 189 =item L<Dpkg::Control::Info>
 190
 191 Parse files like F<debian/control>.
 192
 193 =item L<Dpkg::Control::Tests>
 194
 195 Parse files like F<debian/tests/control>.
 196
 197 =item L<Dpkg::Control::Tests::Entry>
 198
 199 Represents a F<debian/tests/control> stanza.
 200
 201 =item L<Dpkg::Deps>
 202
 203 Parse and manipulate dependencies.
 204
 205 =item L<Dpkg::Deps::Simple>
 206
 207 Represents a single dependency statement.
 208
 209 =item L<Dpkg::Deps::Multiple>
 210
 211 Base module to represent multiple dependencies.
 212
 213 =item L<Dpkg::Deps::Union>
 214
 215 List of unrelated dependencies.
 216
 217 =item L<Dpkg::Deps::AND>
 218
 219 List of AND dependencies.
 220
 221 =item L<Dpkg::Deps::OR>
 222
 223 List of OR dependencies.
 224
 225 =item L<Dpkg::Deps::KnownFacts>
 226
 227 List of installed and virtual packages.
 228
 229 =item L<Dpkg::Exit>
 230
 231 Push, pop and run exit handlers.
 232
 233 =item L<Dpkg::Gettext>
 234
 235 Wrapper around L<Locale::gettext>.
 236
 237 =item L<Dpkg::IPC>
 238
 239 Spawn sub-processes and feed/retrieve data.
 240
 241 =item L<Dpkg::Index>
 242
 243 Collections of L<Dpkg::Control> (F<Packages>/F<Sources> files for example).
 244
 245 =item L<Dpkg::Interface::Storable>
 246
 247 Base object serializer.
 248
 249 =item L<Dpkg::Path>
 250
 251 Common path handling functions.
 252
 253 =item L<Dpkg::Source::Format>
 254
 255 Parse and manipulate debian/source/format files.
 256
 257 =item L<Dpkg::Source::Package>
 258
 259 Extract Debian source packages.
 260
 261 =item L<Dpkg::Substvars>
 262
 263 Substitute variables in strings.
 264
 265 =item L<Dpkg::Vendor>
 266
 267 Identify current distribution vendor.
 268
 269 =item L<Dpkg::Version>
 270
 271 Parse and manipulate Debian package versions.
 272
 273 =back
 274
 275 =head1 CHANGES
 276
 277 =head2 Version 2.00 (dpkg 1.20.0)
 278
 279 Remove variables: $version, $progname, $admindir, $dpkglibdir and $pkgdatadir.
 280
 281 =head2 Version 1.03 (dpkg 1.18.24)
 282
 283 New variable: $PROGPATCH.
 284
 285 =head2 Version 1.02 (dpkg 1.18.11)
 286
 287 New variable: $PROGTAR, $PROGMAKE.
 288
 289 =head2 Version 1.01 (dpkg 1.17.0)
 290
 291 New variables: $PROGNAME, $PROGVERSION, $CONFDIR, $ADMINDIR, $LIBDIR and
 292 $DATADIR.
 293
 294 Deprecated variables: $version, $admindir, $dpkglibdir and $pkgdatadir.
 295
 296 =head2 Version 1.00 (dpkg 1.15.6)
 297
 298 Mark the module as public.
 299
 300 =head1 LICENSE
 301
 302 See the header comment on each module for their particular license.
 303
 304 =cut
 305
 306 1;