Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-07-19 10:16:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: expand flag descriptions, usage overview

Browse Source
This commit is contained in:
Jason Rayne
2025-06-24 11:41:35 -07:00
parent 81641e56b1
commit c8d5e60390
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/config/Config.zig
View File

@ -1975,10 +1975,19 @@ keybind: Keybinds = .{},
/// * `ssh-env` - Enable SSH environment variable compatibility. Automatically
/// converts TERM from `xterm-ghostty` to `xterm-256color` when connecting to
/// remote hosts and propagates COLORTERM, TERM_PROGRAM, and TERM_PROGRAM_VERSION.
/// Whether or not these variables will be accepted by the remote host(s) will
/// depend on whether or not the variables are allowed in their sshd_config.
///
/// * `ssh-terminfo` - Enable automatic terminfo installation on remote hosts.
/// Attempts to install Ghostty's terminfo entry using `infocmp` and `tic` when
/// connecting to hosts that lack it.
/// connecting to hosts that lack it. Requires `infocmp` and `tic` to be available
/// locally. Provides `ghostty ssh-cache-list` and `ghostty ssh-cache-clear`
/// utilities for managing the installation cache.
///
/// SSH features work independently and can be combined for optimal experience:
/// when both `ssh-env` and `ssh-terminfo` are enabled, Ghostty will install its
/// terminfo on remote hosts and use `xterm-ghostty` as TERM, falling back to
/// `xterm-256color` with environment variables if terminfo installation fails.
///
/// Example: `cursor`, `no-cursor`, `sudo`, `no-sudo`, `title`, `no-title`
@"shell-integration-features": ShellIntegrationFeatures = .{},