pub struct NewSession<'a> {Show 16 fields
pub attach: bool,
pub detached: bool,
pub detach_other: bool,
pub not_update_env: bool,
pub print: bool,
pub parent_sighup: bool,
pub start_directory: Option<Cow<'a, str>>,
pub environment: Option<Vec<(Cow<'a, str>, Cow<'a, str>)>>,
pub flags: Option<ClientFlags>,
pub format: Option<Cow<'a, str>>,
pub window_name: Option<Cow<'a, str>>,
pub session_name: Option<Cow<'a, str>>,
pub group_name: Option<Cow<'a, str>>,
pub width: Option<usize>,
pub height: Option<usize>,
pub shell_command: Option<Cow<'a, str>>,
}
Expand description
Structure for creating a new session
§Manual
tmux 3.2:
new-session [-AdDEPX] [-c start-directory] [-e environment] [-f flags] [-F format]
[-n window-name] [-s session-name] [-t group-name] [-x width] [-y height] [shell-command]
(alias: new)
tmux 3.0:
new-session [-AdDEPX] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t group-name] [-x width] [-y height] [shell-command]
(alias: new)
tmux 2.4:
new-session [-AdDEP] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t group-name] [-x width] [-y height] [shell-command]
(alias: new)
tmux 2.1:
new-session [-AdDEP] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t target-session] [-x width] [-y height] [shell-command]
(alias: new)
tmux 1.9:
new-session [-AdDP] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t target-session] [-x width] [-y height] [shell-command]
(alias: new)
tmux 1.8:
new-session [-AdDP] [-F format] [-n window-name] [-s session-name] [-t target-session]
[-x width] [-y height] [shell-command]
(alias: new)
tmux 1.6:
new-session [-d] [-n window-name] [-s session-name] [-t target-session] [-x width]
[-y height] [shell-command]
(alias: new)
tmux 1.2:
new-session [-d] [-n window-name] [-s session-name] [-t target-session] [shell-command]
(alias: new)
tmux 1.1:
new-session [-d] [-n window-name] [-s session-name] [-t target-session] [command]
(alias: new)
tmux ^0.8:
new-session [-d] [-n window-name] [-s session-name] [command]
(alias: new)
Fields§
§attach: bool
[-A]
- behave like attach-session
if session-name
already exists
detached: bool
[-d]
- new session is not attached to the current terminal
detach_other: bool
[-D]
- any other clients attached to the session are detached
not_update_env: bool
[-E]
- update-environment
option will not be applied
print: bool
[-P]
- print information about the new session after it has been created
parent_sighup: bool
[-X]
- send SIGHUP to the parent process, detaching the client
start_directory: Option<Cow<'a, str>>
[-c start-directory]
- specify starting directory
environment: Option<Vec<(Cow<'a, str>, Cow<'a, str>)>>
[-e environment]
- takes the form ‘VARIABLE=value’ and sets an environment variable for the
newly created session; it may be specified multiple times
flags: Option<ClientFlags>
[-f flags]
- comma-separated list of client flags
format: Option<Cow<'a, str>>
[-F format]
- specify different format
window_name: Option<Cow<'a, str>>
[-n window-name]
- window name of the initial window
session_name: Option<Cow<'a, str>>
[-s session-name]
- specify a session name
group_name: Option<Cow<'a, str>>
[-t group-name]
- specify a session group
width: Option<usize>
[-x width]
- specify a different width
height: Option<usize>
[-y height]
- specify a different height
shell_command: Option<Cow<'a, str>>
[shell-command]
- shell command to execute in the initial window
Implementations§
source§impl<'a> NewSession<'a>
impl<'a> NewSession<'a>
pub fn new() -> Self
sourcepub fn detach_other(self) -> Self
pub fn detach_other(self) -> Self
[-D]
- any other clients attached to the session are detached
sourcepub fn not_update_env(self) -> Self
pub fn not_update_env(self) -> Self
[-E]
- update-environment
option will not be applied
sourcepub fn print(self) -> Self
pub fn print(self) -> Self
[-P]
- print information about the new session after it has been created
sourcepub fn parent_sighup(self) -> Self
pub fn parent_sighup(self) -> Self
[-X]
- send SIGHUP to the parent process, detaching the client
sourcepub fn start_directory<S: Into<Cow<'a, str>>>(self, start_directory: S) -> Self
pub fn start_directory<S: Into<Cow<'a, str>>>(self, start_directory: S) -> Self
[-c start-directory]
- specify starting directory
sourcepub fn environment<S: Into<Cow<'a, str>>>(self, variable: S, value: S) -> Self
pub fn environment<S: Into<Cow<'a, str>>>(self, variable: S, value: S) -> Self
[-e start-directory]
- takes the form ‘VARIABLE=value’ and sets an environment variable
for the newly created session; it may be specified multiple times.
sourcepub fn flags(self, flags: ClientFlags) -> Self
pub fn flags(self, flags: ClientFlags) -> Self
[-f flags]
- sets a comma-separated list of client flags
sourcepub fn format<S: Into<Cow<'a, str>>>(self, format: S) -> Self
pub fn format<S: Into<Cow<'a, str>>>(self, format: S) -> Self
[-F format]
- specify different format
sourcepub fn window_name<S: Into<Cow<'a, str>>>(self, window_name: S) -> Self
pub fn window_name<S: Into<Cow<'a, str>>>(self, window_name: S) -> Self
[-n window-name]
- window name of the initial window
sourcepub fn session_name<S: Into<Cow<'a, str>>>(self, session_name: S) -> Self
pub fn session_name<S: Into<Cow<'a, str>>>(self, session_name: S) -> Self
[-s session-name]
- specify a session name
sourcepub fn group_name<S: Into<Cow<'a, str>>>(self, group_name: S) -> Self
pub fn group_name<S: Into<Cow<'a, str>>>(self, group_name: S) -> Self
[-t group-name]
- specify a session group
sourcepub fn shell_command<S: Into<Cow<'a, str>>>(self, shell_command: S) -> Self
pub fn shell_command<S: Into<Cow<'a, str>>>(self, shell_command: S) -> Self
[shell-command]
- shell command to execute in the initial window
pub fn build(self) -> TmuxCommand<'a>
Trait Implementations§
source§impl<'a> Clone for NewSession<'a>
impl<'a> Clone for NewSession<'a>
source§fn clone(&self) -> NewSession<'a>
fn clone(&self) -> NewSession<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for NewSession<'a>
impl<'a> Debug for NewSession<'a>
source§impl<'a> Default for NewSession<'a>
impl<'a> Default for NewSession<'a>
source§fn default() -> NewSession<'a>
fn default() -> NewSession<'a>
source§impl<'a> From<NewSession<'a>> for TmuxCommand<'a>
impl<'a> From<NewSession<'a>> for TmuxCommand<'a>
source§fn from(item: NewSession<'a>) -> Self
fn from(item: NewSession<'a>) -> Self
source§impl<'a> Hash for NewSession<'a>
impl<'a> Hash for NewSession<'a>
source§impl<'a> Ord for NewSession<'a>
impl<'a> Ord for NewSession<'a>
source§fn cmp(&self, other: &NewSession<'a>) -> Ordering
fn cmp(&self, other: &NewSession<'a>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<'a> PartialEq for NewSession<'a>
impl<'a> PartialEq for NewSession<'a>
source§fn eq(&self, other: &NewSession<'a>) -> bool
fn eq(&self, other: &NewSession<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd for NewSession<'a>
impl<'a> PartialOrd for NewSession<'a>
source§fn partial_cmp(&self, other: &NewSession<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &NewSession<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more