io.github.libtmux.SessionSpec.SessionSpec

class io.github.libtmux.SessionSpec.SessionSpec

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.SessionSpec.SessionSpec

How a session should be made.

<p>The shape SplitSpec and WindowSpec use. tmux's -A, which attaches when the name is taken, is deliberately absent: attaching needs a terminal, and it fails with open terminal failed on every supported release when there is none. Asking Server#hasSession first does the same job from a process that has no tty, which is where a library usually runs.

<pre>Session build = server.newSession(s -> s.named("build").sized(new Dimensions(120, 40))); </pre>

Members

• Builder class Collects the choices, each named for what it does rather than for the field it sets.
• argv method The command that makes this session, reporting it through format.
• builder method A builder holding tmux's own defaults: a detached session tmux names itself.
• clientFlags method Client flags, which tmux takes as one comma-separated list.
• command method What the session's first pane runs, empty for the default shell.
• detached method Always true, and not a choice.
• detachOthers method Whether other clients on this session are detached.
• directory method Where the session's first pane starts, or empty to inherit.
• environment method Variables set for the new session, in the order they were given.
• name method The session name, or empty to let tmux number it.
• size method How big the session is, or empty for tmux's default. Requires tmux 3.3a.
• toString method
• windowName method The name of the session's first window, or empty for tmux's choice.
• withoutSize method Whether tmux is told not to give the session a size at all.