docs(functions): split RETURNS into EXIT STATUS and stdout RETURNS
RETURNS previously conflated fish's $status exit code with genuine stdout/printed output, e.g. rm listing "0/1" as if they were print values rather than exit codes. Rename RETURNS to EXIT STATUS across all 83 documented functions, and reintroduce RETURNS as a distinct label reserved for the 15 functions that actually print to stdout. Update build-manual.py's ENTRY_HEADS to render Exit Status before Returns, manualtools.py's SECTIONS constant, and AGENTS.md's label order and label-usage guidance to match. Add two verify-manual.py regression tests: EXIT STATUS bodies must never contain stray stdout/printed language, and Returns: must always render after Exit Status: when both are present. Regenerate docs/fish-config.md.
This commit is contained in:
@@ -19,7 +19,7 @@
|
||||
# scope "universal" or "session"
|
||||
# value "on", "off", "DEFAULT", or any arbitrary string (universal scope only)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
# cur_scope "universal" or "session"
|
||||
# var1–var7 Variable names for rows 0–6 (6 categories + master)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
# cur_row 0-based highlighted row within the page
|
||||
# page "sponge" or "paths"
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -12,8 +12,11 @@
|
||||
# ARGUMENTS
|
||||
# varname Variable name without the $ prefix
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Always; prints the value or "DEFAULT" to stdout
|
||||
# The value, or "DEFAULT" if unset, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# set v (__config_settings_get_raw sponge_delay) # "2" or "DEFAULT"
|
||||
|
||||
@@ -14,8 +14,11 @@
|
||||
# varname Variable name without $ prefix
|
||||
# scope "universal" or "session"
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Always; prints "on", "off", or "DEFAULT" to stdout
|
||||
# "on", "off", or "DEFAULT", printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# set result (__config_settings_get_val __fish_config_op_aliases universal)
|
||||
|
||||
@@ -15,8 +15,11 @@
|
||||
# active_idx 0–3, the active page index
|
||||
# iw inner width in columns to pad the strip to
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Always; prints the tab strip (no trailing newline beyond printf's)
|
||||
# The rendered tab strip, printed to stdout (no trailing newline beyond printf's)
|
||||
#
|
||||
# EXAMPLE
|
||||
# set strip (__config_settings_pagetab 2 76)
|
||||
|
||||
@@ -21,15 +21,18 @@
|
||||
# ARGUMENTS
|
||||
# (none)
|
||||
#
|
||||
# RETURNS
|
||||
# 0 A key was read; one of these tokens is printed to stdout:
|
||||
# up down left right arrow keys
|
||||
# space tab backtab enter escape backspace
|
||||
# quit Ctrl-C (byte 3) in raw mode
|
||||
# <char> any other single printable character
|
||||
# "" nothing decodable was read
|
||||
# EXIT STATUS
|
||||
# 0 A key was read
|
||||
# 1 The terminal could not be put into raw mode (stdin is not a TTY)
|
||||
#
|
||||
# RETURNS
|
||||
# One token, printed to stdout:
|
||||
# up down left right arrow keys
|
||||
# space tab backtab enter escape backspace
|
||||
# quit Ctrl-C (byte 3) in raw mode
|
||||
# <char> any other single printable character
|
||||
# "" nothing decodable was read
|
||||
#
|
||||
# EXAMPLE
|
||||
# set -l key (__config_settings_read_key)
|
||||
# or return # not a TTY — bail
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
# type "list" (whitespace-split) or any other tag (single value)
|
||||
# value The new value; empty string erases (reset to default)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
# __fish_config_op_logging, or
|
||||
# __fish_config_op_greeting
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Component enabled (category explicitly truthy; or category unset and master not falsy)
|
||||
# 1 Component disabled (category explicitly falsy; or category unset and master falsy; or no argument with falsy master)
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# Safe to call at any time; wrapper removal only affects files bearing
|
||||
# the generated version-marker comment.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -18,9 +18,12 @@
|
||||
# ARGUMENTS
|
||||
# name Command name to resolve (e.g. paru, yay)
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 A non-wrapper binary was found
|
||||
# 1 No non-wrapper binary found on PATH
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Real binary path printed to stdout
|
||||
# 1 No non-wrapper binary found on PATH (nothing printed)
|
||||
# The resolved binary's real path, printed to stdout (nothing on failure)
|
||||
#
|
||||
# EXAMPLE
|
||||
# set -l real (__fish_real_command paru) # -> /usr/bin/paru, not the shim
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
# ARGUMENTS
|
||||
# (none)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
# ARGUMENTS
|
||||
# variable_name Name of the variable to check (without $ prefix)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 True (opt-in): value matches 1, true, yes, on, or y
|
||||
# 1 False (opt-out): value matches 0, false, no, off, or n
|
||||
# 2 Empty: variable is unset or empty
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
# into the command line at the cursor position. Bound to @@ by default.
|
||||
# Repaints the prompt after selection or cancellation.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always; no-op if fzf is cancelled
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -9,8 +9,11 @@
|
||||
# order: $KITTY_CONFIG_DIRECTORY, else $XDG_CONFIG_HOME/kitty, else
|
||||
# ~/.config/kitty.
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Always (path printed to stdout)
|
||||
# The Kitty configuration directory path, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# set -l dir (__kitty_logging_dir)
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
# (non-commented) `watcher` directive — whether the fish-config managed one or
|
||||
# a user's own. Used to suppress the setup reminder and to inform status.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 An active watcher directive is present
|
||||
# 1 None present, or kitty.conf does not exist
|
||||
#
|
||||
|
||||
@@ -11,8 +11,11 @@
|
||||
# ARGUMENTS
|
||||
# file Path to a watcher script
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Always (integer printed to stdout)
|
||||
# The watcher version as an integer (0 if absent), printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# __kitty_logging_version ~/.config/kitty/fish-config-watcher.py
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
# label Short description used in the block comment header
|
||||
# pattern One or more gitignore patterns to ensure are present
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 All patterns already ignored or successfully appended
|
||||
# 1 Could not write to .gitignore
|
||||
#
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
# ARGUMENTS
|
||||
# agents_dir Absolute path to the AGENTS/ sub-repo root
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Tooling is current or was installed/updated successfully
|
||||
# 1 Canonical source missing or a copy failed
|
||||
#
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
# ARGUMENTS
|
||||
# dir Absolute path to the git repository to fast-forward
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Fast-forward applied (or already up to date)
|
||||
# 1 A precondition failed; nothing was changed
|
||||
#
|
||||
|
||||
@@ -49,9 +49,12 @@ end
|
||||
# ARGUMENTS
|
||||
# bin The binary name to look up in the catalog
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Binary found in the catalog
|
||||
# 1 Binary not found
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Index printed to stdout
|
||||
# 1 Binary not found (empty output)
|
||||
# The binary's 1-based catalog index, printed to stdout (nothing on failure)
|
||||
#
|
||||
# EXAMPLE
|
||||
# _fish_deps_catalog_idx fzf
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
# ARGUMENTS
|
||||
# pkg The package name to install
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Package installed successfully
|
||||
# 1 No supported package manager found
|
||||
#
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
# ARGUMENTS
|
||||
# pkg The package name to upgrade
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Package upgraded successfully
|
||||
# 1 No supported package manager found
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# -s, --silent Suppress all output
|
||||
# dir The directory path to create
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Directory created or already exists
|
||||
# 1 No target directory specified or mkdir failed
|
||||
#
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
# ARGUMENTS
|
||||
# prefix Log-name prefix to prune (e.g. tmux, zellij)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
# after evaluation. No-ops if qalc is not installed or the buffer
|
||||
# is empty. Intended to be bound to a key in key_bindings.fish.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 1 qalc not found in PATH
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
# unset) or tmux is missing. Shared by conf.d/tmux-logging.fish (shell
|
||||
# startup) and __fish_config_sync_logging (C5 re-enable) so both stay in sync.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
# No-op when logging is disabled, not inside Zellij ($ZELLIJ unset), or the
|
||||
# zellij binary is missing.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
# -s, --silent Suppress all output; errors only (standard UNIX convention)
|
||||
# -h, --help Show this help message and exit
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Setup completed successfully
|
||||
# 1 Fatal error (git init failed, move failed, etc.)
|
||||
#
|
||||
|
||||
+1
-1
@@ -25,7 +25,7 @@
|
||||
# ARGUMENTS
|
||||
# ARGS Any arguments forwarded verbatim to the underlying agy binary
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# Exit status of the underlying agy binary
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
# status Show enabled/disabled state, repo count, and registry path
|
||||
# -h, --help Show this help message
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Subcommand succeeded
|
||||
# 1 Bad usage, target is not a git repo, or target not registered
|
||||
#
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
# ARGUMENTS
|
||||
# owner/repo The repository path in owner/name format
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Issues linked and synced (or no unlinked issues found)
|
||||
# 1 Missing required argument or environment variables
|
||||
#
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@
|
||||
# command The command to run detached
|
||||
# args... Additional arguments for the command
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Command launched successfully
|
||||
# 1 No command provided
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# branch_name Branch to switch to or create
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Branch checked out or created
|
||||
# 1 Not inside a git work tree
|
||||
#
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
# ARGUMENTS
|
||||
# ARGS Any arguments forwarded verbatim to the underlying claude binary
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# Exit status of the underlying claude binary
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to clone-in-kitty (typically a repo URL)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Repository cloned
|
||||
# 1 Not running inside Kitty terminal
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to clone-in-kitty (typically a repo URL)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Repository cloned
|
||||
# 1 Not running inside Kitty terminal
|
||||
#
|
||||
|
||||
@@ -32,10 +32,14 @@
|
||||
# -m, --man Open the compiled man page via man -l
|
||||
# -h, --help Print usage and navigation reference, then exit
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Manual displayed (or --help printed)
|
||||
# EXIT STATUS
|
||||
# 0 Manual displayed
|
||||
# 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).
|
||||
#
|
||||
# EXAMPLE
|
||||
# config-help
|
||||
# config-help keybindings
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
# ARGUMENTS
|
||||
# -h, --help Print usage and exit
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Exited normally (q or Escape pressed)
|
||||
# 1 Unknown flag passed
|
||||
#
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
# ARGUMENTS
|
||||
# args Passed through verbatim to config-settings
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# Same as config-settings
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
# -f, --force Stash local changes before pulling, then pop the stash
|
||||
# -n, --dry-run Check for upstream changes without applying them
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Config updated (or already up to date)
|
||||
# 1 Update failed (network error, merge conflict, or not a git repo)
|
||||
#
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
# command The command to run detached
|
||||
# args... Additional arguments for the command
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Command launched or help/version shown
|
||||
# 1 No command provided or unknown option
|
||||
#
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
# -s, --speed N Encoder speed 0-10 (default: 3, 0 = slowest)
|
||||
# -h, --help Show help message
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Conversion complete
|
||||
# 1 File not found, missing dependency, or encode step failed
|
||||
#
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
# -h, --help Show help message
|
||||
# directory Path to the compose project (defaults to current directory)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Services updated and running
|
||||
# 1 Directory not found or no docker-compose.yml present
|
||||
#
|
||||
|
||||
+1
-1
@@ -31,7 +31,7 @@
|
||||
# -s, --silent Suppress all output, including the editor's
|
||||
# -h, --help Show this help message
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Editor launched successfully
|
||||
# 1 Conflicting flags, no editor found, or clipboard read failed
|
||||
#
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@
|
||||
# ARGUMENTS
|
||||
# command_prefix Search history for the newest command matching this
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# The edited command's exit status, or a message when history lookup
|
||||
# found nothing.
|
||||
#
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
# update Update all installed deps
|
||||
# sync Install missing deps, then update all
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Subcommand completed
|
||||
# 1 Unknown subcommand
|
||||
#
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
# that would prepend to the prompt line and break the two-line nim layout.
|
||||
# Vi-mode display is handled inside fish_prompt itself.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always (function body is empty)
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -10,8 +10,11 @@
|
||||
# C3 overrides are disabled. Has no external dependencies; uses only fish-provided functions
|
||||
# (set_color, fish_git_prompt, prompt_pwd, prompt_hostname).
|
||||
#
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Always; outputs the prompt to stdout
|
||||
# The rendered two-line prompt, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# # Rendered automatically by fish; not called directly.
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
# context (if non-default) — that block is paired with the starship prompt
|
||||
# which already guards on both conditions.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Always
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
# --variables=key Override the variables search binding (default: Ctrl-V)
|
||||
# -h, --help Show help message
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Bindings installed or help shown
|
||||
# 22 Invalid option or positional argument provided
|
||||
#
|
||||
|
||||
+6
-2
@@ -22,10 +22,14 @@
|
||||
# -s, --stdout Print API output to stdout instead of .gitignore
|
||||
# targets Comma- or space-separated list of language/tool names
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Patterns appended or printed
|
||||
# EXIT STATUS
|
||||
# 0 Patterns appended, or resolved with -s/--stdout or -l/--list
|
||||
# 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
|
||||
# gi python,venv
|
||||
# gi -b -p
|
||||
|
||||
+5
-2
@@ -11,10 +11,13 @@
|
||||
# Fetches and prints the machine's public IPv6 address using icanhazip.com.
|
||||
# Prints an error message if IPv6 is unavailable on the current network.
|
||||
#
|
||||
# RETURNS
|
||||
# 0 IPv6 address printed
|
||||
# EXIT STATUS
|
||||
# 0 IPv6 address resolved
|
||||
# 1 IPv6 unavailable or not supported on this network
|
||||
#
|
||||
# RETURNS
|
||||
# The machine's public IPv6 address, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# gip6
|
||||
function gip6 --description 'Get public IPv6 address'
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
# -h, --help Show help message
|
||||
# -f, --force Force-delete unmerged orphaned branches (git branch -D)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Cleanup complete
|
||||
# 1 Argument parsing failed
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Forwarded verbatim to git fetch
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Fetch and status succeeded
|
||||
# 1 Not inside a git work tree
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to the joplin command
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Joplin ran successfully
|
||||
# 1 joplin binary not found in PATH
|
||||
#
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
# dismiss Stop the per-session reminder
|
||||
# -h, --help Show this help
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Success
|
||||
# 1 Unknown subcommand/flag, kitty missing, or a write failure
|
||||
#
|
||||
|
||||
+1
-1
@@ -25,7 +25,7 @@
|
||||
# -h, --help Show help message
|
||||
# -c, --category cat Filter to one category: scrollback, paru, or yay
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 File viewed or no file selected
|
||||
# 1 No log files found
|
||||
#
|
||||
|
||||
+1
-1
@@ -18,7 +18,7 @@
|
||||
# -s, --silent Suppress directory creation output
|
||||
# <dir> Directory to create and enter
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Directory created (or already existed) and entered successfully
|
||||
# 1 Directory creation or cd failed
|
||||
#
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
# -v, --verbose Print which browser is being launched
|
||||
# -h, --help Print usage and exit
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Browser launched
|
||||
# 1 No URL given, invalid $BROWSER, or no browser found
|
||||
#
|
||||
|
||||
+5
-2
@@ -15,10 +15,13 @@
|
||||
# -h, --help Show usage help
|
||||
# args... Arguments forwarded to the clipboard tool
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Clipboard contents printed successfully
|
||||
# EXIT STATUS
|
||||
# 0 Clipboard contents read successfully
|
||||
# 1 No supported clipboard tool found
|
||||
#
|
||||
# RETURNS
|
||||
# The clipboard contents, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# p | grep foo
|
||||
# p > file.txt
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
# pacman -Qi previews, then removes the selected packages using paru or yay.
|
||||
# Arch Linux only.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Packages removed or none selected
|
||||
# 1 No AUR helper (paru or yay) found
|
||||
#
|
||||
|
||||
@@ -14,10 +14,13 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to the clipboard tool
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Clipboard contents printed successfully
|
||||
# EXIT STATUS
|
||||
# 0 Clipboard contents read successfully
|
||||
# 1 No supported clipboard tool found
|
||||
#
|
||||
# RETURNS
|
||||
# The clipboard contents, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# paste > file.txt
|
||||
function paste --description 'Paste from clipboard'
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@
|
||||
# -u, --uninstall Force uninstall mode
|
||||
# package One or more package names to install or remove
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Operation completed
|
||||
# 1 No supported package manager found, unknown flag, or package operation failed
|
||||
#
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# file One or more file paths to create
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Files created
|
||||
# 1 No file argument provided
|
||||
#
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@
|
||||
# prompt... Prompt forwarded to aichat
|
||||
# -h, --help Show usage help
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# aichat's exit status.
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
# ARGUMENTS
|
||||
# commands Bash command string to execute and replay
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Commands ran successfully and changes were replayed
|
||||
# 1 Bash command exited with a non-zero status
|
||||
#
|
||||
|
||||
@@ -37,10 +37,13 @@
|
||||
# -r, --root Ignore the current sub-directory; link to the repo root
|
||||
# -h, --help Print usage and exit
|
||||
#
|
||||
# RETURNS
|
||||
# 0 URL opened (or printed)
|
||||
# EXIT STATUS
|
||||
# 0 URL opened, or resolved with -p/--print
|
||||
# 1 Not a git repo, no origin remote, or browser launch failed
|
||||
#
|
||||
# RETURNS
|
||||
# With -p/--print, the resolved repository URL, printed to stdout
|
||||
#
|
||||
# EXAMPLE
|
||||
# repo-open # open current branch (+ subdir) in browser
|
||||
# repo-open --print # just print the URL
|
||||
|
||||
+1
-1
@@ -25,7 +25,7 @@
|
||||
# -r, -R, --recursive Forwarded to trash put alongside path arguments
|
||||
# args... Files or paths to trash or remove
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Operation succeeded
|
||||
# 1 trash put failed or file not found
|
||||
#
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
# ARGUMENTS
|
||||
# --brief Suppress per-file output; show only the final summary
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 All binaries verified (or summary shown)
|
||||
# 1 sbctl is not installed
|
||||
#
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
# -d, --dry-run Show targets without deleting
|
||||
# -h, --help Show usage help
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Sweep completed (or dry run shown)
|
||||
# 1 fd not found, or unknown argument provided
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to paru or yay
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 AUR helper ran successfully
|
||||
# 1 No AUR helper (paru or yay) found
|
||||
#
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
# -h, --help Show help message
|
||||
# -n, --no-log Exit without saving a scrollback log
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Shell session exited
|
||||
# 1 Argument parsing failed
|
||||
#
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
# command... Command to run in the new pane; opens a bare fish
|
||||
# shell if omitted
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Pane opened successfully
|
||||
# 1 Not running inside Kitty or WezTerm
|
||||
#
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
# exit_code Exit code of the command (unused)
|
||||
# previously_in_history "true"/"false" flag (unused)
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Command contains a secret value — filter out of history
|
||||
# 1 No secret value found — keep in history
|
||||
#
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to the spawn command
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Window opened successfully
|
||||
# 1 Not running inside Kitty or WezTerm
|
||||
#
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
# otherwise require a password entry. Clears the sudo credential cache
|
||||
# when re-enabling, so the lockdown takes effect immediately.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Rule toggled
|
||||
#
|
||||
# EXAMPLE
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
# -g, --global Apply at user/global scope instead of workspace/project
|
||||
# -h, --help Show usage help
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Mode applied successfully
|
||||
# 1 No on/off mode specified
|
||||
#
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to the terminal's launch command
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Tab opened successfully
|
||||
# 1 No supported terminal found
|
||||
#
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
# Runs a full system upgrade via paru or yay with --noconfirm. Falls
|
||||
# back to yay if paru is not installed. Arch Linux only.
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Upgrade completed successfully
|
||||
# 1 No AUR helper (paru or yay) found
|
||||
#
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
# command Command to run with sleep inhibition active
|
||||
# args... Arguments forwarded to the command
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Command ran and completed
|
||||
# 1 No command provided
|
||||
#
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@
|
||||
# ARGUMENTS
|
||||
# text Text to copy; reads from stdin if omitted
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 Text copied to clipboard
|
||||
# 1 No clipboard provider found
|
||||
#
|
||||
|
||||
@@ -60,7 +60,7 @@ end
|
||||
# ARGUMENTS
|
||||
# check The string to compare against the first non-switch token
|
||||
#
|
||||
# RETURNS
|
||||
# EXIT STATUS
|
||||
# 0 First token equals check
|
||||
# 1 No token or token does not match
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user