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