libtmux::Session

class libtmux::Session

class [source] ¶

class [source] ¶

class libtmux::Session

Bases:

• libtmux::detail::Row

One session, as one listing saw it.

Reads its own fields without touching tmux: the listing ran once, and every value here is that moment's. A window created since is not in window_count , and a session killed since still answers.

Equality is the server incarnation and the session id together, so two handles from separate listings of one live server agree, and a handle kept across a restart does not become a handle to whatever reused $0.

Discussed in Architecture , Context managers , Format-token fields , Options and hooks , Traversal

In other ports A tmux session

• Python libtmux.Session
• Ruby LibTmux::Session
• Lua libtmux.Session
• TypeScript session.Session
• Rust session.Session
• Go tmux.Session
• Java io.github.libtmux.Session.Session
• .NET LibTmux.Session
• Swift Session

Members

• windows method
• panes method
• new_window method Created detached: a library call that stole the terminal would be a surprise, and attaching is a separate decision.
• kill method
• rename method
• hooks method
• options method Session options.
• id method
• name method
• attached method session_attached counts clients rather than rendering a flag, so any count other than zero means attached.
• detach_clients method Send every client here away, leaving the session running.
• active_window method
• set_option method
• unset_option method Remove the value set here, so the wider scope shows through again.
• set_hook method
• created method
• active_pane method
• refresh method
• select_next_window method Move the selection, and answer with the window it landed on.
• select_previous_window method
• select_last_window method
• attach_command method A command line that attaches a terminal to this session.
• option method
• window_count method
• path method The directory a new window starts in, not the shell's current directory.
• group method Empty unless the session belongs to a group sharing its windows.
• grouped method
• client_count method
• expand method Ask tmux to expand a format against this session.
• kFields attribute
• kNoun attribute
• Session method
• show_message method Put a message on the status line of every client attached here, and send it to a control client as message.