https://github.com/mattms/shelp

Shell help
https://github.com/mattms/shelp

bash help linux shell

Last synced: about 1 month ago
JSON representation

Shell help

• Host: GitHub
• URL: https://github.com/mattms/shelp
• Owner: MattMS
• License: mit
• Created: 2014-11-09T08:36:07.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-04-07T11:40:24.000Z (almost 8 years ago)
• Last Synced: 2024-10-12T21:52:04.086Z (3 months ago)
• Topics: bash, help, linux, shell
• Language: JavaScript
• Size: 160 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shell help

Shelp was created to help out the various `man` and `--help` pages

missing decent examples.

The aim is examples of common shell tasks with details on when and why

you would use them.

## View online or install

You can

[view these pages on GitHub](https://github.com/MattMS/shelp/tree/master/command#readme)

or

[install the package from NPM](https://www.npmjs.com/package/shelp)

for console access:

	npm install -g shelp

It needs to be installed globally to provide the `shelp` command:

	shelp npm ls

## Goals

- All content is in basic Markdown.

  72 columns is preferred, where possible.

- Content is sent to stdout so it can be piped to [less](command/less/)

  or other display tools.

- Each example should only have 1 paragraph before and/or after it.

  This is not a fixed rule, but encourages simple explanations.

- Links to related documentation are kept at the end of each document.

- All that said, any help is better than no help.

  It can always be cleaned up later.