mirror of
https://github.com/wez/wezterm.git
synced 2024-12-22 12:51:31 +03:00
docs: add --help output from various wezterm cli subcommands
This commit is contained in:
Wez Furlong
parent
287026cfa0
commit
2b9bf36eb6
@ -22,3 +22,8 @@ for cmd in start ssh serial connect ls-fonts show-keys imgcat set-working-direct
|
||||
fname="docs/examples/cmd-synopsis-wezterm-${cmd}--help.txt"
|
||||
cargo run --example narrow $PWD/target/debug/wezterm $cmd --help | ./target/debug/strip-ansi-escapes > $fname
|
||||
done
|
||||
|
||||
for cmd in list list-clients move-pane-to-new-tab split-pane spawn send-text get-text activate-pane-direction ; do
|
||||
fname="docs/examples/cmd-synopsis-wezterm-cli-${cmd}--help.txt"
|
||||
cargo run --example narrow $PWD/target/debug/wezterm cli $cmd --help | ./target/debug/strip-ansi-escapes > $fname
|
||||
done
|
||||
|
||||
@ -12,3 +12,8 @@ ignoring case so you can use `left` rather than `Left`:
|
||||
* `Left`, `Right`, `Up`, `Down` to activate based on direction
|
||||
* `Next`, `Prev` to cycle based on the ordinal position in the pane tree.
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-activate-pane-direction--help.txt" %}
|
||||
```
|
||||
|
||||
@ -25,3 +25,9 @@ The default capture region is the main terminal screen, not including the scroll
|
||||
You may use the `--start-line` and `--end-line` parameters to set the range.
|
||||
Both of these accept integer values, where `0` refers to the top of the non-scrollback
|
||||
screen area, and negative numbers index backwards into the scrollback.
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-get-text--help.txt" %}
|
||||
```
|
||||
|
||||
@ -44,3 +44,9 @@ $ wezterm cli list-clients --format json
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-list-clients--help.txt" %}
|
||||
```
|
||||
|
||||
@ -43,3 +43,9 @@ $ wezterm cli list --format json
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-list--help.txt" %}
|
||||
```
|
||||
|
||||
@ -13,3 +13,9 @@ The following arguments modify the behavior:
|
||||
* `--window-id WINDOW_ID` - Create the new tab in the specified window id rather than the current window.
|
||||
* `--workspace WORKSPACE` - When using `--new-window`, use `WORKSPACE` as the name of the workspace for the newly created window rather than the default workspace name `"default"`.
|
||||
* `--pane-id` - Specifies which pane to move. See also [Targeting Panes](index.md#targeting-panes).
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-move-pane-to-new-tab--help.txt" %}
|
||||
```
|
||||
|
||||
@ -23,3 +23,9 @@ The following arguments modify the behavior:
|
||||
|
||||
* `--no-paste` - Send the text directly, rather than as a bracketed paste. {{since('20220624-141144-bd1b7c5d', inline=True)}}
|
||||
* `--pane-id` - Specifies which pane to send the text to. See also [Targeting Panes](index.md#targeting-panes).
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-send-text--help.txt" %}
|
||||
```
|
||||
|
||||
@ -41,3 +41,9 @@ The following options affect the behavior:
|
||||
* `--workspace WORKSPACE` - when using `--new-window`, set the workspace name rather than using the default name of `"default"`.
|
||||
* `--window-id WINDOW_ID` - Spawn the tab into the specified window, rather than using the current window
|
||||
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-spawn--help.txt" %}
|
||||
```
|
||||
|
||||
@ -48,3 +48,8 @@ The following options affect the behavior:
|
||||
* `--top` - Split vertically, with the new pane on the top.
|
||||
* `--top-level` - Rather than splitting the active pane, split the entire window.
|
||||
|
||||
## Synopsis
|
||||
|
||||
```console
|
||||
{% include "../../examples/cmd-synopsis-wezterm-cli-split-pane--help.txt" %}
|
||||
```
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Wez's Terminal Emulator
|
||||
http://github.com/wez/wezterm
|
||||
|
||||
|
||||
@ -0,0 +1,10 @@
|
||||
Activate an adjacent pane in the specified direction
|
||||
|
||||
Usage: wezterm cli activate-pane-direction <DIRECTION>
|
||||
|
||||
Arguments:
|
||||
<DIRECTION> The direction to switch to [possible values: Up, Down, Left,
|
||||
Right, Next, Prev]
|
||||
|
||||
Options:
|
||||
-h, --help Print help
|
||||
21
docs/examples/cmd-synopsis-wezterm-cli-get-text--help.txt
Normal file
21
docs/examples/cmd-synopsis-wezterm-cli-get-text--help.txt
Normal file
@ -0,0 +1,21 @@
|
||||
Retrieves the textual content of a pane and output it to stdout
|
||||
|
||||
Usage: wezterm cli get-text [OPTIONS]
|
||||
|
||||
Options:
|
||||
--pane-id <PANE_ID>
|
||||
Specify the target pane. The default is to use the current pane based
|
||||
on the environment variable WEZTERM_PANE
|
||||
--start-line <START_LINE>
|
||||
The starting line number. 0 is the first line of terminal screen.
|
||||
Negative numbers proceed backwards into the scrollback. The default
|
||||
value is unspecified is 0, the first line of the terminal screen
|
||||
--end-line <END_LINE>
|
||||
The ending line number. 0 is the first line of terminal screen.
|
||||
Negative numbers proceed backwards into the scrollback. The default
|
||||
value if unspecified is the bottom of the the terminal screen
|
||||
--escapes
|
||||
Include escape sequences that color and style the text. If omitted,
|
||||
unattributed text will be returned
|
||||
-h, --help
|
||||
Print help
|
||||
8
docs/examples/cmd-synopsis-wezterm-cli-list--help.txt
Normal file
8
docs/examples/cmd-synopsis-wezterm-cli-list--help.txt
Normal file
@ -0,0 +1,8 @@
|
||||
list windows, tabs and panes
|
||||
|
||||
Usage: wezterm cli list [OPTIONS]
|
||||
|
||||
Options:
|
||||
--format <FORMAT> Controls the output format. "table" and "json" are
|
||||
possible formats [default: table]
|
||||
-h, --help Print help
|
||||
@ -0,0 +1,8 @@
|
||||
list clients
|
||||
|
||||
Usage: wezterm cli list-clients [OPTIONS]
|
||||
|
||||
Options:
|
||||
--format <FORMAT> Controls the output format. "table" and "json" are
|
||||
possible formats [default: table]
|
||||
-h, --help Print help
|
||||
@ -0,0 +1,17 @@
|
||||
Move a pane into a new tab
|
||||
|
||||
Usage: wezterm cli move-pane-to-new-tab [OPTIONS]
|
||||
|
||||
Options:
|
||||
--pane-id <PANE_ID> Specify the pane that should be moved. The
|
||||
default is to use the current pane based on the
|
||||
environment variable WEZTERM_PANE
|
||||
--window-id <WINDOW_ID> Specify the window into which the new tab will be
|
||||
created. If omitted, the window associated with
|
||||
the current pane is used
|
||||
--new-window Create tab in a new window, rather than the
|
||||
window currently containing the pane
|
||||
--workspace <WORKSPACE> If creating a new window, override the default
|
||||
workspace name with the provided name. The
|
||||
default name is "default"
|
||||
-h, --help Print help
|
||||
15
docs/examples/cmd-synopsis-wezterm-cli-send-text--help.txt
Normal file
15
docs/examples/cmd-synopsis-wezterm-cli-send-text--help.txt
Normal file
@ -0,0 +1,15 @@
|
||||
Send text to a pane as though it were pasted. If bracketed paste mode is enabled
|
||||
in the pane, then the text will be sent as a bracketed paste
|
||||
|
||||
Usage: wezterm cli send-text [OPTIONS] [TEXT]
|
||||
|
||||
Arguments:
|
||||
[TEXT] The text to send. If omitted, will read the text from stdin
|
||||
|
||||
Options:
|
||||
--pane-id <PANE_ID> Specify the target pane. The default is to use the
|
||||
current pane based on the environment variable
|
||||
WEZTERM_PANE
|
||||
--no-paste Send the text directly, rather than as a bracketed
|
||||
paste
|
||||
-h, --help Print help
|
||||
31
docs/examples/cmd-synopsis-wezterm-cli-spawn--help.txt
Normal file
31
docs/examples/cmd-synopsis-wezterm-cli-spawn--help.txt
Normal file
@ -0,0 +1,31 @@
|
||||
Spawn a command into a new window or tab
|
||||
Outputs the pane-id for the newly created pane on success
|
||||
|
||||
Usage: wezterm cli spawn [OPTIONS] [PROG]...
|
||||
|
||||
Arguments:
|
||||
[PROG]... Instead of executing your shell, run PROG. For example: `wezterm
|
||||
cli spawn -- bash -l` will spawn bash as if it were a login shell
|
||||
|
||||
Options:
|
||||
--pane-id <PANE_ID>
|
||||
Specify the current pane. The default is to use the current pane based
|
||||
on the environment variable WEZTERM_PANE. The pane is used to
|
||||
determine the current domain and window
|
||||
--domain-name <DOMAIN_NAME>
|
||||
|
||||
--window-id <WINDOW_ID>
|
||||
Specify the window into which to spawn a tab. If omitted, the window
|
||||
associated with the current pane is used. Cannot be used with
|
||||
`--workspace` or `--new-window`
|
||||
--new-window
|
||||
Spawn into a new window, rather than a new tab
|
||||
--cwd <CWD>
|
||||
Specify the current working directory for the initially spawned
|
||||
program
|
||||
--workspace <WORKSPACE>
|
||||
When creating a new window, override the default workspace name with
|
||||
the provided name. The default name is "default". Requires
|
||||
`--new-window`
|
||||
-h, --help
|
||||
Print help
|
||||
41
docs/examples/cmd-synopsis-wezterm-cli-split-pane--help.txt
Normal file
41
docs/examples/cmd-synopsis-wezterm-cli-split-pane--help.txt
Normal file
@ -0,0 +1,41 @@
|
||||
split the current pane.
|
||||
Outputs the pane-id for the newly created pane on success
|
||||
|
||||
Usage: wezterm cli split-pane [OPTIONS] [PROG]...
|
||||
|
||||
Arguments:
|
||||
[PROG]... Instead of executing your shell, run PROG. For example: `wezterm
|
||||
cli split-pane -- bash -l` will spawn bash as if it were a login
|
||||
shell
|
||||
|
||||
Options:
|
||||
--pane-id <PANE_ID>
|
||||
Specify the pane that should be split. The default is to use the
|
||||
current pane based on the environment variable WEZTERM_PANE
|
||||
--horizontal
|
||||
Equivalent to `--right`. If neither this nor any other direction is
|
||||
specified, the default is equivalent to `--bottom`
|
||||
--left
|
||||
Split horizontally, with the new pane on the left
|
||||
--right
|
||||
Split horizontally, with the new pane on the right
|
||||
--top
|
||||
Split vertically, with the new pane on the top
|
||||
--bottom
|
||||
Split vertically, with the new pane on the bottom
|
||||
--top-level
|
||||
Rather than splitting the active pane, split the entire window
|
||||
--cells <CELLS>
|
||||
The number of cells that the new split should have. If omitted, 50% of
|
||||
the available space is used
|
||||
--percent <PERCENT>
|
||||
Specify the number of cells that the new split should have, expressed
|
||||
as a percentage of the available space
|
||||
--cwd <CWD>
|
||||
Specify the current working directory for the initially spawned
|
||||
program
|
||||
--move-pane-id <MOVE_PANE_ID>
|
||||
Instead of spawning a new command, move the specified pane into the
|
||||
newly created split
|
||||
-h, --help
|
||||
Print help
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Connect to wezterm multiplexer
|
||||
|
||||
Usage: wezterm connect [OPTIONS] <DOMAIN_NAME> [PROG]...
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Output an image to the terminal
|
||||
|
||||
Usage: wezterm imgcat [OPTIONS] [FILE_NAME]
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Display information about fonts
|
||||
|
||||
Usage: wezterm ls-fonts [OPTIONS]
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Record a terminal session as an asciicast
|
||||
|
||||
Usage: wezterm record [PROG]...
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Replay an asciicast terminal session
|
||||
|
||||
Usage: wezterm replay [OPTIONS] <CAST_FILE>
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Open a serial port
|
||||
|
||||
Usage: wezterm serial [OPTIONS] <PORT>
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Advise the terminal of the current working directory by emitting an OSC 7 escape
|
||||
sequence
|
||||
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Show key assignments
|
||||
|
||||
Usage: wezterm show-keys [OPTIONS]
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Establish an ssh session
|
||||
|
||||
Usage: wezterm ssh [OPTIONS] <USER_AT_HOST_AND_PORT> [PROG]...
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Start the GUI, optionally running an alternative program
|
||||
|
||||
Usage: wezterm start [OPTIONS] [PROG]...
|
||||
|
||||
Loading…
Reference in New Issue
Block a user