Window.panes
Source and package
-
Public owner:
LibtmuxExamples#
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 Libtmuxmodule Client = Libtmux_unix.Clientmodule Workspace = Libtmux_unix.Workspacemodule Config = Libtmux_workspace.Configmodule Plan = Libtmux_workspace.Planmodule Execution = Libtmux_workspace.Executionlet 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 ())inlet pane =Snapshot.find_pane(get (Client.capture client))(Pane.Target.id linked.pane)|> Option.getinlet text = "showcase ready" inignore (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 inPrintf.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-" "" inFun.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" inOut_channel.with_open_text config_file (fun output ->output_string output "set-option -s exit-unattached on\n");let wrapper = Filename.concat directory "tmux" inOut_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" |] inlet version =Fun.protect~finally:(fun () ->if Unix.close_process_in channel <> Unix.WEXITED 0 thenfailwith "tmux version discovery failed")(fun () -> String.trim (input_line channel))inif not (String.starts_with ~prefix:"tmux " version) thenfailwith "invalid tmux version";let version = String.sub version 5 (String.length version - 5) inlet ready = Filename.concat directory "ready.txt" inOut_channel.with_open_text ready (fun output ->output_string output "showcase ready\n");let spawn =Spawn.make (Exec { program = "/bin/cat"; args = [ "-u"; ready; "-" ] })inlet config =matchConfig.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)inlet plan =matchPlan.make~endpoint:(Endpoint.socket_path socket)~version ~observed:None configwith| Ok value -> value| Error error -> failwith (Format.asprintf "%a" Plan.pp_error error)inlet operation = get (Workspace.submit_bootstrap ~binary:wrapper plan) inFun.protect~finally:(fun () -> get (Workspace.close operation))(fun () ->let receipt = get (Workspace.await operation) inif receipt.status <> Execution.Succeeded thenfailwith "workspace setup failed";let client = Option.get (Workspace.client operation) inlet initial = List.hd (Iarray.get receipt.steps 0).created inPrintf.printf "socket=%s\n%!" socket;let pane =Snapshot.find_pane(get (Client.capture client))(Pane.Target.id initial.pane)|> Option.getinignore(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" inlet snapshot = with_demo binary capture_graph inprint_graph snapshotRun the recorded entry point:
Terminal window $ opam exec -- dune exec examples/showcase_graph.exe -- tmuxExpected outcome line, after the temporary socket path:
graph: 2 sessions, 2 windows, 3 links, 2 panes
Guides#
Pages that discuss panes.
In other ports#
List a window's panes
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| PowerShell | Lib Use the -Window parameter set to acquire panes in one window. |
| Julia | Lib panes with a captured WindowSnapshot reads panes in that window; missing coverage is an error. |
| Erlang | tmux 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 traverses a captured window without contacting tmux. |
| TypeScript | window |
| Rust | window |
| Go | tmux |
| Java | io |
| Clojure | libtmux Traverses one capture locally. It does not issue a list-panes command. |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| F# | Lib Builds a deferred pane query from one LibTmux.Window and its server. Query.list acquires panes scoped to that window ID. |
| C++ | libtmux:: |
| Swift | Snapshot |
| Perl | Lib Reads this physical window’s captured panes without I/O. |
No equivalent is recorded in Lua or Elixir.