From bfadc284b085ba1aa603476c6bfc754b6b2e3264 Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Fri, 2 May 2025 08:57:29 -0400 Subject: [PATCH] Expand documentation of graphical nodeconsole usage. --- confluent_client/doc/man/nodeconsole.ronn | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/confluent_client/doc/man/nodeconsole.ronn b/confluent_client/doc/man/nodeconsole.ronn index 1325b2bf..26eedc23 100644 --- a/confluent_client/doc/man/nodeconsole.ronn +++ b/confluent_client/doc/man/nodeconsole.ronn @@ -21,9 +21,15 @@ console process which will result in the console window closing. ## OPTIONS +* `-i N`, `--interval`: + For screenshot mode, fetch new screenshots and overwrite old screenshots every N seconds. + For example, `nodeconsole r3u[21:24] -tsi 3` will tile screenshots of r3u21 through r3u24 and + refresh them every 3 seconds. + * `-t`, `--tile`: - Use tmux to arrange consoles of the given noderange into a tiled layout on - the terminal screen + For text consoles, use tmux to arrange consoles of the given noderange into a tiled layout on + the terminal screen. If using 'screenshot' mode, divide the terminal and display the images + in a grid. * `-l`, `--log`: Perform a log reply on the current, local log in /var/log/confluent/consoles. @@ -36,8 +42,12 @@ console process which will result in the console window closing. manager at this time. * `-s`, `--screenshot`: - Attempt to grab screenshot and render using kitty - image protocol. + Attempt to grab screenshot(s) and render using a terminal + image protocol. The image protocol defaults to kitty, and + can be selected by CONFLUENT_IMAGE_PROTOCOL environment variable. + Supported protocols are kitty, iterm, and, sixel (sixel only + if PySixel is installed). This only presents screenshots, there + is no input supported to graphical consoles from a terminal. * `-w`, `--windowed`: Open terminal windows for each node. The