Session.new_window
Create new window, returns new Window.
Source and package
-
Description#
By default, this will make the window active. For the new window to be created and not set to current, pass in
attach=False.Examples#
>>> window_initial = session.new_window(window_name='Example')>>> window_initialWindow(@... 2:Example, Session($1 libtmux_...))>>> window_initial.window_index'2'>>> window_before = session.new_window(... window_name='Window before', direction=WindowDirection.Before)>>> window_initial.refresh()>>> window_beforeWindow(@... 1:Window before, Session($1 libtmux_...))>>> window_initialWindow(@... 3:Example, Session($1 libtmux_...))>>> window_after = session.new_window(... window_name='Window after', direction=WindowDirection.After)>>> window_initial.refresh()>>> window_after.refresh()>>> window_afterWindow(@... 3:Window after, Session($1 libtmux_...))>>> window_initialWindow(@... 4:Example, Session($1 libtmux_...))>>> window_beforeWindow(@... 1:Window before, Session($1 libtmux_...))- Parameters
-
-
window_name(str | None) # -
start_directory(StrPath | None) # – working directory in which the new window is created. -
attach(bool) # – make new window the current window after creating it, default True. -
window_index(str) # – create the new window at the given index position. Default is empty string which will create the window in the next available position. -
window_shell(str | None) # – execute a command on starting the window. The window will close when the command exits. When this command exits the window will close. This feature is useful for long-running processes where the closing of the window upon completion is desired. Note: -
direction(WindowDirection | None) # – Insert window before or after target window. -
target_window(str | None) # – Used byWindow.new_window()to specify the target window. -
kill_existing(bool | None) # – Destroy the window at the target index if it already exists (-kflag). added 0.56 -
select_existing(bool | None) # – If a window with the given name already exists, select it instead of creating a new one (-Sflag). added 0.56
-
- Returns
-
WindowThe newly created window.
tmux command#
The tmux commands behind new_window.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Create a window
| Language | Equivalent |
|---|---|
| Ruby | Lib |
| Lua | libtmux |
| Erlang | tmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Rust | session |
| Go | tmux |
| Java | io |
| Clojure | libtmux |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| Perl | Lib Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes. |
No equivalent is recorded in PowerShell, Julia, Elixir, Common Lisp or F#.