Files
fish-shell/share/functions/man.fish
Johannes Altmanninger a1baf97f54 Do not embed man pages in CMake builds
Commit 0709e4be8b (Use standalone code paths by default, 2025-10-26)
mainly wanted to embed internal functions to unbreak upgrade scenarios.

Embedding man pages in CMake has small-ish disadvantages:
1. extra space usage
2. less discoverability
3. a "cyclic" dependency:
   1. "sphinx-docs" depends on "fish_indent"
   2. "fish_indent" via "crates/build-man-pages" depends on "doc_src/".
   So every "touch doc_src/foo.rst && ninja -Cbuild sphinx-docs"
   re-builds fish, just to re-run sphinx-build.

The significant one is number 3.  It can be worked around by running
sphinx-build with stale "fish_indent" but I don't think we want to
do that.

Let's backtrack a little by stopping embedding man pages in CMake
builds; use the on-disk man pages (which we still install).

The remaining "regression" from 0709e4be8b is that "ninja -Cbuild
fish" needs to rebuild whenever anything in "share/" changes.  I don't
know if that's also annoying?

Since man pages for "build/fish" are not in share/, expose the exact
path as $__fish_man_dir.
2025-11-23 12:30:22 +01:00

55 lines
2.0 KiB
Fish

# localization: skip(uses-apropos)
if not command -qs man
# see #5329 and discussion at https://github.com/fish-shell/fish-shell/commit/13e025bdb01cc4dd08463ec497a0a3495873702f
exit
end
function man
set -l manpath
if __fish_tried_to_embed_manpages
# If we have an embedded page, reuse a function that happens to do
# the right thing.
if not set -q argv[2] &&
status list-files "man/man1/$(__fish_canonicalize_builtin $argv).1" &>/dev/null
__fish_print_help $argv[1]
return
end
else if set -l fish_manpath (path filter -d $__fish_man_dir)
# Prepend fish's man directory if available.
# Work around the "builtin" manpage that everything symlinks to,
# by prepending our fish datadir to man. This also ensures that man gives fish's
# man pages priority, without having to put fish's bin directories first in $PATH.
# Preserve the existing MANPATH, and default to the system path (the empty string).
set manpath $fish_manpath (
if set -q MANPATH
string join -- \n $MANPATH
else if set -l p (command man -p 2>/dev/null)
# NetBSD's man uses "-p" to print the path.
# FreeBSD's man also has a "-p" option, but that requires an argument.
# Other mans (men?) don't seem to have it.
#
# Unfortunately NetBSD prints things like "/usr/share/man/man1",
# while not allowing them as $MANPATH components.
# What it needs is just "/usr/share/man".
#
# So we strip the last component.
# This leaves a few wrong directories, but that should be harmless.
string replace -r '[^/]+$' '' $p
else
echo ''
end
)
if test (count $argv) -eq 1
set argv (__fish_canonicalize_builtin $argv)
end
end
set -q manpath[1]
and set -lx MANPATH $manpath
command man $argv
end