# libtmux:suspend-client

- **Package:** libtmux
- **Language:** Common Lisp
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-lisp/blob/c2e5fc4ed3befda21f45dfa5d5868c38fd138311/src/client-operations.lisp#L92
- **Public owner:** libtmux
- **Page:** https://libtmux.org/en/lisp/latest/reference/libtmux-suspend-client/

```
(suspend-client client target &key cancel-token timeout output-limit)
```

Request suspension of captured terminal TARGET; return a COMMAND-OUTCOME.
Tmux asks the frontend to stop with SIGTSTP. Success acknowledges the request;
it does not prove process suspension. An already suspended frontend can be a
no-op. Its controlling application owns resumption. CLIENT must own TARGET.
Blocks under shared preflight/dispatch limits; returns no replacement. Stale or
foreign targets signal STALE-TARGET; other failures retain their outcome.
Preflight cannot exclude client replacement before dispatch. Never retries.

See also: `libtmux:detach-client`, `libtmux:fetch-clients`, `libtmux:lock-client`, `libtmux:outcome-status`.

## Parameters

- `client`
- `target`
- `cancel-token?`
- `timeout?`
- `output-limit?`

## tmux command

The tmux commands behind `suspend-client`.

- [`suspend-client`](/en/tmux/latest/manual/suspend-client/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_suspend_client_entry`](/en/tmux/latest/reference/c-variable-cmd_suspend_client_entry/) (attribute)
- [`cmd_detach_client_exec`](/en/tmux/latest/reference/c-function-cmd-detach-client-c-cmd_detach_client_exec/) (function)

## Guides

Pages that discuss `suspend-client`.

- [Explicit operations](/en/lisp/latest/guides/operations/)