Skip to content

Commit

Permalink
docopt
Browse files Browse the repository at this point in the history
Made revisions to the content of the docopt template.
  • Loading branch information
chrisallenlane committed Feb 28, 2017
1 parent 068d117 commit 7209f2c
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions bin/cheat
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

"""cheat
Create and view cheatsheets on the command line.
Usage:
cheat <cheatsheet>
cheat -e <cheatsheet>
Expand All @@ -10,24 +12,26 @@ Usage:
cheat -d
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:
-d --directories List directories on CHEATPATH
-e --edit Edit cheatsheet
-l --list List cheatsheets
-s --search Search cheatsheets for <keyword>
-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
Expand Down

0 comments on commit 7209f2c

Please sign in to comment.