From 57ace2d0b8c01931eb98ef7be1a75fc2c762c9f0 Mon Sep 17 00:00:00 2001 From: Tim Visher Date: Mon, 30 Dec 2024 14:52:50 -0500 Subject: [PATCH] Clarify CLI vs. Keybind Actions documentation https://github.com/ghostty-org/ghostty/discussions/4107#discussioncomment-11699228 --- src/cli/help.zig | 2 +- src/cli/list_actions.zig | 5 +++-- src/main_ghostty.zig | 3 ++- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/cli/help.zig b/src/cli/help.zig index e9e4495509..daadc37ccd 100644 --- a/src/cli/help.zig +++ b/src/cli/help.zig @@ -63,7 +63,7 @@ pub fn run(alloc: Allocator) !u8 { try stdout.writeAll( \\ \\Specify `+ --help` to see the help for a specific action, - \\where `` is one of actions listed below. + \\where `` is one of actions listed above. \\ ); diff --git a/src/cli/list_actions.zig b/src/cli/list_actions.zig index 8dbadc65ab..65b9dcdadc 100644 --- a/src/cli/list_actions.zig +++ b/src/cli/list_actions.zig @@ -20,8 +20,9 @@ pub const Options = struct { } }; -/// The `list-actions` command is used to list all the available keybind actions -/// for Ghostty. +/// The `list-actions` command is used to list all the available keybind +/// actions for Ghostty. These are distinct from the CLI Actions which can +/// be listed via `+help` /// /// The `--docs` argument will print out the documentation for each action. pub fn run(alloc: Allocator) !u8 { diff --git a/src/main_ghostty.zig b/src/main_ghostty.zig index b3df805385..9efe8d9b09 100644 --- a/src/main_ghostty.zig +++ b/src/main_ghostty.zig @@ -49,7 +49,8 @@ pub fn main() !MainReturn { error.InvalidAction => try stderr.print( "Error: unknown CLI action specified. CLI actions are specified with\n" ++ - "the '+' character.\n", + "the '+' character.\n\n" ++ + "All valid CLI actions can be listed with `ghostty +help`\n", .{}, ),