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

Tool manpages, doc page, and standardized --help messages #1380

Merged

Commits on Apr 12, 2023

  1. Tool manpages, doc page, and standardized --help messages

    - 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>
    cary-ilm committed Apr 12, 2023
    Configuration menu
    Copy the full SHA
    f16d1d7 View commit details
    Browse the repository at this point in the history
  2. remove debugging status message

    Signed-off-by: Cary Phillips <cary@ilm.com>
    cary-ilm committed Apr 12, 2023
    Configuration menu
    Copy the full SHA
    645c6be View commit details
    Browse the repository at this point in the history