From bd000596678754e52f2bc25f86794010e761f12c Mon Sep 17 00:00:00 2001 From: andywray Date: Sat, 15 Oct 2022 21:09:31 -0400 Subject: [PATCH] Update man page for -w with arbitrary terminal types --- confluent_client/doc/man/nodeconsole.ronn | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/confluent_client/doc/man/nodeconsole.ronn b/confluent_client/doc/man/nodeconsole.ronn index 286e14e1..30244815 100644 --- a/confluent_client/doc/man/nodeconsole.ronn +++ b/confluent_client/doc/man/nodeconsole.ronn @@ -28,8 +28,17 @@ a new session. manager at this time. * `-w`, `--windowed`: - Openes separate xterm windows for each console in the node range provided. This - works for xterm only. + Open terminal windows for each node. The environment variable + NODECONSOLE_WINDOWED_COMMAND must be set, which should be a text string + corresponding to a command that can be used to open a windowed console, + omitting the "nodeconsole " part of the command, for example, to + open a set of consoles for a range of nodes in separate xterm windows, set + NODECONSOLE_WINDOWED_COMMAND to "xterm -e", or in a WSL environment, to open + a set of consoles for a range of nodes in separate Windows Terminal windows, + with the title set for each node, set NODECONSOLE_WINDOWED_COMMAND to "wt.exe + --title node wsl.exe -d AlmaLinux-8 --shell-type login". Note that "node" when + in the NODECONSOLE_WINDOWED_COMMAND environment variable is treated as a keyword, + not a literal. ## ESCAPE SEQUENCE COMMANDS