Core Library0.xAPI Reference

Choose documentation 3

v0.1.1

Current version

v0.1.1
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ruby v0.1.1

Pane.copy_mode

Behavior: Copy mode.

Source and package
Qualified name
LibTmux::Pane#copy_mode
Module
LibTmux
Declared in
Pane
Package
libtmux
Source
gems/libtmux/lib/libtmux/operations.rb
Other languages
PowerShell Julia Elixir PythonLuaTypeScriptRustGoJavaC#C++ Swift Kotlin Scala F#
def copy_mode: ( ?scroll_up: bool, ?exit_on_bottom: bool, ?mouse_drag: bool, ?cancel_mode: bool, ?page_down: bool, ?source: ::LibTmux::EntityRef?, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult

Description#

Behavior contract: Copy mode.

Parameters

tmux command#

The tmux commands behind copy_mode.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Put a pane into copy mode

Equivalents of Put a pane into copy mode in other languages
Language Equivalent
Python libtmux.Pane.copy_mode
Lua libtmux.Pane:copy_mode
TypeScript pane.Pane.enterCopyMode
Rust pane.Pane.copy_mode
Go tmux.Pane.CopyMode
Java io.github.libtmux.Pane.copyMode
C# LibTmux.Pane.EnterCopyModeAsync
C++ libtmux::Pane::enter_copy_mode
Swift no equivalent on Pane

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

Esc

Type to search.

Reference previewOpen reference