config/.vim/ftplugin/man.vim

250 lines
6.4 KiB
VimL
Raw Normal View History

2012-02-01 16:01:06 +01:00
" Vim filetype plugin file
" Language: man
2015-07-07 14:19:34 +02:00
" Maintainer: SungHyun Nam <goweol@gmail.com>
2024-03-06 17:48:17 +01:00
" Last Change: 2019 Sep 26
" (fix by Jason Franklin)
2012-02-01 16:01:06 +01:00
" To make the ":Man" command available before editing a manual page, source
" this script from your startup vimrc file.
" If 'filetype' isn't "man", we must have been called to only define ":Man".
if &filetype == "man"
" Only do this when not done yet for this buffer
if exists("b:did_ftplugin")
finish
endif
let b:did_ftplugin = 1
2024-03-06 17:48:17 +01:00
endif
2012-02-01 16:01:06 +01:00
2024-03-06 17:48:17 +01:00
let s:cpo_save = &cpo
set cpo-=C
2015-07-07 14:19:34 +02:00
2024-03-06 17:48:17 +01:00
if &filetype == "man"
2012-02-01 16:01:06 +01:00
" allow dot and dash in manual page name.
setlocal iskeyword+=\.,-
2024-03-06 17:48:17 +01:00
let b:undo_ftplugin = "setlocal iskeyword<"
2012-02-01 16:01:06 +01:00
" Add mappings, unless the user didn't want this.
if !exists("no_plugin_maps") && !exists("no_man_maps")
if !hasmapto('<Plug>ManBS')
nmap <buffer> <LocalLeader>h <Plug>ManBS
2024-03-06 17:48:17 +01:00
let b:undo_ftplugin = b:undo_ftplugin
\ . '|silent! nunmap <buffer> <LocalLeader>h'
2012-02-01 16:01:06 +01:00
endif
nnoremap <buffer> <Plug>ManBS :%s/.\b//g<CR>:setl nomod<CR>''
nnoremap <buffer> <c-]> :call <SID>PreGetPage(v:count)<CR>
nnoremap <buffer> <c-t> :call <SID>PopPage()<CR>
2024-03-06 17:48:17 +01:00
nnoremap <buffer> <silent> q :q<CR>
" Add undo commands for the maps
let b:undo_ftplugin = b:undo_ftplugin
\ . '|silent! nunmap <buffer> <Plug>ManBS'
\ . '|silent! nunmap <buffer> <c-]>'
\ . '|silent! nunmap <buffer> <c-t>'
\ . '|silent! nunmap <buffer> q'
2012-02-01 16:01:06 +01:00
endif
2024-03-06 17:48:17 +01:00
if exists('g:ft_man_folding_enable') && (g:ft_man_folding_enable == 1)
setlocal foldmethod=indent foldnestmax=1 foldenable
let b:undo_ftplugin = b:undo_ftplugin
\ . '|silent! setl fdm< fdn< fen<'
endif
2015-07-07 14:19:34 +02:00
2012-02-01 16:01:06 +01:00
endif
if exists(":Man") != 2
2024-03-06 17:48:17 +01:00
com -nargs=+ -complete=shellcmd Man call s:GetPage(<q-mods>, <f-args>)
2012-02-01 16:01:06 +01:00
nmap <Leader>K :call <SID>PreGetPage(0)<CR>
2024-03-06 17:48:17 +01:00
nmap <Plug>ManPreGetPage :call <SID>PreGetPage(0)<CR>
2012-02-01 16:01:06 +01:00
endif
" Define functions only once.
if !exists("s:man_tag_depth")
let s:man_tag_depth = 0
let s:man_sect_arg = ""
let s:man_find_arg = "-w"
try
if !has("win32") && $OSTYPE !~ 'cygwin\|linux' && system('uname -s') =~ "SunOS" && system('uname -r') =~ "^5"
let s:man_sect_arg = "-s"
let s:man_find_arg = "-l"
endif
catch /E145:/
" Ignore the error in restricted mode
endtry
func <SID>PreGetPage(cnt)
if a:cnt == 0
let old_isk = &iskeyword
2015-07-07 14:19:34 +02:00
if &ft == 'man'
setl iskeyword+=(,)
endif
2012-02-01 16:01:06 +01:00
let str = expand("<cword>")
let &l:iskeyword = old_isk
let page = substitute(str, '(*\(\k\+\).*', '\1', '')
let sect = substitute(str, '\(\k\+\)(\([^()]*\)).*', '\2', '')
if match(sect, '^[0-9 ]\+$') == -1
let sect = ""
endif
if sect == page
let sect = ""
endif
else
let sect = a:cnt
let page = expand("<cword>")
endif
call s:GetPage(sect, page)
endfunc
func <SID>GetCmdArg(sect, page)
if a:sect == ''
return a:page
endif
return s:man_sect_arg.' '.a:sect.' '.a:page
endfunc
func <SID>FindPage(sect, page)
2024-03-06 17:48:17 +01:00
let where = system("man ".s:man_find_arg.' '.s:GetCmdArg(a:sect, a:page))
2012-02-01 16:01:06 +01:00
if where !~ "^/"
if matchstr(where, " [^ ]*$") !~ "^ /"
return 0
endif
endif
return 1
endfunc
2024-03-06 17:48:17 +01:00
func <SID>GetPage(cmdmods, ...)
2012-02-01 16:01:06 +01:00
if a:0 >= 2
let sect = a:1
let page = a:2
elseif a:0 >= 1
let sect = ""
let page = a:1
else
return
endif
" To support: nmap K :Man <cword>
if page == '<cword>'
let page = expand('<cword>')
endif
2024-03-06 17:48:17 +01:00
if !exists('g:ft_man_no_sect_fallback') || (g:ft_man_no_sect_fallback == 0)
if sect != "" && s:FindPage(sect, page) == 0
let sect = ""
endif
2012-02-01 16:01:06 +01:00
endif
if s:FindPage(sect, page) == 0
2024-03-06 17:48:17 +01:00
let msg = "\nNo manual entry for ".page
if sect != ""
let msg .= " in section ".sect
endif
echo msg
2012-02-01 16:01:06 +01:00
return
endif
exec "let s:man_tag_buf_".s:man_tag_depth." = ".bufnr("%")
exec "let s:man_tag_lin_".s:man_tag_depth." = ".line(".")
exec "let s:man_tag_col_".s:man_tag_depth." = ".col(".")
let s:man_tag_depth = s:man_tag_depth + 1
2024-03-06 17:48:17 +01:00
let open_cmd = 'edit'
2012-02-01 16:01:06 +01:00
" Use an existing "man" window if it exists, otherwise open a new one.
if &filetype != "man"
let thiswin = winnr()
exe "norm! \<C-W>b"
if winnr() > 1
exe "norm! " . thiswin . "\<C-W>w"
while 1
if &filetype == "man"
break
endif
exe "norm! \<C-W>w"
if thiswin == winnr()
break
endif
endwhile
endif
if &filetype != "man"
2024-03-06 17:48:17 +01:00
if exists("g:ft_man_open_mode")
if g:ft_man_open_mode == 'vert'
let open_cmd = 'vsplit'
elseif g:ft_man_open_mode == 'tab'
let open_cmd = 'tabedit'
else
let open_cmd = 'split'
endif
else
let open_cmd = a:cmdmods . ' split'
endif
2012-02-01 16:01:06 +01:00
endif
endif
2024-03-06 17:48:17 +01:00
silent execute open_cmd . " $HOME/" . page . '.' . sect . '~'
2012-02-01 16:01:06 +01:00
" Avoid warning for editing the dummy file twice
setl buftype=nofile noswapfile
2024-03-06 17:48:17 +01:00
setl fdc=0 ma nofen nonu nornu
silent exec "norm! 1GdG"
let unsetwidth = 0
if empty($MANWIDTH)
let $MANWIDTH = winwidth(0)
let unsetwidth = 1
endif
" Ensure Vim is not recursively invoked (man-db does this) when doing ctrl-[
" on a man page reference by unsetting MANPAGER.
" Some versions of env(1) do not support the '-u' option, and in such case
" we set MANPAGER=cat.
if !exists('s:env_has_u')
call system('env -u x true')
let s:env_has_u = (v:shell_error == 0)
endif
let env_cmd = s:env_has_u ? 'env -u MANPAGER' : 'env MANPAGER=cat'
let man_cmd = env_cmd . ' man ' . s:GetCmdArg(sect, page) . ' | col -b'
silent exec "r !" . man_cmd
if unsetwidth
let $MANWIDTH = ''
endif
2012-02-01 16:01:06 +01:00
" Remove blank lines from top and bottom.
2024-03-06 17:48:17 +01:00
while line('$') > 1 && getline(1) =~ '^\s*$'
silent keepj norm! ggdd
2012-02-01 16:01:06 +01:00
endwhile
2024-03-06 17:48:17 +01:00
while line('$') > 1 && getline('$') =~ '^\s*$'
silent keepj norm! Gdd
2012-02-01 16:01:06 +01:00
endwhile
1
setl ft=man nomod
setl bufhidden=hide
setl nobuflisted
2024-03-06 17:48:17 +01:00
setl noma
2012-02-01 16:01:06 +01:00
endfunc
func <SID>PopPage()
if s:man_tag_depth > 0
let s:man_tag_depth = s:man_tag_depth - 1
exec "let s:man_tag_buf=s:man_tag_buf_".s:man_tag_depth
exec "let s:man_tag_lin=s:man_tag_lin_".s:man_tag_depth
exec "let s:man_tag_col=s:man_tag_col_".s:man_tag_depth
exec s:man_tag_buf."b"
exec s:man_tag_lin
2024-03-06 17:48:17 +01:00
exec "norm! ".s:man_tag_col."|"
2012-02-01 16:01:06 +01:00
exec "unlet s:man_tag_buf_".s:man_tag_depth
exec "unlet s:man_tag_lin_".s:man_tag_depth
exec "unlet s:man_tag_col_".s:man_tag_depth
unlet s:man_tag_buf s:man_tag_lin s:man_tag_col
endif
endfunc
endif
2024-03-06 17:48:17 +01:00
let &cpo = s:cpo_save
unlet s:cpo_save
" vim: set sw=2 ts=8 noet: