PtyOptions
Configuration for starting a local PTY-backed terminal session.
Use create and copy for named construction and immutable updates. Command and environment collections are defensively copied when built. Callbacks, policies, and shell producers retain their documented host ownership.
Constructors
Types
Properties
environment variables for the child process. TERM and COLORTERM default to the shared terminal capability identity when the caller does not provide them.
host callbacks for parser-discovered PTY metadata events such as BEL and title changes.
safety policy for terminal-triggered host actions.
host-bound input encoding policy. Local PTY sessions default Return/Enter to CR even when LNM is active, because contemporary PTY line disciplines can otherwise turn DEC CR LF into an extra newline. Unbracketed paste line endings are likewise canonicalized to CR so every pasted boundary has the same input semantics as Enter.
maximum scrollback lines retained by the core buffer.
implemented host actions from TerminalHostModeCapability.
buffer size used by the PTY stdout reader thread.
name for the daemon PTY stdout reader thread.
selected producer of shell metadata, editing context and prompt readiness. Null installs no shell integration. PTY assembly does not select a protocol implementation or own the producer's lifetime.
command to submit once shellIntegration reports a ready prompt. The caller is responsible for installing its shell hooks before launch.
whether East Asian Ambiguous codepoints occupy two cells in the core width policy for future writes.
name for the daemon process exit watcher thread.
initial process working directory, or null to let PTY4J use its platform default.
Functions
Configures a fresh draft synchronously and returns a validated immutable snapshot. Exceptions propagate without changing this snapshot. Supplied services remain host-owned.
Returns a detached mutable draft. Builders are caller-confined and never retained by snapshots.