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.

class libtmux-scala latest

Session

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

A tmux session whose operations run in the effect type F .

View as Markdown

Source and package
Module
io.github.libtmux.scaladsl.cats
Package
io.github.libtmux:libtmux-scala_3
Source
libtmux-scala-cats/src/main/scala/io/github/libtmux/scaladsl/cats/Handles.scala
Other languages
PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlin F#
final class Session[F[_]]
class [source]

Description#

Use server for the connection that owns this handle and asJava for Java interoperability. Captured properties stay unchanged until an explicit refresh returns a new handle.

In other ports A tmux session

Members26 members#

Parent objects1 member#

Collections and queries1 member#

  • windows method This session's windows, in tmux's order.

Common operations1 member#

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

Other members23 members#

  • activePane method The active pane of the active window.
  • activeWindow method The window tmux had active in this session.
  • asJava method The Java handle this wraps: the one escape hatch, as on every handle.
  • 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.
  • equals method
  • expand method Expands a tmux format in this session's context, and answers with what it came to.
  • hashCode method
  • hooks method This session's own hooks.
  • id method The session's stable id.
  • 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, which a user may change at any time.
  • 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.
  • toString method
Esc

Type to search.