Skip to content

Commit

Permalink
Add a reference to building tools from source to the tools webpage. (#…
Browse files Browse the repository at this point in the history
…1622)

Signed-off-by: Cary Phillips <cary@ilm.com>
  • Loading branch information
cary-ilm authored Feb 2, 2024
1 parent 745681c commit 9503110
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
7 changes: 6 additions & 1 deletion website/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
9 changes: 9 additions & 0 deletions website/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ operations, consider `oiiotool
Swiss Army Knife of `OpenImageIO
<https://sites.google.com/site/openimageio/home>`_

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:
Expand Down

0 comments on commit 9503110

Please sign in to comment.