Window
tmux(1) Window [window_manual].
Source and package
-
Examples#
>>> window = session.new_window('My project', attach=True)>>> windowWindow(@2 2:My project, Session($... ...))Windows have panes:
>>> window.panes[Pane(...)]>>> window.active_panePane(...)Relations moving up:
>>> window.sessionSession(...)>>> window.window_id == session.active_window.window_idTrue>>> window == session.active_windowTrue>>> window in session.windowsTrueThe window can be used as a context manager to ensure proper cleanup:
>>> with session.new_window() as window:... pane = window.split()... # Do work with the pane... # Window will be killed automatically when exiting the contextReferences#
- [window_manual]
-
tmux window. openbsd manpage for TMUX(1). "Each session has one or more windows linked to it. A window occupies the entire screen and may be split into rectangular panes..." https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed April 1st, 2018.
Discussed in Server, session, window, pane , Workspaces · Python workspace internal API · Architecture , Ownership and cleanup
In other ports A tmux window
- PowerShell
LibTmux\Get-TmuxWindowThis cmdlet reads shared .NET
LibTmux.Windowplacements. Use-Serverfor all sessions or-Sessionfor one session. - Julia
LibTmux.WindowSnapshotWindowSnapshotholds captured physical-window data.WindowLinkrecords a placement in a session; actions useWindowRef. - Ruby
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
LibTmux.FSharp.WindowThis F# module identifies shared .NET
LibTmux.Windowplacements and builds deferred pane queries.Query.listacquires their results from tmux.
Members56#
Parent objects2#
Collections and queries2#
- panes property Panes contained by window.
- search_panes method Panes in this window, optionally filtered by tmux.
Common operations30#
- split method Split window on active pane and return the created
Pane. - select_layout method Select layout for window.
- kill method Kill
Window. - rename_window method Rename window.
- link method Link this window to another session via
$ tmux link-window. - unlink method Unlink this window from the current session via
$ tmux unlink-window. - select method Select window.
- id property Alias of
Window.window_id. - name property Alias of
Window.window_name. - resize method Resize tmux window.
- move_window method Move current
Windowobject$ tmux move-window. - rotate method Rotate pane positions in the window via
$ tmux rotate-window. - height property Alias of
Window.window_height. - width property Alias of
Window.window_width. - next_layout method Cycle to the next layout via
$ tmux next-layout. - respawn method Respawn the window process via
$ tmux respawn-window. - swap method Swap this window with another via
$ tmux swap-window. - active_pane property Return attached
Pane. - index property Alias of
Window.window_index. - refresh method Refresh window attributes from tmux.
- previous_layout method Cycle to the previous layout via
$ tmux previous-layout. - last_pane method Select the last (previously active) pane via
$ tmux last-pane. - linked_sessions property Every session this window is reachable from.
- display_message method Display message at window scope via
$ tmux display-message. - cmd method Execute tmux subcommand within window context.
- select_pane method Select pane and return selected
Pane. - from_env method Return the window containing the pane this process runs inside of.
- from_window_id method Create Window from existing window_id.
- new_pane method Create a floating
Panein this window ($ tmux new-pane). - new_window method Create new window respective of current window's position.
Other members22#
- default_hook_scope: Option
Scope | None attribute - default_option_scope: Option
Scope | None attribute - attached_pane property Return attached
Pane. - children property Was used by TmuxRelationalObject (but that's longer used in this class).
- find_where method Filter through panes, return first
Pane. - get method Return key-based lookup. Deprecated by attributes.
- get_by_id method Return pane by id. Deprecated in favor of
panes.get(). - kill_window method Kill the current
Windowobject.$ tmux kill-window. - list_panes method Return list of
Panefor the window. - select_window method Select window.
- set_window_option method Set option for tmux window. Deprecated by
Window.set_option(). - show_window_option method Return option for target window. Deprecated by
Window.show_option(). - show_window_options method Show options for tmux window. Deprecated by
Window.show_options(). - split_window method Split window and return the created
Pane. - where method Filter through panes, return list of
Pane. - __enter__ method Enter the context, returning self.
- __eq__ method Equal operator for
Windowobject. - __exit__ method Exit the context, killing the window if it exists.
- __getitem__ method Return item lookup by key. Deprecated in favor of attributes.
- __repr__ method Representation of
Windowobject. - _list_panes method Return list of panes (deprecated in favor of
panes). - _panes property Property / alias to return
_list_panes.
Inherited members198 members#
Reached through libtmux.options.OptionsMixin, libtmux.hooks.HooksMixin, libtmux.neo.Obj.
- show_options method inherited Return all options for the target.
- show_hooks method inherited Return a dict of hooks for the target.
- set_option method inherited Set option for tmux target.
- unset_option method inherited Unset option for tmux target.
- show_option method inherited Return option value for the target.
- set_hook method inherited Set hook for tmux target.
- unset_hook method inherited Unset hook for tmux target.
- window_active attribute inherited
- window_layout attribute inherited
- session_id attribute inherited
- window_activity attribute inherited
- window_linked attribute inherited
- set_hooks method inherited Set multiple indexed hooks at once.
- run_hook method inherited Run a hook immediately. Useful for testing.
- show_hook method inherited Return value for a hook.
- active_window_index attribute inherited
- alternate_saved_x attribute inherited
- alternate_saved_y attribute inherited
- bracket_paste_flag attribute inherited
- buffer_name attribute inherited
- buffer_sample attribute inherited
- buffer_size attribute inherited
- client_activity attribute inherited
- client_cell_height attribute inherited
- client_cell_width attribute inherited
- client_control_mode attribute inherited
- client_created attribute inherited
- client_discarded attribute inherited
- client_flags attribute inherited
- client_height attribute inherited
- client_key_table attribute inherited
- client_last_session attribute inherited
- client_mode_format attribute inherited
- client_name attribute inherited
- client_pid attribute inherited
- client_prefix attribute inherited
- client_readonly attribute inherited
- client_session attribute inherited
- client_termfeatures attribute inherited
- client_termname attribute inherited
- client_termtype attribute inherited
- client_tty attribute inherited
- client_uid attribute inherited
- client_user attribute inherited
- client_utf8 attribute inherited
- client_width attribute inherited
- client_written attribute inherited
- command_list_alias attribute inherited
- command_list_name attribute inherited
- command_list_usage attribute inherited
- config_files attribute inherited
- copy_cursor_line attribute inherited
- copy_cursor_word attribute inherited
- copy_cursor_x attribute inherited
- copy_cursor_y attribute inherited
- current_file attribute inherited
- cursor_character attribute inherited
- cursor_flag attribute inherited
- cursor_x attribute inherited
- cursor_y attribute inherited
- history_bytes attribute inherited
- history_limit attribute inherited
- history_size attribute inherited
- hooks attribute inherited
- insert_flag attribute inherited
- keypad_cursor_flag attribute inherited
- keypad_flag attribute inherited
- last_window_index attribute inherited
- line attribute inherited
- mouse_all_flag attribute inherited
- mouse_any_flag attribute inherited
- mouse_button_flag attribute inherited
- mouse_sgr_flag attribute inherited
- mouse_standard_flag attribute inherited
- next_session_id attribute inherited
- origin_flag attribute inherited
- pane_active attribute inherited
- pane_at_bottom attribute inherited
- pane_at_left attribute inherited
- pane_at_right attribute inherited
- pane_at_top attribute inherited
- pane_bg attribute inherited
- pane_bottom attribute inherited
- pane_current_command attribute inherited
- pane_current_path attribute inherited
- pane_dead attribute inherited
- pane_dead_signal attribute inherited
- pane_dead_status attribute inherited
- pane_dead_time attribute inherited
- pane_fg attribute inherited
- pane_flags attribute inherited
- pane_floating_flag attribute inherited
- pane_format attribute inherited
- pane_height attribute inherited
- pane_id attribute inherited
- pane_in_mode attribute inherited
- pane_index attribute inherited
- pane_input_off attribute inherited
- pane_last attribute inherited
- pane_left attribute inherited
- pane_marked attribute inherited
- pane_marked_set attribute inherited
- pane_mode attribute inherited
- pane_path attribute inherited
- pane_pb_progress attribute inherited
- pane_pb_state attribute inherited
- pane_pid attribute inherited
- pane_pipe attribute inherited
- pane_pipe_pid attribute inherited
- pane_right attribute inherited
- pane_search_string attribute inherited
- pane_start_command attribute inherited
- pane_start_path attribute inherited
- pane_synchronized attribute inherited
- pane_tabs attribute inherited
- pane_title attribute inherited
- pane_top attribute inherited
- pane_tty attribute inherited
- pane_width attribute inherited
- pane_x attribute inherited
- pane_y attribute inherited
- pane_z attribute inherited
- pane_zoomed_flag attribute inherited
- pid attribute inherited
- scroll_position attribute inherited
- scroll_region_lower attribute inherited
- scroll_region_upper attribute inherited
- search_match attribute inherited
- selection_end_x attribute inherited
- selection_end_y attribute inherited
- selection_start_x attribute inherited
- selection_start_y attribute inherited
- session_activity attribute inherited
- session_alerts attribute inherited
- session_attached attribute inherited
- session_attached_list attribute inherited
- session_created attribute inherited
- session_format attribute inherited
- session_group attribute inherited
- session_group_attached attribute inherited
- session_group_attached_list attribute inherited
- session_group_list attribute inherited
- session_group_many_attached attribute inherited
- session_group_size attribute inherited
- session_grouped attribute inherited
- session_last_attached attribute inherited
- session_many_attached attribute inherited
- session_marked attribute inherited
- session_name attribute inherited
- session_path attribute inherited
- session_stack attribute inherited
- session_windows attribute inherited
- socket_path attribute inherited
- start_time attribute inherited
- synchronized_output_flag attribute inherited
- uid attribute inherited
- user attribute inherited
- version attribute inherited
- window_active_clients attribute inherited
- window_active_clients_list attribute inherited
- window_active_sessions attribute inherited
- window_active_sessions_list attribute inherited
- window_activity_flag attribute inherited
- window_bell_flag attribute inherited
- window_bigger attribute inherited
- window_cell_height attribute inherited
- window_cell_width attribute inherited
- window_end_flag attribute inherited
- window_flags attribute inherited
- window_format attribute inherited
- window_height attribute inherited
- window_id attribute inherited
- window_index attribute inherited
- window_last_flag attribute inherited
- window_linked_sessions attribute inherited
- window_linked_sessions_list attribute inherited
- window_marked_flag attribute inherited
- window_name attribute inherited
- window_offset_x attribute inherited
- window_offset_y attribute inherited
- window_panes attribute inherited
- window_raw_flags attribute inherited
- window_silence_flag attribute inherited
- window_stack_index attribute inherited
- window_start_flag attribute inherited
- window_visible_layout attribute inherited
- window_width attribute inherited
- window_zoomed_flag attribute inherited
- wrap_flag attribute inherited
- __init__ method inherited When not a user (custom) option, scope can be implied.
- _refresh method inherited Refresh dataclass fields from a single
list-*row. - _show_hook method inherited Return value for the hook.
- _show_option method inherited Return option value for the target.
- _show_option_raw method inherited Return raw option output for target.
- _show_options method inherited Return a dict of options for the target.
- _show_options_dict method inherited Return dict of options for the target.
- _show_options_raw method inherited Return a dict of options for the target.
- _tmux_bin property inherited Resolve tmux_bin from self (Server) or self.server (Session/Window/Pane).