rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs): regenerate manual, man page, and component registry

Browse Source
This commit is contained in:
Gitea Actions
2026-08-25 05:54:10 +00:00
parent e97b3ee6ab
commit f7cfad559c
2 changed files with 150 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/fish-config.1
+76 -24
View File
@@ -3896,12 +3896,15 @@ The primary prompt is Starship, initialized by conf.d/starship.fish.
Configure it via \[ti]/.config/starship.toml. Configure it via \[ti]/.config/starship.toml.
.PP .PP
conf.d/starship.fish defines a fish_prompt wrapper that only activates conf.d/starship.fish defines a fish_prompt wrapper that only activates
when starship is in PATH. when starship is in PATH and C3 overrides are enabled (see Opinionated
Components above).
It emits OSC 133;A (prompt start) immediately before Starship renders It emits OSC 133;A (prompt start) immediately before Starship renders
and OSC 133;B (input start) immediately after, placing both markers on and OSC 133;B (input start) immediately after, placing both markers on
the prompt line itself. the prompt line itself.
This allows ov to use them as sticky section headers when browsing This allows ov to use them as sticky section headers when browsing
scrollback logs. scrollback logs.
It also prints a blank line before the prompt, skipped in private mode
or on a freshly cleared screen.
Without Starship, fish\[cq]s built-in prompt handles these markers Without Starship, fish\[cq]s built-in prompt handles these markers
automatically. automatically.
.SS Catppuccin Fallback Prompt .SS Catppuccin Fallback Prompt
@@ -3910,11 +3913,13 @@ When Starship is absent or C3 overrides are disabled, a built-in
nim-style two-line prompt activates from functions/fish_prompt.fish. nim-style two-line prompt activates from functions/fish_prompt.fish.
No external dependencies \[em] fish builtins only. No external dependencies \[em] fish builtins only.
.PP .PP
Layout: Layout (a dim job line appears between the two rows for each running
background job):
.IP .IP
.nf .nf
\f[C] \f[C]
┬─[user\[at]host:\[ti]/path] (main) ┬─[user\[at]host:\[ti]/path] (main)
│ nvim notes.md
╰─>$ ╰─>$
\f[R] \f[R]
.fi .fi
@@ -3923,59 +3928,106 @@ Elements:
.IP .IP
.nf .nf
\f[C] \f[C]
Segment Meaning
────────────────────────────────────────────────────────────────
user Yellow (Catppuccin Yellow); red if root user Yellow (Catppuccin Yellow); red if root
\[at]host Blue (local) or Teal (SSH) \[at]host Blue (local) or Teal (SSH)
\[ti]/path prompt_pwd abbreviation (Catppuccin Text) \[ti]/path prompt_pwd abbreviation (Catppuccin Text)
(main) Current git branch in Catppuccin Pink; omitted outside repos ─[N/I/R/V/O] Vi-mode indicator (Normal/Insert/Replace/Visual/Operator);
shown only when vi or hybrid key bindings are active
─[V:name] Active Python venv basename; omitted when none ─[V:name] Active Python venv basename; omitted when none
─[N/I/R/V] Vi-mode indicator when vi bindings are active (main) Current git branch in Catppuccin Pink, with ↑/↓
┬─ / ╰─> Connector lines: Catppuccin Green on success, Red on failure upstream-tracking arrows when applicable;
omitted outside repos
┬─ / ╰─> Connector lines: Catppuccin Green on success,
Red on failure
\f[R] \f[R]
.fi .fi
.PP .PP
The right prompt (fish_right_prompt.fish) always renders, regardless of The right prompt (fish_right_prompt.fish) always renders, independently
C3 state. of which left prompt is active:
On failure it shows a red ✘ and the exit code; on success it shows only
the dim timestamp.
When starship is installed and C3 is enabled, the active Docker context
is also shown (if non-default):
.IP .IP
.nf .nf
\f[C] \f[C]
✘ 1 󰡨 myctx Fri Jun 12 00:51:21 2026 ← failed, starship+C3 active Segment Shown when
✘ 1 Fri Jun 12 00:51:21 2026 ← failed, fallback prompt ────────────────────────────────────────────────────────────────
Fri Jun 12 00:51:21 2026 ← success (no ✘) ✘ <code> The previous command exited non-zero (red)
󰡨 <context> docker and starship are both installed, C3
overrides are enabled, and the active Docker
context is set and non-default
<timestamp> Always (dim, Catppuccin Overlay0)
\f[R]
.fi
.PP
The exit-status and Docker segments are independent \[em] for example,
right after a failing command with a non-default Docker context active:
.IP
.nf
\f[C]
✘ 1 󰡨 myctx Fri Jun 12 00:51:21 2026
\f[R]
.fi
.PP
A successful command with the same Docker context shows the segment too:
.IP
.nf
\f[C]
󰡨 myctx Fri Jun 12 00:51:21 2026
\f[R]
.fi
.PP
And without Starship (or with C3 disabled, or Docker not installed),
only the exit-status prefix and timestamp ever appear:
.IP
.nf
\f[C]
✘ 1 Fri Jun 12 00:51:21 2026
\f[R] \f[R]
.fi .fi
.SS FZF .SS FZF
.PP .PP
FZF is themed to Catppuccin Mocha via FZF_DEFAULT_OPTS set in FZF is themed to Catppuccin Mocha via FZF_DEFAULT_OPTS, set in
integrations/fzf.fish. conf.d/theme.fish (opinionated; disabled by
\f[V]__fish_config_op_overrides\f[R], see Opinionated Components above).
The colors applied: The colors applied:
.IP .IP
.nf .nf
\f[C] \f[C]
Background: #1E1E2E (base) #313244 (surface0) Hex Role Catppuccin name
Foreground: #CDD6F4 (text) ────────────────────────────────────────────────────────
Highlights: #F38BA8 (red) #CBA6F7 (mauve) #B4BEFE (lavender) #1E1E2E Background Base
#313244 Highlighted background Surface0
#45475A Selected background Surface1
#CDD6F4 Foreground Text
#F38BA8 Highlight / header Red
#CBA6F7 Info / prompt Mauve
#B4BEFE Marker Lavender
#F5E0DC Spinner / pointer Rosewater
#6C7086 Border Overlay0
\f[R] \f[R]
.fi .fi
.PP .PP
To customize, override FZF_DEFAULT_OPTS in local.fish. To customize, override FZF_DEFAULT_OPTS in local.fish \[em] it is
sourced after conf.d/theme.fish on every session, so a
\f[V]set -Ux FZF_DEFAULT_OPTS ...\f[R] there always wins.
.SS Catppuccin Mocha Syntax Highlighting .SS Catppuccin Mocha Syntax Highlighting
.PP .PP
The Catppuccin Mocha theme ships with this config in themes/ and is The Catppuccin Mocha theme ships with this config in themes/ and is
applied on first run via \f[V]conf.d/first_run.fish\f[R]. applied automatically on first run via \f[V]conf.d/first_run.fish\f[R]
(gated by \f[V]__fish_config_op_autoexec\f[R]; see Opinionated
Components above).
Colors are stored in fish_variables (universal). Colors are stored in fish_variables (universal).
To switch variants, install a different theme from themes/: Three other bundled variants are available in themes/ \[em] Latte,
Frappé, and Macchiato.
To switch:
.IP .IP
.nf .nf
\f[C] \f[C]
fish_config theme save \[dq]Catppuccin Latte\[dq] fish_config theme choose \[dq]Catppuccin Latte\[dq]
\f[R] \f[R]
.fi .fi
.PP .PP
\f[V]---\f[R] * * * * *
.SH 8. COMPONENTS REFERENCE .SH 8. COMPONENTS REFERENCE
.PP .PP
The following tables detail every component in each category. The following tables detail every component in each category.
docs/fish-config.md
+66 -26
View File
@@ -3025,11 +3025,14 @@ The primary prompt is Starship, initialized by conf.d/starship.fish.
Configure it via ~/.config/starship.toml. Configure it via ~/.config/starship.toml.
conf.d/starship.fish defines a fish_prompt wrapper that only activates when conf.d/starship.fish defines a fish_prompt wrapper that only activates when
starship is in PATH. It emits OSC 133;A (prompt start) immediately before starship is in PATH and C3 overrides are enabled (see Opinionated
Starship renders and OSC 133;B (input start) immediately after, placing both Components above). It emits OSC 133;A (prompt start) immediately before
markers on the prompt line itself. This allows ov to use them as sticky Starship renders and OSC 133;B (input start) immediately after, placing
section headers when browsing scrollback logs. Without Starship, fish's both markers on the prompt line itself. This allows ov to use them as
built-in prompt handles these markers automatically. sticky section headers when browsing scrollback logs. It also prints a
blank line before the prompt, skipped in private mode or on a freshly
cleared screen. Without Starship, fish's built-in prompt handles these
markers automatically.
### Catppuccin Fallback Prompt ### Catppuccin Fallback Prompt
@@ -3037,50 +3040,87 @@ When Starship is absent or C3 overrides are disabled, a built-in nim-style
two-line prompt activates from functions/fish_prompt.fish. No external two-line prompt activates from functions/fish_prompt.fish. No external
dependencies — fish builtins only. dependencies — fish builtins only.
Layout: Layout (a dim job line appears between the two rows for each running
background job):
┬─[user@host:~/path] (main) ┬─[user@host:~/path] (main)
│ nvim notes.md
╰─>$ ╰─>$
Elements: Elements:
Segment Meaning
────────────────────────────────────────────────────────────────
user Yellow (Catppuccin Yellow); red if root user Yellow (Catppuccin Yellow); red if root
@host Blue (local) or Teal (SSH) @host Blue (local) or Teal (SSH)
~/path prompt_pwd abbreviation (Catppuccin Text) ~/path prompt_pwd abbreviation (Catppuccin Text)
(main) Current git branch in Catppuccin Pink; omitted outside repos ─[N/I/R/V/O] Vi-mode indicator (Normal/Insert/Replace/Visual/Operator);
shown only when vi or hybrid key bindings are active
─[V:name] Active Python venv basename; omitted when none ─[V:name] Active Python venv basename; omitted when none
─[N/I/R/V] Vi-mode indicator when vi bindings are active (main) Current git branch in Catppuccin Pink, with ↑/↓
┬─ / ╰─> Connector lines: Catppuccin Green on success, Red on failure upstream-tracking arrows when applicable;
omitted outside repos
┬─ / ╰─> Connector lines: Catppuccin Green on success,
Red on failure
The right prompt (fish_right_prompt.fish) always renders, regardless of C3 The right prompt (fish_right_prompt.fish) always renders, independently of
state. On failure it shows a red ✘ and the exit code; on success it shows which left prompt is active:
only the dim timestamp. When starship is installed and C3 is enabled, the
active Docker context is also shown (if non-default):
✘ 1 󰡨 myctx Fri Jun 12 00:51:21 2026 ← failed, starship+C3 active Segment Shown when
✘ 1 Fri Jun 12 00:51:21 2026 ← failed, fallback prompt ────────────────────────────────────────────────────────────────
Fri Jun 12 00:51:21 2026 ← success (no ✘) ✘ <code> The previous command exited non-zero (red)
󰡨 <context> docker and starship are both installed, C3
overrides are enabled, and the active Docker
context is set and non-default
<timestamp> Always (dim, Catppuccin Overlay0)
The exit-status and Docker segments are independent — for example, right
after a failing command with a non-default Docker context active:
✘ 1 󰡨 myctx Fri Jun 12 00:51:21 2026
A successful command with the same Docker context shows the segment too:
󰡨 myctx Fri Jun 12 00:51:21 2026
And without Starship (or with C3 disabled, or Docker not installed), only
the exit-status prefix and timestamp ever appear:
✘ 1 Fri Jun 12 00:51:21 2026
### FZF ### FZF
FZF is themed to Catppuccin Mocha via FZF_DEFAULT_OPTS set in FZF is themed to Catppuccin Mocha via FZF_DEFAULT_OPTS, set in
integrations/fzf.fish. The colors applied: conf.d/theme.fish (opinionated; disabled by `__fish_config_op_overrides`,
see Opinionated Components above). The colors applied:
Background: #1E1E2E (base) #313244 (surface0) Hex Role Catppuccin name
Foreground: #CDD6F4 (text) ────────────────────────────────────────────────────────
Highlights: #F38BA8 (red) #CBA6F7 (mauve) #B4BEFE (lavender) #1E1E2E Background Base
#313244 Highlighted background Surface0
#45475A Selected background Surface1
#CDD6F4 Foreground Text
#F38BA8 Highlight / header Red
#CBA6F7 Info / prompt Mauve
#B4BEFE Marker Lavender
#F5E0DC Spinner / pointer Rosewater
#6C7086 Border Overlay0
To customize, override FZF_DEFAULT_OPTS in local.fish. To customize, override FZF_DEFAULT_OPTS in local.fish — it is sourced after
conf.d/theme.fish on every session, so a `set -Ux FZF_DEFAULT_OPTS ...`
there always wins.
### Catppuccin Mocha Syntax Highlighting ### Catppuccin Mocha Syntax Highlighting
The Catppuccin Mocha theme ships with this config in themes/ and is applied The Catppuccin Mocha theme ships with this config in themes/ and is applied
on first run via `conf.d/first_run.fish`. Colors are stored in fish_variables automatically on first run via `conf.d/first_run.fish` (gated by
(universal). To switch variants, install a different theme from themes/: `__fish_config_op_autoexec`; see Opinionated Components above). Colors are
stored in fish_variables (universal). Three other bundled variants are
available in themes/ — Latte, Frappé, and Macchiato. To switch:
fish_config theme save "Catppuccin Latte" fish_config theme choose "Catppuccin Latte"
`---` ---
# 8. COMPONENTS REFERENCE # 8. COMPONENTS REFERENCE