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

All tools should have a -h/--help option #13

Closed
5 tasks done
kba opened this issue May 18, 2016 · 2 comments
Closed
5 tasks done

All tools should have a -h/--help option #13

kba opened this issue May 18, 2016 · 2 comments

Comments

@kba
Copy link
Contributor

kba commented May 18, 2016

Not all the tools support a help flag. We should add this as a baseline so users can get at least minimal usage info on the command line.

Tools without -h/--help (c.f. smoke.tsht):

  • hocr-check
  • hocr-combine
  • hocr-extract-images
  • hocr-lines
  • hocr-merge-dc

Plus possibly those that do not run at the moment because of PyXML/lxml #9

@zuphilip
Copy link
Collaborator

Moreover, we can check that the help will be shown, if a command is called without any argument. I am not sure how consistently this is already the case at the moment.

@kba
Copy link
Contributor Author

kba commented May 18, 2016

Some commands expect to read from STDIN and will just wait for input if no argument is given.

@kba kba mentioned this issue May 19, 2016
zuphilip pushed a commit that referenced this issue May 21, 2016
hocr-check: exit 0 if -h / --help
zuphilip pushed a commit that referenced this issue May 21, 2016
hocr-combine: exit 0 if -h / --help, #13
zuphilip pushed a commit that referenced this issue May 21, 2016
zuphilip pushed a commit that referenced this issue May 21, 2016
zuphilip pushed a commit that referenced this issue May 21, 2016
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