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 option to disable automatically outputting helpfile information on bad option entry #65

Open
aebadirad opened this issue Jul 29, 2017 · 5 comments

Comments

@aebadirad
Copy link

Perhaps add an option in the lo4j properties not to spit out the help file content for a misconfigured command line config option?

Some of these help file entries are pretty large, and can make it difficult to see what the input error was in environments with limited scrollback capability.

This is a minor request to improve usability in difficult environments.

@mattsunsjf
Copy link
Contributor

Do you use mlcp.sh/mlcp.bat, JAVA program or custom shell scripts to invoke mlcp?

@mattsunsjf mattsunsjf added this to the N/A milestone Jul 31, 2017
@aebadirad
Copy link
Author

mlcp.sh/mlcp.bat invokes this behavior out of the box.

An easy way to trigger it is just to mlcp import -fakeoption, but it does it with a valid option and a bad value too. It's a very spammy helpfile.

@kcoleman-marklogic
Copy link
Contributor

Some command line tools have the notion of short and long usage messages. You get an abbreviated message if you screw up the command line, and a longer one if you use the help option. That might be something to consider.

For example:

$ tar foo
tar: Old option 'f' requires an argument.
Try 'tar --help' or 'tar --usage' for more information.

$ cp foo
cp: missing destination file operand after ‘foo’
Try 'cp --help' for more information.

I've also seen cases where there's abbreviate usage info like "mycmd filename [options]".

@aebadirad
Copy link
Author

I very much so like that suggestion. This would be ideal from a field-facing perspective.

@mattsunsjf
Copy link
Contributor

Ok, I will see what I can do here.

@mattsunsjf mattsunsjf modified the milestones: 9.0.4, N/A Aug 2, 2017
@mattsunsjf mattsunsjf modified the milestones: 9.0.4, 10.0.2 Mar 22, 2019
@mattsunsjf mattsunsjf assigned yunzvanessa and unassigned mattsunsjf Mar 22, 2019
@yunzvanessa yunzvanessa modified the milestones: 10.0.2, 10.0.3 Aug 24, 2019
@yunzvanessa yunzvanessa modified the milestones: 10.0.3, 11.0.1 Sep 18, 2019
@abika5 abika5 modified the milestones: 11.1.0, 11.2.0 Jan 3, 2024
@abika5 abika5 modified the milestones: 11.3.0, 11.4.0 Jun 20, 2024
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

5 participants