jasper-software / jasper

Official Repository for the JasPer Image Coding Toolkit
http://www.ece.uvic.ca/~mdadams/jasper
Other
223 stars 101 forks source link

[Help document bug] For jasper, the help document misses some options #344

Closed ccccmd closed 1 year ago

ccccmd commented 2 years ago

The "--help" option of jasper misses the option "cmptno", "memory-limit", "list-enabled-formats", "list-all-formats", "enable-format", "enable-all-formats" for version 3.0.6.

            cmdopts->cmptno = atoi(jas_optarg);
            break;
            cmdopts->max_mem = strtoull(jas_optarg, 0, 10);
            break;
            cmdopts->list_codecs = 1;
            cmdopts->list_codecs_all = 0;
            break;
            cmdopts->list_codecs = 1;
            cmdopts->list_codecs_all = 1;
            break;
            cmdopts->enable_format = jas_optarg;
            break;
            cmdopts->enable_all_formats = 1;
            break;

But they do not appear in the document provided by "--help".

It may prevent users from using the relevant function.

mdadams commented 1 year ago

This comment applies to #342, #343, #344, and #345.

Some changes to the usage information printed by various programs and the manual have been made to address this issue. Please read the commit log message for more details.

IMPORTANT NOTES:

Some of the command-line options that were mentioned in this issue were already documented in the manual but not in the usage information printed by the program. It was never the intention for the usage information printed by the program to include information about every command-line option. Only some of the more common options were intended to be identified. A comment to this effect has been added to the usage message.

Please also note that some command-line options are very deliberately undocumented (both in the manual and in the program usage information) because they are intended only for internal use by the JasPer software development team. In some cases this is because the options pose significant security risks if not used in a safe manner. In other cases this is because the options may be removed or changed without any notice.

mdadams commented 1 year ago

As an addendum to my previous comment: The change can be found in commit e97639fe47faed62703ba47c1071b91e3d76eb41.