xref: /freebsd/share/man/man5/libmap.conf.5 (revision 7660b554bc59a07be0431c17e0e33815818baa69)
1.\" Copyright (c) 2003 Matthew N. Dodd <winter@jurai.net>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd April 7, 2003
28.Dt LIBMAP.CONF 5
29.Os
30.Sh NAME
31.Nm libmap.conf
32.Nd "configuration file for dynamic object dependency mapping"
33.Sh DESCRIPTION
34The
35.Nm libmap
36functionality of
37.Xr ld-elf.so.1 1
38allows dynamic object dependencies to be mapped to arbitrary
39names.
40.Pp
41The configuration file consists of two whitespace separated columns; the
42left hand side containing the mapping candidate and the right hand
43side containing the mapping.
44Dependencies are matched against candidates and replaced with the mappings.
45.Pp
46Constrained mappings may be specified by enclosing the name of the
47executable or library in brackets.
48All mappings following a constraint will only be evaluated for that constraint.
49Currently, constraints
50are matched literally so that an executable with a fully qualified pathname
51will only match the same constraint.
52This means that
53.Pa /usr/bin/foo
54will not match a constraint for
55.Pa foo
56and vise-versa.
57.Pp
58WARNING!
59Constrained mappings must never appear first in the configuration file.
60While there is a way to specify the
61.Dq default
62constraint, its use is not recommended.
63.Pp
64The most common use at the date of writing is for allowing multiple
65.Tn POSIX
66threading libraries to be used on a system without relinking or
67changing symlinks.
68.Sh EXAMPLE
69.Bd -literal
70# /etc/libmap.conf
71#
72# candidate		mapping
73#
74libc_r.so.5		libthr.so.1	# Everything uses 'libthr'
75libc_r.so		libthr.so
76
77[/usr/local/bin/mplayer]		# 'mplayer' uses libc_r.
78libc_r.so.5		libc_r.so.5
79libc_r.so		libc_r.so
80
81[mplayer]
82libc_r.so.5		libc_r.so.5
83libc_r.so		libc_r.so
84
85[/usr/local/sbin/httpd]			# Apache uses libkse
86libc_r.so.5		libkse.so.1
87libc_r.so		libkse.so
88
89[httpd]
90libc_r.so.5		libkse.so.1
91libc_r.so		libkse.so
92.Ed
93.Sh FILES
94.Bl -tag -width ".Pa /etc/libmap.conf" -compact
95.It Pa /etc/libmap.conf
96The libmap configuration file.
97.El
98.Sh SEE ALSO
99.Xr ldd 1 ,
100.Xr rtld 1
101.Sh HISTORY
102The
103.Nm
104manual page and
105.Nm libmap
106functionality first appeared in
107.Fx 5.1 .
108.Sh AUTHORS
109This manual page was written by
110.An Matthew N. Dodd Aq winter@jurai.net .
111