mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2026-01-23 02:35:38 +01:00
89e0439e21
Adds zsh-vi-man plugin that provides smart man page lookup for zsh vi mode and emacs mode. Press K in vi normal mode, Ctrl-X k in emacs mode, or Ctrl-K in vi insert mode on any command or option to open its man page. Features: - Smart subcommand detection (git commit → man git-commit) - Option jumping (grep -r → jumps to -r entry in man page) - Combined options support (rm -rf → finds both -r and -f) - Pipe support (cat file | grep -i → opens man grep) - Multiple pager support (less, vim, nvim)
128 lines
3.8 KiB
Bash
128 lines
3.8 KiB
Bash
# lib/pager.zsh - Pager-specific man page opening logic
|
|
# Handles different pagers: less, nvim, vim, etc.
|
|
|
|
# Detect the pager type from ZVM_MAN_PAGER
|
|
# Output: "nvim", "vim", "less", or "other"
|
|
zvm_detect_pager_type() {
|
|
local pager_basename="${ZVM_MAN_PAGER##*/}"
|
|
|
|
if [[ "$pager_basename" =~ ^nvim ]]; then
|
|
echo "nvim"
|
|
elif [[ "$pager_basename" =~ ^vim$ ]]; then
|
|
echo "vim"
|
|
elif [[ "$pager_basename" =~ ^less$ ]]; then
|
|
echo "less"
|
|
else
|
|
echo "other"
|
|
fi
|
|
}
|
|
|
|
# Open man page with neovim
|
|
# Uses neovim's built-in Man command with search
|
|
# Input: $1 = man_page, $2 = search_pattern (vim regex, optional)
|
|
# Returns: 0 on success, 1 on failure
|
|
zvm_open_nvim() {
|
|
local man_page="$1"
|
|
local search_term="$2"
|
|
|
|
# Run nvim exactly as user would: nvim +"Man <cmd>" +only +/<search>
|
|
# No stdin/stdout/stderr redirects - let nvim have full terminal access
|
|
# This prevents issues with plugins like image.nvim that need terminal size
|
|
# Set MANWIDTH to a large number to prevent line wrapping in man pages
|
|
if [[ -n "$search_term" ]]; then
|
|
MANWIDTH=999 ${ZVM_MAN_PAGER} +"Man ${man_page}" +only +"/${search_term}" || \
|
|
MANWIDTH=999 ${ZVM_MAN_PAGER} +"Man ${man_page}" +only || \
|
|
return 1
|
|
else
|
|
MANWIDTH=999 ${ZVM_MAN_PAGER} +"Man ${man_page}" +only || \
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
# Open man page with vim
|
|
# Vim doesn't have :Man built-in like nvim, so we need to load man.vim first
|
|
# Input: $1 = man_page, $2 = search_pattern (vim regex, optional)
|
|
# Returns: 0 on success, 1 on failure
|
|
zvm_open_vim() {
|
|
local man_page="$1"
|
|
local search_term="$2"
|
|
|
|
# Vim requires loading the man.vim ftplugin first before :Man works
|
|
# Set MANWIDTH to prevent line wrapping
|
|
# Use </dev/tty to ensure vim gets proper terminal access from zle widget
|
|
if [[ -n "$search_term" ]]; then
|
|
MANWIDTH=999 ${ZVM_MAN_PAGER} \
|
|
+"runtime ftplugin/man.vim" \
|
|
+"Man ${man_page}" \
|
|
+only \
|
|
+"/${search_term}" </dev/tty || \
|
|
MANWIDTH=999 ${ZVM_MAN_PAGER} \
|
|
+"runtime ftplugin/man.vim" \
|
|
+"Man ${man_page}" \
|
|
+only </dev/tty || \
|
|
return 1
|
|
else
|
|
MANWIDTH=999 ${ZVM_MAN_PAGER} \
|
|
+"runtime ftplugin/man.vim" \
|
|
+"Man ${man_page}" \
|
|
+only </dev/tty || \
|
|
return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
# Open man page with less or other traditional pagers
|
|
# Uses the -p flag for pattern search
|
|
# Input: $1 = man_page, $2 = search_pattern (ERE, optional)
|
|
# Returns: 0 on success, 1 on failure
|
|
zvm_open_less() {
|
|
local man_page="$1"
|
|
local pattern="$2"
|
|
|
|
# Always pipe through ZVM_MAN_PAGER to override system MANPAGER
|
|
# This prevents issues when MANPAGER is set to nvim/vim but ZVM_MAN_PAGER is less
|
|
# Use -R to pass through raw escape sequences (needed for LESS_TERMCAP_* colors)
|
|
if [[ -n "$pattern" ]]; then
|
|
MANPAGER=cat man "$man_page" 2>/dev/null | ${ZVM_MAN_PAGER} -R -p "${pattern}" 2>/dev/null || \
|
|
MANPAGER=cat man "$man_page" 2>/dev/null | ${ZVM_MAN_PAGER} -R || \
|
|
return 1
|
|
else
|
|
MANPAGER=cat man "$man_page" 2>/dev/null | ${ZVM_MAN_PAGER} -R || return 1
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
# Main entry point: open man page with appropriate pager
|
|
# Automatically detects pager type and uses correct pattern format
|
|
# Input: $1 = man_page, $2 = word (for pattern building)
|
|
# Returns: 0 on success, 1 on failure
|
|
zvm_open_man_page() {
|
|
local man_page="$1"
|
|
local word="$2"
|
|
local pager_type
|
|
|
|
pager_type=$(zvm_detect_pager_type)
|
|
|
|
case "$pager_type" in
|
|
nvim)
|
|
local nvim_pattern
|
|
nvim_pattern=$(zvm_build_nvim_pattern "$word")
|
|
zvm_open_nvim "$man_page" "$nvim_pattern"
|
|
;;
|
|
vim)
|
|
local vim_pattern
|
|
vim_pattern=$(zvm_build_nvim_pattern "$word")
|
|
zvm_open_vim "$man_page" "$vim_pattern"
|
|
;;
|
|
less|other)
|
|
local less_pattern
|
|
less_pattern=$(zvm_build_less_pattern "$word")
|
|
zvm_open_less "$man_page" "$less_pattern"
|
|
;;
|
|
esac
|
|
}
|
|
|