mirror of https://github.com/cheat/cheat.git
docopt
Made revisions to the content of the docopt template.
This commit is contained in:
parent
068d117bef
commit
7209f2c929
28
bin/cheat
28
bin/cheat
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
"""cheat
|
"""cheat
|
||||||
|
|
||||||
|
Create and view cheatsheets on the command line.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
cheat <cheatsheet>
|
cheat <cheatsheet>
|
||||||
cheat -e <cheatsheet>
|
cheat -e <cheatsheet>
|
||||||
|
@ -10,24 +12,26 @@ Usage:
|
||||||
cheat -d
|
cheat -d
|
||||||
cheat -v
|
cheat -v
|
||||||
|
|
||||||
cheat allows you to create and view interactive cheatsheets on the
|
|
||||||
command-line. It was designed to help remind *nix system
|
|
||||||
administrators of options for commands that they use frequently,
|
|
||||||
but not frequently enough to remember.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
To look up 'tar':
|
|
||||||
cheat tar
|
|
||||||
|
|
||||||
To create or edit the cheatsheet for 'foo':
|
|
||||||
cheat -e foo
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-d --directories List directories on CHEATPATH
|
-d --directories List directories on CHEATPATH
|
||||||
-e --edit Edit cheatsheet
|
-e --edit Edit cheatsheet
|
||||||
-l --list List cheatsheets
|
-l --list List cheatsheets
|
||||||
-s --search Search cheatsheets for <keyword>
|
-s --search Search cheatsheets for <keyword>
|
||||||
-v --version Print the version number
|
-v --version Print the version number
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
To view the `tar` cheatsheet:
|
||||||
|
cheat tar
|
||||||
|
|
||||||
|
To edit (or create) the `foo` cheatsheet:
|
||||||
|
cheat -e foo
|
||||||
|
|
||||||
|
To list all available cheatsheets:
|
||||||
|
cheat -l
|
||||||
|
|
||||||
|
To search for "ssh" among all cheatsheets:
|
||||||
|
cheat -s ssh
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# require the dependencies
|
# require the dependencies
|
||||||
|
|
Loading…
Reference in New Issue