Document auxiliary test script setupssl.py

[d-w-moore]

          Consider reserving `-h` for printing the help text. Or add a few lines to the README explaining how to view the help text.

Originally posted by @korydraughn in #527 (comment)

[alanking]

I don't think -h is reserved for printing help text in any standard (counter-example: df -h). Plus, -h as an option for a hostname parameter has precedent in docker run and possibly other well-known programs.

The setupssl.py script already has a line saying how to view the help text:

python-irodsclient/irods/test/setupssl.py

Line 86 in 0c9600e

Any invalid option prints this help.

So, what is this issue about?

[trel]

python-irodsclient/irods/test/setupssl.py

Line 81 in 0c9600e

-h In the generated certificate, use the given hostname rather than the value returned from socket.gethostname()

Since we already appear to have a collision, then... we use --help as well as 'any invalid option' if that is easily supported with getopt.

We should move to argparse in 3.0 as well... (#598)

[korydraughn]

So, what is this issue about?

It was about -h being reserved for displaying help text.

That comment stemmed from the fact that when I want to see help text for a command, I always attempt to use -h. Of course, we don't have to standardize on that.

Since we already appear to have a collision, then... we use --help as well as 'any invalid option' if that is easily supported with getopt.

I agree.

[alanking]

Okay, so we can add a --help option and call this done?

[trel]

if getopt allows 'long' options... i think so.

[trel]

looks like it ... does. https://docs.python.org/2.7/library/getopt.html