rootiest
24cdfe4129
Add a new Troubleshooting section to the manual with 9 concise how-to subsections covering uninstall/revert, Fish version requirements, disabling logging, changing the greeting, secrets/local config, the return sentinel gotcha, missing dependencies, Vi mode keybindings, and minimal mode. Renumber Viewing This Manual from Section 11 to Section 12 to place troubleshooting before it. Update TOC and help index accordingly. All verify-manual.py checks pass.
324 lines
11 KiB
Plaintext
324 lines
11 KiB
Plaintext
# Fish Config Help Index
|
|
# Format: keyword=exact heading text as it appears in fish-config.md
|
|
# Multiple keywords may map to the same heading.
|
|
# Update this file whenever headings are added, removed, or renamed.
|
|
# config-help uses this for fast exact lookups; unknown keywords fall back
|
|
# to a normalized heading scan automatically.
|
|
|
|
# ── Top-level ─────────────────────────────────────────────────
|
|
name=# NAME
|
|
synopsis=# SYNOPSIS
|
|
description=# DESCRIPTION
|
|
toc=# TABLE OF CONTENTS
|
|
contents=# TABLE OF CONTENTS
|
|
autopair=# DESCRIPTION
|
|
puffer=# DESCRIPTION
|
|
puffer-fish=# DESCRIPTION
|
|
logging-events=# DESCRIPTION
|
|
|
|
# ── Section 1: Configuration Variables ───────────────────────
|
|
variables=# 1. CONFIGURATION VARIABLES
|
|
config=# 1. CONFIGURATION VARIABLES
|
|
xdg=## Environment Directories (XDG)
|
|
toolhomes=## Tool Homes (XDG-compliant)
|
|
editor=## Editor and Pager
|
|
pager=## Editor and Pager
|
|
scrollback=## Scrollback History
|
|
__fish_scrollback_history_dir=## Scrollback History
|
|
__fish_scrollback_history_max_files=## Scrollback History
|
|
scrollback-dir=## Scrollback History
|
|
|
|
# ── Section 2: PATH ───────────────────────────────────────────
|
|
path=# 2. PATH SETUP
|
|
|
|
# ── Section 3: Key Bindings ───────────────────────────────────
|
|
keybindings=# 3. KEY BINDINGS
|
|
bindings=# 3. KEY BINDINGS
|
|
key-bindings=# 3. KEY BINDINGS
|
|
keys=# 3. KEY BINDINGS
|
|
fzf-bindings=## FZF Bindings (bundled from PatrickF1/fzf.fish)
|
|
fzf=## FZF Bindings (bundled from PatrickF1/fzf.fish)
|
|
|
|
# ── Section 4: Abbreviations ──────────────────────────────────
|
|
abbreviations=# 4. ABBREVIATIONS
|
|
abbr=# 4. ABBREVIATIONS
|
|
abbrs=# 4. ABBREVIATIONS
|
|
editors-abbr=## 4.1 Editors
|
|
nav=## 4.2 Navigation and Listing
|
|
navigation=## 4.2 Navigation and Listing
|
|
listing=## 4.2 Navigation and Listing
|
|
git-abbr=## 4.3 Git
|
|
terminal=## 4.4 Terminal Windows, Tabs, and Panes
|
|
panes=## 4.4 Terminal Windows, Tabs, and Panes
|
|
windows=## 4.4 Terminal Windows, Tabs, and Panes
|
|
tabs=## 4.4 Terminal Windows, Tabs, and Panes
|
|
chezmoi=## 4.5 Chezmoi
|
|
docker=## 4.6 Docker
|
|
systemctl=## 4.7 Systemctl
|
|
systemd=## 4.7 Systemctl
|
|
ai-abbr=## 4.8 AI Assistants
|
|
history=## 4.9 History Expansion
|
|
misc-abbr=## 4.10 Miscellaneous
|
|
|
|
# ── Section 5: Functions ──────────────────────────────────────
|
|
functions=# 5. FUNCTIONS REFERENCE
|
|
files=## 5.1 File and Directory
|
|
cat=### cat
|
|
copy=### copy
|
|
du=### du
|
|
dusize=### dusize
|
|
ls=### ls
|
|
lsr=### lsr
|
|
lss=### lss
|
|
lstree=### lstree
|
|
lt=### lt
|
|
ltr=### ltr
|
|
lx=### lx
|
|
mkdir=### mkdir
|
|
mkcd=### mkcd
|
|
poke=### poke
|
|
rm=### rm
|
|
rg=### rg
|
|
scrub=### scrub
|
|
nav-fns=## 5.2 Navigation
|
|
cdi=### cdi
|
|
clone=### clone
|
|
clonet=### clonet
|
|
editors=## 5.3 Editors and Viewers
|
|
edit=### edit
|
|
fc=### fc
|
|
less=### less
|
|
rawfish=### rawfish
|
|
view=### view
|
|
git=## 5.4 Git and Version Control
|
|
auto-pull=### auto-pull
|
|
branch=### branch
|
|
gi=### gi
|
|
gitignore=### gi
|
|
git-clean=### git-clean
|
|
gitup=### gitup
|
|
gitui=### gitui
|
|
hist=### hist
|
|
pkg=### pkg
|
|
package=### pkg
|
|
package-manager=## 5.5 Package Management
|
|
packages=## 5.5 Package Management
|
|
search=### search
|
|
upgrade=### upgrade
|
|
cleanup=### cleanup
|
|
parur=### parur
|
|
deps=## 5.6 Dependency Management
|
|
fish-deps=### fish-deps
|
|
check-deps=### check_fish_deps
|
|
system=## 5.7 System and Monitoring
|
|
top=### top
|
|
swapstat=### swapstat
|
|
sbver=### sbver
|
|
ports=### ports
|
|
screensleep=### screensleep
|
|
lock=### lock
|
|
sudo-toggle=### sudo-toggle
|
|
limine=### limine-edit
|
|
terminal-mgmt=## 5.8 Terminal Management
|
|
tab=### tab
|
|
split=### split
|
|
spwin=### spwin
|
|
detach=### detach
|
|
bkg=### bkg
|
|
ssh=### ssh
|
|
clipboard=## 5.9 Clipboard
|
|
copy-fn=### y
|
|
paste=### paste
|
|
network=## 5.10 Network
|
|
gip=### gip
|
|
ping=### ping
|
|
qr=### qr
|
|
logging=## 5.11 Pager and Logging
|
|
logs=### logs
|
|
smart-exit=### smart_exit
|
|
ai=## 5.12 AI and Developer Tools
|
|
antigravity-ide=### antigravity-ide
|
|
agy=### agy
|
|
agents-init=### agents-init
|
|
agents=### agents-init
|
|
agents-tools=### agents-init
|
|
version-bump=### agents-init
|
|
.version=### agents-init
|
|
structure-version=### agents-init
|
|
core.hooksPath=### agents-init
|
|
devlogs=### agents-init
|
|
claude-cli=### claude
|
|
claude-docs=### claude-docs
|
|
claude-pr=### claude-pr
|
|
qc=### qc
|
|
quick-chat=### qc
|
|
aichat=### qc
|
|
superpowers=### superpowers
|
|
media=## 5.13 Media and Utilities
|
|
dng2avif=### dng2avif
|
|
spark=### spark
|
|
yt-dlp=### yt-dlp
|
|
miscfns=## 5.14 Miscellaneous
|
|
config-help=### config-help
|
|
open-url=### open-url
|
|
url-open=### open-url
|
|
repo-open=### repo-open
|
|
open-repo=### repo-open
|
|
config-update=### config-update
|
|
config-settings=### config-settings
|
|
config-toggle=### config-settings
|
|
toggle=### config-settings
|
|
bash=### bash
|
|
cheat=### cheat
|
|
dockup=### dockup
|
|
joplin=### joplin
|
|
replay=### replay
|
|
tmux=### tmux-clean
|
|
wake-lock=### wake-lock
|
|
|
|
# ── Tool-name synonyms (replacement → shadowed command) ──────
|
|
# These tools don't appear in any heading, so the fallback scan can't
|
|
# find them; map each to the function that wraps it.
|
|
eza=### ls
|
|
exa=### ls
|
|
lsd=### ls
|
|
trash=### rm
|
|
btop=### top
|
|
prettyping=### ping
|
|
duf=### du
|
|
dust=### du
|
|
kitten=### ssh
|
|
bat=### cat
|
|
|
|
# ── Tool integrations (Section: Integrations) ────────────────
|
|
zoxide=### Zoxide
|
|
z=### Zoxide
|
|
direnv=### DirEnv
|
|
venv=### Auto Python Venv
|
|
virtualenv=### Auto Python Venv
|
|
python=### Auto Python Venv
|
|
wakatime=### WakaTime
|
|
tailscale=### Tailscale
|
|
done=### Done Notifications
|
|
notifications=### Done Notifications
|
|
notify=### Done Notifications
|
|
pager-hierarchy=## Pager Hierarchy
|
|
shell-aliases=## 4.11 Shell Aliases
|
|
kitty-logging=### kitty-logging
|
|
watcher=### kitty-logging
|
|
|
|
# ── Section 6: Dependency Catalog ────────────────────────────
|
|
catalog=# 6. DEPENDENCY CATALOG
|
|
deps-catalog=# 6. DEPENDENCY CATALOG
|
|
required=## Required
|
|
integrations=## Integrations
|
|
recommended=## Recommended
|
|
install-methods=## Install Methods
|
|
|
|
# ── Section 7: Customization ──────────────────────────────────
|
|
customization=# 7. CUSTOMIZATION
|
|
customize=# 7. CUSTOMIZATION
|
|
local=## Machine-local Configuration
|
|
user-dots=## Machine-local Configuration
|
|
dots-link=## Machine-local Configuration
|
|
secrets=## Secrets and API Keys
|
|
overrides=## Overriding Configuration Variables
|
|
universal=## Fish Universal Variables
|
|
opinionated=## Opinionated Components (Minimal Mode)
|
|
minimal=## Opinionated Components (Minimal Mode)
|
|
minimal-mode=## Opinionated Components (Minimal Mode)
|
|
opt-out=## Opinionated Components (Minimal Mode)
|
|
toggles=## Opinionated Components (Minimal Mode)
|
|
component-reference=### Component Reference
|
|
components=### Component Reference
|
|
c1=#### C1 — Command Shadows
|
|
command-shadows=#### C1 — Command Shadows
|
|
aliases-detail=#### C1 — Command Shadows
|
|
c2=#### C2 — Startup Side-Effects
|
|
autoexec=#### C2 — Startup Side-Effects
|
|
startup=#### C2 — Startup Side-Effects
|
|
c3=#### C3 — Key and Environment Overrides
|
|
overrides-detail=#### C3 — Key and Environment Overrides
|
|
bang-bang=#### C3 — Key and Environment Overrides
|
|
c4=#### C4 — Terminal and Tool Integration
|
|
integrations-detail=#### C4 — Terminal and Tool Integration
|
|
c5=#### C5 — Logging and Capture
|
|
logging-detail=#### C5 — Logging and Capture
|
|
logging-sentinel=#### C5 — Logging and Capture
|
|
zellij=#### C5 — Logging and Capture
|
|
zellij-logging=#### C5 — Logging and Capture
|
|
tmux-logging=#### C5 — Logging and Capture
|
|
pipe-pane=#### C5 — Logging and Capture
|
|
dump-screen=#### C5 — Logging and Capture
|
|
c6=#### C6 — Greeting and First-Run UI
|
|
greeting=#### C6 — Greeting and First-Run UI
|
|
|
|
# ── Prompt and Theme ──────────────────────────────────────────
|
|
prompt-theme=## Prompt and Theme
|
|
starship=### Starship
|
|
fallback-prompt=### Catppuccin Fallback Prompt
|
|
catppuccin-prompt=### Catppuccin Fallback Prompt
|
|
nim-prompt=### Catppuccin Fallback Prompt
|
|
fzf-theme=### FZF
|
|
catppuccin-theme=### Catppuccin Mocha Syntax Highlighting
|
|
|
|
# ── Section 8: Fisher Plugins ─────────────────────────────────
|
|
plugins=# 8. FISHER PLUGINS
|
|
fisher=# 8. FISHER PLUGINS
|
|
fisher-managed=## Fisher-Managed Plugins
|
|
sponge=## Fisher-Managed Plugins
|
|
sponge-filtering=## Sponge History Filtering
|
|
history-filtering=## Sponge History Filtering
|
|
privacy=## Sponge History Filtering
|
|
__fish_sponge_extra_sensitive=## Sponge History Filtering
|
|
extra-sensitive=## Sponge History Filtering
|
|
sponge-settings=### config-settings
|
|
bundled-plugins=## Bundled Plugin Functionality
|
|
fish-plugins-manifest=## fish_plugins Manifest
|
|
|
|
# ── Section 9: Installation ────────────────────────────────────
|
|
installation=# 9. INSTALLATION
|
|
install=# 9. INSTALLATION
|
|
sentinel=## Return Sentinel
|
|
updating=## Updating
|
|
|
|
# ── Section 10: Personalization ───────────────────────────────
|
|
personalization=# 10. PERSONALIZATION
|
|
personalize=# 10. PERSONALIZATION
|
|
secrets-file=## secrets.fish
|
|
local-config=## local.fish
|
|
|
|
# ── Section 11: Troubleshooting ──────────────────────────────
|
|
troubleshooting=# 11. TROUBLESHOOTING
|
|
troubleshoot=# 11. TROUBLESHOOTING
|
|
faq=# 11. TROUBLESHOOTING
|
|
uninstall=## Uninstalling / Reverting to Backup
|
|
revert=## Uninstalling / Reverting to Backup
|
|
fish-version=## Fish Version Requirement
|
|
version-req=## Fish Version Requirement
|
|
disable-logging=## Disable Session Logging
|
|
disable-greeting=## Change or Disable the Greeting
|
|
change-greeting=## Change or Disable the Greeting
|
|
secrets-trouble=## Secrets and Machine-Local Configuration
|
|
local-trouble=## Secrets and Machine-Local Configuration
|
|
return-sentinel=## Tool Init Does Nothing (Return Sentinel)
|
|
tool-init=## Tool Init Does Nothing (Return Sentinel)
|
|
missing-deps=## Missing Dependencies
|
|
vi-mode=## Vi Mode Keybindings
|
|
vi-trouble=## Vi Mode Keybindings
|
|
emacs-mode=## Vi Mode Keybindings
|
|
minimal-trouble=## Minimal Mode / Disabling Opinionated Features
|
|
|
|
# ── Section 12: Viewing This Manual ──────────────────────────
|
|
viewing=# 12. VIEWING THIS MANUAL
|
|
manual=# 12. VIEWING THIS MANUAL
|
|
ov=## In the terminal
|
|
man-page=## As a man page
|
|
manpage=## As a man page
|
|
jump=## In the terminal
|
|
html=## The documentation website
|
|
browser=## The documentation website
|
|
site=## The documentation website
|
|
|
|
|