# libtmux:copy-mode

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

```
(copy-mode client pane &key exit page-up cancel-token timeout output-limit)
```

Enter PANE's tmux copy mode, or EXIT it; return a COMMAND-OUTCOME.
PAGE-UP scrolls up on entry and cannot be combined with EXIT. This addresses an
existing pane and does not create an interactive terminal frontend. Signals
STALE-TARGET or an operational condition.

## Parameters

- `client`
- `pane`
- `exit?`
- `page-up?`
- `cancel-token?`
- `timeout?`
- `output-limit?`

## tmux command

The tmux commands behind `copy-mode`.

- [`copy-mode`](/en/tmux/latest/manual/copy-mode/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_copy_mode_entry`](/en/tmux/latest/reference/c-variable-cmd_copy_mode_entry/) (attribute)
- [`cmd_copy_mode_exec`](/en/tmux/latest/reference/c-function-cmd-copy-mode-c-cmd_copy_mode_exec/) (function)

## Guides

Pages that discuss `copy-mode`.

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