rootiest
4912c4052f
Adds a GitHub social icon to the docs site header alongside the existing Gitea one, and documents in the README's Contributing section that git.rootiest.dev is the base repo while the GitHub copy is a one-way mirror, so forks/issues/PRs should go through Gitea. Adds Testing, Contributing, Attribution, and License sections to the manual/man page/site, sourced directly from README.md via a new `<!-- README: Heading -->` placeholder mechanism in build-manual.py, so the README stays the single source of truth for those sections instead of a hand-maintained copy drifting out of sync. Also converts docs/manual/00-table-of-contents.md from a hand-typed list to a generated one (mt.walk()-driven), fixing a numbering drift where Components Reference was omitted and every section after it was off by one relative to its own manTitle.
426 lines
14 KiB
Plaintext
426 lines
14 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
|
|
misc-vars=## Other
|
|
|
|
# ── Section 2: PATH ───────────────────────────────────────────
|
|
path=# 2. PATH SETUP
|
|
|
|
# ── Section 3: Key Bindings ───────────────────────────────────
|
|
keybindings=# 3. KEY BINDINGS
|
|
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
|
|
dirs=### lD
|
|
lsdirs=### lD
|
|
ls=### ls
|
|
lsr=### lsr
|
|
lss=### lss
|
|
lstree=### lstree
|
|
lt=### lt
|
|
ltr=### ltr
|
|
lx=### lx
|
|
mkdir=### mkdir
|
|
mkcd=### mkcd
|
|
mv=### mv
|
|
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
|
|
fzf-update=### fzf-update
|
|
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
|
|
fish-mode-prompt=### fish_mode_prompt
|
|
fish-prompt=### fish_prompt
|
|
fish-right-prompt=### fish_right_prompt
|
|
right-prompt=### fish_right_prompt
|
|
jobrunner=### jobrunner
|
|
jr=### jr
|
|
ssh=### ssh
|
|
clipboard=## 5.9 Clipboard
|
|
copy-fn=### y
|
|
p=### p
|
|
paste=### paste
|
|
network=## 5.10 Network
|
|
fast=### fast
|
|
fast-cli=### fast-cli
|
|
speedtest=### fast-cli
|
|
gip=### gip
|
|
gip4=### gip4
|
|
ipv4=### gip4
|
|
gip6=### gip6
|
|
ipv6=### gip6
|
|
ping=### ping
|
|
qr=### qr
|
|
logging=## 5.11 Pager and Logging
|
|
logs=### logs
|
|
smart-exit=### smart_exit
|
|
sponge-filter-secrets=### sponge_filter_secrets
|
|
secret-filter=### sponge_filter_secrets
|
|
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
|
|
dops=### dops
|
|
docker-ps=### dops
|
|
qc=### qc
|
|
quick-chat=### qc
|
|
aichat=### qc
|
|
superpowers=### superpowers
|
|
media=## 5.13 Media and Utilities
|
|
dng2avif=### dng2avif
|
|
play-media=### play-media
|
|
video=### play-media
|
|
audio=### play-media
|
|
mpv=### play-media
|
|
vlc=### play-media
|
|
spark=### spark
|
|
steam-dl=### steam-dl
|
|
steam=### steam-dl
|
|
yt-dlp=### yt-dlp
|
|
miscfns=## 5.14 Miscellaneous
|
|
bash=### bash
|
|
bd-pull=### bd-pull
|
|
beads=### bd-pull
|
|
cffetch=### cffetch
|
|
fastfetch=### ffetch
|
|
neofetch=### cffetch
|
|
sysinfo=### cffetch
|
|
cheat=### cheat
|
|
config-help=### config-help
|
|
config-update=### config-update
|
|
config-settings=### config-settings
|
|
config-toggle=### config-toggle
|
|
toggle=### config-settings
|
|
dockup=### dockup
|
|
fetch=### cffetch
|
|
ffetch=### ffetch
|
|
fzf_configure_bindings=### fzf_configure_bindings
|
|
joplin=### joplin
|
|
ld=### ld
|
|
lazydocker=### ld
|
|
open-url=### open-url
|
|
url-open=### open-url
|
|
repo-open=### repo-open
|
|
open-repo=### repo-open
|
|
rand_string=### rand_string
|
|
random=### rand_string
|
|
password=### rand_string
|
|
randomword=### rand_string
|
|
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
|
|
kitty-scrollback=### Scrollback History
|
|
|
|
# ── Section 6: Dependency Catalog ────────────────────────────
|
|
catalog=# 6. DEPENDENCY CATALOG
|
|
deps-catalog=# 6. DEPENDENCY CATALOG
|
|
required=## Required
|
|
integrations=## Integrations
|
|
recommended=## Recommended
|
|
optional-deps=## Optional
|
|
terminal-emulators=## Terminal Emulators
|
|
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)
|
|
agent-vault=## Agent Memory Vault
|
|
__fish_agent_vault_dir=## Agent Memory Vault
|
|
__fish_agent_vault_autopush=## Agent Memory Vault
|
|
component-reference=# 8. COMPONENTS REFERENCE
|
|
components=# 8. COMPONENTS REFERENCE
|
|
c0=## Per-function overrides: `C0`/`always`
|
|
always-tag=## Per-function overrides: `C0`/`always`
|
|
c1=## C1 — Command Shadows
|
|
command-shadows=## C1 — Command Shadows
|
|
aliases-detail=## C1 — Command Shadows
|
|
filesystem=### filesystem
|
|
network-shadow=### network
|
|
monitor=### monitor
|
|
shell-tools=### shell-tools
|
|
dev-tools=### dev-tools
|
|
c2=## C2 — Startup Side-Effects
|
|
autoexec=## C2 — Startup Side-Effects
|
|
startup=## C2 — Startup Side-Effects
|
|
plugin-management=### plugin-management
|
|
pkg-wrappers=### pkg-wrappers
|
|
venv-toggle=### venv
|
|
telemetry=### telemetry
|
|
sync=### sync
|
|
c3=## C3 — Key and Environment Overrides
|
|
overrides-detail=## C3 — Key and Environment Overrides
|
|
bang-bang=## C3 — Key and Environment Overrides
|
|
bindings-toggle=### key-bindings
|
|
environment=### environment
|
|
prompt-toggle=### prompt
|
|
privacy=### privacy
|
|
privacy-toggle=### privacy
|
|
do-not-track=### privacy
|
|
disable-telemetry=### privacy
|
|
c4=## C4 — Terminal and Tool Integration
|
|
integrations-detail=## C4 — Terminal and Tool Integration
|
|
terminal-abbrs=### terminal-abbrs
|
|
window-mgmt=### window-mgmt
|
|
window-management=### window-mgmt
|
|
notifications-toggle=### notifications
|
|
history-logs=### history-logs
|
|
pkg-upgrade=### pkg-upgrade
|
|
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
|
|
terminal-capture=### terminal-capture
|
|
multiplexer-capture=### multiplexer-capture
|
|
pkg-logs=### pkg-logs
|
|
c6=## C6 — Greeting and First-Run UI
|
|
greeting=## C6 — Greeting and First-Run UI
|
|
first-run=### first-run
|
|
greeting-message=### greeting-message
|
|
|
|
# ── Prompt and Theme ──────────────────────────────────────────
|
|
prompt-theme=## Prompt and Theme
|
|
prompt=## 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 9: Fisher Plugins ─────────────────────────────────
|
|
plugins=# 9. FISHER PLUGINS
|
|
fisher=# 9. 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 10: Installation ────────────────────────────────────
|
|
installation=# 10. INSTALLATION
|
|
install=# 10. INSTALLATION
|
|
sentinel=## Return Sentinel
|
|
updating=## Updating
|
|
|
|
# ── Section 11: Personalization ───────────────────────────────
|
|
personalization=# 11. PERSONALIZATION
|
|
personalize=# 11. PERSONALIZATION
|
|
secrets-file=## secrets.fish
|
|
local-config=## local.fish
|
|
|
|
# ── Section 12: Troubleshooting ──────────────────────────────
|
|
troubleshooting=# 12. TROUBLESHOOTING
|
|
troubleshoot=# 12. TROUBLESHOOTING
|
|
faq=# 12. TROUBLESHOOTING
|
|
uninstall=## Uninstalling and Reverting to Backup
|
|
revert=## Uninstalling and Reverting to Backup
|
|
fish-version=## Fish Version Requirement
|
|
version-req=## Fish Version Requirement
|
|
disable-logging=## Enable or Disable Session Logging
|
|
enable-logging=## Enable or 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=## What's with the C1-C6 stuff?
|
|
|
|
# ── Section 13: Viewing This Manual ──────────────────────────
|
|
viewing=# 13. VIEWING THIS MANUAL
|
|
manual=# 13. VIEWING THIS MANUAL
|
|
ov=## In the terminal
|
|
manpage=## As a man page
|
|
jump=## In the terminal
|
|
html=## The documentation website
|
|
browser=## The documentation website
|
|
site=## The documentation website
|
|
source=## Reading the source directly
|
|
raw-source=## Reading the source directly
|
|
|
|
# ── Section 14: Testing ───────────────────────────────────────
|
|
testing=# 14. TESTING
|
|
tests=# 14. TESTING
|
|
|
|
# ── Section 15: Contributing ──────────────────────────────────
|
|
contributing=# 15. CONTRIBUTING
|
|
contribute=# 15. CONTRIBUTING
|
|
forge=# 15. CONTRIBUTING
|
|
|
|
# ── Section 16: Attribution ───────────────────────────────────
|
|
attribution=# 16. ATTRIBUTION
|
|
credits=# 16. ATTRIBUTION
|
|
|
|
# ── Section 17: License ───────────────────────────────────────
|
|
license=# 17. LICENSE
|
|
licensing=# 17. LICENSE
|
|
agpl=# 17. LICENSE
|
|
copyright=# 17. LICENSE
|
|
|
|
|