LibTmux.New-TmuxServer
LibTmux\New-TmuxServer Construct a tmux endpoint handle without contacting it.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/NewTmuxServerCommand.cs
- Other languages
- Julia (struct)PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF# (module)
- Name (default): New-TmuxServer [-Socket
Name <System.String >] [-TmuxBinary <SystemPath .String >] [-ConfigurationFile <System.String >] [<CommonParameters >] Path: New-TmuxServer -SocketPath <System.String > [-TmuxBinary <SystemPath .String >] [-ConfigurationFile <System.String >] [<CommonParameters >] -
Description#
Choose a socket name or absolute socket path. Construction performs no tmux I/O and does not start or own a daemon. A later command explicitly acquires data or changes tmux. Omitting both socket selectors uses the core default endpoint.
Notes
The returned
LibTmux.Serveris unmaterialized. TmuxBinaryPath andConfigurationFileaffect subsequent operations; construction does not execute them.Command details#
- Command type
cmdlet- Default parameter set
- Name
- Positional binding
- Enabled.
- Outputs
-
LibTmux.Server
Examples#
Example 1 Construct a handle for the existing socket identified by
$SocketPath. View sourceTerminal window LibTmux\New-TmuxServer -SocketPath $SocketPath- Parameters
-
-
-SocketName(System.String ) (forName) #The tmux socket name.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()
-
-TmuxBinaryPath(System.String ) #The tmux executable used by subsequent operations.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()
-
-ConfigurationFile(System.String ) #The configuration used if a later operation starts tmux.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()
-
-SocketPath(System.String ) (forPath) #The absolute socket path.
- Required
- Yes
- 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.Server: Native pipeline type for this command.
Discussed in Captured state and I/O , Object identity and placement · Attaching to tmux , Getting started , Troubleshooting · Ownership and cleanup
In other ports A tmux server
- Julia
LibTmux.ServerServerdescribes an endpoint without contacting tmux. Read its hierarchy withsnapshot. - Python
- Ruby
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
LibTmux.FSharp.ServerThis F# module provides functions over the shared .NET
LibTmux.Servertype.