docs: document man fish-config and fish_config naming distinction
Adds man page viewing instructions to README Offline Documentation section and to docs/fish-config.md section 9, including a note that fish-config (hyphen) is this config's man page while fish_config (underscore) is fish's built-in browser tool.
This commit is contained in:
@@ -321,6 +321,16 @@ The viewer falls back through: **ov** (syntax highlight + section navigation)
|
|||||||
|
|
||||||
Examples: `config_help keybindings` · `config_help pkg` · `config_help fish-deps` · `config_help abbreviations`
|
Examples: `config_help keybindings` · `config_help pkg` · `config_help fish-deps` · `config_help abbreviations`
|
||||||
|
|
||||||
|
You can also read the documentation as a standard man page:
|
||||||
|
|
||||||
|
```fish
|
||||||
|
man fish-config
|
||||||
|
```
|
||||||
|
|
||||||
|
This works once `~/.local/share/man` is on your `MANPATH` (added automatically by `conf.d/tricks.fish`) and `~/.local/share/man/man1/fish-config.1` is symlinked to `docs/fish-config.1`. The man page itself is auto-generated from `docs/fish-config.md` by the CI pipeline on every push to `main`.
|
||||||
|
|
||||||
|
> **Note:** `fish-config` (hyphen) is this configuration's man page. `fish_config` (underscore) is fish's built-in browser-based configuration tool — a completely separate command. Don't mix them up.
|
||||||
|
|
||||||
### Dependency Management
|
### Dependency Management
|
||||||
|
|
||||||
`fish-deps` is a unified command for checking, installing, and updating all tools this config depends on.
|
`fish-deps` is a unified command for checking, installing, and updating all tools this config depends on.
|
||||||
|
|||||||
@@ -1235,6 +1235,16 @@ navigation.
|
|||||||
|
|
||||||
man -l ~/.config/fish/docs/fish-config.1
|
man -l ~/.config/fish/docs/fish-config.1
|
||||||
|
|
||||||
|
If ~/.local/share/man is on your MANPATH (set automatically by
|
||||||
|
conf.d/tricks.fish) and ~/.local/share/man/man1/fish-config.1 is
|
||||||
|
symlinked to docs/fish-config.1, you can also use:
|
||||||
|
|
||||||
|
man fish-config
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
## Jumping to a section
|
## Jumping to a section
|
||||||
|
|
||||||
config_help keybindings
|
config_help keybindings
|
||||||
|
|||||||
Reference in New Issue
Block a user