Core Library0.xAPI Reference

Choose documentation 3

v0.1.1

Current version

v0.1.1
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

class libtmux-ruby v0.1.1

Endpoint

Executable and socket selection. Construction starts no clients.

Source and package
Qualified name
LibTmux::Endpoint
Module
LibTmux
Package
libtmux
Source
gems/libtmux/lib/libtmux/endpoint.rb
class LibTmux::Endpoint

Description#

Endpoint.new() takes a socket_path: or a socket_name:. With neither, it picks the socket as tmux does when it is given none, and environment: (the process environment by default) decides which: the path in LIBTMUX_SOCKET_PATH, else the name in LIBTMUX_SOCKET, else the socket TMUX names when run inside tmux, else tmux's default socket. A variable that is empty counts as unset, and a socket given as an argument ignores the variables. {.from_env} skips the LIBTMUX_* variables.

Members8#

  • == method Behavior: Endpoints.
  • eql? method Behavior: Endpoints.
  • executable method Returns the value of attribute executable.
  • from_env method The socket of the tmux server this process runs inside, else tmux's default socket. It ignores LIBTMUX_SOCKET_PATH and LIBTMUX_SOCKET.
  • hash method Behavior: Endpoints.
  • inspect method Behavior: Endpoints.
  • new method Behavior: Endpoints.
  • socket_path method Returns the value of attribute socket_path.
Esc

Type to search.

Reference previewOpen reference