From 0b9cf5a9287ec0407f76c311f2f270461699ce41 Mon Sep 17 00:00:00 2001 From: Gitea Actions Date: Thu, 6 Aug 2026 19:48:00 +0000 Subject: [PATCH] chore(docs): regenerate manual and man page --- docs/fish-config.1 | 103 ++++++++++++++++++++++++++++++++++++++++++++ docs/fish-config.md | 70 +++++++++++++++++++++--------- 2 files changed, 152 insertions(+), 21 deletions(-) diff --git a/docs/fish-config.1 b/docs/fish-config.1 index 9d8d0cf..0473550 100644 --- a/docs/fish-config.1 +++ b/docs/fish-config.1 @@ -1959,6 +1959,72 @@ Example: # Rendered automatically by fish; not called directly. \f[R] .fi +.SS jobrunner +.IP +.nf +\f[C] +Synopsis: jobrunner [-t ] [] [] [...] + jr [-t ] [] [] [...] + +Runs, lists, inspects, re-attaches to, and terminates named background +jobs using tmux or GNU screen as the process engine. Unlike bkg and +detach, which discard output, a jobrunner job keeps a live terminal you +can return to later \[em] it survives closing the shell, and \[ga]attach\[ga] +restores it in any subsequent session. +Run and manage named background jobs. Jobs are detached from the shell +and backed by tmux (preferred) or GNU screen. + +If the job name is omitted when starting a new job (e.g. \[ga]jobrunner sleep 1\[ga]), +a memorable, random name (like \[ga]sleepy-badger\[ga]) will be generated. + +Exit Status: + 0 Command succeeded, or no jobs are running + 1 Invalid arguments, or the named job does not exist + 127 neither tmux nor screen is installed + +Notes: + Detach from an attached job with Ctrl-A then D; the job keeps running. + Commands are executed directly rather than through a shell, so pipes and + redirections must be wrapped explicitly, e.g. + \[ga]jobrunner run sync fish -c \[aq]a | b\[aq]\[ga]. + +Example: +jobrunner run -n build make -j8 +jobrunner sleep 1000 +jobrunner -t screen run -n backup rsync -a ./data remote:/backup/ +jobrunner list +jobrunner logs build +jobrunner build +jobrunner kill build +\f[R] +.fi +.PP +\f[B]Dependencies:\f[R] \f[V]tmux\f[R], \f[V]screen\f[R], +\f[V]__jobrunner_sessions\f[R] +.PP +\f[B]Used by:\f[R] \f[V]jr\f[R] +.SS jr +.IP +.nf +\f[C] +Synopsis: jr [] [] [...] + +Shorthand for jobrunner. Accepts the same subcommands, flags, and +shorthands, and inherits its completions. + +Arguments: + See jobrunner --help for the full argument reference. + +Exit Status: + Same as jobrunner. + +Example: +jr run build make -j8 +jr list +\f[R] +.fi +.PP +\f[B]Dependencies:\f[R] \f[V]jobrunner\f[R] .SS split .IP .nf @@ -3079,6 +3145,43 @@ open-url -v https://fish.rootiest.fyi/ .fi .PP \f[B]Used by:\f[R] \f[V]repo-open\f[R] +.SS rand_string +.IP +.nf +\f[C] +Synopsis: rand_string [COMPONENTS/MODIFIERS]... + +Generates a random, memorable string using a sequence of specified word +categories and formatting modifiers. Words are pulled from curated +plain-text databases bundled in \[ga]data/words/\[ga]. + +Modifiers like \[ga]--separator\[ga] and \[ga]--case\[ga] are evaluated sequentially and +apply only to the components that follow them. + +Supported Components: + A bundled word list (e.g. adjective, animal, color, name, noun, verb) +digits= N random digits (e.g. digits=3 -> 842) +literal= A static string component (e.g. literal=TEST) + +Arguments: + -s, --separator= Delimiter for subsequent words (dash, underscore, dot, none, or literal chars) + -c, --case= Casing for subsequent words (lower, upper, title) + -h, --help Show usage help + +Exit Status: + 0 String generated successfully + 1 Unknown category or missing word list file + +Notes: + Falls back to \[ga]random choice\[ga] if GNU \[ga]shuf\[ga] is missing, but \[ga]shuf\[ga] is + much faster for files with >1000 lines. + +Example: +rand_string adjective animal +rand_string --case=title color animal --separator=dot digits=4 +rand_string literal=TEST --separator=underscore verb noun +\f[R] +.fi .SS replay .IP .nf diff --git a/docs/fish-config.md b/docs/fish-config.md index 93b8bc8..5daf23f 100644 --- a/docs/fish-config.md +++ b/docs/fish-config.md @@ -1484,31 +1484,24 @@ Add -i (interactive confirmation) to destructive commands: ### jobrunner - Synopsis: jobrunner [] [] [...] - jr [] [] [...] + Synopsis: jobrunner [-t ] [] [] [...] + jr [-t ] [] [] [...] Runs, lists, inspects, re-attaches to, and terminates named background - jobs using GNU screen as the process engine. Unlike bkg and detach, - which discard output, a jobrunner job keeps a live terminal you can - return to later — it survives closing the shell, and `attach` restores - it in any subsequent session. + jobs using tmux or GNU screen as the process engine. Unlike bkg and + detach, which discard output, a jobrunner job keeps a live terminal you + can return to later — it survives closing the shell, and `attach` + restores it in any subsequent session. + Run and manage named background jobs. Jobs are detached from the shell + and backed by tmux (preferred) or GNU screen. - Every subcommand has a matching flag form, and the common cases are - inferred: no arguments lists jobs, a lone name attaches to it, and a - name followed by a command runs it. - - Arguments: - run, -r, --run ... Start a named job in the background - list, -l, --list List all managed background jobs - attach, -a, --attach Re-attach interactively to a job - kill, -k, --kill Terminate a running background job - logs, -o, --output Print a job's current output, no attach - help, -h, --help Show usage help + If the job name is omitted when starting a new job (e.g. `jobrunner sleep 1`), + a memorable, random name (like `sleepy-badger`) will be generated. Exit Status: 0 Command succeeded, or no jobs are running 1 Invalid arguments, or the named job does not exist - 127 screen is not installed + 127 neither tmux nor screen is installed Notes: Detach from an attached job with Ctrl-A then D; the job keeps running. @@ -1517,14 +1510,15 @@ Add -i (interactive confirmation) to destructive commands: `jobrunner run sync fish -c 'a | b'`. Example: - jobrunner run build make -j8 - jobrunner backup rsync -a ./data remote:/backup/ + jobrunner run -n build make -j8 + jobrunner sleep 1000 + jobrunner -t screen run -n backup rsync -a ./data remote:/backup/ jobrunner list jobrunner logs build jobrunner build jobrunner kill build -**Dependencies:** `screen`, `__jobrunner_sessions` +**Dependencies:** `tmux`, `screen`, `__jobrunner_sessions` **Used by:** `jr` @@ -2538,6 +2532,40 @@ Add -i (interactive confirmation) to destructive commands: **Used by:** `repo-open` +### rand_string + + Synopsis: rand_string [COMPONENTS/MODIFIERS]... + + Generates a random, memorable string using a sequence of specified word + categories and formatting modifiers. Words are pulled from curated + plain-text databases bundled in `data/words/`. + + Modifiers like `--separator` and `--case` are evaluated sequentially and + apply only to the components that follow them. + + Supported Components: + A bundled word list (e.g. adjective, animal, color, name, noun, verb) + digits= N random digits (e.g. digits=3 -> 842) + literal= A static string component (e.g. literal=TEST) + + Arguments: + -s, --separator= Delimiter for subsequent words (dash, underscore, dot, none, or literal chars) + -c, --case= Casing for subsequent words (lower, upper, title) + -h, --help Show usage help + + Exit Status: + 0 String generated successfully + 1 Unknown category or missing word list file + + Notes: + Falls back to `random choice` if GNU `shuf` is missing, but `shuf` is + much faster for files with >1000 lines. + + Example: + rand_string adjective animal + rand_string --case=title color animal --separator=dot digits=4 + rand_string literal=TEST --separator=underscore verb noun + ### replay Synopsis: replay