# tmux refresh-client

Source: https://libtmux.org/en/tmux/latest/manual/refresh-client/

> Refresh the current client if bound to a key, or a single client if one is given with -t.

Refresh the current client if bound to a key, or a single client if one is given with -t.

## Syntax

```tmux-usage
tmux refresh-client [-cDlLRSU] [-A pane:state] [-B name:what:format] [-C XxY] [-f flags] [-r pane:report] [-t target-client] [adjustment]
```

Alias: `refresh`.

## Behavior

Refresh the current client if bound to a key, or a single client if one is given with `-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 or of a window for a control mode client, `size` must be one of ‘`widthxheight`’ or ‘`window ID:widthxheight`’, for example ‘`80x24`’ or ‘`@0:80x24`’. `-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`](https://libtmux.org/en/tmux/latest/manual/attach-session/). `-r` allows a control mode client to provide information about a pane via a report (such as the response to OSC 10). The argument is a pane ID (with a leading ‘`%`’), a colon, then a report escape sequence.

`-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.7c:

* [`cmd_refresh_client_entry`](https://libtmux.org/en/tmux/latest/reference/c-variable-cmd_refresh_client_entry/)
* [`cmd_refresh_client_exec`](https://libtmux.org/en/tmux/latest/reference/c-function-cmd-refresh-client-c-cmd_refresh_client_exec/)

## Use from a library

Each API describes its own defaults, errors and execution model.

* [Python](https://libtmux.org/en/py/latest/reference/libtmux-server-refresh_client/)
* [Go](https://libtmux.org/en/go/latest/reference/tmux-server-refreshclient/)
* [C#](https://libtmux.org/en/csharp/latest/reference/libtmux-server-refreshclientasync/)

tmux sources and license

Syntax comes from `tmux 3.7c list-commands`. See the [global options](https://libtmux.org/en/tmux/latest/manual/full/#DESCRIPTION) for sockets and configuration, and [command syntax and targets](https://libtmux.org/en/tmux/latest/manual/full/#COMMANDS).

Behavior is taken from the [tmux 3.7c manual](https://github.com/tmux/tmux/blob/79072dd1a9f5fb437a5859e362a496fd57ec0981/tmux.1).

[Command declaration](https://github.com/tmux/tmux/blob/79072dd1a9f5fb437a5859e362a496fd57ec0981/cmd-refresh-client.c#L34)

```
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.
```