man/libdpkg.pod

   1 # dpkg manual page - libdpkg(7)
   2 #
   3 # Copyright © 2024 Guillem Jover <guillem@debian.org>
   4 #
   5 # This is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17
  18 =encoding utf8
  19
  20 =head1 NAME
  21
  22 libdpkg - Debian package manager C library
  23
  24 =head1 DESCRIPTION
  25
  26 The B<libdpkg> C library provides functions and infrastructure for the dpkg
  27 tool set, and external projects that need to integrate tightly with it.
  28
  29 The library provides a L<pkgconf(1)> entry named I<libdpkg>.
  30
  31 B<Warning>: The API provided by this library is highly volatile, still in
  32 the process of being cleaned up. It is only supposed to be used internally
  33 by dpkg for now. Header files, functions, variables and types might get
  34 renamed, removed or change semantics. If you still have a need to use it,
  35 which you would be doing anyway, say by locally building dpkg to get the
  36 library, then define the C preprocessor macro LIBDPKG_VOLATILE_API in your
  37 build to acknowledge that fact.
  38
  39 Due to the currently API volatility, only a static library is provided.
  40
  41 =head1 SEE ALSO
  42
  43 F<%PKGDOCDIR%/README.api>,
  44 L<https://www.dpkg.org/doc/libdpkg/>.