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

Add note to use -h for more detail in Usage. #255

Open
richardhsu opened this issue Jul 3, 2014 · 0 comments
Open

Add note to use -h for more detail in Usage. #255

richardhsu opened this issue Jul 3, 2014 · 0 comments

Comments

@richardhsu
Copy link
Contributor

When you type naarad it will generate a simple usage report:

Usage: 
 To generate a diff report      : naarad -d report1 report2 -o <output_location> -c <optional: config-file> -e <optional: turn on exit code>
 To generate an analysis report : naarad -i <input_location> -o <output_location> -c <optional: config_file> -e <optional: turn on exit code> -n <optional: disable plotting of images>

We should add a quick note so users can know to type -h for more detail.

Proposing:

For more detail and help : naarad -h

Usage: 
 To generate a diff report      : naarad -d report1 report2 -o <output_location> -c <optional: config-file> -e <optional: turn on exit code>
 To generate an analysis report : naarad -i <input_location> -o <output_location> -c <optional: config_file> -e <optional: turn on exit code> -n <optional: disable plotting of images>
 For more detail and help       : naarad -h
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

1 participant