summaryrefslogtreecommitdiff
path: root/plugins/history/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
commit610b2529d2213a70e3d1153a9baf046c22f298b9 (patch)
tree75278ef17f12844d6810a40250b4f93abd5dd86c /plugins/history/README.md
parentff6d111d793970fc522dd3743367a4c3c46f5fc2 (diff)
downloadzsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.gz
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.bz2
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.zip
Clean up plugin READMEs and a few plugins
- fasd - history - mercurial - pylint - repo - yii2
Diffstat (limited to 'plugins/history/README.md')
-rw-r--r--plugins/history/README.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/plugins/history/README.md b/plugins/history/README.md
index dd9286894..a9d480f46 100644
--- a/plugins/history/README.md
+++ b/plugins/history/README.md
@@ -1,15 +1,17 @@
-## history
+# history plugin
Provides a couple of convenient aliases for using the `history` command to examine your command line history.
-### Requirements
+To use it, add `history` to the plugins array in your zshrc file:
-* None.
+```zsh
+plugins=(... history)
+```
-### Usage
+## Aliases
-* If `h` is called, your command history is listed. Equivalent to using `history`
-
-* If `hsi` is called with an argument, a **case insensitive** `grep` search is performed on your command history, looking for commands that match the argument provided
-
-* If `hsi` is called without an argument you will help on `grep` arguments \ No newline at end of file
+| Alias | Command | Description |
+|-------|----------------------|------------------------------------------------------------------|
+| `h` | `history` | Prints your command history |
+| `hs` | `history \| grep` | Use grep to search your command history |
+| `hsi` | `history \| grep -i` | Use grep to do a case-insensitive search of your command history |