LibTmux.Get-TmuxClient
Read the clients attached to a tmux server.
Source and package
- Get-TmuxClient [-Server] <Lib
Tmux > [-Name <System.Server .String >] [<CommonParameters >] -
Description#
Read current client rows through the native core. Name is an ordinal literal selector, not a wildcard or tmux target expression. Return native
Clientobjects; an empty server or unmatched name produces no objects.AttachedSessionIdis captured state, so useGet-TmuxClientAttachmentto resolve the current attachment.Notes
This read does not attach, detach or own any client. Listing an unavailable server writes an error.
Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
LibTmux.Server: Native pipeline owner.- Outputs
LibTmux.Client
Examples#
Example 1 Read clients from a previously selected native
$server. View sourceTerminal window $server | LibTmux\Get-TmuxClient- Parameters
-
-
The server whose attached clients are listed.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
An exact, case-sensitive client name.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()
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.Client: Native observed result.
tmux command#
The tmux commands behind Get-TmuxClient.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
List the server's attached clients
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Julia | Lib clients reads attached clients from a captured Snapshot without contacting tmux. |
| Elixir | Lib Returns a Selection of captured attached clients without contacting tmux. |
| TypeScript | server |
| Rust | server |
| Go | tmux |
| Java | io |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| F# | Lib Builds a deferred client query on the shared .NET LibTmux.Server. Query.list acquires attached clients. |
| C++ | libtmux:: |
| Swift | Server |
No equivalent is recorded in Lua.