config: clarify window-width/height behavior

This commit is contained in:
Mitchell Hashimoto
2024-08-26 10:16:34 -07:00
parent 2c22842198
commit b40b6c3438

View File

@ -840,6 +840,8 @@ keybind: Keybinds = .{},
@"window-colorspace": WindowColorspace = .srgb, @"window-colorspace": WindowColorspace = .srgb,
/// The initial window size. This size is in terminal grid cells by default. /// The initial window size. This size is in terminal grid cells by default.
/// Both values must be set to take effect. If only one value is set, it is
/// ignored.
/// ///
/// We don't currently support specifying a size in pixels but a future change /// We don't currently support specifying a size in pixels but a future change
/// can enable that. If this isn't specified, the app runtime will determine /// can enable that. If this isn't specified, the app runtime will determine
@ -850,6 +852,9 @@ keybind: Keybinds = .{},
/// certain size to fit within the grid. There is nothing Ghostty will do about /// certain size to fit within the grid. There is nothing Ghostty will do about
/// this, but it will make an effort. /// this, but it will make an effort.
/// ///
/// Sizes larger than the screen size will be clamped to the screen size.
/// This can be used to create a maximized-by-default window size.
///
/// This will not affect new tabs, splits, or other nested terminal elements. /// This will not affect new tabs, splits, or other nested terminal elements.
/// This only affects the initial window size of any new window. Changing this /// This only affects the initial window size of any new window. Changing this
/// value will not affect the size of the window after it has been created. This /// value will not affect the size of the window after it has been created. This