aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorYacine Hmito <6893840+yacinehmito@users.noreply.github.com>2026-03-09 14:55:14 +0100
committerGitHub <noreply@github.com>2026-03-09 14:55:14 +0100
commit0172836fda1eb97005ec536571714998f48ad2e2 (patch)
tree76aa93a7f7d2bc9e7453a80e2a95af63a63ea68a /docs
parentRemove unnecessary winapi features (#4816) (diff)
downloadsl0ppij-0172836fda1eb97005ec536571714998f48ad2e2.tar.gz
sl0ppij-0172836fda1eb97005ec536571714998f48ad2e2.tar.xz
sl0ppij-0172836fda1eb97005ec536571714998f48ad2e2.zip
feat(cli): add --pane-id option to dump-screen action (#4598)
* feat(cli): add --pane-id option to dump-screen action Adds the ability to dump a specific terminal pane's content by passing `--pane-id <ID>` to the `dump-screen` CLI action. When omitted, the existing behavior of dumping the focused pane is preserved. This enables coding agents running inside Zellij to inspect the content of other panes programmatically, without needing complex workarounds. Prior art: https://github.com/theslyprofessor/zellij-pane-tracker, whose design complexity is due to current limitations that this PR addresses. * address review * improve man page entry
Diffstat (limited to 'docs')
-rw-r--r--docs/MANPAGE.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/MANPAGE.md b/docs/MANPAGE.md
index 404f4fff..731929b9 100644
--- a/docs/MANPAGE.md
+++ b/docs/MANPAGE.md
@@ -156,7 +156,10 @@ ACTIONS
* __MoveFocus: <Direction\>__ - moves focus in the specified direction (Left,
Right, Up, Down).
* __Clear__ - clears current screen.
-* __DumpScreen: <File\>__ - dumps the screen in the specified file.
+* __DumpScreen: <File\> [--pane-id <ID\>]__ - dumps the pane content to the specified file.
+ If --pane-id is provided, dumps the specified pane; otherwise dumps the focused pane.
+ <ID\> can be a bare integer (eg. 1), a terminal pane id (eg. terminal_1) or a plugin pane id (eg. plugin_1).
+ A bare integer is equivalent to a terminal pane id with the same number.
* __DumpLayout: <File\>__ - dumps the screen in the specified or default file.
* __EditScrollback__ - replaces the current pane with the scrollback buffer.
* __ScrollUp__ - scrolls up 1 line in the focused pane.