chore(docs): regenerate offline HTML docs
This commit is contained in:
@@ -505,15 +505,24 @@ q quit</code></pre>
|
||||
<h2 data-number="13.2" id="with-bat">With bat</h2>
|
||||
<pre><code>bat --language=markdown --paging=always ~/.config/fish/docs/fish-config.md</code></pre>
|
||||
<h2 data-number="13.3" id="as-a-man-page">As a man page</h2>
|
||||
<p>The symlink and MANPATH are configured automatically on shell
|
||||
start:</p>
|
||||
<pre><code>config-help --man</code></pre>
|
||||
<p>Opens the compiled docs/fish-config.1 directly via man -l, bypassing
|
||||
the pager fallback chain. The symlink and MANPATH are also configured
|
||||
automatically on shell start for the standard invocation:</p>
|
||||
<pre><code>man fish-config</code></pre>
|
||||
<p>Or read the compiled file directly:</p>
|
||||
<pre><code>man -l ~/.config/fish/docs/fish-config.1</code></pre>
|
||||
<p>NOTE: fish-config (hyphen) is this config's man page. fish_config
|
||||
(underscore) is fish's built-in browser-based configuration tool — a
|
||||
completely separate command. Do not mix them up.</p>
|
||||
<h2 data-number="13.4" id="jumping-to-a-section">Jumping to a
|
||||
<h2 data-number="13.4" id="in-the-browser-html">In the browser
|
||||
(HTML)</h2>
|
||||
<pre><code>config-help --html</code></pre>
|
||||
<p>Opens docs/html/index.html in the default web browser. Browser
|
||||
detection queries the system's x-scheme-handler/https MIME entry (via
|
||||
xdg-mime) to find the real browser binary, then falls back through known
|
||||
browser binaries (firefox, chromium, vivaldi, etc.), and finally
|
||||
xdg-open as a last resort. Set $fish_help_browser or $BROWSER to
|
||||
override.</p>
|
||||
<h2 data-number="13.5" id="jumping-to-a-section">Jumping to a
|
||||
section</h2>
|
||||
<pre><code>help config keybindings
|
||||
help config abbreviations
|
||||
|
||||
@@ -1003,44 +1003,85 @@ spark 1 1 2 5 14 42
|
||||
echo "3 7 2 9 1" | spark</code></pre>
|
||||
<hr />
|
||||
<h2 data-number="9.14" id="514-miscellaneous">5.14 Miscellaneous</h2>
|
||||
<h3 data-number="9.14.1" id="bash">bash</h3>
|
||||
<h3 data-number="9.14.1" id="config-help">config-help</h3>
|
||||
<pre><code>Synopsis: config-help [SECTION]
|
||||
config-help --html
|
||||
config-help --man
|
||||
config-help -h | --help
|
||||
|
||||
Opens the offline fish shell configuration manual. Without flags, opens
|
||||
the Markdown source in the best available pager (ov > bat > man > less >
|
||||
cat). If SECTION is given, jumps to the first heading matching that
|
||||
keyword (case-insensitive; checks fish-config.index aliases first).
|
||||
|
||||
Flags:
|
||||
--html / -w Open docs/html/index.html in the default browser.
|
||||
Detects the browser via xdg-mime x-scheme-handler/https,
|
||||
then known binaries, then xdg-open as last resort.
|
||||
Respects $fish_help_browser and $BROWSER.
|
||||
--man / -m Open docs/fish-config.1 via man -l directly.
|
||||
--help / -h Print usage and navigation key reference.
|
||||
|
||||
config-help keybindings
|
||||
config-help pkg
|
||||
config-help --html
|
||||
config-help --man</code></pre>
|
||||
<h3 data-number="9.14.2" id="config-update">config-update</h3>
|
||||
<pre><code>Synopsis: config-update [-h] [-n] [-f]
|
||||
|
||||
Pulls the latest fish configuration from the upstream repository
|
||||
(https://git.rootiest.dev/rootiest/fish-config.git) into ~/.config/fish.
|
||||
The remote URL is hard-coded, so this works on fresh clones with no git
|
||||
remote configured. All git output is suppressed; colored messages report
|
||||
fetch and merge status. After a successful pull, run `exec fish` to
|
||||
reload.
|
||||
|
||||
Flags:
|
||||
--dry-run / -n Fetch and show available commits without applying them.
|
||||
--force / -f Stash local changes, pull, then restore the stash.
|
||||
--help / -h Show usage.
|
||||
|
||||
config-update
|
||||
config-update --dry-run
|
||||
config-update --force</code></pre>
|
||||
<h3 data-number="9.14.3" id="bash">bash</h3>
|
||||
<pre><code>Synopsis: bash [args...]
|
||||
Switches to bash, with XDG config applied. On exit, $SHELL is reset
|
||||
back to fish.</code></pre>
|
||||
<h3 data-number="9.14.2" id="bd-pull">bd-pull</h3>
|
||||
<h3 data-number="9.14.4" id="bd-pull">bd-pull</h3>
|
||||
<pre><code>Synopsis: bd-pull <owner/repo>
|
||||
Fetches unlinked Gitea issues and creates local Beads entries, updating
|
||||
issue titles with the assigned Beads IDs.
|
||||
Requires $GITEA_TOKEN and $GITEA_URL to be set.
|
||||
|
||||
bd-pull rootiest/fish-config</code></pre>
|
||||
<h3 data-number="9.14.3" id="cheat">cheat</h3>
|
||||
<h3 data-number="9.14.5" id="cheat">cheat</h3>
|
||||
<pre><code>Synopsis: cheat <topic> [args...]
|
||||
Displays a colorized cheatsheet using cheat -c, falls back to tldr,
|
||||
then man.
|
||||
|
||||
cheat tar
|
||||
cheat git</code></pre>
|
||||
<h3 data-number="9.14.4" id="cffetch--ffetch">cffetch / ffetch</h3>
|
||||
<h3 data-number="9.14.6" id="cffetch--ffetch">cffetch / ffetch</h3>
|
||||
<pre><code>Synopsis: cffetch [args...] / ffetch [args...]
|
||||
Clears the screen and displays system information via fastfetch with
|
||||
the custom config at ~/.fastfetch.jsonc. Falls back to neofetch.</code></pre>
|
||||
<h3 data-number="9.14.5" id="dockup">dockup</h3>
|
||||
<h3 data-number="9.14.7" id="dockup">dockup</h3>
|
||||
<pre><code>Synopsis: dockup [-h] [directory]
|
||||
Pulls latest Docker images, restarts services in the given Docker
|
||||
Compose project, and prunes dangling images.
|
||||
|
||||
dockup ~/myapp</code></pre>
|
||||
<h3 data-number="9.14.6" id="joplin">joplin</h3>
|
||||
<h3 data-number="9.14.8" id="joplin">joplin</h3>
|
||||
<pre><code>Synopsis: joplin [args...]
|
||||
Runs the Joplin CLI with Node.js deprecation warnings suppressed.
|
||||
|
||||
joplin ls</code></pre>
|
||||
<h3 data-number="9.14.7" id="ld-1">ld</h3>
|
||||
<h3 data-number="9.14.9" id="ld-1">ld</h3>
|
||||
<pre><code>Synopsis: ld
|
||||
Launches lazydocker targeting the currently active Docker context,
|
||||
detected via docker context inspect.</code></pre>
|
||||
<h3 data-number="9.14.8" id="replay">replay</h3>
|
||||
<h3 data-number="9.14.10" id="replay">replay</h3>
|
||||
<pre><code>Synopsis: replay <commands>
|
||||
Runs Bash commands and replays any resulting changes to environment
|
||||
variables, aliases, and the working directory back into the current
|
||||
@@ -1048,17 +1089,17 @@ Fish session. Useful for sourcing Bash scripts.
|
||||
|
||||
replay "source ~/.bashrc"
|
||||
replay "export FOO=bar"</code></pre>
|
||||
<h3 data-number="9.14.9" id="tmux-clean">tmux-clean</h3>
|
||||
<h3 data-number="9.14.11" id="tmux-clean">tmux-clean</h3>
|
||||
<pre><code>Synopsis: tmux-clean
|
||||
Kills all detached (unattached) tmux sessions, leaving attached ones
|
||||
running.</code></pre>
|
||||
<h3 data-number="9.14.10" id="wake-lock">wake-lock</h3>
|
||||
<h3 data-number="9.14.12" id="wake-lock">wake-lock</h3>
|
||||
<pre><code>Synopsis: wake-lock <command> [args...]
|
||||
Runs a command under systemd-inhibit, preventing the system from going
|
||||
idle or sleeping until the command completes.
|
||||
|
||||
wake-lock rsync -avz src/ dest/</code></pre>
|
||||
<h3 data-number="9.14.11" id="zellij">zellij</h3>
|
||||
<h3 data-number="9.14.13" id="zellij">zellij</h3>
|
||||
<pre><code>Synopsis: zellij [args...]
|
||||
Launches zellij with the Catppuccin Mocha theme applied.</code></pre>
|
||||
<hr />
|
||||
|
||||
@@ -731,6 +731,10 @@ id="toc-spark">spark</a></li>
|
||||
<li><a href="9-5-functions-reference.html#514-miscellaneous"
|
||||
id="toc-514-miscellaneous">5.14 Miscellaneous</a>
|
||||
<ul>
|
||||
<li><a href="9-5-functions-reference.html#config-help"
|
||||
id="toc-config-help">config-help</a></li>
|
||||
<li><a href="9-5-functions-reference.html#config-update"
|
||||
id="toc-config-update">config-update</a></li>
|
||||
<li><a href="9-5-functions-reference.html#bash"
|
||||
id="toc-bash">bash</a></li>
|
||||
<li><a href="9-5-functions-reference.html#bd-pull"
|
||||
@@ -792,6 +796,8 @@ id="toc-with-ov-recommended">With ov (recommended)</a></li>
|
||||
id="toc-with-bat">With bat</a></li>
|
||||
<li><a href="13-9-viewing-this-manual.html#as-a-man-page"
|
||||
id="toc-as-a-man-page">As a man page</a></li>
|
||||
<li><a href="13-9-viewing-this-manual.html#in-the-browser-html"
|
||||
id="toc-in-the-browser-html">In the browser (HTML)</a></li>
|
||||
<li><a href="13-9-viewing-this-manual.html#jumping-to-a-section"
|
||||
id="toc-jumping-to-a-section">Jumping to a section</a></li>
|
||||
</ul></li>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user