SOLR-16766: Remove -usage as option, and ensure both -help and -h work

[bszabo97]

https://issues.apache.org/jira/browse/SOLR-16766

Description

Nowhere do we mention -usage as a parameter, and it's not one that I ever use. -help is common, as is -h, so make sure that works everywhere. There are places where -h doesn't work!

Solution

Deleted appearances of -usage and added -h where it was not present. Also made some "beautification" here and there to make the help more consistent and complete.

Tests

Please describe the tests you've developed or run to confirm this patch implements the feature or solves the problem.

Checklist

Please review the following and check all that apply:

• I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
• I have created a Jira issue and added the issue ID to my pull request title.
• I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
• I have developed this patch against the main branch.
• I have run ./gradlew check.
• I have added tests for my changes.
• I have added documentation for the Reference Guide

[epugh]

LGTM

[epugh]

in the not too distant future, I think all that detailed "help" information is going to move to the Ref Guide, and we'll only have the help that the commons-cli (or the other tool that @elyograg found) being generated in bin/solr -h... That way we can put all the tips and tricks and examples in one place, the Ref Guide! See SOLR-15831.

[epugh]

It would be great to make sure that all the text improvements that you get when you run a -h also are in the Ref Guide page ;-)

[bszabo97]

I was a bit uncertain to add all of the options to the ref guide as well (for example all the -verbose options for every command). But if I understand correctly you would suggest to add all of these options and descriptions (where it is more detailed) to the ref guide?

[epugh]

I was a bit uncertain to add all of the options to the ref guide as well (for example all the -verbose options for every command). But if I understand correctly you would suggest to add all of these options and descriptions (where it is more detailed) to the ref guide?

I think so.... We should point users to the ref guide for detailed help information when using our various bin/solr XXX tools... Otehrwise, what we see is that we duplicate content and it gets out of alignment...

[epugh]

a good example is how the bin/solr package -h tool works, it has it's own home grown help format that is different then other tools....

[bszabo97]

So you suggest to add everything to the ref guide and change the help of the tools to a link which points the users to the corresponding ref guide paragraph instead of having the whole description duplicated?