dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-11-16 05:01:13 +00:00
Code Issues Releases Wiki Activity
347441abdf
prezto/modules/history-substring-search/README.md

116 lines
3.1 KiB
Markdown
Raw Normal View History

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://').
2021-05-04 01:59:31 +00:00
# History Substring Search
Add documentation for history-substring-search
2012-04-04 13:20:34 +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://').
2021-05-04 01:59:31 +00:00
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.
Correct the history-substring-search README
2012-06-14 21:17:36 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
If this module is used in conjunction with the [_`syntax-highlighting`_][3]
module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
Correct the history-substring-search README
2012-06-14 21:17:36 +00:00
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
Additionally, if this module is used in conjunction with the
[_`autosuggestions`_][4] module, this module must be loaded _before_ the
_`autosuggestions`_ module.
To elaborate, the relative order of loading the modules would be
_`syntax-highlighting`_, _`history-substring-search`_ and _`autosuggestions`_.
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://').
2021-05-04 01:59:31 +00:00
## Contributors
Correct the history-substring-search README
2012-06-14 21:17:36 +00:00
New features and bug fixes should be submitted to the
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://').
2021-05-04 01:59:31 +00:00
[`zsh-history-substring-search`][1] project according to its rules and
Correct the history-substring-search README
2012-06-14 21:17:36 +00:00
regulations. This module will be synchronized against it.
Add documentation for history-substring-search
2012-04-04 13:20:34 +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://').
2021-05-04 01:59:31 +00:00
## Settings
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
### Case Sensitivity
[#23] Rename plugins to modules
2012-03-28 16:41:39 +00:00
To enable case-sensitivity for this module only, add the following line to
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:history-substring-search' case-sensitive 'yes'
```
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
### Highlighting
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
If colors are enabled, _history-substring-search_ will automatically highlight
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
positive results.
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To disable highlighting for this module only, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
zstyle ':prezto:module:history-substring-search' color 'no'
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To set the query found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #52] Add zstyles to configure history-substring-search
2012-12-23 21:54:43 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:history-substring-search:color' found ''
```
[Fix #52] Add zstyles to configure history-substring-search
2012-12-23 21:54:43 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To set the query not found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #52] Add zstyles to configure history-substring-search
2012-12-23 21:54:43 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:history-substring-search:color' not-found ''
```
[Fix #52] Add zstyles to configure history-substring-search
2012-12-23 21:54:43 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To set the search globbing flags, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #52] Add zstyles to configure history-substring-search
2012-12-23 21:54:43 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:history-substring-search' globbing-flags ''
history-substring-search: Tweak documentation and cleanup
2023-09-12 04:28:38 +00:00
```
### Case sensitive search
feat(history-substring-search): add `prefixed` setting support zsh-history-substring-search `HISTORY_SUBSTRING_SEARCH_PREFIXED` env Signed-off-by: mritd <mritd@linux.com>
2021-09-19 10:59:54 +00:00
history-substring-search: Tweak documentation and cleanup
2023-09-12 04:28:38 +00:00
To set the search case-sensitivity, add the following line to
feat(history-substring-search): add `prefixed` setting support zsh-history-substring-search `HISTORY_SUBSTRING_SEARCH_PREFIXED` env Signed-off-by: mritd <mritd@linux.com>
2021-09-19 10:59:54 +00:00
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
history-substring-search: Tweak documentation and cleanup
2023-09-12 04:28:38 +00:00
zstyle ':prezto:module:history-substring-search' case-sensitive 'yes'
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```
[Fix #52] Add zstyles to configure history-substring-search
2012-12-23 21:54:43 +00:00
history-substring-search: add fuzzy and unique
2023-05-19 15:41:29 +00:00
### Fuzzy search
history-substring-search: Tweak documentation and cleanup
2023-09-12 04:28:38 +00:00
To enable search for fuzzy matches, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
history-substring-search: add fuzzy and unique
2023-05-19 15:41:29 +00:00
```sh
zstyle ':prezto:module:history-substring-search' fuzzy 'yes'
```
### Unique results
history-substring-search: Tweak documentation and cleanup
2023-09-12 04:28:38 +00:00
To enable unique results, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
history-substring-search: add fuzzy and unique
2023-05-19 15:41:29 +00:00
```sh
history-substring-search: Tweak documentation and cleanup
2023-09-12 04:28:38 +00:00
zstyle ':prezto:module:history-substring-search' unique 'yes'
```
### Prefixed search
To enable prefixed search matches, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:history-substring-search' prefixed 'yes'
history-substring-search: add fuzzy and unique
2023-05-19 15:41:29 +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://').
2021-05-04 01:59:31 +00:00
## Authors
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
_The authors of this module should be contacted via the [issue tracker][5]._
Add documentation for history-substring-search
2012-04-04 13:20:34 +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://').
2021-05-04 01:59:31 +00:00
- [Suraj N. Kurapati](https://github.com/sunaku)
- [Sorin Ionescu](https://github.com/sorin-ionescu)
Add documentation for history-substring-search
2012-04-04 13:20:34 +00:00
Correct the history-substring-search README
2012-06-14 21:17:36 +00:00
[1]: https://github.com/zsh-users/zsh-history-substring-search
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://').
2021-05-04 01:59:31 +00:00
[2]: https://fishshell.com
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
[3]: ../syntax-highlighting#readme
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
[4]: ../autosuggestions#readme
[5]: https://github.com/sorin-ionescu/prezto/issues
Reference in New Issue Copy Permalink