# LibTmux::Pane#break_out

- **Module:** LibTmux
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/46474e8a2f03e39fc2b0ff73b6a841777b79c4d2/gems/libtmux/lib/libtmux/operations.rb#L351
- **Page:** https://libtmux.org/en/ruby/v0.1.2/reference/libtmux-pane-break_out/

```
def break_out: (
  session: ::LibTmux::EntityRef,
  name: ::String,
  ?timeout: ::Numeric,
  ?cancel: untyped
) -> ::LibTmux::Window
```

Exact tmux 3.7 ignores -n on [break-pane](/en/tmux/latest/manual/break-pane/) and crashes without it, so the
name is applied again afterwards. Before 3.6 a sole pane's break prints
no ID, so the window is read back from the pane.

Behavior contract: Entity mutation.

## Parameters

- `session` (`::LibTmux::EntityRef`)
- `name` (`::String`)
- `timeout` (`::Numeric`)
- `cancel` (`untyped`)

## Raises

- [`ProtocolError`](/en/ruby/v0.1.2/reference/libtmux-protocolerror/)

## tmux command

The tmux commands behind `break_out`.

- [`break-pane`](/en/tmux/latest/manual/break-pane/)
- [`list-panes`](/en/tmux/latest/manual/list-panes/) `-t` window scope, [`cmd_list_panes_window`](/en/tmux/latest/reference/c-function-cmd-list-panes-c-cmd_list_panes_window/) (source: `gems/libtmux/lib/libtmux/operations.rb:360`)
- [`rename-window`](/en/tmux/latest/manual/rename-window/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_break_pane_entry`](/en/tmux/latest/reference/c-variable-cmd_break_pane_entry/) (attribute)
- [`cmd_break_pane_exec`](/en/tmux/latest/reference/c-function-cmd-break-pane-c-cmd_break_pane_exec/) (function)
- [`cmd_list_panes_entry`](/en/tmux/latest/reference/c-variable-cmd_list_panes_entry/) (attribute)
- [`cmd_list_panes_window`](/en/tmux/latest/reference/c-function-cmd-list-panes-c-cmd_list_panes_window/) (function)
- [`cmd_rename_window_entry`](/en/tmux/latest/reference/c-variable-cmd_rename_window_entry/) (attribute)
- [`cmd_rename_window_exec`](/en/tmux/latest/reference/c-function-cmd-rename-window-c-cmd_rename_window_exec/) (function)

## In other ports

Move a pane out into a window of its own

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Pane.break_pane`](/en/py/latest/reference/libtmux-pane-break_pane/) (method) |
| Lua | [`libtmux.Pane:break_out`](/en/lua/latest/reference/libtmux-pane-break_out/) (method) |
| TypeScript | [`pane.Pane.breakOut`](/en/ts/latest/reference/pane-pane-breakout/) (method) |
| Rust | [`pane.Pane.break_out`](/en/rs/latest/reference/pane-pane-break_out/) (method) |
| Go | [`tmux.Pane.BreakPane`](/en/go/latest/reference/tmux-pane-breakpane/) (method) |
| Java | [`io.github.libtmux.Pane.breakOut`](/en/java/latest/reference/io-github-libtmux-pane-pane-breakout/) (method) |
| C# | [`LibTmux.Pane.BreakAsync`](/en/csharp/latest/reference/libtmux-pane-breakasync/) (method) |
| C++ | [`libtmux::Pane::break_out`](/en/cxx/latest/reference/libtmux-pane-break_out/) (method) |
| Swift | [`Server.breakPane(_:from:named:)`](/en/swift/latest/reference/server-breakpane(_-from-named-)/) (method) |

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