server.Server

class server.Server

class [source] ¶

class [source] ¶

class server.Server

Members

• serverBrand attribute
• batch method Run planned mutations in order, resolving each to what it made.
• clients method Every client attached to the server.
• cmd method Run a tmux command this package does not model.
• colors method How many colours this server was told the terminal has.
• configFile method The configuration file this server was pointed at, if any.
• connect method Bind this server to one control-mode connection and return it.
• constructor method
• daemonIdentity method Which daemon is answering on this socket right now.
• deleteBuffer method Discard a named paste buffer.
• equals method Whether other is a handle addressing the same tmux server.
• getEnvironment method One variable from the server's global environment, or undefined when tmux carries no entry.
• hasSession method Whether a session with this name exists.
• ifShell method Run one command or another depending on a condition.
• isAlive method Whether the tmux server is reachable.
• kill method Terminate the tmux server and every session on it.
• listBuffers method Every buffer name this server holds.
• listCommands method Every command name the running tmux understands.
• loadBuffer method Fill a paste buffer from data fed through tmux's stdin.
• newSession method Create a detached session and resolve it as a handle.
• panes method Every pane on the server.
• pipeline method Run several tmux commands in order.
• raiseIfDead method Assert the server is reachable, raising with tmux's reason if not.
• removeEnvironment method Mark a variable in the server's global environment for removal from the environment of processes tmux starts, leaving the entry in place.
• runShell method Run a shell command through tmux and return whatever it printed.
• saveBuffer method Write a paste buffer to a file instead of reading it back.
• sessions method Every session on the server, read now.
• setBuffer method Put a string into a named paste buffer.
• setEnvironment method Set a variable in the server's global environment.
• setGlobalOption method Set a default every session or window inherits.
• setHook method Bind a tmux command to a global hook.
• setOption method Set a server-scope option.
• showBuffer method Read a named paste buffer's contents.
• showBufferBytes method Read a named paste buffer without decoding or splitting its bytes.
• showEnvironment method Every variable in the server's global environment.
• showGlobalOptions method Read the defaults every session or window inherits.
• showHooks method Every global hook tmux currently reports.
• showOptions method Every server-scope option tmux currently reports.
• showResolvedOptions method The option values that govern this server, own and inherited together.
• snapshot method Acquire an immutable view of the server at this instant.
• socketName method The socket name this server addresses, if it was named rather than pathed.
• socketPath method The socket path this server addresses, if it was given one.
• sourceFile method Run a tmux config file against this server.
• tmuxBin method The tmux executable this server runs.
• toString method How this server renders in a log line or an error.
• unsetEnvironment method Drop a variable from the server's global environment entirely.
• unsetGlobalOption method Remove a default, so tmux falls back to its own built-in value.
• unsetHook method Remove a global hook.
• unsetOption method Remove a server-scope option.
• version method The tmux version this server is running.
• versionAtLeast method Whether this server is at least minimum, written the way tmux writes it.
• watch method Stream tmux's control-mode notifications until the stream is disposed.
• windows method Every window on the server, including each placement of a linked window.
• withConnection method Run body against a connected server, closing it afterwards.