2 .\" Copyright (c) 1993 Paul Kranenburg
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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
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.
30 .\" $FreeBSD: src/sbin/ldconfig/ldconfig.8,v 1.19.2.10 2003/05/13 19:25:19 trhodes Exp $
31 .\" $DragonFly: src/sbin/ldconfig/ldconfig.8,v 1.2 2003/06/17 04:27:33 dillon Exp $
38 .Nd configure the shared library cache
43 .Op Fl f Ar hints_file
48 utility is used to prepare a set of
50 for use by the dynamic linker
51 to facilitate quick lookup of shared libraries available in multiple
52 directories. It scans a set of built-in system directories and any
54 specified on the command line (in the given order) looking for
55 shared libraries and stores the results in a system file to forestall
56 the overhead that would otherwise result from the directory search
57 operations the dynamic linker would have to perform to load the
58 required shared libraries.
60 Files named on the command line are expected to contain directories
61 to scan for shared libraries. Each directory's pathname must start on a new
62 line. Blank lines and lines starting with the comment character
65 Filenames must conform to the
67 pattern in order to be added to the hints file.
69 For security reasons, directories which are world or group-writable or which
70 are not owned by root produce warning messages and are skipped, unless
75 The shared libraries which are found will be automatically available for loading
76 if needed by the program being prepared for execution.
77 This obviates the need
78 for storing search paths within the executable.
82 environment variable can be used to override the use of
83 directories (or the order thereof) from the cache or to specify additional
84 directories where shared libraries might be found.
88 separated list of directory paths which are searched by
90 when it needs to load a shared library.
91 It can be viewed as the run-time
99 utility is typically run as part of the boot sequence.
101 The following options are recognized by
103 .Bl -tag -width indent
105 Generate the hints for a.out format shared libraries.
107 Generate the hints for ELF format shared libraries.
109 Rescan the previously configured directories. This opens the previous hints
110 file and fetches the directory list from the header. Any additional pathnames
111 on the command line are also processed.
112 This is the default action when no parameters are given.
113 .It Fl f Ar hints_file
114 Read and/or update the specified hints file, instead of the standard file.
115 This option is provided primarily for testing.
117 Run in insecure mode. The security checks will not be performed.
119 Instead of replacing the contents of the hints file
120 with those found in the directories specified,
123 Directories recorded in the hints file by previous runs of
125 are also rescanned for new shared libraries.
127 List the current contents of the hints file
128 on the standard output.
129 The hints file is not modified. The list of
130 directories stored in the hints file is included.
132 Do not scan the built-in system directory
134 for shared libraries.
136 Switch on verbose mode.
139 Special care must be taken when loading shared libraries into the address
143 Whenever such a program is run by any user except the owner of the program,
145 will only load shared libraries from the hints
149 is not used to search for libraries.
150 Thus, the role of ldconfig is dual.
152 addition to building a set of hints for quick lookup, it also serves to
153 specify the trusted collection of directories from which shared objects can
156 .Bl -tag -width OBJFORMATxxx -compact
160 (see below) to determine whether
164 is the default. If set, its value should be either
170 .Bl -tag -width /var/run/ld-elf.so.hintsxxx -compact
171 .It Pa /var/run/ld.so.hints
172 Standard hints file for the a.out dynamic linker.
173 .It Pa /var/run/ld-elf.so.hints
174 Standard hints file for the ELF dynamic linker.
175 .It Pa /etc/ld.so.conf
176 Conventional configuration file containing directory names for
179 .It Pa /etc/ld-elf.so.conf
180 Conventional configuration file containing directory names for
183 .It Pa /etc/objformat
188 is the default. If present, it must consist of a single line
200 utility first appeared in SunOS 4.0, it appeared in its current form
204 Some security checks (for example, verifying root ownership of
205 added directories) are not performed when