annotate runtime/doc/pi_netrw.txt @ 466:7a01bd1ac566

updated for version 7.0125
author vimboss
date Mon, 08 Aug 2005 22:00:59 +0000
parents 3b705e71c7b0
children f8b75b8f1988
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1 *pi_netrw.txt* For Vim version 7.0. Last change: Aug 08, 2005
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Charles E. Campbell, Jr.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
6 *dav* *http* *network* *rcp* *scp*
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
7 *fetch* *netrw* *Nread* *rsync* *sftp*
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
8 *ftp* *netrw.vim* *Nwrite* *netrw-file*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 0. Contents *netrw-contents*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
13 1. Netrw Reference......................................|netrw-ref|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
14 2. Network-Oriented File Transfer.......................|netrw-xfer|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
15 NETRC..............................................|netrw-netrc|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
16 PASSWORD...........................................|netrw-passwd|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
17 3. Activation...........................................|netrw-activate|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
18 4. Transparent File Transfer............................|netrw-transparent|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
19 5. Ex Commands..........................................|netrw-ex|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
20 6. Variables and Options................................|netrw-var|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
21 7. Directory Browser....................................|netrw-browse| {{{1
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
22 Maps...............................................|netrw-maps|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
23 Exploring..........................................|netrw-explore-cmds|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
24 Quick Reference Commands Table.....................|netrw-browse-cmds|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
25 Netrw Browser Variables............................|netrw-browse-var|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
26 Introduction To Directory Browsing.................|netrw-browse-intro|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
27 Directory Exploring Commands.......................|netrw-explore|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
28 Refreshing The Listing.............................|netrw-ctrl-l|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
29 Going Up...........................................|netrw--|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
30 Browsing...........................................|netrw-cr|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
31 Long Vs Short Listing..............................|netrw-i|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
32 Making A New Directory.............................|netrw-d|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
33 Deleting Files Or Directories......................|netrw-delete|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
34 Renaming Files Or Directories......................|netrw-move|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
35 Hiding Files Or Directories........................|g:netrw-a|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
36 Edit File Or Directory Hiding List.................|netrw-h|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
37 Browsing With A Horizontally Split Window..........|netrw-o|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
38 Preview Window.....................................|netrw-p|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
39 Selecting Sorting Style............................|netrw-s|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
40 Editing The Sorting Sequence.......................|netrw-S|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
41 Reversing Sorting Order............................|netrw-r|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
42 Changing To A Predecessor Directory................|netrw-u|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
43 Changing To A Successor Directory..................|netrw-U|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
44 Browsing With A Vertically Split Window............|netrw-v|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
45 Customizing Browsing With A User Function..........|netrw-x|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
46 Making The Browsing Directory The Current Directory|netrw-c|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
47 Bookmarking A Directory............................|netrw-b|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
48 Changing To A Bookmarked Directory.................|netrw-B|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
49 Listing Bookmarks And History......................|netrw-q|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
50 Improving Directory Browsing.......................|netrw-list-hack| }}}1
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
51 8. Problems and Fixes...................................|netrw-problems|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
52 9. Debugging............................................|netrw-debug|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
53 10. History..............................................|netrw-history|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
54 11. Credits..............................................|netrw-credits|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 The functionality mentioned here is done via using |standard-plugin|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 techniques. This plugin is only available if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
59 set nocp " 'compatible' is not set
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
60 filetype plugin on " plugins are enabled
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 You can avoid loading this plugin by setting the "loaded_netrw" variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 in your <.vimrc> file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 :let loaded_netrw = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 {Vi does not have any of this}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 1. Netrw Reference *netrw-ref*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 OPTIONS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 let g:netrw_ftp =0 use ftp (default) (uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 =1 use alternate ftp method (user uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 If you're having trouble with ftp, try changing the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 of this variable in your <.vimrc> to change methods
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 let g:netrw_ignorenetrc= 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 If you have a <.netrc> file but it doesn't work and you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 want it ignored, then set this variable as shown. Its mere
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 existence is enough to cause <.netrc> to be ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 Controlling External Applications
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
85 Protocol Variable Default Value
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
86 -------- ---------------- -------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
87 dav: g:netrw_dav_cmd = "cadaver"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
88 fetch: g:netrw_fetch_cmd = "fetch -o"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
89 ftp: g:netrw_ftp_cmd = "ftp"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
90 http: g:netrw_http_cmd = "fetch -o" if fetch is available
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
91 http: g:netrw_http_cmd = "wget -q -O" If wget is available
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
92 rcp: g:netrw_rcp_cmd = "rcp"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
93 rsync: g:netrw_rsync_cmd = "rsync -a"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
94 scp: g:netrw_scp_cmd = "scp -q"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 sftp: g:netrw_sftp_cmd = "sftp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
97 READING *netrw-read* *netrw-nread*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 :Nread ? give help
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
99 :Nread "machine:path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
100 :Nread "machine path" uses ftp with <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
101 :Nread "machine id password path" uses ftp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
102 :Nread "dav://machine[:port]/path" uses cadaver
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
103 :Nread "fetch://[user@]machine/path" uses fetch
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
104 :Nread "ftp://[user@]machine[[:#]port]/path" uses ftp autodetects <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
105 :Nread "http://[user@]machine/path" uses http uses wget
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
106 :Nread "rcp://[user@]machine/path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
107 :Nread "rsync://[user@]machine[:port]/path" uses rsync
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
108 :Nread "scp://[user@]machine[[:#]port]/path" uses scp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
109 :Nread "sftp://[user@]machine/path" uses sftp
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
111 WRITING *netrw-write* *netrw-nwrite*
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
112 :Nwrite ? give help
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
113 :Nwrite "machine:path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
114 :Nwrite "machine path" uses ftp with <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
115 :Nwrite "machine id password path" uses ftp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
116 :Nwrite "dav://machine[:port]/path" uses cadaver
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
117 :Nwrite "ftp://[user@]machine[[:#]port]/path" uses ftp autodetects <.netrc>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
118 :Nwrite "rcp://[user@]machine/path" uses rcp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
119 :Nwrite "rsync://[user@]machine[:port]/path" uses rsync
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
120 :Nwrite "scp://[user@]machine[[:#]port]/path" uses scp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
121 :Nwrite "sftp://[user@]machine/path" uses sftp
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 http: not supported!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
124 DIRECTORY LISTING
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
125 :Nread [protocol]://[user]@hostname/path/
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
126
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 USER AND PASSWORD CHANGING
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 Attempts to use ftp will prompt you for a user-id and a password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 These will be saved in g:netrw_uid and g:netrw_passwd Subsequent uses
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 of ftp will re-use those. If you need to use a different user id
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 and/or password, you'll want to call NetUserPass() first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 :NetUserPass [uid [password]] -- prompts as needed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 :call NetUserPass() -- prompts for uid and password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 :call NetUserPass("uid") -- prompts for password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 :call NetUserPass("uid","password") -- sets global uid and password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
138 VARIABLES *netrw-variables*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 b:netrw_lastfile last file Network-read/written retained on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 a per-buffer basis (supports plain :Nw )
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 s:netrw_line during Nw/NetWrite, holds current line number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 s:netrw_col during Nw/NetWrite, holds current column number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 s:netrw_line and s:netrw_col are used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 restore the cursor position on writes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 g:netrw_ftp if it doesn't exist, use default ftp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 =0 use default ftp (uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 =1 use alternate ftp method (user uid password)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 g:netrw_ftpmode ="binary" (default)
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
149 ="ascii"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 g:netrw_uid (ftp) user-id, retained on a per-session basis
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 g:netrw_passwd (ftp) password, retained on a per-session basis
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
152 g:netrw_win95ftp =1 if using Win95, will remove four trailing blank
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
153 lines that o/s's ftp "provides" on transfers
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
154 =0 force normal ftp behavior (no trailing line
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
155 removal)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 g:netrw_cygwin =1 assume scp under windows is from cygwin
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
157 Also permits network browsing to use
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
158 ls with time and size sorting
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 (default if windows)
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
160 =0 assume Windows' scp accepts windows-style paths
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
161 Network browsing uses dir instead of ls
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
162 This option is ignored if you're using unix
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
163 g:netrw_use_nt_rcp=0 don't use the rcp of WinNT, Win2000 and WinXP
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
164 =1 use WinNT's rcp in binary mode (default)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
166 PATHS *netrw-path*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
167
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
168 Paths to files are generally user-directory relative for most protocols.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
169 It is possible that some protocol will make paths relative to some
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
170 associated directory, however.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
171
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
172 example: vim scp://user@host/somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
173 example: vim scp://user@host/subdir1/subdir2/somefile
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
174
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
175 where "somefile" is the "user"'s home directory. If you wish to get a
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
176 file using root-relative paths, use the full path:
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
177
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
178 example: vim scp://user@host//somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
179 example: vim scp://user@host//subdir1/subdir2/somefile
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
180
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 2. Network-Oriented File Transfer *netrw-xfer*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 Network-oriented file transfer under Vim is implemented by a VimL-based script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186 (<netrw.vim>) using plugin techniques. It currently supports both reading
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 and writing across networks using rcp, scp, ftp or ftp+<.netrc>, scp, fetch,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 dav/cadaver, rsync, or sftp.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 http is currently supported read-only via use of wget or fetch.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 <netrw.vim> is a standard plugin which acts as glue between Vim and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193 various file transfer programs. It uses autocommand events (BufReadCmd,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 FileReadCmd, BufWriteCmd) to intercept reads/writes with url-like filenames. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 ex. vim ftp://hostname/path/to/file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 The characters preceding the colon specify the protocol to use;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 in the example, its ftp. The <netrw.vim> script then formulates
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 a command or a series of commands (typically ftp) which it issues
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 to an external program (ftp, scp, etc) which does the actual file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 transfer/protocol. Files are read from/written to a temporary file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 (under Unix/Linux, /tmp/...) which the <netrw.vim> script will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 clean up.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 One may modify any protocol's implementing external application
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
207 by setting a variable (ex. scp uses the variable g:netrw_scp_cmd,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 which is defaulted to "scp -q").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 Ftp, an old protocol, seems to be blessed by numerous implementations.
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
211 Unfortunately, some implementations are noisy (ie., add junk to the end
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212 of the file). Thus, concerned users may decide to write a NetReadFixup()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 function that will clean up after reading with their ftp. Some Unix systems
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
214 (ie., FreeBSD) provide a utility called "fetch" which uses the ftp protocol
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 but is not noisy and more convenient, actually, for <netrw.vim> to use.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 Consequently, if "fetch" is executable, it will be used to do reads for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 ftp://... (and http://...) . See |netrw-var| for more about this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 For rcp, scp, sftp, and http, one may use network-oriented file transfers
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
220 transparently; ie.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 vim rcp://[user@]machine/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223 vim scp://[user@]machine/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 If your ftp supports <.netrc>, then it too can be just as transparently used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 if the needed triad of machine name, user id, and password are present in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 that file. Your ftp must be able to use the <.netrc> file on its own, however.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 vim ftp://[user@]machine[[:#]portnumber]/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 However, ftp will often need to query the user for the userid and password.
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
232 The latter will be done "silently"; ie. asterisks will show up instead of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233 the actually-typed-in password. Netrw will retain the userid and password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 for subsequent read/writes from the most recent transfer so subsequent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 transfers (read/write) to or from that machine will take place without
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236 additional prompting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 *netrw-urls*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239 +=================================+============================+============+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
240 | Reading | Writing | Uses |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241 +=================================+============================+============+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
242 | DAV: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
243 | dav://host/path | | cadaver |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
244 | :Nread dav://host/path | :Nwrite dav://host/path | cadaver |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
246 | FETCH: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
247 | fetch://[user@]host/path | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
248 | fetch://[user@]host:http/path | Not Available | fetch |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
249 | :Nread fetch://[user@]host/path| | |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
251 | FILE: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
252 | file:///* | file:///* | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
253 | file://localhost/* | file://localhost/* | |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
255 | FTP: (*3) | (*3) | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
256 | ftp://[user@]host/path | ftp://[user@]host/path | ftp (*2) |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
257 | :Nread ftp://host/path | :Nwrite ftp://host/path | ftp+.netrc |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
258 | :Nread host path | :Nwrite host path | ftp+.netrc |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
259 | :Nread host uid pass path | :Nwrite host uid pass path | ftp |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
261 | HTTP: wget is executable: (*4) | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
262 | http://[user@]host/path | Not Available | wget |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
264 | HTTP: fetch is executable (*4) | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
265 | http://[user@]host/path | Not Available | fetch |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
267 | RCP: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
268 | rcp://[user@]host/path | rcp://[user@]host/path | rcp |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
270 | RSYNC: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
271 | rsync://[user@]host/path | rsync://[user@]host/path | rsync |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
272 | :Nread rsync://host/path | :Nwrite rsync://host/path | rsync |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
273 | :Nread rcp://host/path | :Nwrite rcp://host/path | rcp |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
275 | SCP: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
276 | scp://[user@]host/path | scp://[user@]host/path | scp |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
277 | :Nread scp://host/path | :Nwrite scp://host/path | scp (*1) |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 +---------------------------------+----------------------------+------------+
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
279 | SFTP: | | |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
280 | sftp://[user@]host/path | sftp://[user@]host/path | sftp |
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
281 | :Nread sftp://host/path | :Nwrite sftp://host/path | sftp (*1) |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 +=================================+============================+============+
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
284 (*1) For an absolute path use scp://machine//path.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
285
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
286 (*2) if <.netrc> is present, it is assumed that it will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
287 work with your ftp client. Otherwise the script will
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
288 prompt for user-id and pasword.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
290 (*3) for ftp, "machine" may be machine#port or machine:port
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 if a different port is needed than the standard ftp port
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 (*4) for http:..., if wget is available it will be used. Otherwise,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 if fetch is available it will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296 Both the :Nread and the :Nwrite ex-commands can accept multiple filenames.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299 NETRC *netrw-netrc*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 The typical syntax for lines in a <.netrc> file is given as shown below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 Ftp under Unix usually support <.netrc>; Windows' ftp usually doesn't.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304 machine {full machine name} login {user-id} password "{password}"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305 default login {user-id} password "{password}"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 Your ftp client must handle the use of <.netrc> on its own, but if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
308 <.netrc> file exists, an ftp transfer will not ask for the user-id or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309 password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 Note:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312 Since this file contains passwords, make very sure nobody else can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313 read this file! Most programs will refuse to use a .netrc that is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314 readable for others. Don't forget that the system administrator can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 still read the file!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 PASSWORD *netrw-passwd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 The script attempts to get passwords for ftp invisibly using |inputsecret()|,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 a built-in Vim function. See |netrw-uidpass| for how to change the password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 after one has set it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 Unfortunately there doesn't appear to be a way for netrw to feed a password
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 to scp. Thus every transfer via scp will require re-entry of the password.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 3. Activation *netrw-activate*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 Network-oriented file transfers are available by default whenever
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 |'nocompatible'| mode is enabled. The <netrw.vim> file resides in your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 system's vim-plugin directory and is sourced automatically whenever you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 bring up vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338 4. Transparent File Transfer *netrw-transparent*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 Transparent file transfers occur whenever a regular file read or write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 (invoked via an |:autocmd| for |BufReadCmd| or |BufWriteCmd| events) is made.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 Thus one may use files across networks as if they were local. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 vim ftp://[user@]machine/path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
346 :wq
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
349 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
350 5. Ex Commands *netrw-ex*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
352 The usual read/write commands are supported. There are also a couple of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
353 additional commands available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
354
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
355 :[range]Nw Write the specified lines to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
356 file as specified in b:netrw_lastfile.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
357
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
358 :[range]Nw {netfile} [{netfile}]...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
359 Write the specified lines to the {netfile}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
360
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
361 :Nread
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362 Read the specified lines into the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
363 buffer from the file specified in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
364 b:netrw_lastfile.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
365
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
366 :Nread {netfile} {netfile}...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367 Read the {netfile} after the current line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 *netrw-uidpass*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 :call NetUserPass()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371 If b:netrw_uid and b:netrw_passwd don't exist,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372 this function query the user for them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
374 :call NetUserPass("userid")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
375 This call will set the b:netrw_uid and, if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
376 the password doesn't exist, will query the user for it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
377
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
378 :call NetUserPass("userid","passwd")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
379 This call will set both the b:netrw_uid and b:netrw_passwd.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
380 The user-id and password are used by ftp transfers. One may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
381 effectively remove the user-id and password by using ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
382 strings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
383
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
384
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
385 ==============================================================================
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
386 6. Variables and Options *netrw-options* *netrw-var*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
387
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
388 The script <netrw.vim> uses several variables which can affect <netrw.vim>'s
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
389 behavior. These variables typically may be set in the user's <.vimrc> file:
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
390 >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
391 -------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
392 Netrw Options
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
393 -------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
394 Option Meaning
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
395 -------------- -----------------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
396 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
397 b:netrw_col Holds current cursor position (during NetWrite)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
398 g:netrw_cygwin =1 assume scp under windows is from cygwin
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
399 (default/windows)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
400 =0 assume scp under windows accepts windows
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
401 style paths (default/else)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
402 g:netrw_ftp =0 use default ftp (uid password)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
403 g:netrw_ftpmode ="binary" (default)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
404 ="ascii" (your choice)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
405 g:netrw_ignorenetrc =1 (default)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
406 if you have a <.netrc> file but you don't
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
407 want it used, then set this variable. Its
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408 mere existence is enough to cause <.netrc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
409 to be ignored.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
410 b:netrw_lastfile Holds latest method/machine/path.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
411 b:netrw_line Holds current line number (during NetWrite)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
412 g:netrw_passwd Holds current password for ftp.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
413 g:netrw_silent =0 transfers done normally
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
414 =1 transfers done silently
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
415 g:netrw_uid Holds current user-id for ftp.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
416 =1 use alternate ftp (user uid password)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
417 (see |netrw-options|)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
418 g:netrw_use_nt_rcp =0 don't use WinNT/2K/XP's rcp (default)
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
419 =1 use WinNT/2K/XP's rcp, binary mode
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
420 g:netrw_win95ftp =0 use unix-style ftp even if win95/98/ME/etc
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
421 =1 use default method to do ftp >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
422 -----------------------------------------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
423 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
424 The script will also make use of the following variables internally, albeit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
425 temporarily.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
426 >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
427 -------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
428 Temporary Variables
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
429 -------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
430 Variable Meaning
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
431 -------- ------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
432 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 g:netrw_method Index indicating rcp/ftp+.netrc/ftp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
434 g:netrw_machine Holds machine name parsed from input
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
435 g:netrw_fname Holds filename being accessed >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
436 ------------------------------------------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
437 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
438 *netrw-protocol*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
440 Netrw supports a number of protocols. These protocols are invoked using the
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
441 variables listed below, and may be modified by the user.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 ------------------------
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
444 Protocol Control Options
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445 ------------------------
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
446 Option Type Setting Meaning
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
447 --------- -------- -------------- ---------------------------
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
448 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
449 netrw_ftp variable =doesn't exist userid set by "user userid"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
450 =0 userid set by "user userid"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
451 =1 userid set by "userid"
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
452 NetReadFixup function =doesn't exist no change
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
453 =exists Allows user to have files
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
454 read via ftp automatically
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
455 transformed however they wish
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
456 by NetReadFixup()
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
457 g:netrw_dav_cmd variable ="cadaver"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
458 g:netrw_fetch_cmd variable ="fetch -o"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
459 g:netrw_ftp_cmd variable ="ftp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
460 g:netrw_http_cmd variable ="fetch -o" else if fetch is executable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461 g:netrw_http_cmd variable ="wget -O" if wget is executable
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
462 g:netrw_list_cmd variable ="ssh HOSTNAME ls -Fa"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 g:netrw_rcp_cmd variable ="rcp"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464 g:netrw_rsync_cmd variable ="rsync -a"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 g:netrw_scp_cmd variable ="scp -q"
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
466 g:netrw_sftp_cmd variable ="sftp" >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
467 -------------------------------------------------------------------------
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 <
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
469 *netrw-ftp*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 The first two options both help with certain ftp's that give trouble otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 In order to best understand how to use these options if ftp is giving you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 troubles, a bit of discussion follows on how netrw does ftp reads.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
473
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 The g:netrw_..._cmd variables specify the external program to use handle
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 the associated protocol (rcp, ftp, etc), plus any options.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
477 The g:netrw_list_cmd's HOSTNAME entry will be changed via substitution with
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
478 whatever the current request is for a hostname.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
479
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
480 For ftp, netrw typically builds up lines of one of the following formats in a
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481 temporary file:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 IF g:netrw_ftp !exists or is not 1 IF g:netrw_ftp exists and is 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 ---------------------------------- ------------------------------
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
485 <
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
486 open machine [port] open machine [port]
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
487 user userid password userid password
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
488 [g:netrw_ftpmode] password
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
489 get filename tempfile [g:netrw_ftpmode]
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
490 get filename tempfile >
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
491 ---------------------------------------------------------------------
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 Netrw then executes the lines above by use of a filter:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
495 :%! {g:netrw_ftp_cmd} -i [-n]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
497
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
499 g:netrw_ftp_cmd is usually "ftp",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
500 -i tells ftp not to be interactive
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
501 -n means don't use netrc and is used for Method #3 (ftp w/o <.netrc>)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
502
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
503 If <.netrc> exists it will be used to avoid having to query the user for
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
504 userid and password. The transferred file is put into a temporary file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
505 The temporary file is then read into the main editing session window that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
506 requested it and the temporary file deleted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 If your ftp doesn't accept the "user" command and immediately just demands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509 a userid, then try putting "let netrw_ftp=1" in your <.vimrc>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
510
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
511 *netrw-cadaver*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
512 To handle the SSL certificate dialog for untrusted servers, one may pull
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
513 down the certificate and place it into /usr/ssl/cert.pem. This operation
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
514 renders the server treatment as "trusted".
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
515
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
516 *netrw-fixup* *netreadfixup*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 If your ftp for whatever reason generates unwanted lines (such as AUTH
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 messages) you may write a NetReadFixup(tmpfile) function:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 function! NetReadFixup(method,line1,line2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 " a:line1: first new line in current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 " a:line2: last new line in current file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
523 if a:method == 1 "rcp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524 elseif a:method == 2 "ftp + <.netrc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525 elseif a:method == 3 "ftp + machine,uid,password,filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526 elseif a:method == 4 "scp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527 elseif a:method == 5 "http/wget
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528 elseif a:method == 6 "dav/cadaver
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 elseif a:method == 7 "rsync
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 elseif a:method == 8 "fetch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531 elseif a:method == 9 "sftp
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
532 else " complain
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
534 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
535 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 The NetReadFixup() function will be called if it exists and thus allows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537 you to customize your reading process. As a further example, <netrw.vim>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 contains just such a function to handle Windows 95 ftp. For whatever
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539 reason, Windows 95's ftp dumps four blank lines at the end of a transfer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
540 and so it is desirable to automate their removal. Here's some code taken
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
541 from <netrw.vim> itself:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
542 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
543 if has("win95") && g:netrw_win95ftp
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
544 fun! NetReadFixup(method, line1, line2)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
545 if method == 3 " ftp (no <.netrc>)
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
546 let fourblanklines= line2 - 3
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
547 silent fourblanklines.",".line2."g/^\s*/d"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 ==============================================================================
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
554 7. Directory Browser *netrw-browse* *netrw-dir* *netrw-list* *netrw-help*
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
555
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
556 MAPS *netrw-maps*
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
557 ?................Help.......................................|netrw-help|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
558 <cr>.............Browsing...................................|netrw-cr|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
559 <del>............Deleting Files or Directories..............|netrw-delete|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
560 -................Going Up...................................|netrw--|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
561 a................Hiding Files or Directories................|netrw-a|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
562 b................Bookmarking a Directory....................|netrw-b|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
563 B................Changing to a Bookmarked Directory.........|netrw-B|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
564 c................Make Browsing Directory The Current Dir....|netrw-c|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
565 d................Make A New Directory.......................|netrw-d|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
566 D................Deleting Files or Directories..............|netrw-D|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
567 <c-h>............Edit File/Directory Hiding List............|netrw-h|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
568 i................Long Listing...............................|netrw-i|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
569 <c-l>............Refreshing the Listing.....................|netrw-ctrl-l|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
570 o................Browsing with a Horizontal Split...........|netrw-o|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
571 p................Preview Window.............................|netrw-p|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
572 q................Listing Bookmarks and History..............|netrw-q|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
573 r................Reversing Sorting Order....................|netrw-r|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
574 R................Renaming Files or Directories..............|netrw-R|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
575 s................Selecting Sorting Style....................|netrw-s|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
576 S................Editing the Sorting Sequence...............|netrw-S|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
577 u................Changing to a Predecessor Directory........|netrw-u|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
578 U................Changing to a Successor Directory..........|netrw-U|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
579 v................Browsing with a Vertical Split.............|netrw-v|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
580 x................Customizing Browsing.......................|netrw-x|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
581
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
582 COMMANDS *netrw-explore-cmds*
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
583 :Explore[!] [dir].Explore directory of current file........|netrw-explore|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
584 :Sexplore[!] [dir].Split & Explore directory of current file|netrw-explore|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
585 :Hexplore[!] [dir].Horizontal Split & Explore...............|netrw-explore|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
586 :Vexplore[!] [dir].Vertical Split & Explore.................|netrw-explore|
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
587 :Pexplore[!] [dir].Vertical Split & Explore.................|netrw-explore|
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
588 :Nexplore[!] [dir].Vertical Split & Explore.................|netrw-explore|
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
589
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
590 QUICK REFERENCE COMMANDS TABLE *netrw-browse-cmds*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
591 >
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
592 ------- -----------
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
593 Command Explanation
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
594 ------- -----------
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
595 < ? Causes Netrw to issue help
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
596 <cr> Netrw will enter the directory or read the file
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
597 <del> Netrw will attempt to remove the file/directory
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
598 d Make a directory
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
599 D Netrw will attempt to remove the file(s)/directory(ies)
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
600 R Netrw will attempt to rename the file(s)/directory(ies)
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
601 - Makes Netrw go up one directory
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
602 a Toggles between normal display,
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
603 hiding (suppress display of files matching g:netrw_list_hide)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
604 showing (display only files which match g:netrw_list_hide)
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
605 c Make current browsing directory the current directory
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
606 <c-h> Edit file hiding list
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
607 i Toggles between long and short listing
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
608 <c-l> Causes Netrw to refresh the directory listing
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
609 o Enter the file/directory under the cursor in a new browser
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
610 window. A horizontal split is used.
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
611 p Preview the file
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
612 r Reverse sorting order
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
613 s Select sorting style: by name, time, or file size
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
614 v Enter the file/directory under the cursor in a new browser
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
615 window. A vertical split is used.
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
616 x Apply a function to a file.
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
617
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
618 NETRW BROWSER VARIABLES *netrw-browse-var*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
619 >
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
620 --- -----------
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
621 Var Explanation
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
622 --- -----------
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
623 < g:netrw_alto change from above splitting to
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
624 below splitting by setting this
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
625 variable (see |netrw-o|)
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
626 default: =0
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
627
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
628 g:netrw_altv change from left splitting to
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
629 right splitting by setting this
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
630 variable (see |netrw-v|)
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
631 default: =0
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
632
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
633 g:netrw_ftp_browse_reject ftp can produce a number of errors
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
634 and warnings that can show up as
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
635 "directories" and "files" in the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
636 listing. This pattern is used to
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
637 remove such embedded messages. By
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
638 default its value is:
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
639 '^total\s\+\d\+$\|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
640 ^Trying\s\+\d\+.*$\|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
641 ^KERBEROS_V\d rejected\|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
642 ^Security extensions not\|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
643 No such file\|
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
644 : connect to address [0-9a-fA-F:]*
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
645 : No route to host$'
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
646
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
647 g:netrw_ssh_browse_reject ssh can sometimes produce unwanted
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
648 lines/messages/banners/and whatnot
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
649 that one doesn't want masquerading
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
650 as "directories" and "files". Use
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
651 this pattern to remove such embedded
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
652 messages. By default its value is:
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
653 '^total\s\+\d\+$'
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
654
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
655 g:netrw_keepdir =1 (default) keep current directory
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
656 immune from the browsing directory.
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
657 =0 keep the current directory the
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
658 same as the browsing directory.
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
659 The browsing directory is contained in
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
660 b:netrw_curdir
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
661
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
662 g:netrw_list_cmd command for listing remote directories
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
663 default: (if ssh is executable)
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
664 "ssh HOSTNAME ls -FLa"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
665
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
666 g:netrw_longlist if =1, then long listing will be default
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
667
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
668 g:netrw_ftp_list_cmd options for passing along to ftp for
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
669 directory listing. Defaults:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
670 unix or g:netrw_cygwin set: : "ls -lF"
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
671 otherwise "dir"
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
672
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
673 g:netrw_list_hide comma separated list of patterns for
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
674 hiding files
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
675 default: ""
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
676
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
677 g:netrw_local_mkdir command for making a local directory
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
678 default: "ssh HOSTNAME mkdir"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
679
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
680 g:netrw_local_rmdir remove directory command (rmdir)
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
681 default: "rmdir"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
682
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
683 g:netrw_maxfilenamelen =32 by default, selected so as to make
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
684 long listings fit on 80 column displays.
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
685 If your screen is wider, and you have
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
686 file/directory names longer than 32 bytes,
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
687 you may set this option to keep listings
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
688 columnar.
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
689
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
690 g:netrw_mkdir_cmd command for making a remote directory
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
691 default: "ssh HOSTNAME mkdir"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
692
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
693 g:netrw_rm_cmd command for removing files
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
694 default: "ssh HOSTNAME rm"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
695
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
696 g:netrw_rmdir_cmd command for removing directories
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
697 default: "ssh HOSTNAME rmdir"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
698
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
699 g:netrw_rmf_cmd command for removing softlinks
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
700 default: "ssh HOSTNAME rm -f"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
701
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
702 g:netrw_hide if true, the hiding list is used
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
703 default: =0
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
704
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
705 g:netrw_sort_by sort by "name", "time", or "size"
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
706 default: "name"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
707
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
708 g:netrw_sort_direction sorting direction: "normal" or "reverse"
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
709 default: "normal"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
710
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
711 g:netrw_sort_sequence when sorting by name, first sort by the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
712 comma-separated pattern sequence
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
713 default: '[\/]$,*,\.bak$,\.o$,\.h$,
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
714 \.info$,\.swp$,\.obj$'
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
715
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
716 g:netrw_timefmt specify format string to strftime() (%c)
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
717 default: "%c"
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
718
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
719 g:netrw_winsize specify initial size of new o/v windows
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
720 default: ""
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
721
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
722 INTRODUCTION TO DIRECTORY BROWSING *netrw-browse-intro*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
723
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
724 Netrw supports the browsing of directories on the local system and on remote
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
725 hosts, including generating listing directories, entering directories, editing
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
726 files therein, deleting files/directories, making new directories, and moving
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
727 (renaming) files and directories. The Netrw browser generally implements the
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
728 previous explorer maps and commands for remote directories, although details
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
729 (such as pertinent global variable names) necessarily differ.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
730
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
731 The Netrw remote file and directory browser handles two protocols: ssh and
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
732 ftp. The protocol in the url, if it is ftp, will cause netrw to use ftp
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
733 in its remote browsing. Any other protocol will be used for file transfers,
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
734 but otherwise the ssh protocol will be used to do remote directory browsing.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
735
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
736 To enter the netrw directory browser, simply attempt to read a "file" with a
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
737 trailing slash and it will be interpreted as a request to list a directory:
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
738
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
739 vim [protocol]://[user@]hostname/path/
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
740
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
741 If you'd like to avoid entering the password in for directory listings, scp,
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
742 ssh interaction, etc, see |netrw-list-hack|.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
743
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
744 *netrw-explore* *netrw-pexplore*
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
745 *netrw-hexplore* *netrw-sexplore*
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
746 DIRECTORY EXPLORING COMMANDS *netrw-nexplore* *netrw-vexplore*
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
747
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
748 :Explore[!] [dir]... Explore directory of current file
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
749 :Sexplore[!] [dir]... Split & Explore directory of current file
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
750 :Hexplore[!] [dir]... Horizontal Split & Explore
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
751 :Vexplore[!] [dir]... Vertical Split & Explore
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
752 :Nexplore............. used with **/patterns; go to next matching file
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
753 :Pexplore............. used with **/patterns; go to previous matching file
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
754
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
755 The Explore command will open the local-directory browser on the current
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
756 file's directory (or on directory [dir] if specified). The window will be
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
757 split only if the file has been modified, otherwise the browsing window will
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
758 take over that window. Normally the splitting is taken horizontally; the
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
759 optional ! will use vertical splitting.
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
760
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
761 Sexplore will always split the window before invoking the local-directory
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
762 browser. As with Explore, the splitting is normally done horizontally, but
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
763 with the optional ! the splitting will be done vertically.
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
764
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
765 Hexplore does an Explore with |belowright| horizontal splitting; the
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
766 optional ! does the Explore with |aboveleft| horizontal splitting.
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
767
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
768 Vexplore does an Explore with |leftabove| vertical splitting; the
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
769 optional "!" does an Explore with |topleft| vertical splitting.
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
770
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
771 (Following needs v7.0 or later) *netrw-starstar*
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
772 When Explore, Sexplore, Hexplore, or Vexplore are used like
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
773 >
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
774 :Explore **/filename_pattern
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
775 <
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
776 netrw will attempt to find a (sub)directory which matches the filename
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
777 pattern. Internally, it produces a list of files which match the pattern
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
778 and their paths; to that extent it resembles the Unix operation:
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
779 >
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
780 find $(pwd) -name "$1" -exec "echo" "{}" ";" 2> /dev/null
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
781 <
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
782 The directory display is updated to show the subdirectory containing a
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
783 matching file. One may then proceed to the next (or previous) matching files'
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
784 directories by using Nexplore or Pexplore, respectively. If your console or
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
785 gui produces recognizable shift-up or shift-down sequences, then you'll likely
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
786 find the following mappings convenient:
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
787
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
788 <s-down> == Nexplore, and
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
789 <s-up> == Pexplore.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
790
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
791 As an example, consider
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
792 >
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
793 :Explore **/*.c
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
794 :Nexplore
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
795 :Nexplore
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
796 :Pexplore
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
797 <
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
798 The status line will show, on the right hand side of the status line, a
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
799 message like "Match 3 of 20".
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
800
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
801
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
802 REFRESHING THE LISTING *netrw-ctrl-l*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
803
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
804 To refresh either a local or remote directory listing, press ctrl-l (<c-l>) or
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
805 hit the <cr> when atop the ./ directory entry in the listing. One may also
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
806 refresh a local directory by using ":e .".
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
807
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
808
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
809 GOING UP *netrw--*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
810
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
811 To go up a directory, press - or his the <cr> when atop the ../ directory
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
812 entry in the listing.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
813
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
814 Netrw will modify the command in *g:netrw_list_cmd* to perform the directory
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
815 listing operation. By default the command is:
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
816
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
817 ssh HOSTNAME ls -FLa
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
818
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
819 where the HOSTNAME becomes the [user@]hostname as requested by the attempt to
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
820 read. Naturally, the user may override this command with whatever is
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
821 preferred. The NetList function which implements remote directory browsing
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
822 expects that directories will be flagged by a trailing slash.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
823
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
824
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
825 BROWSING *netrw-cr*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
826
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
827 Browsing is simple: move the cursor onto a file or directory of interest.
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
828 Hitting the <cr> (the return key) will select the file or directory.
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
829 Directories will themselves be listed, and files will be opened using the
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
830 protocol given in the original read request.
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
831
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
832
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
833 LONG VS SHORT LISTING *netrw-i*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
834
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
835 The short listing format gives just the files' and directories' names.
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
836 The long listing is either based on the "ls" command via ssh for remote
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
837 directories or displays the filename, file size (in bytes), and the
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
838 time and date of last modification for local directories.
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
839
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
840
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
841 MAKING A NEW DIRECTORY *netrw-d*
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
842
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
843 With the "d" map one may make a new directory either remotely (which
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
844 depends on the global variable g:netrw_mkdir_cmd) or locally (which depends on
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
845 the global variable g:netrw_local_mkdir). Netrw will issue a request for the
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
846 new directory's name. A bare <CR> at that point will abort the making of the
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
847 directory. Attempts to make a local directory that already exists (as either
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
848 a file or a directory) will be detected, reported on, and ignored.
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
849
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
850
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
851 DELETING FILES OR DIRECTORIES *netrw-delete* *netrw-D*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
852
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
853 Deleting/removing files and directories involves moving the cursor to the
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
854 file/directory to be deleted and pressing "D". Directories must be empty first
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
855 before they can be successfully removed. If the directory is a softlink to a
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
856 directory, then netrw will make two requests to remove the directory before
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
857 succeeding. Netrw will ask for confirmation before doing the removal(s).
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
858 You may select a range of lines with the "V" command (visual selection),
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
859 and then pressing "D".
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
860
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
861 *g:netrw_rm_cmd*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
862 The g:netrw_rm_cmd, g:netrw_rmf_cmd, and g:netrw_rmdir_cmd variables are used
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
863 to control the attempts to remove files and directories. The g:netrw_rm_cmd
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
864 is used with files, and its default value is:
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
865
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
866 g:netrw_rm_cmd: ssh HOSTNAME rm
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
867
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
868 *g:netrw_rmdir_cmd*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
869 The g:netrw_rmdir_cmd variable is used to support the removal of directories.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
870 Its default value is:
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
871
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
872 g:netrw_rmdir_cmd: ssh HOSTNAME rmdir
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
873
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
874 *g:netrw_rmf_cmd*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
875 If removing a directory fails with g:netrw_rmdir_cmd, netrw then will attempt
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
876 to remove it again using the g:netrw_rmf_cmd variable. Its default value is:
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
877
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
878 g:netrw_rmf_cmd: ssh HOSTNAME rm -f
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
879
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
880
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
881 RENAMING FILES OR DIRECTORIES *netrw-move* *netrw-rename* *netrw-R*
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
882
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
883 Renaming/moving files and directories involves moving the cursor to the
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
884 file/directory to be moved (renamed) and pressing "R". You will then be
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
885 queried for where you want the file/directory to be moved. You may select a
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
886 range of lines with the "V" command (visual selection), and then pressing "R".
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
887
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
888 The g:netrw_rename_cmd variable is used to implement renaming. By default its
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
889 value is:
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
890
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
891 ssh HOSTNAME mv
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
892
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
893 One may rename a block of files and directories by selecting them with
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
894 the V (|linewise-visual|).
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
895
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
896
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
897 HIDING FILES OR DIRECTORIES *g:netrw-a* *g:netrw_list_hide*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
898
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
899 Netrw's browsing facility allows one to use the hiding list in one of
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
900 three ways: ignore it, hide files which match, and show only those files
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
901 which match. The "a" map allows the user to cycle about these three ways.
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
902
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
903 The g:netrw_list_hide variable holds a comma delimited list of patterns
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
904 (ex. \.obj) which specify the hiding list. (also see |netrw-h|) To
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
905 set the hiding list, use the <c-h> map. As an example, to hide files
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
906 which begin with a ".", one may use the <c-h> map to set the hiding
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
907 list to '^\..*' (or one may put let g:netrw_list_hide= '^\..*' in
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
908 one's <.vimrc>). One may then use the "a" key to show all files,
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
909 hide matching files, or to show only the matching files.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
910
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
911
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
912 EDIT FILE OR DIRECTORY HIDING LIST *netrw-h* *netrw-edithide*
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 12
diff changeset
913
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
914 The "<ctrl-h>" map brings up a requestor allowing the user to change the
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
915 file/directory hiding list. The hiding list consists of one or more patterns
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
916 delimited by commas. Files and/or directories satisfying these patterns will
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
917 either be hidden (ie. not shown) or be the only ones displayed (see |netrw-a|).
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
918
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
919
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
920 BROWSING WITH A HORIZONTALLY SPLIT WINDOW *netrw-o* *netrw-horiz*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
921
21
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
922 Normally one enters a file or directory using the <cr>. However, the "o" map
db5102f7e29f updated for version 7.0013
vimboss
parents: 15
diff changeset
923 allows one to open a new window to hold the new directory listing or file. A
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
924 horizontal split is used. (for vertical splitting, see |netrw-v|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
925
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
926 Normally, the o key splits the window horizontally with the new window
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
927 and cursor at the top. To change to splitting the window horizontally
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
928 with the new window and cursor at the bottom, have
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
929
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
930 let g:netrw_alto = 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
931
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
932 in your <.vimrc>.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
933
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
934
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
935 PREVIEW WINDOW *netrw-p* *netrw-preview*
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
936
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
937 One may use a preview window (currently only for local browsing) by using
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
938 the "p" key when the cursor is atop the desired filename to be previewed.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
939
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
940
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
941 SELECTING SORTING STYLE *netrw-s* *netrw-sort*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
942
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
943 One may select the sorting style by name, time, or (file) size. The
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
944 "s" map allows one to circulate among the three choices; the directory
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
945 listing will automatically be refreshed to reflect the selected style.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
946
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
947
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
948 EDITING THE SORTING SEQUENCE *netrw-S* *netrw-sortsequence*
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
949
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
950 When "Sorted by" is name, one may specify priority via the sorting
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
951 sequence (g:netrw_sort_sequence). The sorting sequence typically
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
952 prioritizes the name-listing by suffix, although any pattern will do.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
953 Patterns are delimited by commas. The default sorting sequence is:
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
954 >
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
955 /$,*,\.bak$,\.o$,\.h$,\.info$,\.swp$,\.obj$
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
956 <
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
957 The lone * is where all filenames not covered by one of the other
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
958 patterns will end up. One may change the sorting sequence by modifying
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
959 the g:netrw_sort_sequence variable (either manually or in your <.vimrc>)
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
960 or by using the "S" map.
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
961
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
962
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
963 REVERSING SORTING ORDER *netrw-r* *netrw-reverse*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
964
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
965 One may toggle between normal and reverse sorting order by pressing the
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
966 "r" key.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
967
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
968
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
969 CHANGING TO A PREDECESSOR DIRECTORY *netrw-u* *netrw-updir*
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
970
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
971 Every time you change to a new directory (new for the current session),
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
972 netrw will save the directory in a recently-visited directory history
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
973 list (unless g:netrw_dirhistmax is zero; by default, its ten). With the
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
974 "u" map, one can change to an earlier directory (predecessor). To do
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
975 the opposite, see |netrw-U|.
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
976
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
977
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
978 CHANGING TO A SUCCESSOR DIRECTORY *netrw-U* *netrw-downdir*
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
979
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
980 With the "U" map, one can change to a later directory (successor).
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
981 This map is the opposite of the "u" map. (see |netrw-u|) Use the
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
982 q map to list both the bookmarks and history. (see |netrw-q|)
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
983
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
984
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
985 BROWSING WITH A VERTICALLY SPLIT WINDOW *netrw-v*
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
986
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
987 Normally one enters a file or directory using the <cr>. However, the "v"
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
988 map allows one to open a new window to hold the new directory listing or
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
989 file. A vertical split is used. (for horizontal splitting, see |netrw-o|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
990
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
991 Normally, the v key splits the window vertically with the new window
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
992 and cursor at the left. To change to splitting the window vertically
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
993 with the new window and cursor at the right, have
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
994
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
995 let g:netrw_altv = 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
996
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
997 in your <.vimrc>.
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
998
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
999
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1000 CUSTOMIZING BROWSING WITH A USER FUNCTION *netrw-x* *netrw-handler*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1001
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1002 One may "enter" a file with a special handler, thereby firing up a browser or
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1003 other application, for example, on a file by hitting the "x" key. Presumably
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1004 one could write handlers that would start OpenOffice programs (oowriter), etc,
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1005 based on the file's extension coupled with the user's hitting the "x" key atop
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1006 the file.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1007
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1008 The Netrw executor applies a user-defined function to a file, based on its
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1009 extension. Of course, the handler function must exist for it to be called!
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1010 >
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1011 Ex. mypgm.html x ->
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1012 NetrwFileHandler_html("scp://user@host/some/path/mypgm.html")
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1013 <
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1014 See the <plugin/NetrwFileHandlers.vim> for an example of how to handle an html
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1015 file with mozilla.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1016
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1017
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1018 MAKING THE BROWSING DIRECTORY THE CURRENT DIRECTORY *netrw-c* *netrw-curdir*
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1019
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1020 By default, g:netrw_keepdir is 1. This setting means that the current
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1021 directory will not track the browsing directory. However, setting
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1022 g:netrw_keepdir to 0 (say, in your <.vimrc>) will tell netrw to have the
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1023 currently browsed directory be the current directory.
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1024
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1025 With the default setting for g:netrw_keepdir, in order to make the two
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1026 directories the same, use the "c" map (just type c). That map will set
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1027 the current directory to the current browsing directory.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1028
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1029
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1030 BOOKMARKING A DIRECTORY *netrw-b* *netrw-bookmark* *netrw-bookmarks*
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1031
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1032 One may easily "bookmark" a directory by using >
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1033
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1034 {cnt}b
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1035 <
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1036 Any count may be used. One may use viminfo's "!" option to retain bookmarks
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1037 between vim sessions. See |netrw-B| for how to return to a bookmark and
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1038 |netrw-q| for how to list them.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1039
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1040
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1041 CHANGING TO A BOOKMARKED DIRECTORY *netrw-B*
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1042
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1043 To change directory back to a bookmarked directory, use
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1044
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1045 {cnt}B
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1046
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1047 Any count may be used to reference any of the bookmarks. See |netrw-b|
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1048 for how to bookmark a directory and |netrw-q| for how to list them.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1049
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1050
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1051 LISTING BOOKMARKS AND HISTORY *netrw-q* *netrw-listbookmark*
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1052
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1053 Pressing "q" will list the bookmarked directories and directory traversal
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1054 history (query). (see |netrw-b|, |netrw-B|, |netrw-u|, and |netrw-U|)
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1055
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1056
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1057 IMPROVING DIRECTORY BROWSING *netrw-listhack*
12
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1058
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1059 Especially with the remote directory browser, constantly entering the password
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1060 is tedious.
bdeee1504ac1 updated for version 7.0004
vimboss
parents: 11
diff changeset
1061
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
1062 For Linux/Unix systems, I suggest looking into
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
1063
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
1064 http://hacks.oreilly.com/pub/h/66
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
1065
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
1066 It gives a tip for setting up password-less use of ssh and scp, and discusses
4424b47a0797 updated for version 7.0003
vimboss
parents: 9
diff changeset
1067 the associated security issues.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1068
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1069
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1070 ==============================================================================
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1071 8. Problems and Fixes *netrw-problems*
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1072
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1073 (This section is likely to grow as I get feedback)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1074 (also see |netrw-debug|)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1075
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1076 P1. I use windows 95, and my ftp dumps four blank lines at the
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1077 end of every read.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1078
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1079 See |netrw-fixup|, and put the following into your
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1080 <.vimrc> file:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1081
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1082 let g:netrw_win95ftp= 1
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1083
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1084
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1085
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1086 P2. I use windows, and my network browsing with ftp doesn't sort by
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1087 time or size
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1088
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1089 Windows' ftp has a minimal support for ls (ie. it doesn't
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1090 accept sorting options). It doesn't support the -F which
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1091 gives an explanatory character (ABC/ for "ABC is a directory").
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1092 Netrw uses dir to get its short and long listings. If you
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1093 think your ftp does support a full-up ls, put the following
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1094 into your <.vimrc>:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1095
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1096 let g:netrw_ftp_list_cmd= "ls -lF"
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1097
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1098 Alternatively, if you have cygwin on your Windows box, put
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1099 into your <.vimrc>:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1100
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1101 let g:netrw_cygwin= 1
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1102
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1103 P3. I tried rcp://user@host/ (or protocol other than ftp) and netrw
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1104 used ssh! That wasn't what I asked for...
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1105
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1106 Netrw has two methods for browsing remote directories: ssh
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1107 and ftp. Unless you specify ftp specifically, ssh is used.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1108 When it comes time to do download a file (not just a directory
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1109 listing), netrw will use the given protocol to do so.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1110
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1111 P4. I would like long listings to be the default.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1112
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1113 let g:netrw_longlist=1
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1114
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1115 Check out |netrw-browse-var| for more customizations that
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1116 you can set.
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1117
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1118 P5. My times come up oddly in local browsing
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1119
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1120 Does your system's strftime() accept the "%c" to yield dates
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1121 such as "Sun Apr 27 11:49:23 1997"? If not, do a "man strftime"
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1122 and find out what option should be used. Then put it into
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1123 your <.vimrc>:
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1124 let g:netrw_timefmt= "%X" (where X is the option)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1125
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1126 P6. I want my current directory to track my browsing.
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1127 How do I do that?
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1128
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1129 let g:netrw_keepdir= 0
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1130
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1131
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1132 ==============================================================================
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1133 9. Debugging *netrw-debug*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1134
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1135 The <netrw.vim> script is typically available as:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1136
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1137 /usr/local/share/vim/vim6x/plugin/netrw.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1138
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1139 which is loaded automatically at startup (assuming :set nocp).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1140
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1141 1. Get the <Decho.vim> script, available as:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1142
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1143 http://mysite.verizon.net/astronaut/vim/index.html#vimlinks_scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1144 as "Decho, a vimL debugging aid"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1145 or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1146 http://vim.sourceforge.net/scripts/script.php?script_id=120
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1147
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1148 and put it into your local plugin directory.
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1149
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1150 2. <Decho.vim> itself needs the <cecutil.vim> script, so you'll need
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1151 to put it into your .vim/plugin, too. You may obtain it from:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1152
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1153 http://mysite.verizon.net/astronaut/vim/index.html#VimFuncs
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1154 as "DrC's Utilities"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1155
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1156 3. Edit the <netrw.vim> file by typing:
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1157
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1158 vim netrw.vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1159 :DechoOn
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1160 :wq
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1161
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1162 To restore to normal non-debugging behavior, edit <netrw.vim>
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1163 by typing
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1164
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1165 vim netrw.vim
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1166 :DechoOff
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1167 :wq
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1168
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1169 This command, provided by <Decho.vim>, will comment out all
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1170 Decho-debugging statements (Dfunc(), Dret(), Decho(), Dredir()).
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1171
cc049b00ee70 updated for version 7.0014
vimboss
parents: 21
diff changeset
1172 4. Then bring up vim and attempt a transfer. A set of messages
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1173 should appear concerning the steps that <netrw.vim> took in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1174 attempting to read/write your file over the network. Please
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1175 send that information to <netrw.vim>'s maintainer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1176
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1177 NdrOchip at ScampbellPfamily.AbizM - NOSPAM
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1178
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1179 ==============================================================================
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1180 10. History *netrw-history*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1181
466
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1182 v59: * bugfix -- another keepalt work-around installed (for vim6.3)
7a01bd1ac566 updated for version 7.0125
vimboss
parents: 464
diff changeset
1183 * "Match # of #" for Explore **/pattern matches
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1184 v58: * Explore and relatives can now handle **/somefilepattern (v7)
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1185 * Nexplore and Pexplore introduced (v7). shift-down and shift-up
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1186 cursor keys will invoke Nexplore and Pexplore, respectively.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1187 * bug fixed with o and v
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1188 * autochdir only worked around for vim when it has been
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1189 compiled with either |+netbeans_intg| or |+sun_workshop|
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1190 * Under Windows, all directories and files were being preceded
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1191 with a "/" when local browsing. Fixed.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1192 * When: syntax highlighting is off, laststatus=2, and remote
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1193 browsing is used, sometimes the laststatus highlighting
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1194 bleeds into the entire display. Work around - do an extra
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1195 redraw in that case.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1196 * Bugfix: when g:netrw_keepdir=0, due to re-use of buffers,
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1197 netrw didn't change the directory when it should've
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 461
diff changeset
1198 * Bugfix: D and R commands work again
461
f98374445f66 updated for version 7.0123
vimboss
parents: 459
diff changeset
1199 v57: * Explore and relatives can now handle RO files
f98374445f66 updated for version 7.0123
vimboss
parents: 459
diff changeset
1200 * reverse sort restored with vim7's sort command
f98374445f66 updated for version 7.0123
vimboss
parents: 459
diff changeset
1201 * g:netrw_keepdir now being used to keep the current directory
f98374445f66 updated for version 7.0123
vimboss
parents: 459
diff changeset
1202 unchanged as intended (sense change)
f98374445f66 updated for version 7.0123
vimboss
parents: 459
diff changeset
1203 * vim 6.3 still supported
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1204 v56: * LocalBrowse now saves autochdir setting, unsets it, and
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1205 restores it before returning.
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1206 * using vim's rename() instead of system + local_rename variable
461
f98374445f66 updated for version 7.0123
vimboss
parents: 459
diff changeset
1207 * avoids changing directory when g:netrw_keepdir is false
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1208 v55: * -bar used with :Explore :Sexplore etc to allow multiple
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1209 commands to be separated by |s
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1210 * browser listings now use the "nowrap" option
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1211 * browser: some unuseful error messages now suppressed
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1212 v54: * For backwards compatibility, Explore and Sexplore have been
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1213 implemented. In addition, Hexplore and Vexplore commands
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1214 are available, too.
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1215 * <amatch> used instead of <afile> in the transparency
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1216 support (BufReadCmd, FileReadCmd, FileWriteCmd)
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1217 * ***netrw*** prepended to various error messages netrw may emit
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1218 * g:netrw_port used instead of b:netrw_port for scp
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1219 * any leading [:#] is removed from port numbers
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1220 v53: * backslashes as well as slashes placed in various patterns
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1221 (ex. g:netrw_sort_sequence) to better support Windows
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1222 v52: * nonumber'ing now set for browsing buffers
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1223 * when the hiding list hid all files, error messages ensued. Fixed
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1224 * when browsing, swf is set, but directory is not set, when netrw
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1225 was attempting to restore options, vim wanted to save a swapfile
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1226 to a local directory using an url-style path. Fixed
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1227 v51: * cygwin detection now automated (using windows and &shell is bash)
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1228 * customizable browser "file" rejection patterns
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1229 * directory history
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1230 * :[range]w url now supported (ie. netrw has a FileWriteCmd event)
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1231 * error messages have a "Press <cr> to continue" to allow them
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1232 to be seen
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1233 * directory browser displays no longer bother the swapfile
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1234 * u/U commands to go up and down the history stack
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1235 * history stack may be saved with viminfo with its "!" option
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1236 * bugfixes associated with unwanted [No Files] entries
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1237 v50: * directories now displayed using buftype=nofile; should keep the
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1238 directory names as-is
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1239 * attempts to remove empty "[No File]" buffers leftover
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1240 from :file ..name.. commands
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1241 * bugfix: a "caps-lock" editing difficulty left in v49 was fixed
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1242 * syntax highlighting for "Showing:" the hiding list included
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1243 * bookmarks can now be retained if "!" is in the viminfo option
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1244 v49: * will use ftp for http://.../ browsing v48:
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1245 * One may use ftp to do remote host file browsing
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1246 * (windows and !cygwin) remote browsing with ftp can now use
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1247 the "dir" command internally to provide listings
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1248 * g:netrw_keepdir now allows one to keep the initial current
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1249 directory as the current directory (normally the local file
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1250 browser makes the currently viewed directory the current
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1251 directory)
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1252 * g:netrw_alto and g:netrw_altv now support alternate placement
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1253 of windows started with o or v
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1254 * Nread ? and Nwrite ? now uses echomsg (instead of echo) so
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1255 :messages can repeat showing the help
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1256 * bugfix: avoids problems with partial matches of directory names
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1257 to prior buffers with longer names
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1258 * one can suppress error messages with g:netrw_quiet ctrl-h used
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1259 * instead of <Leader>h for editing hiding list one may edit the
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1260 * sorting sequence with the S map now allows confirmation of
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1261 * deletion with [y(es) n(o) a(ll) q(uit)] the "x" map now handles
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1262 * special file viewing with:
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1263 (windows) rundll32 url.dll (gnome) gnome-open (kde)
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1264 kfmclient If none of these are on the executable path, then
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1265 NetrwFileHandlers.vim is used.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1266 * directory bookmarking during both local and remote browsing
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1267 implemented
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1268 * one may view all, use the hiding list to suppress, or use the
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1269 hiding list to show-only remote and local file/directory
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1270 listings
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1271 * improved unusual file and directory name handling preview
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1272 * window support
36
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1273 v47: * now handles local directory browsing.
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1274 v46: * now handles remote directory browsing
125e80798a85 updated for version 7.0021
vimboss
parents: 26
diff changeset
1275 * g:netrw_silent (if 1) will cause all transfers to be silent
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1276 v45: * made the [user@]hostname:path form a bit more restrictive to
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1277 better handle errors in using protocols (e.g. scp:usr@host:file
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1278 was being recognized as an rcp request) v44: * changed from
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1279 "rsync -a" to just "rsync"
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1280 * somehow an editing error messed up the test to recognize
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1281 use of the fetch method for NetRead.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1282 * more debugging statements included
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1283 v43: * moved "Explanation" comments to <pi_netrw.txt> help file as
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1284 "Network Reference" (|netrw-ref|)
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1285 * <netrw.vim> now uses Dfunc() Decho() and Dret() for debugging
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1286 * removed superfluous NetRestorePosn() calls
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1287 v42: * now does BufReadPre and BufReadPost events on file:///* and
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1288 file://localhost/* v41: * installed file:///* and
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1289 file://localhost/* handling v40: * prevents redraw when a
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1290 protocol error occurs so that the user may see it v39: * sftp
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1291 support v38: * Now uses NetRestorePosn() calls with
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1292 Nread/Nwrite commands
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1293 * Temporary files now removed via bwipe! instead of bwipe
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1294 (thanks to Dave Roberts) v37: * Claar's modifications which
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1295 test if ftp is successful, otherwise give an error message
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1296 * After a read, the alternate file was pointing to the temp file.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1297 The temp file buffer is now wiped out.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1298 * removed silent from transfer methods so user can see what's
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1299 happening
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1300
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1301
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1302 ==============================================================================
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1303 11. Credits *netrw-credits*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1304
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1305 Vim editor by Bram Moolenaar (Thanks, Bram!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1306 dav support by C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1307 fetch support by Bram Moolenaar and C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1308 ftp support by C Campbell <NdrOchip@ScampbellPfamily.AbizM> - NOSPAM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1309 http support by Bram Moolenaar <bram@moolenaar.net>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1310 rcp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1311 rsync support by C Campbell (suggested by Erik Warendorph)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1312 scp support by raf <raf@comdyn.com.au>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1313 sftp support by C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1314
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1315 inputsecret(), BufReadCmd, BufWriteCmd contributed by C Campbell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1316
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1317 Jérôme Augé -- also using new buffer method with ftp+.netrc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1318 Bram Moolenaar -- obviously vim itself, :e and v:cmdarg use, fetch,...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1319 Yasuhiro Matsumoto -- pointing out undo+0r problem and a solution
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1320 Erik Warendorph -- for several suggestions (g:netrw_..._cmd
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1321 variables, rsync etc)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1322 Doug Claar -- modifications to test for success with ftp operation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1323
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1324 ==============================================================================
459
d9d38102399f updated for version 7.0122
vimboss
parents: 236
diff changeset
1325 vim:tw=78:ts=8:ft=help:norl:fdm=marker