annotate runtime/ftplugin/man.vim @ 49:000769ce6c9d default tip

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