Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-12-26 04:53:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix command docs deployment for input listen (#9805)

Browse source 
Fix command docs deployment for `input listen`, for more detail check:
https://github.com/nushell/nushell.github.io/pull/987
This commit is contained in:
Justin Ma 2023-07-26 20:00:23 +08:00 committed by GitHub
parent a33b5fe6ce
commit 5a28371b18
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
crates/nu-command/src/platform/input/input_listen.rs
View file

@ -54,13 +54,15 @@ impl Command for InputListen {
fn extra_usage(&self) -> &str { fn extra_usage(&self) -> &str {
r#"There are 5 different type of events: focus, key, mouse, paste, resize. Each will produce a r#"There are 5 different type of events: focus, key, mouse, paste, resize. Each will produce a
corresponding record, distinguished by type field: corresponding record, distinguished by type field:
```
{ type: focus event: (gained|lost) } { type: focus event: (gained|lost) }
{ type: key key_type: <key_type> code: <string> modifiers: [ <modifier> ... ] } { type: key key_type: <key_type> code: <string> modifiers: [ <modifier> ... ] }
{ type: mouse col: <int> row: <int> kind: <string> modifiers: [ <modifier> ... ] } { type: mouse col: <int> row: <int> kind: <string> modifiers: [ <modifier> ... ] }
{ type: paste content: <string> } { type: paste content: <string> }
{ type: resize col: <int> row: <int> } { type: resize col: <int> row: <int> }
There are 6 <modifier> variants: shift, control, alt, super, hyper, meta. ```
There are 4 <key_type> variants: There are 6 `modifier` variants: shift, control, alt, super, hyper, meta.
There are 4 `key_type` variants:
f - f1, f2, f3 ... keys f - f1, f2, f3 ... keys
char - alphanumeric and special symbols (a, A, 1, $ ...) char - alphanumeric and special symbols (a, A, 1, $ ...)
media - dedicated media keys (play, pause, tracknext ...) media - dedicated media keys (play, pause, tracknext ...)