Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-ocaml latest

Window.panes

Source and package
Qualified name
Libtmux.Window.panes
Module
Libtmux
Declared in
Window
Package
libtmux
Source
lib/libtmux.mli
Other languages
Perlmethod Erlangfunction PowerShellcmdlet Juliafunction Elixir Haskell Common Lispfunction PythonRuby Lua TypeScriptRustGoJavaC#C++SwiftKotlinScalaF#function Clojurefunction

Public owner: Libtmux

Examples#

Navigate the typed object graph. This complete program creates a private daemon, checks its result and closes its clients. Use OCaml 5.5.2 on Linux with tmux 3.3a through 3.8. Run it from the source checkout after following the installation guide. View source

open Libtmux
module Client = Libtmux_unix.Client
module Workspace = Libtmux_unix.Workspace
module Config = Libtmux_workspace.Config
module Plan = Libtmux_workspace.Plan
module Execution = Libtmux_workspace.Execution
let get = function
| Ok value -> value
| Error error -> failwith (Format.asprintf "%a" Error.pp error)
let capture_graph client (initial : Created.t) spawn =
let linked =
get
(Client.create_session client ~name:"linked" ~window_name:"linked-home"
~spawn ())
in
let pane =
Snapshot.find_pane
(get (Client.capture client))
(Pane.Target.id linked.pane)
|> Option.get
in
let text = "showcase ready" in
ignore (get (Client.wait_for_text ~timeout:0.5 client pane ~text));
get
(Client.link_window client initial.window ~session:linked.session ~index:7);
get (Client.capture client)
let print_graph snapshot =
Snapshot.sessions snapshot
|> Iarray.iter (fun session ->
Session.window_links session
|> Iarray.iter (fun link ->
let window = Window_link.window link in
Printf.printf "%s/%d %s: %d pane(s)\n" (Session.name session)
(Window_link.index link) (Window.name window)
(Iarray.length (Window.panes window))));
assert (Iarray.length (Snapshot.sessions snapshot) = 2);
assert (Iarray.length (Snapshot.windows snapshot) = 2);
assert (Iarray.length (Snapshot.window_links snapshot) = 3);
assert (Iarray.length (Snapshot.panes snapshot) = 2);
print_endline "graph: 2 sessions, 2 windows, 3 links, 2 panes"
let with_demo binary use =
let directory = Filename.temp_dir "libtmux-ocaml-showcase-" "" in
Fun.protect
~finally:(fun () ->
Sys.readdir directory
|> Array.iter (fun name -> Sys.remove (Filename.concat directory name));
Unix.rmdir directory)
(fun () ->
let socket = Filename.concat directory "server" in
(* Give this private daemon a lifetime even if startup fails. *)
let config_file = Filename.concat directory "tmux.conf" in
Out_channel.with_open_text config_file (fun output ->
output_string output "set-option -s exit-unattached on\n");
let wrapper = Filename.concat directory "tmux" in
Out_channel.with_open_text wrapper (fun output ->
Printf.fprintf output "#!/bin/sh\nexec %s -f %s \"$@\"\n"
(Filename.quote binary)
(Filename.quote config_file));
Unix.chmod wrapper 0o700;
let channel = Unix.open_process_args_in binary [| binary; "-V" |] in
let version =
Fun.protect
~finally:(fun () ->
if Unix.close_process_in channel <> Unix.WEXITED 0 then
failwith "tmux version discovery failed")
(fun () -> String.trim (input_line channel))
in
if not (String.starts_with ~prefix:"tmux " version) then
failwith "invalid tmux version";
let version = String.sub version 5 (String.length version - 5) in
let ready = Filename.concat directory "ready.txt" in
Out_channel.with_open_text ready (fun output ->
output_string output "showcase ready\n");
let spawn =
Spawn.make (Exec { program = "/bin/cat"; args = [ "-u"; ready; "-" ] })
in
let config =
match
Config.make ~directory ~session:"showcase"
[ Config.window ~name:"editor" [ Config.pane ~spawn () ] ]
with
| Ok value -> value
| Error error -> failwith (Format.asprintf "%a" Config.pp_error error)
in
let plan =
match
Plan.make
~endpoint:(Endpoint.socket_path socket)
~version ~observed:None config
with
| Ok value -> value
| Error error -> failwith (Format.asprintf "%a" Plan.pp_error error)
in
let operation = get (Workspace.submit_bootstrap ~binary:wrapper plan) in
Fun.protect
~finally:(fun () -> get (Workspace.close operation))
(fun () ->
let receipt = get (Workspace.await operation) in
if receipt.status <> Execution.Succeeded then
failwith "workspace setup failed";
let client = Option.get (Workspace.client operation) in
let initial = List.hd (Iarray.get receipt.steps 0).created in
Printf.printf "socket=%s\n%!" socket;
let pane =
Snapshot.find_pane
(get (Client.capture client))
(Pane.Target.id initial.pane)
|> Option.get
in
ignore
(get
(Client.wait_for_text ~timeout:0.5 client pane
~text:"showcase ready"));
use client initial spawn))
let () =
let binary = if Array.length Sys.argv = 2 then Sys.argv.(1) else "tmux" in
let snapshot = with_demo binary capture_graph in
print_graph snapshot

Run the recorded entry point:

Terminal window
$ opam exec -- dune exec examples/showcase_graph.exe -- tmux

Expected outcome line, after the temporary socket path:

graph: 2 sessions, 2 windows, 3 links, 2 panes
Parameters

Guides#

Pages that discuss panes.

In other ports#

List a window's panes

Equivalents of List a window's panes in other languages
Language Equivalent
Python libtmux.Window.panes
Ruby LibTmux::Window#list_panes
PowerShell LibTmux\Get-TmuxPane Use the -Window parameter set to acquire panes in one window.
Julia LibTmux.panes panes with a captured WindowSnapshot reads panes in that window; missing coverage is an error.
Erlang tmux_snapshot:related/3 Pass panes, a captured physical window and its snapshot for a local relationship read.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:panes panes traverses a captured window without contacting tmux.
TypeScript window.Window.panes
Rust window.Window.panes
Go tmux.Window.Panes
Java io.github.libtmux.Window.panes
Clojure libtmux.data/panes Traverses one capture locally. It does not issue a list-panes command.
Kotlin io.github.libtmux.kotlin.Window.panes
Scala io.github.libtmux.scaladsl.Window.panes
C# LibTmux.Window.Panes
F# LibTmux.FSharp.Window.panes Builds a deferred pane query from one LibTmux.Window and its server. Query.list acquires panes scoped to that window ID.
C++ libtmux::Window::panes
Swift Snapshot.panes(of:)
Perl LibTmux::Window::panes Reads this physical window’s captured panes without I/O.

No equivalent is recorded in Lua or Elixir.

Esc

Type to search.

Reference previewOpen reference