wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-09-19 02:37:51 +03:00
Code Issues Projects Releases Wiki Activity

docs: add show-keys command

Browse Source
This commit is contained in:
Wez Furlong 2022-06-24 10:41:21 -07:00
parent e633d897dc
commit 0261f96341
2 changed files with 53 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
ci/generate-docs.py
View File

@ -78,9 +78,7 @@ class GenColorScheme(object):
img = os.path.basename(img)
title = os.path.basename(img).rsplit(".", 1)[0]
idx.write(f"# {title}\n")
idx.write(
f'<img src="{img}" alt="{title}">\n\n'
)
idx.write(f'<img src="{img}" alt="{title}">\n\n')
idx.write("To use this scheme, add this to your config:\n")
idx.write(
f"""
@ -152,7 +150,14 @@ TOC = [
Page("F.A.Q.", "faq.md"),
Page("Getting Help", "help.md"),
Page("Contributing", "contributing.md"),
Page("CLI Reference", "cli/general.md", children=[Gen("cli", "cli/cli")]),
Page(
"CLI Reference",
"cli/general.md",
children=[
Gen("cli", "cli/cli"),
Page("show-keys", "cli/show-keys.md"),
],
),
Page(
"Lua Reference",
"config/lua/general.md",

44
docs/cli/show-keys.md Normal file
View File

@ -0,0 +1,44 @@
# `wezterm show-keys`
*Since: nightly builds only*
Prints the complete set of key assignments based on your config file.
The command shows each key table as well as the set of mouse bindings.
A truncated example of the output is shown below.
```
Default key table
-----------------
CTRL Tab -> ActivateTabRelative(1)
SHIFT | CTRL Tab -> ActivateTabRelative(-1)
...
Key Table: copy_mode
--------------------
Tab -> CopyMode(MoveForwardWord)
SHIFT Tab -> CopyMode(MoveBackwardWord)
SHIFT $ -> CopyMode(MoveToEndOfLineContent)
...
Key Table: search_mode
----------------------
Enter -> CopyMode(PriorMatch)
Escape -> CopyMode(Close)
CTRL n -> CopyMode(NextMatch)
...
Mouse
-----
Down { streak: 1, button: Left } -> SelectTextAtMouseCursor(Cell)
SHIFT Down { streak: 1, button: Left } -> ExtendSelectionToMouseCursor(None)
ALT Down { streak: 1, button: Left } -> SelectTextAtMouseCursor(Block)
...
```