adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(man): improve :Man completion for man-db

Browse Source 
On man-db systems, complete with actual man sections and pages, instead
of shell commands.

I tried to come up with a portable solution for multiple man
implementations in https://github.com/vim/vim/discussions/16794 but I
think the differences between implementations were too large to do that
without overly complicated code. So instead, I implemented it for man-db
(which I think is common on Linux) and hopefully left it easier for
other people to implement it on other systems in the future if they want
to.

closes: #16843

Signed-off-by: David Mandelberg <david@mandelberg.org>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
David Mandelberg
2025-03-10 21:26:50 +01:00
committed by Christian Brabandt
parent 969e11a18b
commit c2623824a7
4 changed files with 115 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
runtime/ftplugin/man.vim
View File

@ -6,6 +6,7 @@
" Last Change: 2024 Jun 06 (disabled the q mapping, #8210)
" 2024 Jul 06 (use nnoremap, #15130)
" 2024 Aug 23 (improve the <Plug>ManBS mapping, #15547, #15556)
" 2025 Mar 09 (improve :Man completion for man-db, #16843)
" To make the ":Man" command available before editing a manual page, source
" this script from your startup vimrc file.
@ -24,6 +25,14 @@ endif
let s:cpo_save = &cpo
set cpo-=C
if !exists('g:ft_man_implementation')
if executable('mandb') > 0
let g:ft_man_implementation = 'man-db'
else
let g:ft_man_implementation = ''
endif
endif
if &filetype == "man"
" Allow hyphen, plus, colon, dot, and commercial at in manual page name.
" Parentheses are not here but in dist#man#PreGetPage()
@ -60,11 +69,19 @@ if &filetype == "man"
endif
if exists(":Man") != 2
com -nargs=+ -complete=shellcmd Man call dist#man#GetPage(<q-mods>, <f-args>)
if g:ft_man_implementation ==# 'man-db'
com -nargs=+ -complete=customlist,dist#man#ManDbComplete Man call dist#man#GetPage(<q-mods>, <f-args>)
else
com -nargs=+ -complete=shellcmd Man call dist#man#GetPage(<q-mods>, <f-args>)
endif
nnoremap <Leader>K :call dist#man#PreGetPage(0)<CR>
nnoremap <Plug>ManPreGetPage :call dist#man#PreGetPage(0)<CR>
endif
if exists(":ManReload") != 2
com ManReload call dist#man#Reload()
endif
let &cpo = s:cpo_save
unlet s:cpo_save