Mercurial > vim
annotate runtime/ftplugin/man.vim @ 20151:39cb08f7f6b0
Added tag v8.2.0630 for changeset 1e76da634877cf30a1c7cd1374e1ed6703b9413c
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Fri, 24 Apr 2020 21:30:03 +0200 |
parents | 18043e7ab449 |
children | 56265f711890 |
rev | line source |
---|---|
7 | 1 " Vim filetype plugin file |
2 " Language: man | |
2034 | 3 " Maintainer: SungHyun Nam <goweol@gmail.com> |
20025
18043e7ab449
patch 8.2.0568: the man filetype plugin overwrites the unnamed register
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
4 " Last Change: 2020 Apr 13 |
7 | 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". | |
10 if &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 | |
14421 | 17 endif |
7 | 18 |
14421 | 19 let s:cpo_save = &cpo |
20 set cpo-=C | |
21 | |
22 if &filetype == "man" | |
7 | 23 " allow dot and dash in manual page name. |
24 setlocal iskeyword+=\.,- | |
14421 | 25 let b:undo_ftplugin = "setlocal iskeyword<" |
7 | 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 | |
14421 | 31 let b:undo_ftplugin = b:undo_ftplugin |
32 \ . '|silent! nunmap <buffer> <LocalLeader>h' | |
7 | 33 endif |
816 | 34 nnoremap <buffer> <Plug>ManBS :%s/.\b//g<CR>:setl nomod<CR>'' |
7 | 35 |
36 nnoremap <buffer> <c-]> :call <SID>PreGetPage(v:count)<CR> | |
37 nnoremap <buffer> <c-t> :call <SID>PopPage()<CR> | |
7272
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
6476
diff
changeset
|
38 nnoremap <buffer> <silent> q :q<CR> |
14421 | 39 |
40 " Add undo commands for the maps | |
41 let b:undo_ftplugin = b:undo_ftplugin | |
42 \ . '|silent! nunmap <buffer> <Plug>ManBS' | |
43 \ . '|silent! nunmap <buffer> <c-]>' | |
44 \ . '|silent! nunmap <buffer> <c-t>' | |
45 \ . '|silent! nunmap <buffer> q' | |
7272
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
6476
diff
changeset
|
46 endif |
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
6476
diff
changeset
|
47 |
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
6476
diff
changeset
|
48 if exists('g:ft_man_folding_enable') && (g:ft_man_folding_enable == 1) |
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
6476
diff
changeset
|
49 setlocal foldmethod=indent foldnestmax=1 foldenable |
14421 | 50 let b:undo_ftplugin = b:undo_ftplugin |
51 \ . '|silent! setl fdm< fdn< fen<' | |
7 | 52 endif |
53 | |
54 endif | |
55 | |
56 if exists(":Man") != 2 | |
14421 | 57 com -nargs=+ -complete=shellcmd Man call s:GetPage(<q-mods>, <f-args>) |
7 | 58 nmap <Leader>K :call <SID>PreGetPage(0)<CR> |
10548 | 59 nmap <Plug>ManPreGetPage :call <SID>PreGetPage(0)<CR> |
7 | 60 endif |
61 | |
62 " Define functions only once. | |
63 if !exists("s:man_tag_depth") | |
64 | |
65 let s:man_tag_depth = 0 | |
66 | |
1623 | 67 let s:man_sect_arg = "" |
68 let s:man_find_arg = "-w" | |
69 try | |
70 if !has("win32") && $OSTYPE !~ 'cygwin\|linux' && system('uname -s') =~ "SunOS" && system('uname -r') =~ "^5" | |
71 let s:man_sect_arg = "-s" | |
72 let s:man_find_arg = "-l" | |
73 endif | |
74 catch /E145:/ | |
75 " Ignore the error in restricted mode | |
76 endtry | |
7 | 77 |
78 func <SID>PreGetPage(cnt) | |
79 if a:cnt == 0 | |
80 let old_isk = &iskeyword | |
6369 | 81 if &ft == 'man' |
82 setl iskeyword+=(,) | |
83 endif | |
7 | 84 let str = expand("<cword>") |
85 let &l:iskeyword = old_isk | |
86 let page = substitute(str, '(*\(\k\+\).*', '\1', '') | |
87 let sect = substitute(str, '\(\k\+\)(\([^()]*\)).*', '\2', '') | |
88 if match(sect, '^[0-9 ]\+$') == -1 | |
89 let sect = "" | |
90 endif | |
91 if sect == page | |
92 let sect = "" | |
93 endif | |
94 else | |
95 let sect = a:cnt | |
96 let page = expand("<cword>") | |
97 endif | |
19813 | 98 call s:GetPage('', sect, page) |
7 | 99 endfunc |
100 | |
101 func <SID>GetCmdArg(sect, page) | |
102 if a:sect == '' | |
103 return a:page | |
104 endif | |
105 return s:man_sect_arg.' '.a:sect.' '.a:page | |
106 endfunc | |
107 | |
108 func <SID>FindPage(sect, page) | |
10734 | 109 let where = system("man ".s:man_find_arg.' '.s:GetCmdArg(a:sect, a:page)) |
7 | 110 if where !~ "^/" |
111 if matchstr(where, " [^ ]*$") !~ "^ /" | |
112 return 0 | |
113 endif | |
114 endif | |
115 return 1 | |
116 endfunc | |
117 | |
14421 | 118 func <SID>GetPage(cmdmods, ...) |
7 | 119 if a:0 >= 2 |
120 let sect = a:1 | |
121 let page = a:2 | |
122 elseif a:0 >= 1 | |
123 let sect = "" | |
124 let page = a:1 | |
125 else | |
126 return | |
127 endif | |
128 | |
129 " To support: nmap K :Man <cword> | |
130 if page == '<cword>' | |
131 let page = expand('<cword>') | |
132 endif | |
133 | |
18186 | 134 if !exists('g:ft_man_no_sect_fallback') || (g:ft_man_no_sect_fallback == 0) |
135 if sect != "" && s:FindPage(sect, page) == 0 | |
136 let sect = "" | |
137 endif | |
7 | 138 endif |
139 if s:FindPage(sect, page) == 0 | |
18186 | 140 let msg = "\nNo manual entry for ".page |
141 if sect != "" | |
142 let msg .= " in section ".sect | |
143 endif | |
144 echo msg | |
7 | 145 return |
146 endif | |
147 exec "let s:man_tag_buf_".s:man_tag_depth." = ".bufnr("%") | |
148 exec "let s:man_tag_lin_".s:man_tag_depth." = ".line(".") | |
149 exec "let s:man_tag_col_".s:man_tag_depth." = ".col(".") | |
150 let s:man_tag_depth = s:man_tag_depth + 1 | |
151 | |
17470
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
152 let open_cmd = 'edit' |
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
153 |
7 | 154 " Use an existing "man" window if it exists, otherwise open a new one. |
155 if &filetype != "man" | |
156 let thiswin = winnr() | |
157 exe "norm! \<C-W>b" | |
1125 | 158 if winnr() > 1 |
7 | 159 exe "norm! " . thiswin . "\<C-W>w" |
160 while 1 | |
161 if &filetype == "man" | |
162 break | |
163 endif | |
164 exe "norm! \<C-W>w" | |
165 if thiswin == winnr() | |
166 break | |
167 endif | |
168 endwhile | |
169 endif | |
1125 | 170 if &filetype != "man" |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
171 if exists("g:ft_man_open_mode") |
17470
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
172 if g:ft_man_open_mode == 'vert' |
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
173 let open_cmd = 'vsplit' |
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
174 elseif g:ft_man_open_mode == 'tab' |
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
175 let open_cmd = 'tabedit' |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
176 else |
17470
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
177 let open_cmd = 'split' |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
178 endif |
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
179 else |
17470
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
180 let open_cmd = a:cmdmods . ' split' |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
181 endif |
1125 | 182 endif |
7 | 183 endif |
17470
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
184 |
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
185 silent execute open_cmd . " $HOME/" . page . '.' . sect . '~' |
d2a834aa7cc0
patch 8.1.1733: the man ftplugin leaves an empty buffer behind
Bram Moolenaar <Bram@vim.org>
parents:
15640
diff
changeset
|
186 |
7 | 187 " Avoid warning for editing the dummy file twice |
816 | 188 setl buftype=nofile noswapfile |
7 | 189 |
17541
d9aa921b7198
patch 8.1.1768: man plugin changes setting in current window
Bram Moolenaar <Bram@vim.org>
parents:
17470
diff
changeset
|
190 setl fdc=0 ma nofen nonu nornu |
20025
18043e7ab449
patch 8.2.0568: the man filetype plugin overwrites the unnamed register
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
191 %delete _ |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
192 let unsetwidth = 0 |
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
193 if empty($MANWIDTH) |
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
194 let $MANWIDTH = winwidth(0) |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
195 let unsetwidth = 1 |
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
196 endif |
12826 | 197 |
198 " Ensure Vim is not recursively invoked (man-db does this) when doing ctrl-[ | |
199 " on a man page reference by unsetting MANPAGER. | |
13125 | 200 " Some versions of env(1) do not support the '-u' option, and in such case |
201 " we set MANPAGER=cat. | |
202 if !exists('s:env_has_u') | |
203 call system('env -u x true') | |
204 let s:env_has_u = (v:shell_error == 0) | |
205 endif | |
206 let env_cmd = s:env_has_u ? 'env -u MANPAGER' : 'env MANPAGER=cat' | |
19968 | 207 let env_cmd .= ' GROFF_NO_SGR=1' |
13125 | 208 let man_cmd = env_cmd . ' man ' . s:GetCmdArg(sect, page) . ' | col -b' |
209 silent exec "r !" . man_cmd | |
12826 | 210 |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
211 if unsetwidth |
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
212 let $MANWIDTH = '' |
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
213 endif |
7 | 214 " Remove blank lines from top and bottom. |
15640 | 215 while line('$') > 1 && getline(1) =~ '^\s*$' |
20025
18043e7ab449
patch 8.2.0568: the man filetype plugin overwrites the unnamed register
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
216 1delete _ |
7 | 217 endwhile |
15640 | 218 while line('$') > 1 && getline('$') =~ '^\s*$' |
20025
18043e7ab449
patch 8.2.0568: the man filetype plugin overwrites the unnamed register
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
219 $delete _ |
7 | 220 endwhile |
221 1 | |
222 setl ft=man nomod | |
223 setl bufhidden=hide | |
224 setl nobuflisted | |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
225 setl noma |
7 | 226 endfunc |
227 | |
228 func <SID>PopPage() | |
229 if s:man_tag_depth > 0 | |
230 let s:man_tag_depth = s:man_tag_depth - 1 | |
231 exec "let s:man_tag_buf=s:man_tag_buf_".s:man_tag_depth | |
232 exec "let s:man_tag_lin=s:man_tag_lin_".s:man_tag_depth | |
233 exec "let s:man_tag_col=s:man_tag_col_".s:man_tag_depth | |
234 exec s:man_tag_buf."b" | |
235 exec s:man_tag_lin | |
13857 | 236 exec "norm! ".s:man_tag_col."|" |
7 | 237 exec "unlet s:man_tag_buf_".s:man_tag_depth |
238 exec "unlet s:man_tag_lin_".s:man_tag_depth | |
239 exec "unlet s:man_tag_col_".s:man_tag_depth | |
240 unlet s:man_tag_buf s:man_tag_lin s:man_tag_col | |
241 endif | |
242 endfunc | |
243 | |
244 endif | |
245 | |
14421 | 246 let &cpo = s:cpo_save |
247 unlet s:cpo_save | |
248 | |
9326
cd9c4bbe1d03
commit https://github.com/vim/vim/commit/ddf8d1c746ee081d15c9d7e0515f6ac43adbf363
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
249 " vim: set sw=2 ts=8 noet: |