libtmux::Server

class libtmux::Server

class [source] ¶

class [source] ¶

class libtmux::Server

Members

• at_default method The server tmux would talk to with no -L or -S at all, which is the one a person means when they say "my tmux".
• at_socket_name method -L name: resolved under tmux's socket directory, as the tmux flag does.
• at_socket_path method -S path: the socket file, used verbatim.
• bind_key method Bind a key in a key table, and take a binding away again.
• buffers method The server's cut buffers, newest first as tmux orders them.
• capabilities method The local backend contract; no command runs.
• check_alive method The same question, keeping why the answer was no.
• check_file method Parse the same file and report what tmux would refuse in it, running none of it.
• clients method
• commands method Every command this tmux understands, with its alias and usage.
• control method Open a control-mode connection to one session.
• control_with_options method The Server supplies the socket and session supplies the session name; every other connection option is kept, including pane output policy.
• expand method Ask tmux to expand a format, against no target but the server itself.
• from_env method The server this process is running inside.
• global_hooks method A hook set globally is not reported by the unscoped listing, so reading it back needs the scope it was set with.
• global_options method
• hooks method
• is_alive method Whether a server is answering on this socket.
• kill method End the server and everything in it.
• load_buffer method Read a file into a named buffer, and write one back out.
• new_session method Created detached, and returned, because tmux prints what it made.
• options method
• pane method
• panes method
• run method Run one command and return its standard output.
• run_batch method Run several commands in one invocation.
• run_chain method Run a chain.
• run_shell method Run a shell command on the machine the server is on.
• save_buffer method
• server_options method The server's own options, which are neither session nor window options and are the only ones a server without a session still has.
• session method One object by target, for a caller holding an id or a session:window path that came from somewhere else.
• sessions method One snapshot each.
• set_buffer method Put text in a named buffer, replacing what was there.
• set_global_hook method
• set_global_option method Sets the value every session inherits, rather than one session's own.
• set_server_option method
• show_message method Put a message on the status line of every attached client, and send it to each control client as message.
• signal method Release whoever is waiting on the channel, or latch it for whoever waits next.
• source_file method Run the commands in a file, the way tmux runs a configuration file.
• tmux_version method Ask the selected subprocess executable with tmux -V without touching a server.
• try_submit method Admit one command to an explicit bounded runtime without waiting for it.
• unbind_key method Unbinding a key that was not bound succeeds; unbinding in a table that does not exist is refused.
• wait_for method Block until someone signals this channel, or the deadline passes.
• window method
• windows method tmux scopes window and pane listings to the current session unless asked for every one, so -a is part of the request rather than a caller's responsibility to remember.