Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

typealias libtmux-scala latest

Session

Package io.github.libtmux.scaladsl.Session io.github.libtmux.scaladsl

A captured session, opaque over the Java handle; every operation beyond equality is an extension, generated from the operation catalog or handwritten where the catalog marks it WAIT , STREAM or LIFECYCLE .

View as Markdown

Source and package
Module
io.github.libtmux.scaladsl
Package
io.github.libtmux:libtmux-scala_3
Source
libtmux-scala/src/main/scala/io/github/libtmux/scaladsl/Session.scala
Other languages
PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlin F#
opaque type Session = JavaSessionobject Session
typealias [source]

Discussed in Server, session, window, pane

In other ports A tmux session

Members25 members#

Parent objects1 member#

  • server method The server this session lives on.

Collections and queries1 member#

  • windows method This session's windows.

Common operations1 member#

  • newWindow method Creates a window in this session and returns that exact window.

Other members22 members#

  • activePane method The active pane of the active window.
  • activeWindow method The window tmux had active in this session.
  • asJava method The underlying Java session. Opaque wrapping is free, so this never copies scope or state.
  • attached method Whether a client was attached when this was captured.
  • detachClients method Detaches every client attached to this session, leaving the session running.
  • environment method This session's own environment, which a process started in it is given on top of the server's.
  • expand method Expands a tmux format in this session's context, and answers with what it came to.
  • given_CanEqual_Session_Session constant
  • hooks method This session's own hooks.
  • id method The session id, as text, so it can be compared and listed.
  • info method The fields this capture stored.
  • kill method Ends this session.
  • lastWindow method Returns to the window that was active before this one.
  • name method The session name.
  • nextWindow method Moves to the next window in this session, wrapping at the end.
  • options method This session's own options.
  • previousWindow method Moves to the previous window in this session, wrapping at the start.
  • refresh method Takes a new capture and returns this session as it is now.
  • rename method Renames this session and returns its replacement capture.
  • selectWindow method Makes a window of this session the active one.
  • setHistoryLimit method Sets the scrollback retained by panes created in this session.
  • windowCount method How many windows this session holds.
Esc

Type to search.