From 95031106a8a70b1aed4cbac3a42cac0014b86bc8 Mon Sep 17 00:00:00 2001 From: Cary Phillips Date: Fri, 2 Feb 2024 11:37:38 -0800 Subject: [PATCH] Add a reference to building tools from source to the tools webpage. (#1622) Signed-off-by: Cary Phillips --- website/install.rst | 7 ++++++- website/tools.rst | 9 +++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/website/install.rst b/website/install.rst index 7f1d8aee27..aa64ee0507 100644 --- a/website/install.rst +++ b/website/install.rst @@ -423,7 +423,12 @@ Component Options * ``OPENEXR_BUILD_TOOLS`` - Build and install the binary programs (exrheader, exrinfo, + Build the binary programs (exrheader, exrinfo, + exrmakepreview, etc). Default is ``ON``. + +* ``OPENEXR_INSTALL_TOOLS`` + + Install the binary programs (exrheader, exrinfo, exrmakepreview, etc). Default is ``ON``. * ``OPENEXR_INSTALL_EXAMPLES`` diff --git a/website/tools.rst b/website/tools.rst index c100cb2331..ffad27610b 100644 --- a/website/tools.rst +++ b/website/tools.rst @@ -14,6 +14,15 @@ operations, consider `oiiotool Swiss Army Knife of `OpenImageIO `_ +The OpenEXR tools are not generally included in most package managers' +distribution of OpenEXR libraries (e.g. via ``yum install``). To build +the tools from source, configure the top-level OpenEXR project build +with the cmake option ``OPENEXR_BUILD_TOOLS=ON``. The tools can only +be built from source as a component of the overall project build, not +separately. To further include the tools in the OpenEXR installation +after build (i.e. ``cmake --target install``), configure with +``OPENEXR_INSTALL_TOOLS=ON``. Both are on by default. + .. toctree:: :caption: Tools :titlesonly: