Tool manpages, doc page, and standardized --help messages #1380
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add manpages for the tool programs (exr2aces, exrenvmap, etc)
- Pages are generated via help2man
- Pages are installed into share/man
- Standardize the tool usage messages:
* The output of --help goes to stdout, so that "exrheader --help | more" is easy
* Usage output goes to stderr on mistakes like malformed arguments
* Each program has a --version option
* ImfMisc.h has a getLibraryVersion() that returns the
CMAKE_OPENEXR_VERSION the library was compiled with (which might
be mismatched with the headers currently being compiled.
- The website has a "Tools" page that describes the tools and usage,
but also includes a pointer to oiiotool for any serious image
processing utilities
- The website html output is no longer installed with the
distribution. This was inadvertent and not helpful, a leftover from
when "docs" referred to the .pdf technical documentation that now
lives on the webpage.
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
meshula
approved these changes
Apr 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add manpages for the tool programs (exr2aces, exrenvmap, etc)
Standardize the tool usage messages:
--helpgoes to stdout, so thatexrheader --help | moreis easy-versionoptionImfMisc.hhas agetLibraryVersion()that returns theCMAKE_OPENEXR_VERSIONthe library was compiled with (which might be mismatched with the headers currently being compiled.The website has a "Tools" page that describes the tools and usage, but also includes a pointer to oiiotool for any serious image processing utilities
The website html output is no longer installed with the distribution. This was inadvertent and not helpful, a leftover from when "docs" referred to the .pdf technical documentation that now lives on the webpage.