Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a reference to building tools from source to the tools webpage. #1622

Merged
merged 1 commit into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading