1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-25 22:33:52 +03:00
wezterm/docs/config/lua/keyassignment/Search.md
Benoit de Chezelles f37c3ae5da
Fix some documentation pages (#3321)
* Update ssh_backend.md

* Update normalize_output_to_unicode_nfc.md

* Update strikethrough_position.md

* Update underline_position.md

* Update underline_thickness.md

* Fix lua config docs titles to be formatted as inline code

* Mention how suggested alphabet for quick select is choosen

* Mention update-status and update-right-status for status_update_interval

* Fix docs for all keyassignments to be formatted as inline code

* Fix Lua object index titles

* Fix titles of `wezterm.*` module index pages

* Fix title of `Color` object & `wezterm.color` functions

We reduce titles from h2 to h1 because mkdocs defaults the page title to
the page file name if no h1 header is found.

* Unify title of all object methods

* Add index page for Gui events
2023-03-22 06:36:03 -07:00

48 lines
1.2 KiB
Markdown

# `Search`
{{since('20200607-144723-74889cd4')}}
This action will trigger the search overlay for the current tab.
It accepts a typed pattern string as its parameter, allowing for
`Regex`, `CaseSensitiveString` and `CaseInSensitiveString` as
pattern matching types.
The supported [regular expression syntax is described
here](https://docs.rs/regex/1.3.9/regex/#syntax).
```lua
local act = wezterm.action
config.keys = {
-- search for things that look like git hashes
{
key = 'H',
mods = 'SHIFT|CTRL',
action = act.Search {
Regex = '[a-f0-9]{6,}',
},
},
-- search for the lowercase string "hash" matching the case exactly
{
key = 'H',
mods = 'SHIFT|CTRL',
action = act.Search { CaseSensitiveString = 'hash' },
},
-- search for the string "hash" matching regardless of case
{
key = 'H',
mods = 'SHIFT|CTRL',
action = act.Search { CaseInSensitiveString = 'hash' },
},
}
```
[Learn more about the search overlay](../../../scrollback.md#searching-the-scrollback)
{{since('20220624-141144-bd1b7c5d')}}
You may now use `wezterm.action.Search("CurrentSelectionOrEmptyString")` to have the search take the currently selected text as the item to search.
The selection text is adjusted to be a single line.