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.  There is one
  35 entry per line. Blank lines are B<not> allowed.  Lines beginning
  36 with a B<#> character are considered commentary, and are ignored.
  37 All other lines must have the format:
  38
  39 =over
  40
  41 [I<type>B<:>]
  42 I<library>
  43 I<version>
  44 I<dependencies>
  45
  46 =back
  47
  48 The I<library> and I<version> fields are whitespace-delimited,
  49 but the I<dependencies> field extends to the end of the line.  The
  50 I<type> field is optional and normally not needed.
  51
  52 The I<dependencies> field has the same syntax as the B<Depends>
  53 field in a binary control file, see B<deb-control>(5).
  54
  55 =head1 SONAME FORMATS
  56
  57 The SONAME formats supported are:
  58
  59 =over
  60
  61 I<name>.so.I<version>
  62
  63 =back
  64
  65 and
  66
  67 =over
  68
  69 I<name>-I<version>.so
  70
  71 =back
  72
  73 where I<name> is usually prefixed by B<lib>.
  74
  75 The former tends to be used by shared libraries with stable interfaces.
  76 The latter by shared libraries with unstable interfaces, where the whole
  77 version becomes part of the SONAME and needs to be specified in full
  78 when linking against those libraries.
  79
  80 =head1 EXAMPLES
  81
  82 The
  83 B<shlibs>
  84 file for a typical library package, named
  85 I<libcrunch1>,
  86 that provides one library whose SONAME is
  87 I<libcrunch.so.1>,
  88 might read
  89
  90 =over
  91
  92  libcrunch 1 libcrunch1 (>= 1.2-1)
  93
  94 =back
  95
  96 The I<dependencies>
  97 must mention the most recent version of the package that added new
  98 symbols to the library: in the above example, new symbols were added to
  99 version 1.2 of
 100 I<libcrunch>.
 101 This is not the only reason the dependencies might need to be
 102 tightened.
 103
 104 =head1 SEE ALSO
 105
 106 B<deb-control>(5),
 107 B<dpkg-shlibdeps>(1),
 108 B<deb-symbols>(5).