summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/MACOSX_RPATH.rst
blob: 1c503d1648606e481cf1fc87c1098771a47db853 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
MACOSX_RPATH
------------

Whether this target on Mac OS X is located at runtime using rpaths.

When this property is set to true, the directory portion of
the "install_name" field of this shared library will be ``@rpath``
unless overridden by :prop_tgt:`INSTALL_NAME_DIR`.  This indicates
the shared library is to be found at runtime using runtime
paths (rpaths).

This property is initialized by the value of the variable
:variable:`CMAKE_MACOSX_RPATH` if it is set when a target is
created.

Runtime paths will also be embedded in binaries using this target and
can be controlled by the :prop_tgt:`INSTALL_RPATH` target property on
the target linking to this target.

Policy CMP0042 was introduced to change the default value of
MACOSX_RPATH to ON.  This is because use of ``@rpath`` is a
more flexible and powerful alternative to ``@executable_path`` and
``@loader_path``.