mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-08-24 16:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: reformatting for help book support (#13994)

Browse Source
This commit is contained in:
Mitchell Hashimoto
2026-08-24 09:09:12 -07:00
committed by GitHub
parent 75d657788a 88dc6f9723
commit 53d1b28ad3
3 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/cli/help.zig
View File

@@ -17,7 +17,7 @@ pub const Options = struct {
};
/// The `help` command shows general help about Ghostty. Recognized as either
/// `-h, `--help`, or like other actions `+help`.
/// `-h`, `--help`, or like other actions `+help`.
///
/// You can also specify `--help` or `-h` along with any action such as
/// `+list-themes` to see help for a specific action.

16
src/cli/ssh.zig
View File

@@ -162,17 +162,17 @@ pub const Options = struct {
///
/// Examples:
///
/// # Basic invocation using defaults:
/// ghostty +ssh user@example.com
/// # Basic invocation using defaults:
/// ghostty +ssh user@example.com
///
/// # Forward Ghostty env vars but skip the terminfo install:
/// ghostty +ssh --terminfo=false user@example.com
/// # Forward Ghostty env vars but skip the terminfo install:
/// ghostty +ssh --terminfo=false user@example.com
///
/// # `ssh` flags (short-form `-p`, etc.) pass through unchanged:
/// ghostty +ssh -p 2222 -i ~/.ssh/id_ed25519 user@example.com
/// # `ssh` flags (short-form `-p`, etc.) pass through unchanged:
/// ghostty +ssh -p 2222 -i ~/.ssh/id_ed25519 user@example.com
///
/// # Use `--` explicitly if your ssh args might collide with our flags:
/// ghostty +ssh -- --some-rare-ssh-arg user@example.com
/// # Use `--` explicitly if your ssh args might collide with our flags:
/// ghostty +ssh -- --some-rare-ssh-arg user@example.com
///
/// Pass `--verbose` to see what `+ssh` is doing. For cache inspection
/// and management, see `ghostty +ssh-cache`.

15
src/cli/ssh_cache.zig
View File

@@ -50,13 +50,14 @@ pub const Options = struct {
/// `--prune=6h`, `--prune=1y`.
///
/// Examples:
/// ghostty +ssh-cache # List all cached destinations
/// ghostty +ssh-cache user@example.com # Show that destination
/// ghostty +ssh-cache example.com # Show all users on that host
/// ghostty +ssh-cache --add=user@example.com # Manually add a destination
/// ghostty +ssh-cache --remove=user@example.com # Remove a destination
/// ghostty +ssh-cache --prune=30d # Remove entries older than 30 days
/// ghostty +ssh-cache --clear # Clear entire cache
///
/// ghostty +ssh-cache # List all cached destinations
/// ghostty +ssh-cache user@example.com # Show that destination
/// ghostty +ssh-cache example.com # Show all users on that host
/// ghostty +ssh-cache --add=user@example.com # Manually add a destination
/// ghostty +ssh-cache --remove=user@example.com # Remove a destination
/// ghostty +ssh-cache --prune=30d # Remove entries older than 30 days
/// ghostty +ssh-cache --clear # Clear entire cache
pub fn run(alloc_gpa: Allocator) !u8 {
var arena = std.heap.ArenaAllocator.init(alloc_gpa);
defer arena.deinit();