Enum Command 

pub enum Command {
    Attach {
        target: Option<String>,
    },
    Serve,
    RuntimeKeeper {
        keeper_socket: PathBuf,
        cols: u16,
        rows: u16,
        cwd: Option<PathBuf>,
        env: Vec<(String, OsString)>,
        command: Vec<String>,
    },
    Automation {
        target: Option<String>,
        all_sessions: bool,
    },
    Ping {
        payload: String,
    },
    KillServer,
    NewSession {
        name: String,
    },
    ListSessions,
    HasSession {
        target: String,
    },
    KillSession {
        target: Option<String>,
        force: bool,
        detach: bool,
    },
    RenameSession {
        target: Option<String>,
        name: String,
    },
    ListBuffers {
        target: Option<String>,
        attached: bool,
        detached: bool,
    },
    AttachBuffer {
        buffer_id: u64,
        target: Option<String>,
    },
    ListClients,
    DetachClient {
        client_id: Option<u64>,
    },
    SwitchClient {
        client_id: Option<u64>,
        target: String,
    },
    Buffer {
        command: BufferCommand,
    },
    Node {
        command: NodeCommand,
    },
    NewWindow {
        target: Option<String>,
        title: Option<String>,
        command: Vec<String>,
    },
    ListWindows {
        target: Option<String>,
    },
    SelectWindow {
        target: String,
    },
    RenameWindow {
        target: Option<String>,
        title: String,
    },
    KillWindow {
        target: Option<String>,
        detach: bool,
    },
    SplitWindow {
        target: Option<String>,
        horizontal: bool,
        vertical: bool,
        command: Vec<String>,
    },
    ListPanes {
        target: Option<String>,
    },
    SelectPane {
        target: Option<String>,
        last: bool,
    },
    ResizePane {
        target: Option<String>,
        sizes: Vec<u16>,
        left: bool,
        right: bool,
        up: bool,
        down: bool,
        zoom: bool,
        adjustment: Option<u16>,
    },
    SynchronizePanes {
        target: Option<String>,
        state: Option<SwitchArg>,
    },
    SendKeys {
        target: Option<String>,
        enter: bool,
        keys: Vec<String>,
    },
    CapturePane {
        target: Option<String>,
    },
    KillPane {
        target: Option<String>,
        detach: bool,
    },
    DisplayPopup {
        target: Option<String>,
        title: Option<String>,
        x: u16,
        y: u16,
        width: u16,
        height: u16,
        command: Vec<String>,
    },
    KillPopup {
        target: Option<String>,
        detach: bool,
    },
    DisplayMessage {
        target: Option<String>,
        client: Option<NonZeroU64>,
        print: bool,
        duration: Option<u32>,
        message: Vec<String>,
    },
    SetEnvironment {
        target: Option<String>,
        global: bool,
        unset: bool,
        name: String,
        value: Option<String>,
    },
    ShowEnvironment {
        target: Option<String>,
        global: bool,
        name: Option<String>,
    },
}

Variants

Attach

Fields

target: Option<String>

Serve

RuntimeKeeper

Fields

keeper_socket: PathBuf

cols: u16

rows: u16

cwd: Option<PathBuf>

env: Vec<(String, OsString)>

command: Vec<String>

Automation

Fields

target: Option<String>

all_sessions: bool

Ping

Fields

payload: String

KillServer

Stop the server and end every program it runs. Unlike stopping the server with a signal, nothing is left for a restarted server to reattach to or restore.

NewSession

Fields

name: String

ListSessions

HasSession

Fields

target: String

KillSession

Close a session and end the programs in its panes and popups.

Fields

target: Option<String>

force: bool

detach: bool

Keep the programs running as detached buffers instead.

RenameSession

Fields

target: Option<String>

name: String

ListBuffers

Fields

target: Option<String>

attached: bool

detached: bool

AttachBuffer

Fields

buffer_id: u64

target: Option<String>

ListClients

DetachClient

Detach a client. From the command prompt the client defaults to the one the prompt belongs to.

Fields

client_id: Option<u64>

SwitchClient

Show session -t on a client. From the command prompt the client defaults to the one the prompt belongs to.

Fields

client_id: Option<u64>

target: String

Buffer

Fields

command: BufferCommand

Node

Fields

command: NodeCommand

NewWindow

Fields

target: Option<String>

title: Option<String>

command: Vec<String>

ListWindows

Fields

target: Option<String>

SelectWindow

Fields

target: String

RenameWindow

Fields

target: Option<String>

title: String

KillWindow

Close a window and end the programs in its panes.

Fields

target: Option<String>

detach: bool

Keep the programs running as detached buffers instead.

SplitWindow

Fields

target: Option<String>

horizontal: bool

vertical: bool

command: Vec<String>

ListPanes

Fields

target: Option<String>

SelectPane

Focus a pane, or with -l the pane focused before the current one in the session’s current window (tmux select-pane -l).

Fields

target: Option<String>

last: bool

ResizePane

Resize a pane like tmux: -L/-R/-U/-D [N] moves its border N cells (default 1), -Z toggles zoom, and --sizes sets the parent split’s weights directly.

Fields

target: Option<String>

sizes: Vec<u16>

left: bool

right: bool

up: bool

down: bool

zoom: bool

adjustment: Option<u16>

SynchronizePanes

Turn tmux-style synchronize-panes on or off for a window, or toggle it when no state is given. Prints the resulting state.

Fields

target: Option<String>

state: Option<SwitchArg>

SendKeys

Fields

target: Option<String>

enter: bool

keys: Vec<String>

CapturePane

Fields

target: Option<String>

KillPane

Close a pane and end its program.

Fields

target: Option<String>

detach: bool

Keep the program running as a detached buffer instead.

DisplayPopup

Fields

target: Option<String>

title: Option<String>

x: u16

y: u16

width: u16

height: u16

command: Vec<String>

KillPopup

Close a popup and end the programs in it.

Fields

target: Option<String>

detach: bool

Keep the programs running as detached buffers instead.

DisplayMessage

Show a message in the status line of the clients showing the target pane’s session (or of client -c) for a few seconds, like tmux. -p prints it instead. The message may use #S, #I, #W, #D, #T, #{pane_current_path} and #{pane_current_command}.

Fields

target: Option<String>

client: Option<NonZeroU64>

print: bool

duration: Option<u32>

How long to show the message, in milliseconds.

message: Vec<String>

SetEnvironment

Set an environment variable for panes created later in a session, or in every session with -g, like tmux. -u unsets it.

Fields

target: Option<String>

global: bool

unset: bool

name: String

value: Option<String>

ShowEnvironment

Print a session’s environment (or the global one with -g) as NAME=VALUE lines, or one variable when NAME is given.

Fields

target: Option<String>

global: bool

name: Option<String>

Trait Implementations

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Command

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Command

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand