Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Provided Documentation for help command #691

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions _commands/shells/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
---
## help

#### **Description:**

`help` takes a linux command as an input and outputs information about that command. 'help' can be used to learn more information about a command that a user is unfamilier with.

If no command is given as input, a list of help topics is printed.

There are three command line flags:

Options:
- -d output short description for the command
- -m display usage in pseudo-manpage format
- -s output only a short usage synopsis for the command

#### **Usage and Examples**
Generally, running 'help' on a linux command is not very helpful, as the information provided is extensive and hard to follow. Thus, running with the -d flag is easier to understand and is usually more applicable. Also, running help with the -s flag will output how to use the command.

Examples:

~~~ bash
$ help -d help
help - Display information about builtin commands
$ help -d cd
cd - Change the shell working directory
$ help -s help
help: help [-dms] [pattern ...]
$help -s cd
cd: cd [-L|[-P [-e]] [-@]] [dir]
~~~