rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(help): prefer help config syntax; add NOTES to config-help doc block
Generate documentation / build-docs (push) Successful in 35s
Details
Offline docs drift reminder / remind (push) Successful in 10s
Details

Browse Source 
- help.fish: expand SYNOPSIS/DESCRIPTION to document -w/--html, -m/--man,
  -h/--help flags; note flags are only intercepted when 'config' is argv[1]
- config-help.fish: add # NOTES section explaining help config as the
  preferred invocation; update --help banner to show both names; update
  --help USAGE/EXAMPLES output to use `help config` syntax throughout
- docs/fish-config.md: update §5.14 synopsis/examples and "Viewing" sections
  to use `help config` as primary form; inline note for direct config-help use
- README.md: update docs table to show `help config --html` / `--man`
This commit is contained in:
Rootiest
2026-06-08 23:04:39 -04:00
parent e86b537f6d
commit 79f8445e25
4 changed files with 62 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -45,8 +45,8 @@ To browse the docs from the terminal:
|---|---|
| `help config` | Open the terminal manual in the best available pager |
| `help config <keyword>` | Jump directly to a section matching the keyword |
| `config-help --html` | Open the pre-built HTML docs in the default browser |
| `config-help --man` | Open the compiled man page via `man -l` |
| `help config --html` | Open the pre-built HTML docs in the default browser |
| `help config --man` | Open the compiled man page via `man -l` |
The pager falls back through: **ov** → **bat** → **man -l** → **less** → **cat**.