man/deb-symbols.pod

   1 # dpkg manual page - deb-symbols(5)
   2 #
   3 # Copyright © 2007-2012 Raphaël Hertzog <hertzog@debian.org>
   4 # Copyright © 2011, 2013-2015 Guillem Jover <guillem@debian.org>
   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-symbols - Debian's extended shared library information file
  24
  25 =head1 SYNOPSIS
  26
  27 B<DEBIAN/symbols>
  28
  29 =head1 DESCRIPTION
  30
  31 The symbol files are shipped in Debian binary packages, and its format
  32 is a subset of the template symbol files used by B<dpkg-gensymbols>(1)
  33 in Debian source packages, see L<deb-src-symbols(5)>.
  34
  35 The format for an extended shared library dependency information entry
  36 in these files is:
  37
  38 Z<>
  39  I<library-soname> I<main-dependency-template>
  40  [| I<alternative-dependency-template>]
  41  [...]
  42  [* I<field-name>: I<field-value>]
  43  [...]
  44   I<symbol> I<minimal-version> [I<id-of-dependency-template>]
  45
  46 The I<library-soname> is exactly the value of the SONAME field
  47 as exported by B<objdump>(1). A I<dependency-template> is a
  48 dependency where I<#MINVER#> is dynamically replaced either by
  49 a version check like “(E<gt>= I<minimal-version>)” or by nothing (if
  50 an unversioned dependency is deemed sufficient).
  51
  52 Each exported I<symbol> (listed as I<name>@I<version>, with
  53 I<version> being “Base” if the library is not versioned) is associated
  54 to a I<minimal-version> of its dependency template (the main dependency
  55 template is always used and will end up being combined with the dependency
  56 template referenced by I<id-of-dependency-template> if present). The
  57 first alternative dependency template is numbered 1, the second one 2,
  58 etc.
  59 Each column is separated by exactly a single whitespace.
  60
  61 Each entry for a library can also have some fields of meta-information.
  62 Those fields are stored on lines starting with an asterisk. Currently,
  63 the only valid fields are:
  64
  65 =over
  66
  67 =item B<Build-Depends-Package>
  68
  69 It indicates the name of the “-dev” package associated to the library
  70 and is used by B<dpkg-shlibdeps> to make sure that the dependency
  71 generated is at least as strict as the corresponding build dependency
  72 (since dpkg 1.14.13).
  73
  74 =item B<Build-Depends-Packages>
  75
  76 The same as B<Build-Depends-Package> but accepts a comma-separated
  77 list of package names (since dpkg 1.20.0).
  78 This field will override any B<Build-Depends-Package> field present,
  79 and is mostly useful with “-dev” packages and metapackages depending
  80 on these, say for a transition period.
  81
  82 =item B<Allow-Internal-Symbol-Groups>
  83
  84 It indicates what internal symbol groups should be ignored, as a whitespace
  85 separated list, so that the symbols contained in those groups get
  86 included in the output file (since dpkg 1.20.1).
  87 This should only be necessary for toolchain
  88 packages providing those internal symbols. The available groups are
  89 system dependent, for ELF and GNU-based systems these are B<aeabi>
  90 and B<gomp>.
  91
  92 =item B<Ignore-Blacklist-Groups>
  93
  94 A deprecated alias for B<Allow-Internal-Symbol-Groups> (since dpkg 1.20.1,
  95 supported since dpkg 1.17.6).
  96
  97 =back
  98
  99 =head1 EXAMPLES
 100
 101 =head2 Simple symbols file
 102
 103  libftp.so.3 libftp3 #MINVER#
 104   DefaultNetbuf@Base 3.1-1-6
 105   FtpAccess@Base 3.1-1-6
 106   [...]
 107
 108 =head2 Advanced symbols file
 109
 110  libGL.so.1 libgl1
 111  | libgl1-mesa-glx #MINVER#
 112  * Build-Depends-Package: libgl1-mesa-dev
 113   publicGlSymbol@Base 6.3-1
 114   [...]
 115   implementationSpecificSymbol@Base 6.5.2-7 1
 116   [...]
 117
 118 =head1 SEE ALSO
 119
 120 L<https://wiki.debian.org/Projects/ImprovedDpkgShlibdeps>,
 121 L<deb-src-symbols(5)>,
 122 B<dpkg-shlibdeps>(1),
 123 B<dpkg-gensymbols>(1).