1
0
Fork 0
mirror of synced 2024-06-26 02:11:09 -04:00
zimfw/modules/history/README.md
Eric Nielsen af11392473 [history] Remove EXTENDED_HISTORY and INC_APPEND_HISTORY
as they are not required (not even recommended) to be set along with
`SHARE_HISTORY`. See zshoptions(1) on `SHARE_HISTORY`:

> This option ... also causes your typed commands to be appended to the
> history file (the latter is like specifying `INC_APPEND_HISTORY`,
> which should be turned off if this option is in effect). The history
> lines are also output with timestamps ala `EXTENDED_HISTORY` ...

Also update copy in comments and in the README. Stick with the following
style for the README:

* Header 1 with the module name is in `lowercase`.
* Other headers are in `Sentence case`. Common header names that should
  be consistently used are `Aliases`, `Functions`, `Settings`, and
  `Zsh options`.
* The names `Zim` and `Zsh` always appear capitalized, even in the
  middle of sentences.

Closes #313
2018-12-15 08:10:29 -05:00

23 lines
765 B
Markdown

history
=======
Sets sane history options.
The history is set to be saved in the `${ZDOTDIR:-${HOME}}/.zhistory` file.
Zsh options
-----------
* `BANG_HIST` performs csh-style '!' expansion.
* `SHARE_HISTORY` causes all terminals to share the same history 'session'.
* `HIST_IGNORE_DUPS` does not enter immediate duplicates into the history.
* `HIST_IGNORE_ALL_DUPS` removes older command from the history if a duplicate is to be added.
* `HIST_IGNORE_SPACE` removes commands from the history that begin with a space.
* `HIST_SAVE_NO_DUPS` ommits older commands that duplicate newer ones when saving.
* `HIST_VERIFY` doesn't execute the command directly upon history expansion.
Aliases
-------
* `history-stat` lists the 10 most used commands