add history documentation

This commit is contained in:
Matt Hamilton 2015-12-15 02:45:18 -05:00
parent 434232b5c6
commit 83476386b0

28
modules/history/README.md Normal file
View File

@ -0,0 +1,28 @@
History
=======
Sets sane default history options.
History file is set to save in `${ZDOTDIR:-$HOME}/.zhistory`
(most likely ~/.zhistory)
Zsh Options
-----------
| Option | Effect |
| ------ | ------ |
| BANG_HIST | Use csh-style '!' expansion |
| EXTENDED_HISTORY | Save timestamps along with commands |
| INC_APPEND_HISTORY | Commands are added to the history file immediately upon execution |
| SHARE_HISTORY | Causes all terminals to share the same history 'session' |
| HIST_IGNORE_DUPS | Do not enter immediate duplicates into history |
| HIST_IGNORE_ALL_DUPS | If duplicate is to be added, remove older instance in history |
| HIST_IGNORE_SPACE | Do not add any commands to history that begin with a space |
| HIST_SAVE_NO_DUPS | When saving, older commands that duplicate newer commands are omitted |
| HIST_VERIFY | Upon history 'selection', don't execute immediately. Require a carriage return |
Aliases
-------
* `history-stat` lists the 10 most used commands