sbin/ldconfig/ldconfig.8

   1 .\"
   2 .\" Copyright (c) 1993 Paul Kranenburg
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"      This product includes software developed by Paul Kranenburg.
  16 .\" 3. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd October 3, 1993
  33 .Dt LDCONFIG 8
  34 .Os
  35 .Sh NAME
  36 .Nm ldconfig
  37 .Nd configure the shared library cache
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl aout | Fl elf
  41 .Op Fl Rimrsv
  42 .Op Fl f Ar hints_file
  43 .Op Ar directory | Ar
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility is used to prepare a set of
  48 .Dq hints
  49 for use by the dynamic linker
  50 to facilitate quick lookup of shared libraries available in multiple
  51 directories.  It scans a set of built-in system directories and any
  52 .Ar directories
  53 specified on the command line (in the given order) looking for
  54 shared libraries and stores the results in a system file to forestall
  55 the overhead that would otherwise result from the directory search
  56 operations the dynamic linker would have to perform to load the
  57 required shared libraries.
  58 .Pp
  59 Files named on the command line are expected to contain directories
  60 to scan for shared libraries.  Each directory's pathname must start on a new
  61 line.  Blank lines and lines starting with the comment character
  62 .Ql \&#
  63 are ignored.
  64 .Pp
  65 For security reasons, directories which are world or group-writable or which
  66 are not owned by root produce warning messages and are skipped, unless
  67 the
  68 .Fl i
  69 option is present.
  70 .Pp
  71 The shared libraries which are found will be automatically available for loading
  72 if needed by the program being prepared for execution.
  73 This obviates the need
  74 for storing search paths within the executable.
  75 .Pp
  76 The
  77 .Ev LD_LIBRARY_PATH
  78 environment variable can be used to override the use of
  79 directories (or the order thereof) from the cache or to specify additional
  80 directories where shared libraries might be found.
  81 .Ev LD_LIBRARY_PATH
  82 is a
  83 .Sq \&:
  84 separated list of directory paths which are searched by
  85 the dynamic linker
  86 when it needs to load a shared library.
  87 It can be viewed as the run-time
  88 equivalent of the
  89 .Fl L
  90 switch of
  91 .Xr ld 1 .
  92 .Pp
  93 The
  94 .Nm
  95 utility is typically run as part of the boot sequence.
  96 .Pp
  97 The following options are recognized by
  98 .Nm :
  99 .Bl -tag -width indent
 100 .It Fl aout
 101 Generate the hints for a.out format shared libraries.
 102 .It Fl elf
 103 Generate the hints for ELF format shared libraries.
 104 .It Fl R
 105 Rescan the previously configured directories.  This opens the previous hints
 106 file and fetches the directory list from the header.  Any additional pathnames
 107 on the command line are also processed.
 108 This is the default action when no parameters are given.
 109 .It Fl f Ar hints_file
 110 Read and/or update the specified hints file, instead of the standard file.
 111 This option is provided primarily for testing.
 112 .It Fl i
 113 Run in insecure mode. The security checks will not be performed.
 114 .It Fl m
 115 Instead of replacing the contents of the hints file
 116 with those found in the directories specified,
 117 .Dq merge
 118 in new entries.
 119 Directories recorded in the hints file by previous runs of
 120 .Nm
 121 are also rescanned for new shared libraries.
 122 .It Fl r
 123 List the current contents of the hints file
 124 on the standard output.
 125 The hints file is not modified.  The list of
 126 directories stored in the hints file is included.
 127 .It Fl s
 128 Do not scan the built-in system directory
 129 .Pq Dq /usr/lib
 130 for shared libraries.
 131 .It Fl v
 132 Switch on verbose mode.
 133 .El
 134 .Sh Security
 135 Special care must be taken when loading shared libraries into the address
 136 space of
 137 .Ev set-user-Id
 138 programs.
 139 Whenever such a program is run,
 140 the dynamic linker
 141 will only load shared libraries from the hints
 142 file.
 143 In particular, the
 144 .Ev LD_LIBRARY_PATH
 145 is not used to search for libraries.
 146 Thus, the role of ldconfig is dual.
 147 In
 148 addition to building a set of hints for quick lookup, it also serves to
 149 specify the trusted collection of directories from which shared objects can
 150 be safely loaded.
 151 .Sh ENVIRONMENT
 152 .Bl -tag -width OBJFORMATxxx -compact
 153 .It Ev OBJFORMAT
 154 Overrides
 155 .Pa /etc/objformat
 156 (see below) to determine whether
 157 .Fl aout
 158 or
 159 .Fl elf
 160 is the default.  If set, its value should be either
 161 .Ql aout
 162 or
 163 .Ql elf .
 164 .El
 165 .Sh FILES
 166 .Bl -tag -width /var/run/ld-elf.so.hintsxxx -compact
 167 .It Pa /var/run/ld.so.hints
 168 Standard hints file for the a.out dynamic linker.
 169 .It Pa /var/run/ld-elf.so.hints
 170 Standard hints file for the ELF dynamic linker.
 171 .It Pa /etc/ld.so.conf
 172 Conventional configuration file containing directory names for
 173 invocations with
 174 .Fl aout .
 175 .It Pa /etc/ld-elf.so.conf
 176 Conventional configuration file containing directory names for
 177 invocations with
 178 .Fl elf .
 179 .It Pa /etc/objformat
 180 Determines whether
 181 .Fl aout
 182 or
 183 .Fl elf
 184 is the default.  If present, it must consist of a single line
 185 containing either
 186 .Ql OBJFORMAT=aout
 187 or
 188 .Ql OBJFORMAT=elf .
 189 .El
 190 .Sh SEE ALSO
 191 .Xr ld 1 ,
 192 .Xr link 5
 193 .Sh HISTORY
 194 A
 195 .Nm
 196 utility first appeared in SunOS 4.0, it appeared in its current form
 197 in
 198 .Fx 1.1 .
 199 .Sh BUGS
 200 Some security checks (for example, verifying root ownership of
 201 added directories) are not performed when
 202 .Fl aout
 203 is specified.