RMUX(1)

NAME
rmux - tmux-compatible terminal multiplexer CLI

SYNOPSIS
rmux [-2CDhlNuVv] [-c shell-command] [-f file] [-L socket-name] [-S socket-path] [-T features] [command [flags]]

DESCRIPTION
RMUX is a cross-platform terminal multiplexer built around a local client and server architecture. Unix builds use OS socket credentials; Windows builds use same-user named pipes and ConPTY. It preserves tmux-compatible command-line behavior while keeping RMUX product labels in binary output, help text, and status text.

TOP-LEVEL OPTIONS

-2  Accept the tmux-compatible 256-colour compatibility flag.

-C  Enter tmux text control mode.

-D  Run the hidden server in the foreground.

-h  Print the tmux-style top-level usage line to standard output and exit 0.

-l  Accept the tmux-compatible login-shell flag.

-N  Disable automatic server startup for commands that otherwise auto-start.

-u  Force UTF-8 mode for the client process.

-V  Print the RMUX package version and exit 0. For build and support details, use rmux diagnose --json or rmux diagnose --human. In short-option clusters, -V stops the -h scan, so -Vh prints the version.

-v  Accept the tmux-compatible verbose flag.

-c shell-command
    Start or connect to the rmux server, then execute the resolved shell with -c shell-command using the current terminal.

-f file
    Load the given configuration file.

-L socket-name
    Use the named socket below the rmux UID socket directory.

-S socket-path
    Use the given absolute socket path.

-T features
    Accept tmux-compatible terminal feature declarations.

COMMAND HELP
Command help uses rmux <command> --help. Short -h remains available for tmux command semantics such as rmux split-window -h.

LIST-COMMANDS
list-commands is client-local and does not contact the server. With no arguments it prints one line per implemented command in tmux command table order.

list-keys can render the compiled default key table without a running server when no runtime key-table mutations are available.

IMPLEMENTED COMMAND SURFACE
The public CLI dispatches 90 commands:
attach-session (attach)
bind-key (bind)
break-pane (breakp)
capture-pane (capturep)
choose-buffer
choose-client
choose-tree
clear-history (clearhist)
clear-prompt-history (clearphist)
clock-mode
command-prompt
confirm-before (confirm)
copy-mode
customize-mode
delete-buffer (deleteb)
detach-client (detach)
display-menu (menu)
display-message (display)
display-popup (popup)
display-panes (displayp)
find-window (findw)
has-session (has)
if-shell (if)
join-pane (joinp)
kill-pane (killp)
kill-server
kill-session
kill-window (killw)
last-pane (lastp)
last-window (last)
link-window (linkw)
list-buffers (lsb)
list-clients (lsc)
list-commands (lscm)
list-keys (lsk)
list-panes (lsp)
list-sessions (ls)
list-windows (lsw)
load-buffer (loadb)
lock-client (lockc)
lock-server (lock)
lock-session (locks)
move-pane (movep)
move-window (movew)
new-session (new)
new-window (neww)
next-layout (nextl)
next-window (next)
paste-buffer (pasteb)
pipe-pane (pipep)
previous-layout (prevl)
previous-window (prev)
refresh-client (refresh)
rename-session (rename)
rename-window (renamew)
resize-pane (resizep)
resize-window (resizew)
respawn-pane (respawnp)
respawn-window (respawnw)
rotate-window (rotatew)
run-shell (run)
save-buffer (saveb)
select-layout (selectl)
select-pane (selectp)
select-window (selectw)
send-keys (send)
send-prefix
server-access
set-buffer (setb)
set-environment (setenv)
set-hook
set-option (set)
set-window-option (setw)
show-buffer (showb)
show-environment (showenv)
show-hooks
show-messages (showmsgs)
show-options (show)
show-prompt-history (showphist)
show-window-options (showw)
source-file (source)
split-window (splitw)
start-server (start)
suspend-client (suspendc)
swap-pane (swapp)
swap-window (swapw)
switch-client (switchc)
unbind-key (unbind)
unlink-window (unlinkw)
wait-for (wait)

BUILT-IN COMMAND ALIASES

choose-session
    Expands to choose-tree -s.

choose-window
    Expands to choose-tree -w.

NOTES
link-window and unlink-window ship in the public CLI surface with tmux-style shared window links across sessions, including linked-window format variables and hook context.