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

Merge pull request #1904 from antonk52/f/config-docs

Browse Source 
docs: add valid values for enum config options
This commit is contained in:
Mitchell Hashimoto
2024-07-01 09:34:23 -07:00
committed by GitHub
parent e2c359274d d946809d6d
commit 076c395cbe
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/config/Config.zig
View File

@ -297,6 +297,13 @@ palette: Palette = .{},
/// a prompt, regardless of this configuration. You can disable that behavior /// a prompt, regardless of this configuration. You can disable that behavior
/// by specifying `shell-integration-features = no-cursor` or disabling shell /// by specifying `shell-integration-features = no-cursor` or disabling shell
/// integration entirely. /// integration entirely.
///
/// Valid values are:
///
/// * `block`
/// * `bar`
/// * `underline`
///
@"cursor-style": terminal.CursorStyle = .block, @"cursor-style": terminal.CursorStyle = .block,
/// Sets the default blinking state of the cursor. This is just the default /// Sets the default blinking state of the cursor. This is just the default
@ -310,6 +317,13 @@ palette: Palette = .{},
/// (AT&T cursor blink) as an alternate approach to turning blinking on/off. If /// (AT&T cursor blink) as an alternate approach to turning blinking on/off. If
/// this is set to any value other than null, DEC mode 12 will be ignored but /// this is set to any value other than null, DEC mode 12 will be ignored but
/// `DECSCUSR` will still be respected. /// `DECSCUSR` will still be respected.
///
/// Valid values are:
///
/// * `` (blank)
/// * `true`
/// * `false`
///
@"cursor-style-blink": ?bool = null, @"cursor-style-blink": ?bool = null,
/// The color of the text under the cursor. If this is not set, a default will /// The color of the text under the cursor. If this is not set, a default will
@ -354,6 +368,14 @@ palette: Palette = .{},
/// ///
/// If you always want shift to extend mouse selection even if the program /// If you always want shift to extend mouse selection even if the program
/// requests otherwise, set this to `never`. /// requests otherwise, set this to `never`.
///
/// Valid values are:
///
/// * `true`
/// * `false`
/// * `always`
/// * `never`
///
@"mouse-shift-capture": MouseShiftCapture = .false, @"mouse-shift-capture": MouseShiftCapture = .false,
/// Multiplier for scrolling distance with the mouse wheel. Any value less /// Multiplier for scrolling distance with the mouse wheel. Any value less
@ -769,6 +791,13 @@ keybind: Keybinds = .{},
/// Whether to allow programs running in the terminal to read/write to the /// Whether to allow programs running in the terminal to read/write to the
/// system clipboard (OSC 52, for googling). The default is to allow clipboard /// system clipboard (OSC 52, for googling). The default is to allow clipboard
/// reading after prompting the user and allow writing unconditionally. /// reading after prompting the user and allow writing unconditionally.
///
/// Valid values are:
///
/// * `ask`
/// * `allow`
/// * `deny`
///
@"clipboard-read": ClipboardAccess = .ask, @"clipboard-read": ClipboardAccess = .ask,
@"clipboard-write": ClipboardAccess = .allow, @"clipboard-write": ClipboardAccess = .allow,