annotate runtime/ftplugin/man.vim @ 1623:53938adac247

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