# pane.Pane.enterCopyMode

- **Module:** pane
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ts/blob/073b9d7dedad900bff6f5ec0ea47794e40225870/packages/libtmux/src/pane.ts#L629
- **Page:** https://libtmux.org/en/ts/latest/reference/pane-pane-entercopymode/

```
enterCopyMode(): Promise<void>
```

Enter this pane's copy mode.

## Examples

```ts
await pane.enterCopyMode();
```

## tmux command

The tmux commands behind `enterCopyMode`.

- [`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)

## In other ports

Put a pane into copy mode

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Pane.copy_mode`](/en/py/latest/reference/libtmux-pane-copy_mode/) (method) |
| Ruby | [`LibTmux::Pane#copy_mode`](/en/ruby/latest/reference/libtmux-pane-copy_mode/) (method) |
| Lua | [`libtmux.Pane:copy_mode`](/en/lua/latest/reference/libtmux-pane-copy_mode/) (method) |
| Rust | [`pane.Pane.copy_mode`](/en/rs/latest/reference/pane-pane-copy_mode/) (method) |
| Go | [`tmux.Pane.CopyMode`](/en/go/latest/reference/tmux-pane-copymode/) (method) |
| Java | [`io.github.libtmux.Pane.copyMode`](/en/java/latest/reference/io-github-libtmux-pane-pane-copymode/) (method) |
| C# | [`LibTmux.Pane.EnterCopyModeAsync`](/en/csharp/latest/reference/libtmux-pane-entercopymodeasync/) (method) |
| C++ | [`libtmux::Pane::enter_copy_mode`](/en/cxx/latest/reference/libtmux-pane-enter_copy_mode/) (method) |
| Swift | no equivalent on `Pane` |

No equivalent is recorded in PowerShell, Julia, Elixir, Kotlin, Scala or F#.