From 7359c12e79a8e8011b65a1f7b1dd29689826ee45 Mon Sep 17 00:00:00 2001 From: rootiest Date: Sat, 6 Jun 2026 04:35:21 -0400 Subject: [PATCH] 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. --- README.md | 10 ++++++++++ docs/fish-config.md | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index 0af9afe..5f6b6de 100644 --- a/README.md +++ b/README.md @@ -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` +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 `fish-deps` is a unified command for checking, installing, and updating all tools this config depends on. diff --git a/docs/fish-config.md b/docs/fish-config.md index 1c7dd42..f3f7b58 100644 --- a/docs/fish-config.md +++ b/docs/fish-config.md @@ -1235,6 +1235,16 @@ navigation. 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 config_help keybindings