tmux refresh-client
Refresh the current client if bound to a key, or a single client if one is given with -t.
Syntax¶
tmux refresh-client [-cDlLRSU] [-A pane:state] [-B name:what:format] [-C XxY] [-f flags] [-t target-client] [adjustment]Alias: refresh.
Behavior¶
-t. If -S is
specified, only update the client's status line.
The -U, -D,
-L -R, and
-c flags allow the visible portion of a window
which is larger than the client to be changed.
-U moves the visible part up by
adjustment rows and -D
down, -L left by
adjustment columns and -R
right. -c returns to tracking the cursor
automatically. If adjustment is omitted, 1 is
used. Note that the visible position is a property of the client not of
the window, changing the current window in the attached session will
reset it.
-C sets the width and height of a
control mode client. -A allows a control mode
client to trigger actions on a pane. The argument is a pane ID (with
leading ‘%’), a colon, then one of
‘on’,
‘off’,
‘continue’ or
‘pause’. If
‘off’,
tmux will not send output from the pane to the
client and if all clients have turned the pane off, will stop reading
from the pane. If ‘continue’,
tmux will return to sending output to the pane
if it was paused (manually or with the pause-after
flag). If ‘pause’,
tmux will pause the pane.
-A may be given multiple times for different
panes.
-B sets a subscription to a format for
a control mode client. The argument is split into three items by colons:
name is a name for the subscription;
what is a type of item to subscribe to;
format is the format. After a subscription is
added, changes to the format are reported with the
%subscription-changed notification, at most once
a second. If only the name is given, the subscription is removed.
what may be empty to check the format only for the
attached session, or one of: a pane ID such as
‘%0’;
‘%*’ for all panes in the attached
session; a window ID such as ‘@0’;
or ‘@*’ for all windows in the
attached session.
-f sets a comma-separated list of
client flags, see attach-session.
-l requests the clipboard from the
client using the xterm(1) escape sequence and stores
it in a new paste buffer.
-L, -R,
-U and -D move the
visible portion of the window left, right, up or down by
adjustment, if the window is larger than the
client. -c resets so that the position follows
the cursor. See the window-size option.
C implementation¶
Internal declarations in tmux 3.2a:
Use from a library¶
Each API describes its own defaults, errors and execution model.
tmux sources and license
Syntax comes from tmux 3.2a list-commands. See the global options for sockets and configuration, and command syntax and targets.
Behavior is taken from the tmux 3.2a manual.
Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com> Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.