config-help

Synopsis

Usage

config-help [section]
config-help --html
config-help [section] --man
config-help --help

Description

Opens the offline fish shell configuration manual in the best available pager. Falls back through ov -> bat -> man -> less -> cat. If a section keyword is provided, the pager opens at the first heading that matches the keyword. Lookup order: docs/fish-config.index (exact keyword aliases), then a normalized heading scan as fallback. When opened with ov a sticky navigation hint is shown at the top of the screen. Section matching is case-insensitive. Pass --html / -w to open the published documentation website (https://fish.rootiest.fyi/) in the default browser via xdg-open — deep links to a section aren’t supported there, so if a keyword is given a note points you to the site’s search box instead. Pass --man / -m to open the compiled man page (docs/fish-config.1) via man -l; if a section keyword is given, the pager opens at the nearest match. Pass --help or -h for usage and the navigation key reference.

Arguments

section	Optional keyword to jump to a matching section heading
-w, --html	Open the published documentation website in the default browser
-m, --man	Open the compiled man page via man -l
-h, --help	Print usage and navigation reference, then exit

Exit Status

0	Manual displayed
1	Documentation file not found, or required tool not available

Returns

With -h/--help, the usage and navigation reference, printed to stdout. Otherwise, the manual is shown via the resolved pager (not captured stdout).

Notes

The preferred invocation is help config […] — this function is registered as a handler in the help wrapper so that syntax works transparently. Direct config-help calls are also valid.

Example

config-help
config-help keybindings
config-help pkg
config-help fish-deps
config-help --html
config-help --man
config-help keys --man
config-help --help
config-help pkg --man

Dependencies: xdg-open, man, ov, bat

Classification: self-limiting(grep), bypasses-shadow(less)