aselimov/zsh-history-substring-search
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: fix markdown rendering on Github: - and _

Browse source 
* Extra `---` lines were rendered as horizontal rules.
* Underscores in configuration variables were italics.
This commit is contained in:
Suraj N. Kurapati 2016-07-16 09:11:25 -07:00
parent 43b456b85c
commit 434fabd55e
1 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,5 +1,4 @@
zsh-history-substring-search # zsh-history-substring-search
==============================================================================
This is a clean-room implementation of the [Fish shell][1]'s history search This is a clean-room implementation of the [Fish shell][1]'s history search
feature, where you can type in any part of any previously entered command feature, where you can type in any part of any previously entered command
@ -13,13 +12,13 @@ You can also use K and J in VI mode or ^P and ^N in EMACS mode for the same.
[5]: https://github.com/zsh-users/zsh-history-substring-search [5]: https://github.com/zsh-users/zsh-history-substring-search
[6]: https://github.com/zsh-users/zsh-syntax-highlighting [6]: https://github.com/zsh-users/zsh-syntax-highlighting
------------------------------------------------------------------------------
Requirements Requirements
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
* [ZSH](http://zsh.sourceforge.net) 4.3 or newer * [ZSH](http://zsh.sourceforge.net) 4.3 or newer
------------------------------------------------------------------------------
Usage Usage
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -84,33 +83,33 @@ Usage
the cursor reaches the last line of the command, pressing the DOWN the cursor reaches the last line of the command, pressing the DOWN
arrow key again will cause this script to perform another search. arrow key again will cause this script to perform another search.
------------------------------------------------------------------------------
Configuration Configuration
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
This script defines the following global variables. You may override their This script defines the following global variables. You may override their
default values only after having loaded this script into your ZSH session. default values only after having loaded this script into your ZSH session.
* HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_FOUND is a global variable that defines * `HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_FOUND` is a global variable that defines
how the query should be highlighted inside a matching command. Its default how the query should be highlighted inside a matching command. Its default
value causes this script to highlight using bold, white text on a magenta value causes this script to highlight using bold, white text on a magenta
background. See the "Character Highlighting" section in the zshzle(1) man background. See the "Character Highlighting" section in the zshzle(1) man
page to learn about the kinds of values you may assign to this variable. page to learn about the kinds of values you may assign to this variable.
* HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_NOT_FOUND is a global variable that * `HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_NOT_FOUND` is a global variable that
defines how the query should be highlighted when no commands in the defines how the query should be highlighted when no commands in the
history match it. Its default value causes this script to highlight using history match it. Its default value causes this script to highlight using
bold, white text on a red background. See the "Character Highlighting" bold, white text on a red background. See the "Character Highlighting"
section in the zshzle(1) man page to learn about the kinds of values you section in the zshzle(1) man page to learn about the kinds of values you
may assign to this variable. may assign to this variable.
* HISTORY_SUBSTRING_SEARCH_GLOBBING_FLAGS is a global variable that defines * `HISTORY_SUBSTRING_SEARCH_GLOBBING_FLAGS` is a global variable that defines
how the command history will be searched for your query. Its default value how the command history will be searched for your query. Its default value
causes this script to perform a case-insensitive search. See the "Globbing causes this script to perform a case-insensitive search. See the "Globbing
Flags" section in the zshexpn(1) man page to learn about the kinds of Flags" section in the zshexpn(1) man page to learn about the kinds of
values you may assign to this variable. values you may assign to this variable.
* HISTORY_SUBSTRING_SEARCH_ENSURE_UNIQUE is a global variable that defines * `HISTORY_SUBSTRING_SEARCH_ENSURE_UNIQUE` is a global variable that defines
whether all search results returned are _unique_. If set to a non-empty whether all search results returned are _unique_. If set to a non-empty
value, then only unique search results are presented. This behaviour is off value, then only unique search results are presented. This behaviour is off
by default. An alternative way to ensure that search results are unique is by default. An alternative way to ensure that search results are unique is
@ -124,7 +123,7 @@ default values only after having loaded this script into your ZSH session.
receive globally unique search results only once, then use this receive globally unique search results only once, then use this
configuration variable, or use `setopt HIST_IGNORE_ALL_DUPS`. configuration variable, or use `setopt HIST_IGNORE_ALL_DUPS`.
------------------------------------------------------------------------------
History History
------------------------------------------------------------------------------ ------------------------------------------------------------------------------