aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-09-14 15:58:56 +0200
committerJay Berkenbilt <ejb@ql.org>2022-09-14 15:58:56 +0200
commit2e35ead5791feea1f7d9cde9c4eaf5c8d1efa2fa (patch)
tree1e8be602f0cd1d75be9ab693a3e45768aff6371b
parentfaac493a5dcbe913ccc950b92b9f8c1e8492b7ef (diff)
downloadqpdf-2e35ead5791feea1f7d9cde9c4eaf5c8d1efa2fa.tar.zst
Doc: add examples for install dev component (fixes #767)
-rw-r--r--manual/installation.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/manual/installation.rst b/manual/installation.rst
index 08c49765..9a13b3ab 100644
--- a/manual/installation.rst
+++ b/manual/installation.rst
@@ -190,6 +190,41 @@ There are several components that can be installed separately:
- - examples
- Example source files
+Note that the ``lib`` component installs only runtime libraries, not
+header files or other files/links needed to build against qpdf. For
+that, you need ``dev``. If you are using shared libraries, the ``dev``
+will install files or create symbolic links that depend on files
+installed by ``lib``, so you will need to install both. If you wanted
+to build software against the qpdf library and only wanted to install
+the files you needed for that purpose, here are some examples:
+
+- Install development files with static libraries only:
+
+ ::
+
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_SHARED_LIBS=OFF
+ cmake --build build --parallel --target libqpdf
+ cmake --install build --component dev
+
+- Install development files with shared libraries only:
+
+ ::
+
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_STATIC_LIBS=OFF
+ cmake --build build --parallel --target libqpdf
+ cmake --install build --component lib
+ cmake --install build --component dev
+
+
+- Install development files with shared and static libraries:
+
+ ::
+
+ cmake -S . -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo
+ cmake --build build --parallel --target libqpdf libqpdf_static
+ cmake --install build --component lib
+ cmake --install build --component dev
+
There are also separate options, discussed in :ref:`build-options`,
that control how certain specific parts of the software are installed.