1" Vim filetype plugin file 2" Language: man 3" Maintainer: Jason Franklin <[email protected]> 4" Maintainer: SungHyun Nam <[email protected]> 5" Last Change: 2020 Jun 01 6 7" To make the ":Man" command available before editing a manual page, source 8" this script from your startup vimrc file. 9 10" If 'filetype' isn't "man", we must have been called to only define ":Man". 11if &filetype == "man" 12 13 " Only do this when not done yet for this buffer 14 if exists("b:did_ftplugin") 15 finish 16 endif 17 let b:did_ftplugin = 1 18endif 19 20let s:cpo_save = &cpo 21set cpo-=C 22 23if &filetype == "man" 24 " allow dot and dash in manual page name. 25 setlocal iskeyword+=\.,- 26 let b:undo_ftplugin = "setlocal iskeyword<" 27 28 " Add mappings, unless the user didn't want this. 29 if !exists("no_plugin_maps") && !exists("no_man_maps") 30 if !hasmapto('<Plug>ManBS') 31 nmap <buffer> <LocalLeader>h <Plug>ManBS 32 let b:undo_ftplugin = b:undo_ftplugin 33 \ . '|silent! nunmap <buffer> <LocalLeader>h' 34 endif 35 nnoremap <buffer> <Plug>ManBS :%s/.\b//g<CR>:setl nomod<CR>'' 36 37 nnoremap <buffer> <silent> <c-]> :call <SID>PreGetPage(v:count)<CR> 38 nnoremap <buffer> <silent> <c-t> :call <SID>PopPage()<CR> 39 nnoremap <buffer> <silent> q :q<CR> 40 41 " Add undo commands for the maps 42 let b:undo_ftplugin = b:undo_ftplugin 43 \ . '|silent! nunmap <buffer> <Plug>ManBS' 44 \ . '|silent! nunmap <buffer> <c-]>' 45 \ . '|silent! nunmap <buffer> <c-t>' 46 \ . '|silent! nunmap <buffer> q' 47 endif 48 49 if exists('g:ft_man_folding_enable') && (g:ft_man_folding_enable == 1) 50 setlocal foldmethod=indent foldnestmax=1 foldenable 51 let b:undo_ftplugin = b:undo_ftplugin 52 \ . '|silent! setl fdm< fdn< fen<' 53 endif 54 55endif 56 57if exists(":Man") != 2 58 com -nargs=+ -complete=shellcmd Man call s:GetPage(<q-mods>, <f-args>) 59 nmap <Leader>K :call <SID>PreGetPage(0)<CR> 60 nmap <Plug>ManPreGetPage :call <SID>PreGetPage(0)<CR> 61endif 62 63" Define functions only once. 64if !exists("s:man_tag_depth") 65 66let s:man_tag_depth = 0 67 68let s:man_sect_arg = "" 69let s:man_find_arg = "-w" 70try 71 if !has("win32") && $OSTYPE !~ 'cygwin\|linux' && system('uname -s') =~ "SunOS" && system('uname -r') =~ "^5" 72 let s:man_sect_arg = "-s" 73 let s:man_find_arg = "-l" 74 endif 75catch /E145:/ 76 " Ignore the error in restricted mode 77endtry 78 79func <SID>PreGetPage(cnt) 80 if a:cnt == 0 81 let old_isk = &iskeyword 82 if &ft == 'man' 83 setl iskeyword+=(,) 84 endif 85 let str = expand("<cword>") 86 let &l:iskeyword = old_isk 87 let page = substitute(str, '(*\(\k\+\).*', '\1', '') 88 let sect = substitute(str, '\(\k\+\)(\([^()]*\)).*', '\2', '') 89 if match(sect, '^[0-9 ]\+$') == -1 90 let sect = "" 91 endif 92 if sect == page 93 let sect = "" 94 endif 95 else 96 let sect = a:cnt 97 let page = expand("<cword>") 98 endif 99 call s:GetPage('', sect, page) 100endfunc 101 102func <SID>GetCmdArg(sect, page) 103 if a:sect == '' 104 return a:page 105 endif 106 return s:man_sect_arg.' '.a:sect.' '.a:page 107endfunc 108 109func <SID>FindPage(sect, page) 110 let where = system("man ".s:man_find_arg.' '.s:GetCmdArg(a:sect, a:page)) 111 if where !~ "^/" 112 if matchstr(where, " [^ ]*$") !~ "^ /" 113 return 0 114 endif 115 endif 116 return 1 117endfunc 118 119func <SID>GetPage(cmdmods, ...) 120 if a:0 >= 2 121 let sect = a:1 122 let page = a:2 123 elseif a:0 >= 1 124 let sect = "" 125 let page = a:1 126 else 127 return 128 endif 129 130 " To support: nmap K :Man <cword> 131 if page == '<cword>' 132 let page = expand('<cword>') 133 endif 134 135 if !exists('g:ft_man_no_sect_fallback') || (g:ft_man_no_sect_fallback == 0) 136 if sect != "" && s:FindPage(sect, page) == 0 137 let sect = "" 138 endif 139 endif 140 if s:FindPage(sect, page) == 0 141 let msg = 'man.vim: no manual entry for "' . page . '"' 142 if !empty(sect) 143 let msg .= ' in section ' . sect 144 endif 145 echomsg msg 146 return 147 endif 148 exec "let s:man_tag_buf_".s:man_tag_depth." = ".bufnr("%") 149 exec "let s:man_tag_lin_".s:man_tag_depth." = ".line(".") 150 exec "let s:man_tag_col_".s:man_tag_depth." = ".col(".") 151 let s:man_tag_depth = s:man_tag_depth + 1 152 153 let open_cmd = 'edit' 154 155 " Use an existing "man" window if it exists, otherwise open a new one. 156 if &filetype != "man" 157 let thiswin = winnr() 158 exe "norm! \<C-W>b" 159 if winnr() > 1 160 exe "norm! " . thiswin . "\<C-W>w" 161 while 1 162 if &filetype == "man" 163 break 164 endif 165 exe "norm! \<C-W>w" 166 if thiswin == winnr() 167 break 168 endif 169 endwhile 170 endif 171 if &filetype != "man" 172 if exists("g:ft_man_open_mode") 173 if g:ft_man_open_mode == 'vert' 174 let open_cmd = 'vsplit' 175 elseif g:ft_man_open_mode == 'tab' 176 let open_cmd = 'tabedit' 177 else 178 let open_cmd = 'split' 179 endif 180 else 181 let open_cmd = a:cmdmods . ' split' 182 endif 183 endif 184 endif 185 186 silent execute open_cmd . " $HOME/" . page . '.' . sect . '~' 187 188 " Avoid warning for editing the dummy file twice 189 setl buftype=nofile noswapfile 190 191 setl fdc=0 ma nofen nonu nornu 192 %delete _ 193 let unsetwidth = 0 194 if empty($MANWIDTH) 195 let $MANWIDTH = winwidth(0) 196 let unsetwidth = 1 197 endif 198 199 " Ensure Vim is not recursively invoked (man-db does this) when doing ctrl-[ 200 " on a man page reference by unsetting MANPAGER. 201 " Some versions of env(1) do not support the '-u' option, and in such case 202 " we set MANPAGER=cat. 203 if !exists('s:env_has_u') 204 call system('env -u x true') 205 let s:env_has_u = (v:shell_error == 0) 206 endif 207 let env_cmd = s:env_has_u ? 'env -u MANPAGER' : 'env MANPAGER=cat' 208 let env_cmd .= ' GROFF_NO_SGR=1' 209 let man_cmd = env_cmd . ' man ' . s:GetCmdArg(sect, page) . ' | col -b' 210 silent exec "r !" . man_cmd 211 212 if unsetwidth 213 let $MANWIDTH = '' 214 endif 215 " Remove blank lines from top and bottom. 216 while line('$') > 1 && getline(1) =~ '^\s*$' 217 1delete _ 218 endwhile 219 while line('$') > 1 && getline('$') =~ '^\s*$' 220 $delete _ 221 endwhile 222 1 223 setl ft=man nomod 224 setl bufhidden=hide 225 setl nobuflisted 226 setl noma 227endfunc 228 229func <SID>PopPage() 230 if s:man_tag_depth > 0 231 let s:man_tag_depth = s:man_tag_depth - 1 232 exec "let s:man_tag_buf=s:man_tag_buf_".s:man_tag_depth 233 exec "let s:man_tag_lin=s:man_tag_lin_".s:man_tag_depth 234 exec "let s:man_tag_col=s:man_tag_col_".s:man_tag_depth 235 exec s:man_tag_buf."b" 236 exec s:man_tag_lin 237 exec "norm! ".s:man_tag_col."|" 238 exec "unlet s:man_tag_buf_".s:man_tag_depth 239 exec "unlet s:man_tag_lin_".s:man_tag_depth 240 exec "unlet s:man_tag_col_".s:man_tag_depth 241 unlet s:man_tag_buf s:man_tag_lin s:man_tag_col 242 endif 243endfunc 244 245endif 246 247let &cpo = s:cpo_save 248unlet s:cpo_save 249 250" vim: set sw=2 ts=8 noet: 251