Documentation: Installation.

redcode · Sep 11, 2024 · ea975f2 · ea975f2
1 parent 027b358
commit ea975f2
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/README b/README
@@ -98,6 +98,11 @@ options. The following are some of the most relevant standard options of CMake:
         Choose the type of build (configuration) to generate.
         The default is `Release`.
 
+    -DCMAKE_INSTALL_NAME_DIR="<path>"
+        Specify the directory portion of the dynamic library install name on
+        Apple platforms (for installed shared libraries).
+        Not defined by default.
+
     -DCMAKE_INSTALL_PREFIX="<path>"
         Specify the installation prefix.
         The default is `/usr/local` (on UNIX and UNIX-like operating systems).
@@ -337,4 +342,4 @@ You should have received a copy of the GNU Lesser General Public License along
 with this library. If not, see <http://www.gnu.org/licenses/>.
 
 ________________________________________________________________________________
-Last update: 2024-08-25                                               README EOF
+Last update: 2024-09-11                                               README EOF
diff --git a/README.md b/README.md
@@ -385,6 +385,10 @@ If in doubt, read the [CMake documentation](https://cmake.org/documentation/) fo
 	Choose the type of build (configuration) to generate.  
 	The default is `Release`.
 
+* <span id="cmake_option_cmake_install_name_dir">**<code>-D[CMAKE_INSTALL_NAME_DIR](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_NAME_DIR.html)="\<path\>"</code>**</span>  
+	Specify the [directory portion](https://developer.apple.com/documentation/xcode/build-settings-reference#Dynamic-Library-Install-Name-Base) of the [dynamic library install name](https://developer.apple.com/documentation/xcode/build-settings-reference#Dynamic-Library-Install-Name) on Apple platforms (for installed shared libraries).  
+	Not defined by default.
+
 * <span id="cmake_option_cmake_install_prefix">**<code>-D[CMAKE_INSTALL_PREFIX](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html)="\<path\>"</code>**</span>  
 	Specify the installation prefix.  
 	The default is `"/usr/local"` (on [UNIX](https://en.wikipedia.org/wiki/Unix) and [UNIX-like](https://en.wikipedia.org/wiki/Unix-like) operating systems).
@@ -512,7 +516,7 @@ cd Zeta
 mkdir build && cd build
 cmake \
 	-DCMAKE_BUILD_TYPE=Release \
-	-DCMAKE_INSTALL_PREFIX=$HOME/.local \
+	-DCMAKE_INSTALL_PREFIX="$HOME/.local" \
 	-DZeta_WITH_CMAKE_SUPPORT=YES \
 	-DZeta_WITH_PKGCONFIG_SUPPORT=YES \
 	..
@@ -522,7 +526,8 @@ mkdir build && cd build
 cmake \
 	-DBUILD_SHARED_LIBS=YES \
 	-DCMAKE_BUILD_TYPE=Release \
-	-DCMAKE_INSTALL_PREFIX=$HOME/.local \
+	-DCMAKE_INSTALL_NAME_DIR="\${CMAKE_INSTALL_LIBDIR}" \
+	-DCMAKE_INSTALL_PREFIX="$HOME/.local" \
 	-DZ80_WITH_CMAKE_SUPPORT=YES \
 	-DZ80_WITH_PKGCONFIG_SUPPORT=YES \
 	-DZ80_WITH_EXECUTE=YES \

diff --git a/documentation/Installation.rst b/documentation/Installation.rst
@@ -59,6 +59,11 @@ If in doubt, read the `CMake documentation <https://cmake.org/documentation/>`_
    Choose the type of build (configuration) to generate. |br| |nl|
    The default is ``Release``.
 
+.. option:: -DCMAKE_INSTALL_NAME_DIR="<path>"
+
+   Specify the `directory portion <https://developer.apple.com/documentation/xcode/build-settings-reference#Dynamic-Library-Install-Name-Base>`_ of the `dynamic library install name <https://developer.apple.com/documentation/xcode/build-settings-reference#Dynamic-Library-Install-Name>`_ on Apple platforms (for installed shared libraries). |br| |nl|
+   Not defined by default.
+
 .. option:: -DCMAKE_INSTALL_PREFIX="<path>"
 
    Specify the installation prefix. |br| |nl|