Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clarify CLI vs. Keybind Actions documentation
Browse files Browse the repository at this point in the history
timvisher committed Dec 30, 2024
1 parent 2f6860f commit 671a825
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/cli/help.zig
Original file line number Diff line number Diff line change
@@ -63,7 +63,7 @@ pub fn run(alloc: Allocator) !u8 {
try stdout.writeAll(
\\
\\Specify `+<action> --help` to see the help for a specific action,
\\where `<action>` is one of actions listed below.
\\where `<action>` is one of actions listed above.
\\
);

5 changes: 3 additions & 2 deletions src/cli/list_actions.zig
Original file line number Diff line number Diff line change
@@ -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 {
3 changes: 2 additions & 1 deletion src/main_ghostty.zig
Original file line number Diff line number Diff line change
@@ -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`",
.{},
),

0 comments on commit 671a825

Please sign in to comment.