man/deb-shlibs.pod

   1 # dpkg manual page - deb-shlibs(5)
   2 #
   3 # Copyright © 1996 Michael Shields <shields@crosslink.net>
   4 # Copyright © 2008 Zack Weinberg <zackw@panix.com>
   5 #
   6 # This is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  18
  19 =encoding utf8
  20
  21 =head1 NAME
  22
  23 deb-shlibs - Debian shared library information file
  24
  25 =head1 SYNOPSIS
  26
  27 B<debian/shlibs>, B<debian/>I<binary-name>B<.shlibs>, B<DEBIAN/shlibs>
  28
  29 =head1 DESCRIPTION
  30
  31 B<shlibs>
  32 files map shared library names and versions
  33 (I<SONAMEs>)
  34 to dependencies suitable for a package control file.
  35 There is one entry per line.
  36 Blank lines are B<not> allowed.
  37 Lines beginning
  38 with a B<#> character are considered commentary, and are ignored.
  39 All other lines must have the format:
  40
  41 =over
  42
  43 [I<type>B<:>]
  44 I<library>
  45 I<version>
  46 I<dependencies>
  47
  48 =back
  49
  50 The I<library> and I<version> fields are whitespace-delimited,
  51 but the I<dependencies> field extends to the end of the line.
  52 The
  53 I<type> field is optional and normally not needed.
  54
  55 The I<dependencies> field has the same syntax as the B<Depends>
  56 field in a binary control file, see L<deb-control(5)>.
  57
  58 =head1 SONAME FORMATS
  59
  60 The SONAME formats supported are:
  61
  62 =over
  63
  64 I<name>.so.I<version>
  65
  66 =back
  67
  68 and
  69
  70 =over
  71
  72 I<name>-I<version>.so
  73
  74 =back
  75
  76 where I<name> is usually prefixed by B<lib>.
  77
  78 The former tends to be used by shared libraries with stable interfaces.
  79 The latter by shared libraries with unstable interfaces, where the whole
  80 version becomes part of the SONAME and needs to be specified in full
  81 when linking against those libraries.
  82
  83 =head1 EXAMPLES
  84
  85 The
  86 B<shlibs>
  87 file for a typical library package, named
  88 I<libcrunch1>,
  89 that provides one library whose SONAME is
  90 I<libcrunch.so.1>,
  91 might read
  92
  93 =over
  94
  95  libcrunch 1 libcrunch1 (>= 1.2-1)
  96
  97 =back
  98
  99 The I<dependencies>
 100 must mention the most recent version of the package that added new
 101 symbols to the library: in the above example, new symbols were added to
 102 version 1.2 of
 103 I<libcrunch>.
 104 This is not the only reason the dependencies might need to be
 105 tightened.
 106
 107 =head1 SEE ALSO
 108
 109 L<deb-control(5)>,
 110 L<deb-symbols(5)>,
 111 L<dpkg-shlibdeps(1)>.