LibTmux.Get-TmuxWindow
LibTmux\Get-TmuxWindow Read contextual windows from a server or session.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxWindowCommand.cs
- Other languages
- Julia (struct)PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF# (module)
- Server (default): Get-TmuxWindow [-Server] <Lib
Tmux > [-Id <System.Server .String >] [-Name <System.String >] [<CommonParameters >] Session: Get-TmuxWindow [-Session] <LibTmux > [-Id <System.Session .String >] [-Name <System.String >] [<CommonParameters >] -
Description#
Accept a native
ServerorSessionas the owner. Each result retains its session placement. A linked window can therefore appear more than once. Id and Name are ordinal literal selectors; they do not expand wildcards.Notes
Global window identity differs from session-relative placement. Do not silently deduplicate results when placement index matters.
Command details#
- Command type
cmdlet- Default parameter set
-
Server - Positional binding
- Enabled.
- Pipeline inputs
-
LibTmux.Server: Native pipeline type for this command.;LibTmux.Session: Native pipeline type for this command. - Outputs
-
LibTmux.Window
Examples#
Example 1
Listwindow placements on the existing server identified by$SocketPath. View sourceTerminal window LibTmux\New-TmuxServer -SocketPath $SocketPath | LibTmux\Get-TmuxWindow- Parameters
-
-
-Server(LibTmux ) (for.Server Server) #The server whose windows are read.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
An ordinal, literal window identifier selector.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Completion
ArgumentCompleter("LibTmux.PowerShell.WindowSelectorCompleter")- Validation
ValidateNotNullOrEmpty()
-
An ordinal, literal window name selector.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Completion
ArgumentCompleter("LibTmux.PowerShell.WindowSelectorCompleter")- Validation
ValidateNotNullOrEmpty()
-
-Session(LibTmux ) (for.Session Session) #The session whose windows are read.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
Common parameters 12
PowerShell supplies these parameters. See common parameter behavior for their effects.
-
-Verbose(System.Management ) #.Automation .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
LibTmux.Window: Native pipeline type for this command.
tmux command
list-windowsDiscussed in Captured state and I/O · Arrange panes and resize windows , Read tmux objects
In other ports A tmux window
- Julia
LibTmux.WindowSnapshotWindowSnapshotholds captured physical-window data.WindowLinkrecords a placement in a session; actions useWindowRef. - Python
- 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.
In other ports List a session's windows
- Julia
LibTmux.windowswindowswith a capturedSessionSnapshotreads distinct physical windows in that session. Usewindowlinksfor placements. - Python
- Ruby
- Lua No source-verified Lua equivalent is recorded for this operation.
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
LibTmux.FSharp.Session.windowsBuilds a deferred window query from one
LibTmux.Sessionand its server.Query.listacquires placements scoped to that session ID.
In other ports List the server's windows
- Julia
LibTmux.windowswindowswith aSnapshotreads every captured physical window. Usewindowlinksfor session placements. - Python
- Ruby
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
LibTmux.FSharp.Server.windowsBuilds a deferred query for placements across all sessions.
Query.listacquires the results; a linked window appears once for each session placement.