Added example to man page, switched format strings to single quotes. #48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…n is clear, it is nice to see an example to get started. Single quotes are used to prevent the shell from running our bmon patterns as commands, and to prevent it from doing wildcard expansion for the interface string.
…e shell from running our provided format placeholders.
…hile this is less pretty than it was before, it allows the user to actually paste the format string directly into their bmon command to try it out. Before this change, the way the string was formatted you could not simply paste it in and run it (whether it had single or double quotes).
Owner
|
This looks great, thanks! |
Contributor
Author
|
No problem! Thanks for the fantastic tool! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I thought an example of the format output mode would be helpful, so I added one to the man page. I also changed the format strings in out_format.c to use single quotes instead of double quotes. This prevents the shell from evaluating our format strings as commands, since they are wrapped in
$(...). Lastly, I changed the long format string example to be one string as opposed to a multiline string. While the previous format looked nicer, you could not directly paste this into a bmon command and have it work correctly due to the spacing. With this format, you can do that.I made separate commits for each of these changes, so you can cherry pick what you want if you don't want the full set.