LibTmux.Get-TmuxPane
LibTmux\Get-TmuxPane Read panes from a server, session or window.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxPaneCommand.cs
- Other languages
- Julia (struct)PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF# (module)
- Server (default): Get-TmuxPane [-Server] <Lib
Tmux > [-Id <System.Server .String >] [<CommonParameters >] Session: Get-TmuxPane [-Session] <LibTmux > [-Id <System.Session .String >] [<CommonParameters >] Window: Get-TmuxPane [-Window] <LibTmux > [-Id <System.Window .String >] [<CommonParameters >] -
Description#
Acquire panes from the native owning object. Id is an ordinal literal selector. Linked windows can expose multiple contextual placements of one physical pane. Use native
Where-Objectover the returned captured properties for local selection.Notes
CurrentCommandandCurrentPathread captured data without I/O. Zero results emit nothing; one emits one object; many emit separate objects. Use @() for a stable array.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.;LibTmux.Window: Native pipeline type for this command. - Outputs
-
LibTmux.Pane
Examples#
Example 1
Listpanes on the existing server identified by$SocketPath. View sourceTerminal window LibTmux\New-TmuxServer -SocketPath $SocketPath | LibTmux\Get-TmuxPane- Parameters
-
-
-Server(LibTmux ) (for.Server Server) #The server whose panes are read.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
An ordinal, literal pane identifier selector.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Completion
ArgumentCompleter("LibTmux.PowerShell.PaneSelectorCompleter")- Validation
ValidateNotNullOrEmpty()
-
-Session(LibTmux ) (for.Session Session) #The session whose panes are read.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-Window(LibTmux ) (for.Window Window) #The window whose panes 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.Pane: Native pipeline type for this command.
tmux command
list-panesDiscussed in Captured state and I/O · Send input to a pane , Arrange panes and resize windows , Read tmux objects
In other ports A tmux pane
- Julia
LibTmux.PaneSnapshotPaneSnapshotholds captured pane data. Actions use itsPaneRef;PaneOccurrenceadds a window placement in a session. - Python
- Ruby
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
LibTmux.FSharp.PaneThis F# module reads captured fields and starts explicit operations on the shared .NET
LibTmux.Panetype.
In other ports List a window's panes
- Julia
LibTmux.panespaneswith a capturedWindowSnapshotreads panes in that window; missing coverage is an error. - 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.Window.panesBuilds a deferred pane query from one
LibTmux.Windowand its server.Query.listacquires panes scoped to that window ID.
In other ports List a session's panes
- Julia Traverse
windows(session)andpanes(window)in the captured snapshot.panes(snapshot)has server-wide scope. - Python
- Ruby
- Lua No source-verified Lua equivalent is recorded for this operation.
- TypeScript
- Rust
- Go
- Java no direct accessor; traverse Session.windows and Window.panes
- C#
- C++
- Swift
- Kotlin No source-verified Kotlin equivalent is recorded for this operation.
- Scala No source-verified Scala equivalent is recorded for this operation.
- F#
LibTmux.FSharp.Session.panesBuilds a deferred pane query from one
LibTmux.Sessionand its server.Query.listacquires panes across that session’s windows.
In other ports List the server's panes
- Julia
LibTmux.panespaneswith aSnapshotreads every captured physical pane. Usepaneoccurrencesfor session placements. - Python
- Ruby
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
LibTmux.FSharp.Server.panesBuilds a deferred pane query on the shared .NET
LibTmux.Server.Query.listacquires panes across that server.