Add info on command help #1393
Merged
Add info on command help #1393
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
das-g
requested changes
Oct 15, 2018
en/intro_to_command_line/README.md
Outdated
| @@ -146,6 +146,24 @@ You'll probably see something similar on your machine. Once you open the command | |||
|
|
|||
| --- | |||
|
|
|||
| ### Learn more about a command | |||
|
|
|||
| Many commands you can type at the command prompt have built-in help that you can display and read! For example, to learn more about the Current directory command: | |||
There was a problem hiding this comment.
Is "current" capitalized here intentionally?
There was a problem hiding this comment.
I had thought the tutorial capitalized it but I think you are right, I was looking at a header... will fix.
en/intro_to_command_line/README.md
Outdated
|
|
||
| <!--sec data-title="Command help: OS X and Linux" data-id="OSX_Linux_pwd" data-collapse=true ces--> | ||
|
|
||
| OS X and Linux have a `man` command, which gives you help on commands. Try `man pwd` and see what it says, or put `man` before other commands to see their help. |
There was a problem hiding this comment.
If the man page doesn't fit in the command line window, man will automatically invoke a pager (usually less) to display the content. It should probably be mentioned how to navigate in there (arrow keys, page-up/page-down keys) and how to exit the pager (q for "quit").
There was a problem hiding this comment.
Good idea! I'll update the text...
Do not capitalize name of command in "Get help" section. Also describe how to use the pager in man on Linux / OS/X.
|
How's this version? Thanks for the feedback! |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1384