Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

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

module libtmux-clojure latest

libtmux.core

Explicit tmux effects through open! and snapshot!.

Source and package
Qualified name
libtmux.core
Module
libtmux.core
Package
io.github.libtmux:libtmux-clojure
Source
libtmux-clojure/src/main/clojure/libtmux/core.clj

Description#

Captured maps retain opaque Java references; libtmux.data traverses them locally.

Members52#

Collections and queries6#

  • sessions! function Acquires captured sessions; acquisition failure throws.
  • windows! function Acquires captured window occurrences.
  • panes! function Acquires captured pane occurrences.
  • clients! function Acquires captured clients.
  • buffers! function Lists captured buffer names and byte sizes.
  • snapshot! function Acquires an eager captured graph from an explicit server.

Common operations16#

  • open! function Opens local resources for an explicit :socket-path or :socket-name endpoint.
  • capture! function Captures pane lines; :from :history includes scrollback.
  • send-keys! function Sends an explicit vector of tmux key names.
  • new-session! function Creates a detached session and returns a fresh captured session map.
  • new-window! function Creates a window and returns a fresh captured window occurrence.
  • split-pane! function Splits a Pane ref and returns a fresh captured pane occurrence.
  • kill-server! function Kills the explicit tmux server; close! only releases local resources.
  • refresh! function Reacquires an explicit reference, retaining window and pane placement.
  • rename! function Renames a session or window and captures its current data.
  • apply-layout! function Applies an explicit tmux layout string.
  • batch! function Runs independent argv commands using a fresh Java Batch and returns positions.
  • chain! function Runs dependent argv commands with tmux's implicit target between positions.
  • send-literal! function Sends literal text; completion does not mean application readiness.
  • await-channel! function Waits on an explicit tmux channel while reserving capacity for its release.
  • await-text! function Waits within a positive Duration; returns a keyword describing the outcome.
  • move-window! function Moves a window to a session and explicit index.

Other members30#

  • append-hook! function Appends one explicit tmux argv command to a hook.
  • close! function Releases the supplied Server's local resources without killing tmux.
  • delete-buffer! function Deletes an explicit buffer.
  • detach-client! function Detaches the explicit client.
  • environment! function Returns values and explicitly removed names, preserving removal versus absence.
  • error-summary function Returns fixed error metadata without arguments or cause messages.
  • expand! function Evaluates an explicit tmux format at the supplied scope.
  • find-session! function Finds a session by exact name; absence returns nil.
  • hooks! function Returns hook names and their ordered command vectors.
  • join-pane! function Joins a pane to a window.
  • kill! function Kills the explicitly supplied session, window, or pane.
  • link-window! function Links a window into a session.
  • options! function Reads :local options by default, or :effective inherited options.
  • paste-buffer! function Pastes an explicit buffer into a pane.
  • raw! function Runs explicit tmux argv and returns exit status and streams; no shell.
  • remove-environment! function Marks an environment name removed for new child processes.
  • resize! function Resizes a window or pane to positive cell dimensions.
  • run-shell! function Runs an explicitly requested shell command on the server.
  • select! function Selects the preserved window or pane occurrence.
  • set-buffer! function Stores literal buffer contents.
  • set-environment! function Sets a literal environment value.
  • set-hook! function Replaces a hook with one explicit tmux argv command.
  • set-option! function Sets a literal option value at the explicit scope.
  • show-buffer! function Reads literal buffer contents.
  • signal-channel! function Signals an explicit tmux channel.
  • switch-client! function Switches an explicit client to a session.
  • unlink-window! function Unlinks the preserved window occurrence.
  • unset-environment! function Removes the local environment entry, allowing inheritance.
  • unset-hook! function Removes an explicit hook.
  • unset-option! function Removes a local option override.

Guides#

Pages that discuss libtmux.core.

Esc

Type to search.

Reference previewOpen reference