chore(docs): regenerate manual and man page

This commit is contained in:
Gitea Actions
2026-07-26 20:48:03 +00:00
parent b6034114ad
commit 27b6b22f6a
+75 -55
View File
@@ -887,7 +887,7 @@ Arguments:
-s, --silent Suppress directory creation output -s, --silent Suppress directory creation output
<dir> Directory to create and enter <dir> Directory to create and enter
Returns: Exit Status:
0 Directory created (or already existed) and entered successfully 0 Directory created (or already existed) and entered successfully
1 Directory creation or cd failed 1 Directory creation or cd failed
@@ -926,7 +926,7 @@ directories via _fish_mkdir_p with tree output.
Arguments: Arguments:
file One or more file paths to create file One or more file paths to create
Returns: Exit Status:
0 Files created 0 Files created
1 No file argument provided 1 No file argument provided
@@ -976,7 +976,7 @@ Arguments:
-r, -R, --recursive Forwarded to trash put alongside path arguments -r, -R, --recursive Forwarded to trash put alongside path arguments
args... Files or paths to trash or remove args... Files or paths to trash or remove
Returns: Exit Status:
0 Operation succeeded 0 Operation succeeded
1 trash put failed or file not found 1 trash put failed or file not found
@@ -1006,7 +1006,7 @@ Arguments:
-d, --dry-run Show targets without deleting -d, --dry-run Show targets without deleting
-h, --help Show usage help -h, --help Show usage help
Returns: Exit Status:
0 Sweep completed (or dry run shown) 0 Sweep completed (or dry run shown)
1 fd not found, or unknown argument provided 1 fd not found, or unknown argument provided
@@ -1045,7 +1045,7 @@ window. Only works inside the Kitty terminal.
Arguments: Arguments:
args... Arguments forwarded to clone-in-kitty (typically a repo URL) args... Arguments forwarded to clone-in-kitty (typically a repo URL)
Returns: Exit Status:
0 Repository cloned 0 Repository cloned
1 Not running inside Kitty terminal 1 Not running inside Kitty terminal
@@ -1065,7 +1065,7 @@ Kitty terminal tab. Only works inside the Kitty terminal.
Arguments: Arguments:
args... Arguments forwarded to clone-in-kitty (typically a repo URL) args... Arguments forwarded to clone-in-kitty (typically a repo URL)
Returns: Exit Status:
0 Repository cloned 0 Repository cloned
1 Not running inside Kitty terminal 1 Not running inside Kitty terminal
@@ -1103,7 +1103,7 @@ Arguments:
-s, --silent Suppress all output, including the editor\[aq]s -s, --silent Suppress all output, including the editor\[aq]s
-h, --help Show this help message -h, --help Show this help message
Returns: Exit Status:
0 Editor launched successfully 0 Editor launched successfully
1 Conflicting flags, no editor found, or clipboard read failed 1 Conflicting flags, no editor found, or clipboard read failed
@@ -1129,7 +1129,7 @@ executing if the buffer is left empty.
Arguments: Arguments:
command_prefix Search history for the newest command matching this command_prefix Search history for the newest command matching this
Returns: Exit Status:
The edited command\[aq]s exit status, or a message when history lookup The edited command\[aq]s exit status, or a message when history lookup
found nothing. found nothing.
@@ -1214,7 +1214,7 @@ Arguments:
status Show enabled/disabled state, repo count, and registry path status Show enabled/disabled state, repo count, and registry path
-h, --help Show this help message -h, --help Show this help message
Returns: Exit Status:
0 Subcommand succeeded 0 Subcommand succeeded
1 Bad usage, target is not a git repo, or target not registered 1 Bad usage, target is not a git repo, or target not registered
@@ -1237,7 +1237,7 @@ exist. Extra arguments are forwarded to git checkout.
Arguments: Arguments:
branch_name Branch to switch to or create branch_name Branch to switch to or create
Returns: Exit Status:
0 Branch checked out or created 0 Branch checked out or created
1 Not inside a git work tree 1 Not inside a git work tree
@@ -1265,10 +1265,14 @@ Arguments:
-s, --stdout Print API output to stdout instead of .gitignore -s, --stdout Print API output to stdout instead of .gitignore
targets Comma- or space-separated list of language/tool names targets Comma- or space-separated list of language/tool names
Returns: Exit Status:
0 Patterns appended or printed 0 Patterns appended, or resolved with -s/--stdout or -l/--list
1 Not in a git repository or API fetch failed 1 Not in a git repository or API fetch failed
Returns:
With -s/--stdout, the fetched .gitignore pattern text, printed to stdout.
With -l/--list, the supported target list, printed to stdout.
Example: Example:
gi python,venv gi python,venv
gi -b -p gi -b -p
@@ -1289,7 +1293,7 @@ Arguments:
-h, --help Show help message -h, --help Show help message
-f, --force Force-delete unmerged orphaned branches (git branch -D) -f, --force Force-delete unmerged orphaned branches (git branch -D)
Returns: Exit Status:
0 Cleanup complete 0 Cleanup complete
1 Argument parsing failed 1 Argument parsing failed
@@ -1326,7 +1330,7 @@ are forwarded to git fetch.
Arguments: Arguments:
args... Forwarded verbatim to git fetch args... Forwarded verbatim to git fetch
Returns: Exit Status:
0 Fetch and status succeeded 0 Fetch and status succeeded
1 Not inside a git work tree 1 Not inside a git work tree
@@ -1372,7 +1376,7 @@ Presents an fzf picker of all installed packages (via pacman -Qqs) with
pacman -Qi previews, then removes the selected packages using paru or yay. pacman -Qi previews, then removes the selected packages using paru or yay.
Arch Linux only. Arch Linux only.
Returns: Exit Status:
0 Packages removed or none selected 0 Packages removed or none selected
1 No AUR helper (paru or yay) found 1 No AUR helper (paru or yay) found
@@ -1405,7 +1409,7 @@ Arguments:
-u, --uninstall Force uninstall mode -u, --uninstall Force uninstall mode
package One or more package names to install or remove package One or more package names to install or remove
Returns: Exit Status:
0 Operation completed 0 Operation completed
1 No supported package manager found, unknown flag, or package operation failed 1 No supported package manager found, unknown flag, or package operation failed
@@ -1427,7 +1431,7 @@ installation. Falls back to yay if paru is not installed. Arch Linux only.
Arguments: Arguments:
args... Arguments forwarded to paru or yay args... Arguments forwarded to paru or yay
Returns: Exit Status:
0 AUR helper ran successfully 0 AUR helper ran successfully
1 No AUR helper (paru or yay) found 1 No AUR helper (paru or yay) found
@@ -1444,7 +1448,7 @@ Synopsis: upgrade
Runs a full system upgrade via paru or yay with --noconfirm. Falls Runs a full system upgrade via paru or yay with --noconfirm. Falls
back to yay if paru is not installed. Arch Linux only. back to yay if paru is not installed. Arch Linux only.
Returns: Exit Status:
0 Upgrade completed successfully 0 Upgrade completed successfully
1 No AUR helper (paru or yay) found 1 No AUR helper (paru or yay) found
@@ -1499,7 +1503,7 @@ Arguments:
update Update all installed deps update Update all installed deps
sync Install missing deps, then update all sync Install missing deps, then update all
Returns: Exit Status:
0 Subcommand completed 0 Subcommand completed
1 Unknown subcommand 1 Unknown subcommand
@@ -1578,7 +1582,7 @@ count.
Arguments: Arguments:
--brief Suppress per-file output; show only the final summary --brief Suppress per-file output; show only the final summary
Returns: Exit Status:
0 All binaries verified (or summary shown) 0 All binaries verified (or summary shown)
1 sbctl is not installed 1 sbctl is not installed
@@ -1611,7 +1615,7 @@ Toggles the sudo NOPASSWD rule on and off via
otherwise require a password entry. Clears the sudo credential cache otherwise require a password entry. Clears the sudo credential cache
when re-enabling, so the lockdown takes effect immediately. when re-enabling, so the lockdown takes effect immediately.
Returns: Exit Status:
0 Rule toggled 0 Rule toggled
Example: Example:
@@ -1663,7 +1667,7 @@ Arguments:
command The command to run detached command The command to run detached
args... Additional arguments for the command args... Additional arguments for the command
Returns: Exit Status:
0 Command launched successfully 0 Command launched successfully
1 No command provided 1 No command provided
@@ -1687,7 +1691,7 @@ Arguments:
command The command to run detached command The command to run detached
args... Additional arguments for the command args... Additional arguments for the command
Returns: Exit Status:
0 Command launched or help/version shown 0 Command launched or help/version shown
1 No command provided or unknown option 1 No command provided or unknown option
@@ -1711,7 +1715,7 @@ Arguments:
command... Command to run in the new pane; opens a bare fish command... Command to run in the new pane; opens a bare fish
shell if omitted shell if omitted
Returns: Exit Status:
0 Pane opened successfully 0 Pane opened successfully
1 Not running inside Kitty or WezTerm 1 Not running inside Kitty or WezTerm
@@ -1732,7 +1736,7 @@ present, otherwise kitty \[at] launch) or WezTerm (via wezterm cli spawn).
Arguments: Arguments:
args... Arguments forwarded to the spawn command args... Arguments forwarded to the spawn command
Returns: Exit Status:
0 Window opened successfully 0 Window opened successfully
1 Not running inside Kitty or WezTerm 1 Not running inside Kitty or WezTerm
@@ -1771,7 +1775,7 @@ terminal\[aq]s tab-open command.
Arguments: Arguments:
args... Arguments forwarded to the terminal\[aq]s launch command args... Arguments forwarded to the terminal\[aq]s launch command
Returns: Exit Status:
0 Tab opened successfully 0 Tab opened successfully
1 No supported terminal found 1 No supported terminal found
@@ -1793,10 +1797,13 @@ Arguments:
-h, --help Show usage help -h, --help Show usage help
args... Arguments forwarded to the clipboard tool args... Arguments forwarded to the clipboard tool
Returns: Exit Status:
0 Clipboard contents printed successfully 0 Clipboard contents read successfully
1 No supported clipboard tool found 1 No supported clipboard tool found
Returns:
The clipboard contents, printed to stdout
Example: Example:
p | grep foo p | grep foo
p > file.txt p > file.txt
@@ -1814,10 +1821,13 @@ falls back to xclip on X11.
Arguments: Arguments:
args... Arguments forwarded to the clipboard tool args... Arguments forwarded to the clipboard tool
Returns: Exit Status:
0 Clipboard contents printed successfully 0 Clipboard contents read successfully
1 No supported clipboard tool found 1 No supported clipboard tool found
Returns:
The clipboard contents, printed to stdout
Example: Example:
paste > file.txt paste > file.txt
\f[R] \f[R]
@@ -1834,7 +1844,7 @@ Reads from stdin when no arguments are given.
Arguments: Arguments:
text Text to copy; reads from stdin if omitted text Text to copy; reads from stdin if omitted
Returns: Exit Status:
0 Text copied to clipboard 0 Text copied to clipboard
1 No clipboard provider found 1 No clipboard provider found
@@ -1879,10 +1889,13 @@ Synopsis: gip6
Fetches and prints the machine\[aq]s public IPv6 address using icanhazip.com. Fetches and prints the machine\[aq]s public IPv6 address using icanhazip.com.
Prints an error message if IPv6 is unavailable on the current network. Prints an error message if IPv6 is unavailable on the current network.
Returns: Exit Status:
0 IPv6 address printed 0 IPv6 address resolved
1 IPv6 unavailable or not supported on this network 1 IPv6 unavailable or not supported on this network
Returns:
The machine\[aq]s public IPv6 address, printed to stdout
Example: Example:
gip6 gip6
\f[R] \f[R]
@@ -1948,7 +1961,7 @@ Arguments:
-h, --help Show help message -h, --help Show help message
-c, --category cat Filter to one category: scrollback, paru, or yay -c, --category cat Filter to one category: scrollback, paru, or yay
Returns: Exit Status:
0 File viewed or no file selected 0 File viewed or no file selected
1 No log files found 1 No log files found
@@ -1973,7 +1986,7 @@ Arguments:
-h, --help Show help message -h, --help Show help message
-n, --no-log Exit without saving a scrollback log -n, --no-log Exit without saving a scrollback log
Returns: Exit Status:
0 Shell session exited 0 Shell session exited
1 Argument parsing failed 1 Argument parsing failed
@@ -2051,7 +2064,7 @@ Arguments:
-s, --silent Suppress all output; errors only (standard UNIX convention) -s, --silent Suppress all output; errors only (standard UNIX convention)
-h, --help Show this help message and exit -h, --help Show this help message and exit
Returns: Exit Status:
0 Setup completed successfully 0 Setup completed successfully
1 Fatal error (git init failed, move failed, etc.) 1 Fatal error (git init failed, move failed, etc.)
@@ -2084,7 +2097,7 @@ to the real agy binary unchanged.
Arguments: Arguments:
ARGS Any arguments forwarded verbatim to the underlying agy binary ARGS Any arguments forwarded verbatim to the underlying agy binary
Returns: Exit Status:
Exit status of the underlying agy binary Exit status of the underlying agy binary
Example: Example:
@@ -2131,7 +2144,7 @@ to the real claude binary unchanged.
Arguments: Arguments:
ARGS Any arguments forwarded verbatim to the underlying claude binary ARGS Any arguments forwarded verbatim to the underlying claude binary
Returns: Exit Status:
Exit status of the underlying claude binary Exit status of the underlying claude binary
Example: Example:
@@ -2208,7 +2221,7 @@ Arguments:
prompt... Prompt forwarded to aichat prompt... Prompt forwarded to aichat
-h, --help Show usage help -h, --help Show usage help
Returns: Exit Status:
aichat\[aq]s exit status. aichat\[aq]s exit status.
Example: Example:
@@ -2233,7 +2246,7 @@ Arguments:
-g, --global Apply at user/global scope instead of workspace/project -g, --global Apply at user/global scope instead of workspace/project
-h, --help Show usage help -h, --help Show usage help
Returns: Exit Status:
0 Mode applied successfully 0 Mode applied successfully
1 No on/off mode specified 1 No on/off mode specified
@@ -2260,7 +2273,7 @@ Arguments:
-s, --speed N Encoder speed 0-10 (default: 3, 0 = slowest) -s, --speed N Encoder speed 0-10 (default: 3, 0 = slowest)
-h, --help Show help message -h, --help Show help message
Returns: Exit Status:
0 Conversion complete 0 Conversion complete
1 File not found, missing dependency, or encode step failed 1 File not found, missing dependency, or encode step failed
@@ -2362,7 +2375,7 @@ Requires $GITEA_TOKEN and $GITEA_URL to be set.
Arguments: Arguments:
owner/repo The repository path in owner/name format owner/repo The repository path in owner/name format
Returns: Exit Status:
0 Issues linked and synced (or no unlinked issues found) 0 Issues linked and synced (or no unlinked issues found)
1 Missing required argument or environment variables 1 Missing required argument or environment variables
@@ -2435,10 +2448,14 @@ Arguments:
-m, --man Open the compiled man page via man -l -m, --man Open the compiled man page via man -l
-h, --help Print usage and navigation reference, then exit -h, --help Print usage and navigation reference, then exit
Returns: Exit Status:
0 Manual displayed (or --help printed) 0 Manual displayed
1 Documentation file not found, or required tool not available 1 Documentation file not found, or required tool not available
Returns:
With -h/--help, the usage and navigation reference, printed to stdout.
Otherwise, the manual is shown via the resolved pager (not captured stdout).
Notes: Notes:
The preferred invocation is \[ga]help config [...]\[ga] \[em] this function is The preferred invocation is \[ga]help config [...]\[ga] \[em] this function is
registered as a handler in the help wrapper so that syntax works registered as a handler in the help wrapper so that syntax works
@@ -2510,7 +2527,7 @@ Navigation:
Arguments: Arguments:
-h, --help Print usage and exit -h, --help Print usage and exit
Returns: Exit Status:
0 Exited normally (q or Escape pressed) 0 Exited normally (q or Escape pressed)
1 Unknown flag passed 1 Unknown flag passed
@@ -2532,7 +2549,7 @@ notice to stderr, then delegates all arguments to config-settings.
Arguments: Arguments:
args Passed through verbatim to config-settings args Passed through verbatim to config-settings
Returns: Exit Status:
Same as config-settings Same as config-settings
Example: Example:
@@ -2557,7 +2574,7 @@ Arguments:
-f, --force Stash local changes before pulling, then pop the stash -f, --force Stash local changes before pulling, then pop the stash
-n, --dry-run Check for upstream changes without applying them -n, --dry-run Check for upstream changes without applying them
Returns: Exit Status:
0 Config updated (or already up to date) 0 Config updated (or already up to date)
1 Update failed (network error, merge conflict, or not a git repo) 1 Update failed (network error, merge conflict, or not a git repo)
@@ -2580,7 +2597,7 @@ Arguments:
-h, --help Show help message -h, --help Show help message
directory Path to the compose project (defaults to current directory) directory Path to the compose project (defaults to current directory)
Returns: Exit Status:
0 Services updated and running 0 Services updated and running
1 Directory not found or no docker-compose.yml present 1 Directory not found or no docker-compose.yml present
@@ -2616,7 +2633,7 @@ NODE_OPTIONS=--no-deprecation.
Arguments: Arguments:
args... Arguments forwarded to the joplin command args... Arguments forwarded to the joplin command
Returns: Exit Status:
0 Joplin ran successfully 0 Joplin ran successfully
1 joplin binary not found in PATH 1 joplin binary not found in PATH
@@ -2649,7 +2666,7 @@ Arguments:
dismiss Stop the per-session reminder dismiss Stop the per-session reminder
-h, --help Show this help -h, --help Show this help
Returns: Exit Status:
0 Success 0 Success
1 Unknown subcommand/flag, kitty missing, or a write failure 1 Unknown subcommand/flag, kitty missing, or a write failure
@@ -2699,7 +2716,7 @@ Arguments:
-v, --verbose Print which browser is being launched -v, --verbose Print which browser is being launched
-h, --help Print usage and exit -h, --help Print usage and exit
Returns: Exit Status:
0 Browser launched 0 Browser launched
1 No URL given, invalid $BROWSER, or no browser found 1 No URL given, invalid $BROWSER, or no browser found
@@ -2726,7 +2743,7 @@ session. Useful for sourcing Bash-only scripts.
Arguments: Arguments:
commands Bash command string to execute and replay commands Bash command string to execute and replay
Returns: Exit Status:
0 Commands ran successfully and changes were replayed 0 Commands ran successfully and changes were replayed
1 Bash command exited with a non-zero status 1 Bash command exited with a non-zero status
@@ -2767,10 +2784,13 @@ Arguments:
-r, --root Ignore the current sub-directory; link to the repo root -r, --root Ignore the current sub-directory; link to the repo root
-h, --help Print usage and exit -h, --help Print usage and exit
Returns: Exit Status:
0 URL opened (or printed) 0 URL opened, or resolved with -p/--print
1 Not a git repo, no origin remote, or browser launch failed 1 Not a git repo, no origin remote, or browser launch failed
Returns:
With -p/--print, the resolved repository URL, printed to stdout
Notes: Notes:
Typo abbreviation: open-repo (expands to repo-open on space/enter). Typo abbreviation: open-repo (expands to repo-open on space/enter).
@@ -2808,7 +2828,7 @@ Arguments:
command Command to run with sleep inhibition active command Command to run with sleep inhibition active
args... Arguments forwarded to the command args... Arguments forwarded to the command
Returns: Exit Status:
0 Command ran and completed 0 Command ran and completed
1 No command provided 1 No command provided