mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-01 19:49:25 +00:00
general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
8edc5e9323
commit
d80e393f78
@ -1,28 +1,25 @@
|
||||
History Substring Search
|
||||
========================
|
||||
# History Substring Search
|
||||
|
||||
Integrates [zsh-history-substring-search][1] into Prezto, which implements
|
||||
the [Fish shell][2]'s history search feature, where the user can type in any
|
||||
part of a previously entered command and press up and down to cycle through
|
||||
matching commands.
|
||||
Integrates [`zsh-history-substring-search`][1] into Prezto, which implements the
|
||||
[Fish shell][2]'s history search feature, where the user can type in any part of
|
||||
a previously entered command and press up and down to cycle through matching
|
||||
commands.
|
||||
|
||||
If this module is used in conjunction with the *syntax-highlighting* module,
|
||||
this module must be loaded **after** the *syntax-highlighting* module.
|
||||
|
||||
Contributors
|
||||
------------
|
||||
## Contributors
|
||||
|
||||
New features and bug fixes should be submitted to the
|
||||
[zsh-history-substring-search][1] project according to its rules and
|
||||
[`zsh-history-substring-search`][1] project according to its rules and
|
||||
regulations. This module will be synchronized against it.
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Case Sensitivity
|
||||
|
||||
To enable case-sensitivity for this module only, add the following line to
|
||||
*zpreztorc*:
|
||||
*~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:history-substring-search' case-sensitive 'yes'
|
||||
@ -34,38 +31,37 @@ If colors are enabled, *history-substring-search* will automatically highlight
|
||||
positive results.
|
||||
|
||||
To enable highlighting for this module only, add the following line to
|
||||
*zpreztorc*:
|
||||
*~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:history-substring-search' color 'yes'
|
||||
```
|
||||
|
||||
To set the query found color, add the following line to *zpreztorc*:
|
||||
To set the query found color, add the following line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:history-substring-search:color' found ''
|
||||
```
|
||||
|
||||
To set the query not found color, add the following line to *zpreztorc*:
|
||||
To set the query not found color, add the following line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:history-substring-search:color' not-found ''
|
||||
```
|
||||
|
||||
To set the search globbing flags, add the following line to *zpreztorc*:
|
||||
To set the search globbing flags, add the following line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:history-substring-search' globbing-flags ''
|
||||
```
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][3].*
|
||||
|
||||
- [Suraj N. Kurapati](https://github.com/sunaku)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Suraj N. Kurapati](https://github.com/sunaku)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/zsh-users/zsh-history-substring-search
|
||||
[2]: http://fishshell.com
|
||||
[2]: https://fishshell.com
|
||||
[3]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
Reference in New Issue
Block a user