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

Program Options: -- help #54

Closed
cvvergara opened this issue Apr 29, 2015 · 3 comments
Closed

Program Options: -- help #54

cvvergara opened this issue Apr 29, 2015 · 3 comments

Comments

@cvvergara
Copy link
Member

-h -- help
specifics: help should show also if an unknown/required or any parameter is wrong, the help message should be displayed.
Component of issue: #43

@cvvergara
Copy link
Member Author

Because --host -h is for Host,
for the help only use --help

@dkastl
Copy link
Member

dkastl commented Jun 23, 2015

Well, I thought what about looking at how @psql@ and @osm2psql@ do, but unfortunately they do differently. I think following one of them is a good idea, because then users will feel familiar with the program options:

psql

       -h hostname
       --host=hostname
           Specifies the host name of the machine on which the server is running. If the value begins
           with a slash, it is used as the directory for the Unix-domain socket.

       -?
       --help
           Show help about psql command line arguments, and exit.

osm2psql

       -H|--host hostname
              Database server hostname or socket location.

       -h|--help
              Help information.
              Add -v to display supported projections.

Not sure, which one looks better. So for me any is fine.

@cvvergara cvvergara changed the title Program Options: -h -- help Program Options: -- help Mar 18, 2016
@cvvergara
Copy link
Member Author

Removed the -h of the title becausse its used as a shortcut for --host

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants